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 'package:servicestack/servicestack.dart';

// @DataContract
class AuthenticateResponse implements IMeta, IHasSessionId, IHasBearerToken, IConvertible
{
    // @DataMember(Order=1)
    String? userId;

    // @DataMember(Order=2)
    String? sessionId;

    // @DataMember(Order=3)
    String? userName;

    // @DataMember(Order=4)
    String? displayName;

    // @DataMember(Order=5)
    String? referrerUrl;

    // @DataMember(Order=6)
    String? bearerToken;

    // @DataMember(Order=7)
    String? refreshToken;

    // @DataMember(Order=8)
    String? profileUrl;

    // @DataMember(Order=9)
    List<String>? roles;

    // @DataMember(Order=10)
    List<String>? permissions;

    // @DataMember(Order=11)
    ResponseStatus? responseStatus;

    // @DataMember(Order=12)
    Map<String,String?>? meta;

    AuthenticateResponse({this.userId,this.sessionId,this.userName,this.displayName,this.referrerUrl,this.bearerToken,this.refreshToken,this.profileUrl,this.roles,this.permissions,this.responseStatus,this.meta});
    AuthenticateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        sessionId = json['sessionId'];
        userName = json['userName'];
        displayName = json['displayName'];
        referrerUrl = json['referrerUrl'];
        bearerToken = json['bearerToken'];
        refreshToken = json['refreshToken'];
        profileUrl = json['profileUrl'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        permissions = JsonConverters.fromJson(json['permissions'],'List<String>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'sessionId': sessionId,
        'userName': userName,
        'displayName': displayName,
        'referrerUrl': referrerUrl,
        'bearerToken': bearerToken,
        'refreshToken': refreshToken,
        'profileUrl': profileUrl,
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'permissions': JsonConverters.toJson(permissions,'List<String>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'meta': meta
    };

    getTypeName() => "AuthenticateResponse";
    TypeContext? context = _ctx;
}

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

    // @DataMember(Order=2)
    String? state;

    // @DataMember(Order=3)
    String? oauth_token;

    // @DataMember(Order=4)
    String? oauth_verifier;

    // @DataMember(Order=5)
    String? userName;

    // @DataMember(Order=6)
    String? password;

    // @DataMember(Order=7)
    bool? rememberMe;

    // @DataMember(Order=9)
    String? errorView;

    // @DataMember(Order=10)
    String? nonce;

    // @DataMember(Order=11)
    String? uri;

    // @DataMember(Order=12)
    String? response;

    // @DataMember(Order=13)
    String? qop;

    // @DataMember(Order=14)
    String? nc;

    // @DataMember(Order=15)
    String? cnonce;

    // @DataMember(Order=17)
    String? accessToken;

    // @DataMember(Order=18)
    String? accessTokenSecret;

    // @DataMember(Order=19)
    String? scope;

    // @DataMember(Order=20)
    Map<String,String?>? meta;

    Authenticate({this.provider,this.state,this.oauth_token,this.oauth_verifier,this.userName,this.password,this.rememberMe,this.errorView,this.nonce,this.uri,this.response,this.qop,this.nc,this.cnonce,this.accessToken,this.accessTokenSecret,this.scope,this.meta});
    Authenticate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        provider = json['provider'];
        state = json['state'];
        oauth_token = json['oauth_token'];
        oauth_verifier = json['oauth_verifier'];
        userName = json['userName'];
        password = json['password'];
        rememberMe = json['rememberMe'];
        errorView = json['errorView'];
        nonce = json['nonce'];
        uri = json['uri'];
        response = json['response'];
        qop = json['qop'];
        nc = json['nc'];
        cnonce = json['cnonce'];
        accessToken = json['accessToken'];
        accessTokenSecret = json['accessTokenSecret'];
        scope = json['scope'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'provider': provider,
        'state': state,
        'oauth_token': oauth_token,
        'oauth_verifier': oauth_verifier,
        'userName': userName,
        'password': password,
        'rememberMe': rememberMe,
        'errorView': errorView,
        'nonce': nonce,
        'uri': uri,
        'response': response,
        'qop': qop,
        'nc': nc,
        'cnonce': cnonce,
        'accessToken': accessToken,
        'accessTokenSecret': accessTokenSecret,
        'scope': scope,
        'meta': meta
    };

    getTypeName() => "Authenticate";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
});

Dart Authenticate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	provider: String,
	state: String,
	oauth_token: String,
	oauth_verifier: String,
	userName: String,
	password: String,
	rememberMe: False,
	errorView: String,
	nonce: String,
	uri: String,
	response: String,
	qop: String,
	nc: String,
	cnonce: String,
	accessToken: String,
	accessTokenSecret: String,
	scope: String,
	meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userId: String,
	sessionId: String,
	userName: String,
	displayName: String,
	referrerUrl: String,
	bearerToken: String,
	refreshToken: String,
	profileUrl: String,
	roles: 
	[
		String
	],
	permissions: 
	[
		String
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	meta: 
	{
		String: String
	}
}