api_auth

<back to all web services

CurrentSessionRequest

The following routes are available for this service:
GET/api/accountInformation about current logged-in user
UserInfo Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
NameformstringNo
EmailformstringNo
Telephoneformlong?No
HyperIDformstringNo
IsConfirmedformboolNo
IsEmailConfirmedformboolNo
IsTelephoneConfirmedformboolNo
IsAddressConfirmedformboolNo
IsPassportConfirmedformboolNo
DatacenterIDformbyteNo
SessionIDformlongNo
MailNodeIDformint?No
CanResendConfirmationformboolNo
LanguageformstringNo
ServerTimeformDateTimeNo
ExpirationTimeformDateTimeNoExpiration time of current session
UserAgentformUserAgentInfoNo
SessionKeyformstringNo
MinAuthLevelformintNo
SessionAuthLevelformintNo
UserAgentInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DeviceNameformstringNo
DeviceTypeformshortNo
OSTypeformshortNo
OSVersionformstringNo
BrowserNameformstringNo
BrowserVersionformstringNo

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.

GET /api/account HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <CanResendConfirmation>false</CanResendConfirmation>
  <DatacenterID>0</DatacenterID>
  <Email>String</Email>
  <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
  <HyperID>String</HyperID>
  <IsAddressConfirmed>false</IsAddressConfirmed>
  <IsEmailConfirmed>false</IsEmailConfirmed>
  <IsPassportConfirmed>false</IsPassportConfirmed>
  <IsTelephoneConfirmed>false</IsTelephoneConfirmed>
  <Language>String</Language>
  <MailNodeID>0</MailNodeID>
  <MinAuthLevel>0</MinAuthLevel>
  <Name>String</Name>
  <PersonID>0</PersonID>
  <ServerTime>0001-01-01T00:00:00</ServerTime>
  <SessionAuthLevel>0</SessionAuthLevel>
  <SessionID>0</SessionID>
  <SessionKey>String</SessionKey>
  <Telephone>0</Telephone>
  <UserAgent>
    <BrowserName>String</BrowserName>
    <BrowserVersion>String</BrowserVersion>
    <DeviceName>String</DeviceName>
    <DeviceType>0</DeviceType>
    <Name>String</Name>
    <OSType>0</OSType>
    <OSVersion>String</OSVersion>
  </UserAgent>
</UserInfo>