api_auth

<back to all web services

PeopleRequest

PeopleRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeCountqueryboolNo
IncludeDataqueryboolNo
SiteIDquerylong?No
FiltersqueryIList<Filter>No
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
ForChatqueryboolNo
Exceptquerylong[]No
Filter Parameters:
NameParameterData TypeRequiredDescription
IsCustomformboolNo
PeopleResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformPersonOverview[]No
TotalCountformintNo
PersonOverview Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
NameformstringNo
AccountNameformstringNo
EmailformstringNo
Telephoneformlong?No
LanguageIDformstringNo
IsConfirmedformboolNo
InvitationStatusformbyteNo
VersionformDateTimeNo
ActivityformintNo
SiteInvitationIDformlong?No

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

HTTP + CSV

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

POST /csv/reply/PeopleRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"includeCount":false,"includeData":false,"siteID":0,"startIndex":0,"perPage":0,"orderBy":"String","forChat":false,"except":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"items":[{"personID":0,"name":"String","accountName":"String","email":"String","telephone":0,"languageID":"String","isConfirmed":false,"invitationStatus":0,"activity":0,"siteInvitationID":0}],"totalCount":0}