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.
ResponseOfGroupDetailsName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfGroupDetails |
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": "9421499e-081a-413a-a208-1ba5de5a6d22", "Groupname": "sample string 2", "DateCreated": "sample string 3", "DateModified": "sample string 4", "Contacts": 5, "LastModifiedBy": "sample string 6", "PermissionDetails": "sample string 7" } } }
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>9421499e-081a-413a-a208-1ba5de5a6d22</GroupID> <Groupname>sample string 2</Groupname> <DateCreated>sample string 3</DateCreated> <DateModified>sample string 4</DateModified> <Contacts>5</Contacts> <LastModifiedBy>sample string 6</LastModifiedBy> <PermissionDetails>sample string 7</PermissionDetails> <PermissionLevel>8</PermissionLevel> <GroupAccountID>79262889-5191-4bb7-8be7-f7831d330c37</GroupAccountID> <ParentGroupID>09ae7cd7-4511-4188-b02e-9f82524a4d15</ParentGroupID> </Detail> </ResponseData> </ResponseOfGroupDetails>