heilog.ch.Api

<back to all web services

AuthRequest

The following routes are available for this service:
POST/auth
AuthRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
PasswordbodystringNo
WebsitebodyWebsiteNo
Website Enum:
NameValue
Platform1
Admin2
AuthResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
EmailformstringNo
LanguageCodeformLanguageCodeNo
BearerTokenformstringNo
ResponseStatusformResponseStatusNo
LanguageCode Enum:
NameValue
de1
fr2
it3

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 /auth HTTP/1.1 
Host: heidak-api.build.exanic.ch 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuthRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FINControlAoPortal.ServiceModel.Authentication">
  <Email>String</Email>
  <Password>String</Password>
  <Website>Platform</Website>
</AuthRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FINControlAoPortal.ServiceModel.Authentication">
  <BearerToken>String</BearerToken>
  <Email>String</Email>
  <LanguageCode>de</LanguageCode>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <UserId>0</UserId>
</AuthResponse>