GET api/v1/admin/accounts/{id}/addressbookgrouppermissions/{subAccountID}

Return a list of gorups with all the permissions that are given to the sub accounts. Filter can be applied by supplying a value for "SubAccountID", otherwise leave as "null" or "none" to return permissions for all the sub accounts that belong to the master.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Master Account ID	globally unique identifier	Required
subAccountID	Sub Account ID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionResponse[]

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.Accounts.AccountAddressbookGroupPermissionResponse[]	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "ID": "7cdc7cfc-c03d-4f8a-93e8-844043d4a336",
        "Name": "sample string 2",
        "GroupID": "3c64b254-6eea-4e5e-b3eb-8e743fdccb5b",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      },
      {
        "ID": "7cdc7cfc-c03d-4f8a-93e8-844043d4a336",
        "Name": "sample string 2",
        "GroupID": "3c64b254-6eea-4e5e-b3eb-8e743fdccb5b",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfAccountAddressbookGroupPermissionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <AccountAddressbookGroupPermissionResponse>
        <ID>7cdc7cfc-c03d-4f8a-93e8-844043d4a336</ID>
        <Name>sample string 2</Name>
        <GroupID>3c64b254-6eea-4e5e-b3eb-8e743fdccb5b</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
      <AccountAddressbookGroupPermissionResponse>
        <ID>7cdc7cfc-c03d-4f8a-93e8-844043d4a336</ID>
        <Name>sample string 2</Name>
        <GroupID>3c64b254-6eea-4e5e-b3eb-8e743fdccb5b</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>