getUserGroupSet

Returns a set of user groups that match all the specified conditions.

Authentication

Authentication required : an API access token must be provided in the URL query string.

Request

Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.

HTTP Request

GET https://api.jelevelamain.fr/getUserGroupSet?apiKey=API_KEY&accessToken=ACCESS_TOKEN

Parameters

Each parameter is URL-encoded and added to the URL query string.

Response

The first DataSetPage of the matching user group set. The next pages can be obtained by sending getDataSetPage requests with the dataSetId specified in the response :

{
    "dataSetId" : string,
    "itemType" : "userGroup",
    "numberOfPages" : unsigned integer,
    "numberOfItemsPerPage" : unsigned integer,
    "totalNumberOfItems" : unsigned integer,
    "items" : UserGroup[],
    "currentPageIndex" : unsigned integer        
}

Try it !

You can test this request on live data and see the API response by filling the form below.

Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.