GET | /agent-api/connections/{clientId} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserAuthId | form | string | No | |
ClientId | form | string | No | |
ClientName | form | string | No | |
ClientContactName | form | string | No | |
ClientContactEMail | form | string | No | |
ClientContactPhone | form | string | No | |
SessionId | form | string | No | |
SessionCreatedDate | form | DateTime? | No | |
SessionExpirationDate | form | DateTime? | No | |
SubscriptionId | form | string | No | |
AgentVersion | form | string | No | |
HardwareKey | form | string | No | |
AgentMachineName | form | string | No | |
AgentNetAddress | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { UserAuthId: String, ClientId: String, ClientName: String, ClientContactName: String, ClientContactEMail: String, ClientContactPhone: String, SessionId: String, SessionCreatedDate: 0001-01-01T00:00:00, SessionExpirationDate: 0001-01-01T00:00:00, SubscriptionId: String, AgentVersion: String, HardwareKey: String, AgentMachineName: String, AgentNetAddress: String }