Mercedes.Auth.API

<back to all web services

Authorisation

The following routes are available for this service:
POST/v1/authorisation
"use strict";
export class AuthorisationResponse {
    /** @param {{status?:string,GasUserId?:string,Application?:string,Roles?:string[],GSSNRetailerIds?:string[],DefaultGSSNRetailerId?:string,DefaultVehicleType?:string,DefaultRole?:string,DefaultRoleCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    status;
    /** @type {string} */
    GasUserId;
    /** @type {string} */
    Application;
    /** @type {string[]} */
    Roles;
    /** @type {string[]} */
    GSSNRetailerIds;
    /** @type {string} */
    DefaultGSSNRetailerId;
    /** @type {string} */
    DefaultVehicleType;
    /** @type {string} */
    DefaultRole;
    /** @type {number} */
    DefaultRoleCount;
}
export class Authorisation {
    /** @param {{GasUserId?:string,ApplicationDotRole?:string[],GEMSOutletId?:string[],Application?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GasUserId;
    /** @type {string[]} */
    ApplicationDotRole;
    /** @type {string[]} */
    GEMSOutletId;
    /** @type {string} */
    Application;
}

JavaScript Authorisation DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/authorisation HTTP/1.1 
Host: prod-api-auth-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"GasUserId":"String","ApplicationDotRole":["String"],"GEMSOutletId":["String"],"Application":"String"}

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

{"status":"String","GasUserId":"String","Application":"String","Roles":["String"],"GSSNRetailerIds":["String"],"DefaultGSSNRetailerId":"String","DefaultVehicleType":"String","DefaultRole":"String","DefaultRoleCount":0}