ContactService
Click here for a complete list of operations.
GetContact
Get contact by id (GUID).
Params:
- id - contact id to search for.
- additionalInfo - ContactInformation flags. See GetContacts for details
Result: Contact derived type - EmailContact, SmsContact, IMContact, VoiceCallContact. See GetContacts for details. null if contact was not found.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/soap/v1/contact.asmx HTTP/1.1 Host: www.host-tracker.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.host-tracker.com/Services/GetContact" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <AuthHeader xmlns="http://www.host-tracker.com/Services"> <login>string</login> <password>string</password> <ticket>string</ticket> </AuthHeader> </soap:Header> <soap:Body> <GetContact xmlns="http://www.host-tracker.com/Services"> <id>guid</id> <additionalInfo>None or Subscriptions</additionalInfo> </GetContact> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetContactResponse xmlns="http://www.host-tracker.com/Services"> <GetContactResult> <id>guid</id> <confirmed>boolean</confirmed> <contactType>string</contactType> <name>string</name> <address>string</address> <sendCost>decimal</sendCost> <sendCostDirty>boolean</sendCostDirty> <alertDelay>int</alertDelay> <activePeriodStart>string</activePeriodStart> <activePeriodEnd>string</activePeriodEnd> <activeDays> <string>string</string> <string>string</string> </activeDays> <billingOverlimit> <string>string</string> <string>string</string> </billingOverlimit> <subscriptions> <Subscription> <alertTypes xsi:nil="true" /> <reportTypes xsi:nil="true" /> <taskIds xsi:nil="true" /> <contactIds xsi:nil="true" /> </Subscription> <Subscription> <alertTypes xsi:nil="true" /> <reportTypes xsi:nil="true" /> <taskIds xsi:nil="true" /> <contactIds xsi:nil="true" /> </Subscription> </subscriptions> </GetContactResult> </GetContactResponse> </soap:Body> </soap:Envelope>