CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

setAgentsToConnectionMapping

Map Agents to Connections. Arguments are Login token, and connection to agent mappings.

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/setAgentsToConnectionMapping"

<?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>
    <setAgentsToConnectionMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </setAgentsToConnectionMapping>
  </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>
    <setAgentsToConnectionMappingResponse xmlns="http://www.birst.com/">
      <setAgentsToConnectionMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
      </setAgentsToConnectionMappingResult>
    </setAgentsToConnectionMappingResponse>
  </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>
    <setAgentsToConnectionMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </setAgentsToConnectionMapping>
  </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>
    <setAgentsToConnectionMappingResponse xmlns="http://www.birst.com/">
      <setAgentsToConnectionMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
      </setAgentsToConnectionMappingResult>
    </setAgentsToConnectionMappingResponse>
  </soap12:Body>
</soap12:Envelope>