GetPermissions

This call is to retrieve an array of Permission objects for the location.

Response Parameters

Id int — Unique Id of this Permission
IsActive bool — True if this Permisson is active, False if not
Name string — Name of this Permission
PermissionUniqueId Guid — Primary Key for Permission

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetPermissions request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetPermissions

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetPermissions' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetPermissions"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetPermissions/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetPermissionsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetPermissionsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Permissions>
          <Permission>
            <Id>1</Id>
            <IsActive>true</IsActive>
            <Name>Void Items</Name>
            <PermissionUniqueId>d4e5f6a7-b8c9-0123-def0-123456789012</PermissionUniqueId>
          </Permission>
        </Permissions>
      </GetPermissionsResult>
    </GetPermissionsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Permission objects.