CommandWebService

Click here for a complete list of operations.

getDirectoryPermissions

List the permissions for a particular directory. Arguments are Login token, space Id and directory (a null value means top level). Returns an XML representation of the directory permissions.

SOAP

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

Request

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDirectoryPermissions"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <getDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryPermissions>
  </s:Body>
</s:Envelope>

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <getDirectoryPermissionsResponse xmlns="http://www.birst.com/">
      <getDirectoryPermissionsResult>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
      </getDirectoryPermissionsResult>
    </getDirectoryPermissionsResponse>
  </s:Body>
</s:Envelope>