CommandWebService
Click here for a complete list of operations.
getAgentHealth
Get health status of agents. Arguments are agent IDs and returns agent status.
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 /CommandWebService.asmx HTTP/1.1 Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.birst.com/getAgentHealth" <?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> <getAgentHealth xmlns="http://www.birst.com/"> <token>string</token> <agentIds> <string>string</string> <string>string</string> </agentIds> </getAgentHealth> </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> <getAgentHealthResponse xmlns="http://www.birst.com/"> <getAgentHealthResult> <AgentStatus> <agentId>string</agentId> <status>string</status> <userId>string</userId> <activityStatus>string</activityStatus> </AgentStatus> <AgentStatus> <agentId>string</agentId> <status>string</status> <userId>string</userId> <activityStatus>string</activityStatus> </AgentStatus> </getAgentHealthResult> </getAgentHealthResponse> </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 /CommandWebService.asmx HTTP/1.1 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> <getAgentHealth xmlns="http://www.birst.com/"> <token>string</token> <agentIds> <string>string</string> <string>string</string> </agentIds> </getAgentHealth> </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> <getAgentHealthResponse xmlns="http://www.birst.com/"> <getAgentHealthResult> <AgentStatus> <agentId>string</agentId> <status>string</status> <userId>string</userId> <activityStatus>string</activityStatus> </AgentStatus> <AgentStatus> <agentId>string</agentId> <status>string</status> <userId>string</userId> <activityStatus>string</activityStatus> </AgentStatus> </getAgentHealthResult> </getAgentHealthResponse> </soap12:Body> </soap12:Envelope>