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 .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 /v1/authorisation HTTP/1.1 
Host: prod-api-auth-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Authorisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Auth.API.ServiceModel">
  <Application>String</Application>
  <ApplicationDotRole xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ApplicationDotRole>
  <GEMSOutletId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GEMSOutletId>
  <GasUserId>String</GasUserId>
</Authorisation>

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

<AuthorisationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Auth.API.ServiceModel">
  <Application>String</Application>
  <DefaultGSSNRetailerId>String</DefaultGSSNRetailerId>
  <DefaultRole>String</DefaultRole>
  <DefaultRoleCount>0</DefaultRoleCount>
  <DefaultVehicleType>String</DefaultVehicleType>
  <GSSNRetailerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GSSNRetailerIds>
  <GasUserId>String</GasUserId>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <status>String</status>
</AuthorisationResponse>