CommandWebService


Click here for a complete list of operations.

registerBirstConnectAgent

Registers a new birst connect agent. Arguments are Login token, agent name and agent description and returns the unique id of the registered agent.

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

<?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>
    <registerBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
      <userId>string</userId>
      <restricted>boolean</restricted>
      <agentGroup>string</agentGroup>
    </registerBirstConnectAgent>
  </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>
    <registerBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <registerBirstConnectAgentResult>string</registerBirstConnectAgentResult>
    </registerBirstConnectAgentResponse>
  </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>
    <registerBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
      <userId>string</userId>
      <restricted>boolean</restricted>
      <agentGroup>string</agentGroup>
    </registerBirstConnectAgent>
  </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>
    <registerBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <registerBirstConnectAgentResult>string</registerBirstConnectAgentResult>
    </registerBirstConnectAgentResponse>
  </soap12:Body>
</soap12:Envelope>