This shows you the differences between two versions of the page.
|
api-xml-template [2014/12/20 11:41] 127.0.0.1 external edit |
api-xml-template [2017/07/26 08:24] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== API - XML Template ====== | ||
| - | This API method returns the structure (in XML format) of the Contact table from the specified Account's database. This includes the default system fields (such as EmailAddress) and any custom fields that may have been created. | ||
| - | |||
| - | [[api|Other Sentori API methods]] | ||
| - | |||
| - | ===== Request ===== | ||
| - | |||
| - | |Post|<nowiki>https://api.sentoriapp.com/v1/contacts.asmx/XmlTemplate</nowiki>| | ||
| - | |Required Headers|ApiKey: <Guid>| | ||
| - | |Optional Headers|Accept-Encoding: Gzip (indicates to the API that it can compress the Response)| | ||
| - | | ||
| - | |||
| - | ===== Response ===== | ||
| - | |||
| - | |Body|<code><Contacts> | ||
| - | <Contact> | ||
| - | <IsBadEmailAddress>True/False</IsBadEmailAddress> | ||
| - | <CRMID>Small Text</CRMID> | ||
| - | <Title>Small Text</Title> | ||
| - | <FirstName>Small Text</FirstName> | ||
| - | <LastName>Small Text</LastName> | ||
| - | <KnownAs>Small Text</KnownAs> | ||
| - | <EmailAddress>Email Address</EmailAddress> | ||
| - | <MobilePhoneNumber>Small Text</MobilePhoneNumber> | ||
| - | </Contact> | ||
| - | </Contacts></code>| | ||
| - | |Headers|200 OK | | ||
| - | |Errors|403 Invalid API Key| | ||
| - | |||
| - | ===== Example HTTP Transaction ===== | ||
| - | |||
| - | <code> | ||
| - | GET https://api.sentoriapp.com/v1/contacts.asmx/XmlTemplate HTTP/1.1 | ||
| - | apikey: e9614e92-1999-441a-89b7-707b1542c642 | ||
| - | Host: api.sentoriapp.com | ||
| - | </code> | ||
| - | |||
| - | <code> | ||
| - | HTTP/1.1 200 OK | ||
| - | Content-Length: 386 | ||
| - | Content-Type: application/xml; charset=utf-8 | ||
| - | |||
| - | <Contacts> | ||
| - | <Contact> | ||
| - | <IsBadEmailAddress>True/False</IsBadEmailAddress> | ||
| - | <CRMID>Small Text</CRMID> | ||
| - | <Title>Small Text</Title> | ||
| - | <FirstName>Small Text</FirstName> | ||
| - | <LastName>Small Text</LastName> | ||
| - | <KnownAs>Small Text</KnownAs> | ||
| - | <EmailAddress>Email Address</EmailAddress> | ||
| - | <MobilePhoneNumber>Small Text</MobilePhoneNumber> | ||
| - | </Contact> | ||
| - | </Contacts> | ||
| - | </code> | ||