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

NameDescriptionTypeAdditional 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[]
NameDescriptionTypeAdditional 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": "e21088db-aac2-41f3-965f-4d63490aa9fa",
        "Name": "sample string 2",
        "GroupID": "0a245efe-9668-4dac-9c51-47460f98dbb0",
        "GroupName": "sample string 4",
        "PermissionLevel": 0
      },
      {
        "ID": "e21088db-aac2-41f3-965f-4d63490aa9fa",
        "Name": "sample string 2",
        "GroupID": "0a245efe-9668-4dac-9c51-47460f98dbb0",
        "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>e21088db-aac2-41f3-965f-4d63490aa9fa</ID>
        <Name>sample string 2</Name>
        <GroupID>0a245efe-9668-4dac-9c51-47460f98dbb0</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
      <AccountAddressbookGroupPermissionResponse>
        <ID>e21088db-aac2-41f3-965f-4d63490aa9fa</ID>
        <Name>sample string 2</Name>
        <GroupID>0a245efe-9668-4dac-9c51-47460f98dbb0</GroupID>
        <GroupName>sample string 4</GroupName>
        <PermissionLevel>NONE</PermissionLevel>
      </AccountAddressbookGroupPermissionResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAccountAddressbookGroupPermissionResponse>