Windows Live Contacts API: REST Schema

[thiruvasagamani]

Windows Live Contacts API: REST Schema

The Windows Live Contacts address book schema determines the URI and valid XPath queries for the Windows Live Contacts Representational State Transfer (REST) API. The schema may occasionally change, but the basic methods and usage will remain the same. URIs that are constructed with the schema are assumed to have the following prefix:


REST Schema
Copy Code

Code Select Expand

<LiveContacts>
<Owner>
  <CID>User Unique ID</CID>
  <WindowsLiveID>PassportMemberName</WindowsLiveID>
  <Profiles>
   <Personal>
    <NameTitle>NameTitle</NameTitle>
    <FirstName>FirstName</FirstName>
    <MiddleName>MiddleName</MiddleName>
    <LastName>LastName</LastName>
    <Suffix>Suffix</Suffix>
    <YomiFirstName>FirstNamePronunciation</YomiFirstName>
    <YomiLastName>LastNamePronunciation</YomiLastName>
    <Birthdate>UTCTimeStamp</Birthdate>
    <Anniversary>Date</Anniversary>
    <Gender>Gender</Gender>
    <TimeZone>TimeZone</TimeZone>
    <SpouseName>SpouseName</SpouseName>
   </Personal>
   <Professional>
    <JobTitle>JobTitle</JobTitle>
    <Profession>Profession</Profession>
    <Manager>ManagerName</Manager>
    <Assistant>AssistantName</Assistant>
   </Professional>
  </Profiles>
  <Emails></Emails>
  <Phones></Phones>
  <Locations></Locations>
  <URIs></URIs>
</Owner>
<Contacts>
  <Contact>
   <ID>ContactID</ID>
   <CID>Unique User ID</CID>
   <WindowsLiveID>PassportMemberName</WindowsLiveID>
   <AutoUpdateEnabled>TrueFalse</AutoUpdateEnabled>
   <AutoUpdateStatus>Live|LivePending</AutoUpdateStatus>
   <Profiles>
    <Personal>
     <NameToFileAs>FileName</NameToFileAs>
     <NameTitle>NameTitle</NameTitle>
     <FirstName>FirstName</FirstName>
     <MiddleName>MiddleName</MiddleName>
     <LastName>LastName</LastName>
     <Suffix>Suffix</Suffix>
     <YomiFirstName>FirstNamePronunciation</YomiFirstName>
     <YomiLastName>LastNamePronunciation</YomiLastName>
     <UniqueName>Unique Quickname</UniqueName>
     <SortName>name to sort by</SortName>
     <NickName>name entered by the owner</NickName>
     <DisplayName>name provided by the contact</DisplayName>
     <Birthdate>UTCTimeStamp</Birthdate>
     <Anniversary>Date</Anniversary>
     <Gender>Gender</Gender>
     <TimeZone>TimeZone</TimeZone>
     <SpouseName>SpouseName</SpouseName>
    </Personal>
    <Professional>
     <JobTitle>JobTitle</JobTitle>
     <Profession>Profession</Profession>
     <Manager>ManagerName</Manager>
     <Assistant>AssistantName</Assistant>
    </Professional>
   </Profiles>
   <Emails>
    <Email>
     <ID>EmailID</ID>
     <EmailType>EmailType</EmailType>
     <Address>EmailAddress</Address>
     <IsIMEnabled>TrueFalse</IsIMEnabled>
     <IsDefault>TrueFalse</IsDefault>
    </Email>
   </Emails>
   <Phones>
    <Phone>
     <ID>PhoneID</ID>
     <PhoneType>PhoneType</PhoneType>
     <Number>PhoneNumber</Number>
     <IsIMEnabled>TrueFalse</IsIMEnabled>
     <IsDefault>TrueFalse</IsDefault>
    </Phone>
   </Phones>
   <Locations>
    <Location>
     <ID>LocationID</ID>
     <Office>Office</Office>
     <Department>Department</Department>
     <CompanyName>CompanyName</CompanyName>
     <YomiCompanyName>CompanyNamePronunciation</YomiCompanyName>
     <LocationType>LocationType</LocationType>
     <StreetLine>StreetNameLine</StreetLine>
     <StreetLine2>StreetNameLine</StreetLine2>
     <PrimaryCity>CityNameLine</PrimaryCity>
     <SecondaryCity>CityNameLine</SecondaryCity>
     <SubDivision>StateOrProvince</SubDivision>
     <PostalCode>PostcodeOrZipcode</PostalCode>
     <CountryRegion>Country</CountryRegion>
     <Latitude>Latitude</Latitude>
     <Longitude>Longitude</Longitude>
     <IsDefault>TrueFalse</IsDefault>
    </Location>
   </Locations>
   <URIs>
    <URI>
     <ID>URLID</ID>
     <URIType>URIType</URIType>
     <Name>URIName</Name>
     <Address>URLName</Address>
    </URI>
   </URIs>
  </Contact>
</Contacts>
<Tags>
  <Tag>
   <ID>GroupID|CategoryID}</ID>
   <Name>TagName</Name>
   <ContactIDs>
    <ContactID>ContactID</ContactID>
   </ContactIDs>
  </Tag>
</Tags>
</LiveContacts>


Source : MSDN