api_auth

<back to all web services

SiteAuthorizationsRequest

SiteAuthorizationsRequest Parameters:
NameParameterData TypeRequiredDescription
PersonIDquerylong?No
SiteIDquerylong?No
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
IncludeCountqueryboolNo
IncludeDataqueryboolNo
PagedListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ItemsformT[]No
TotalCountformint?No
SiteAuthorization Parameters:
NameParameterData TypeRequiredDescription
AuthorizationIDformlongNo
SiteIDformlongNo
SiteNameformstringNo
PersonIDformlongNo
PersonNameformstringNo
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
ScopeIDformbyteNo

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

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

<SiteAuthorizationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common">
    <d2p1:SiteAuthorization>
      <d2p1:AuthorizationID>0</d2p1:AuthorizationID>
      <d2p1:CreationTime>0001-01-01T00:00:00</d2p1:CreationTime>
      <d2p1:ExpirationTime>0001-01-01T00:00:00</d2p1:ExpirationTime>
      <d2p1:PersonID>0</d2p1:PersonID>
      <d2p1:PersonName>String</d2p1:PersonName>
      <d2p1:ScopeID>0</d2p1:ScopeID>
      <d2p1:SiteID>0</d2p1:SiteID>
      <d2p1:SiteName>String</d2p1:SiteName>
    </d2p1:SiteAuthorization>
  </Items>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common">0</TotalCount>
</SiteAuthorizationsResponse>