Mercedes.Auth.API

<back to all web services

Authorisation

The following routes are available for this service:
POST/v1/authorisation
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthorisationResponse:
    status: Optional[str] = None
    gas_user_id: Optional[str] = None
    application: Optional[str] = None
    roles: Optional[List[str]] = None
    gssn_retailer_ids: Optional[List[str]] = None
    default_g_s_s_n_retailer_id: Optional[str] = None
    default_vehicle_type: Optional[str] = None
    default_role: Optional[str] = None
    default_role_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Authorisation:
    gas_user_id: Optional[str] = None
    application_dot_role: Optional[List[str]] = None
    gems_outlet_id: Optional[List[str]] = None
    application: Optional[str] = None

Python 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>