Billiecart API

Authenticate

auth

Sign In

The following routes are available for this service:
OPTIONS,GET,POST,DELETE	/auth
OPTIONS,GET,POST,DELETE	/auth/{provider}

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Sign In
*/
@Api(Description="Sign In")
@DataContract
open class Authenticate : IPost, IMeta
{
    /**
    * AuthProvider, e.g. credentials
    */
    @DataMember(Order=1)
    var provider:String? = null

    @DataMember(Order=2)
    var state:String? = null

    @DataMember(Order=3)
    var oauth_token:String? = null

    @DataMember(Order=4)
    var oauth_verifier:String? = null

    @DataMember(Order=5)
    var userName:String? = null

    @DataMember(Order=6)
    var password:String? = null

    @DataMember(Order=7)
    var rememberMe:Boolean? = null

    @DataMember(Order=9)
    var errorView:String? = null

    @DataMember(Order=10)
    var nonce:String? = null

    @DataMember(Order=11)
    var uri:String? = null

    @DataMember(Order=12)
    var response:String? = null

    @DataMember(Order=13)
    var qop:String? = null

    @DataMember(Order=14)
    var nc:String? = null

    @DataMember(Order=15)
    var cnonce:String? = null

    @DataMember(Order=17)
    var accessToken:String? = null

    @DataMember(Order=18)
    var accessTokenSecret:String? = null

    @DataMember(Order=19)
    var scope:String? = null

    @DataMember(Order=20)
    var meta:HashMap<String,String> = HashMap<String,String>()
}

@DataContract
open class AuthenticateResponse : IMeta, IHasSessionId, IHasBearerToken
{
    @DataMember(Order=1)
    var userId:String? = null

    @DataMember(Order=2)
    var sessionId:String? = null

    @DataMember(Order=3)
    var userName:String? = null

    @DataMember(Order=4)
    var displayName:String? = null

    @DataMember(Order=5)
    var referrerUrl:String? = null

    @DataMember(Order=6)
    var bearerToken:String? = null

    @DataMember(Order=7)
    var refreshToken:String? = null

    @DataMember(Order=8)
    var profileUrl:String? = null

    @DataMember(Order=9)
    var roles:ArrayList<String> = ArrayList<String>()

    @DataMember(Order=10)
    var permissions:ArrayList<String> = ArrayList<String>()

    @DataMember(Order=11)
    var responseStatus:ResponseStatus? = null

    @DataMember(Order=12)
    var meta:HashMap<String,String> = HashMap<String,String>()
}

Kotlin Authenticate DTOs

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: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Authenticate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <provider>String</provider>
  <State>String</State>
  <oauth_token>String</oauth_token>
  <oauth_verifier>String</oauth_verifier>
  <UserName>String</UserName>
  <Password>String</Password>
  <RememberMe>false</RememberMe>
  <ErrorView>String</ErrorView>
  <nonce>String</nonce>
  <uri>String</uri>
  <response>String</response>
  <qop>String</qop>
  <nc>String</nc>
  <cnonce>String</cnonce>
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <scope>String</scope>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</Authenticate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserId>String</UserId>
  <SessionId>String</SessionId>
  <UserName>String</UserName>
  <DisplayName>String</DisplayName>
  <ReferrerUrl>String</ReferrerUrl>
  <BearerToken>String</BearerToken>
  <RefreshToken>String</RefreshToken>
  <ProfileUrl>String</ProfileUrl>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</AuthenticateResponse>