api_auth

<back to all web services

AccountGroupsRequest

AccountGroupsRequest Parameters:
NameParameterData TypeRequiredDescription
SiteIDquerylong?No
FiltersqueryIList<Filter>No
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
IncludeCountqueryboolNo
IncludeDataqueryboolNo
Filter Parameters:
NameParameterData TypeRequiredDescription
IsCustomformboolNo
AccountGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformAccountGroupOverview[]No
TotalCountformintNo
AccountGroupOverview Parameters:
NameParameterData TypeRequiredDescription
SiteIDformlongNo
GroupIDformlongNo
NameformstringNo
MailNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/AccountGroupsRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"siteID":0,"startIndex":0,"perPage":0,"orderBy":"String","includeCount":false,"includeData":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"siteID":0,"groupID":0,"name":"String","mailName":"String"}],"totalCount":0}