GET v1/core/accounts/{accId}/accessgroups/{accGrpId}/members/paged?pageNumber={pageNumber}&pageSize={pageSize}&includeTotal={includeTotal}

Return a paged set of members in the group

Request Information

Parameters

NameDescriptionAdditional information
accId
The account ID

Define this parameter in the request URI.

accGrpId
The access group ID

Define this parameter in the request URI.

pageNumber
The page number, starting from 0. The default value is 0.
            If an invalid value is supplied, 1000 will be used instead.

Define this parameter in the request URI.

pageSize
The number of results to return per page. Allowable values between 0 and 1000.
            The default value is 0. If an invalid value is supplied, 1000 will be used instead.

Define this parameter in the request URI.

includeTotal
Flag indicating whether to include the total row count. 
            Default value is false.

Define this parameter in the request URI.

Response Information

A paged list of access group members

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "PreviousPage": 1,
    "CurrentPage": 1,
    "NextPage": 1,
    "PageSize": 2,
    "TotalCount": 1,
    "ResultSet": [
      {
        "ID": 1,
        "AccessGroupID": 2,
        "UserID": 3
      },
      {
        "ID": 1,
        "AccessGroupID": 2,
        "UserID": 3
      },
      {
        "ID": 1,
        "AccessGroupID": 2,
        "UserID": 3
      }
    ]
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"PreviousPage":1,"CurrentPage":1,"NextPage":1,"PageSize":2,"TotalCount":1,"ResultSet":[{"ID":1,"AccessGroupID":2,"UserID":3},{"ID":1,"AccessGroupID":2,"UserID":3},{"ID":1,"AccessGroupID":2,"UserID":3}]},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfPagedListOfAccessGroupMemberCA1DLPoZCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <CurrentPage>1</CurrentPage>
    <NextPage>1</NextPage>
    <PageSize>2</PageSize>
    <PreviousPage>1</PreviousPage>
    <ResultSet>
      <AccessGroupMember>
        <AccessGroupID>2</AccessGroupID>
        <ID>1</ID>
        <UserID>3</UserID>
      </AccessGroupMember>
      <AccessGroupMember>
        <AccessGroupID>2</AccessGroupID>
        <ID>1</ID>
        <UserID>3</UserID>
      </AccessGroupMember>
      <AccessGroupMember>
        <AccessGroupID>2</AccessGroupID>
        <ID>1</ID>
        <UserID>3</UserID>
      </AccessGroupMember>
    </ResultSet>
    <TotalCount>1</TotalCount>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfPagedListOfAccessGroupMemberCA1DLPoZCA1DLPoZ>

application/bson

Sample:
USuccessData�PreviousPageCurrentPageNextPagePageSizeTotalCountResultSet�0,IDAccessGroupIDUserID1,IDAccessGroupIDUserID2,IDAccessGroupIDUserIDErrorCodeErrorDescriptionsample string 3Metasample string 4