CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

getUsersInAccount

This webservice retrieves list of users from the account of invoking user. Only an Account Admin user is authorised to invoke this API.

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

<?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>
    <getUsersInAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <offset>int</offset>
      <limit>int</limit>
      <search>string</search>
    </getUsersInAccount>
  </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>
    <getUsersInAccountResponse xmlns="http://www.birst.com/">
      <getUsersInAccountResult>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
      </getUsersInAccountResult>
    </getUsersInAccountResponse>
  </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>
    <getUsersInAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <offset>int</offset>
      <limit>int</limit>
      <search>string</search>
    </getUsersInAccount>
  </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>
    <getUsersInAccountResponse xmlns="http://www.birst.com/">
      <getUsersInAccountResult>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
      </getUsersInAccountResult>
    </getUsersInAccountResponse>
  </soap12:Body>
</soap12:Envelope>