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

<SiteSessionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <CountOnly>false</CountOnly>
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common.Filters" i:nil="true" />
  <OrderBy>String</OrderBy>
  <PerPage>0</PerPage>
  <PersonID>0</PersonID>
  <StartIndex>0</StartIndex>
</SiteSessionsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SiteSessionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Items>
    <SiteSessionOverview>
      <CreationTime>0001-01-01T00:00:00</CreationTime>
      <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
      <IPAddress>String</IPAddress>
      <IdentityProviderID>0</IdentityProviderID>
      <IsAlive>false</IsAlive>
      <IsIdle>false</IsIdle>
      <PersonID>0</PersonID>
      <PersonName>String</PersonName>
      <RequireConfirmation>false</RequireConfirmation>
    </SiteSessionOverview>
  </Items>
  <TotalCount>0</TotalCount>
</SiteSessionsResponse>