api_auth

<back to all web services

SiteSessionsRequest

SiteSessionsRequest Parameters:
NameParameterData TypeRequiredDescription
FiltersqueryIList<Filter>No
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
CountOnlyqueryboolNo
PersonIDquerylong?No
Filter Parameters:
NameParameterData TypeRequiredDescription
IsCustomformboolNo
SiteSessionsResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformSiteSessionOverview[]No
TotalCountformintNo
SiteSessionOverview Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
PersonNameformstringNo
IPAddressformstringNo
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
IdentityProviderIDformbyteNo
RequireConfirmationformboolNo
IsAliveformboolNo
IsIdleformboolNo

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/SiteSessionsRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"items":[{"personID":0,"personName":"String","ipAddress":"String","expirationTime":"0001-01-01T00:00:00.000Z","identityProviderID":0,"requireConfirmation":false,"isAlive":false,"isIdle":false}],"totalCount":0}