eRelocation_API
Click here for a complete list of operations.
GetAgents
Returns a comprehensive XmlDocument of a company's "agents" (people), with many options available to add or remove data from the generated document.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /default.asmx HTTP/1.1 Host: api.erelocation.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.erelocation.net/GetAgents" <?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> <GetAgents xmlns="https://api.erelocation.net/"> <ThirdPartyID>string</ThirdPartyID> <ChangedSinceUTC>string</ChangedSinceUTC> <OfficeID>string</OfficeID> <OnlyShowActive>string</OnlyShowActive> <IncludeAgentProfile>string</IncludeAgentProfile> <ProductionIncludesExcludedSources>string</ProductionIncludesExcludedSources> <ProductionIncludesNonExcludedSources>string</ProductionIncludesNonExcludedSources> </GetAgents> </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> <GetAgentsResponse xmlns="https://api.erelocation.net/"> <GetAgentsResult>xml</GetAgentsResult> </GetAgentsResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /default.asmx HTTP/1.1 Host: api.erelocation.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetAgents xmlns="https://api.erelocation.net/"> <ThirdPartyID>string</ThirdPartyID> <ChangedSinceUTC>string</ChangedSinceUTC> <OfficeID>string</OfficeID> <OnlyShowActive>string</OnlyShowActive> <IncludeAgentProfile>string</IncludeAgentProfile> <ProductionIncludesExcludedSources>string</ProductionIncludesExcludedSources> <ProductionIncludesNonExcludedSources>string</ProductionIncludesNonExcludedSources> </GetAgents> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetAgentsResponse xmlns="https://api.erelocation.net/"> <GetAgentsResult>xml</GetAgentsResult> </GetAgentsResponse> </soap12:Body> </soap12:Envelope>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /default.asmx/GetAgents HTTP/1.1 Host: api.erelocation.net Content-Type: application/x-www-form-urlencoded Content-Length: length ThirdPartyID=string&ChangedSinceUTC=string&OfficeID=string&OnlyShowActive=string&IncludeAgentProfile=string&ProductionIncludesExcludedSources=string&ProductionIncludesNonExcludedSources=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0"?> xml