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 .jsv suffix or ?format=jsv

HTTP + 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
}