GET api/v1/addressbook/groups/{groupID}
This method returns a group stored on any account.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupID |
Unique indentifier for the group in question. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Group Details.
TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.AddressBooks.GroupDetailsName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.AddressBooks.GroupDetails |
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": { "GroupID": "47c69585-c536-480c-9c75-2bf9ad55f49d", "Groupname": "sample string 2", "DateCreated": "2024-03-28T21:29:14.9917359+00:00", "DateModified": "2024-03-28T21:29:14.9917359+00:00", "Contacts": 4, "LastModifiedBy": "sample string 5", "PermissionDetails": "sample string 6" } } }
application/xml, text/xml
Sample:
<ResponseOfGroupDetails 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> <GroupID>47c69585-c536-480c-9c75-2bf9ad55f49d</GroupID> <Groupname>sample string 2</Groupname> <DateCreated>2024-03-28T21:29:14.9917359+00:00</DateCreated> <DateModified>2024-03-28T21:29:14.9917359+00:00</DateModified> <Contacts>4</Contacts> <LastModifiedBy>sample string 5</LastModifiedBy> <PermissionDetails>sample string 6</PermissionDetails> <PermissionLevel>7</PermissionLevel> <GroupAccountID>a9b39cba-36ac-4377-80ac-ab1479ab9c63</GroupAccountID> <ParentGroupID>647c05f7-ce6c-42a5-aa3f-6e2e224fb324</ParentGroupID> </Detail> </ResponseData> </ResponseOfGroupDetails>