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 .xml suffix or ?format=xml

HTTP + XML

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

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

<PeopleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Except xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Except>
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common.Filters" i:nil="true" />
  <ForChat>false</ForChat>
  <IncludeCount>false</IncludeCount>
  <IncludeData>false</IncludeData>
  <OrderBy>String</OrderBy>
  <PerPage>0</PerPage>
  <SiteID>0</SiteID>
  <StartIndex>0</StartIndex>
</PeopleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PeopleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Items>
    <PersonOverview>
      <Activity>0</Activity>
      <Email>String</Email>
      <InvitationStatus>0</InvitationStatus>
      <IsConfirmed>false</IsConfirmed>
      <LanguageID>String</LanguageID>
      <Name>String</Name>
      <PersonID>0</PersonID>
      <SiteInvitationID>0</SiteInvitationID>
      <Telephone>0</Telephone>
      <Version>0001-01-01T00:00:00</Version>
    </PersonOverview>
  </Items>
  <TotalCount>0</TotalCount>
</PeopleResponse>