DataService

<back to all web services

AgentConnectionGet

Requires Authentication
The following routes are available for this service:
GET/agent-api/connections/{clientId}
AgentConnectionGet Parameters:
NameParameterData TypeRequiredDescription
ClientIdpathstringNo
AgentConnectionInfo Parameters:
NameParameterData TypeRequiredDescription
UserAuthIdformstringNo
ClientIdformstringNo
ClientNameformstringNo
ClientContactNameformstringNo
ClientContactEMailformstringNo
ClientContactPhoneformstringNo
SessionIdformstringNo
SessionCreatedDateformDateTime?No
SessionExpirationDateformDateTime?No
SubscriptionIdformstringNo
AgentVersionformstringNo
HardwareKeyformstringNo
AgentMachineNameformstringNo
AgentNetAddressformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /agent-api/connections/{clientId} HTTP/1.1 
Host: dataservice.mychirotouch.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentConnectionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ips.ChiroTouch.DataService.Model.Agent">
  <AgentMachineName>String</AgentMachineName>
  <AgentNetAddress>String</AgentNetAddress>
  <AgentVersion>String</AgentVersion>
  <ClientContactEMail>String</ClientContactEMail>
  <ClientContactName>String</ClientContactName>
  <ClientContactPhone>String</ClientContactPhone>
  <ClientId>String</ClientId>
  <ClientName>String</ClientName>
  <HardwareKey>String</HardwareKey>
  <SessionCreatedDate>0001-01-01T00:00:00</SessionCreatedDate>
  <SessionExpirationDate>0001-01-01T00:00:00</SessionExpirationDate>
  <SessionId>String</SessionId>
  <SubscriptionId>String</SubscriptionId>
  <UserAuthId>String</UserAuthId>
</AgentConnectionInfo>