Mercedes.Auth.API

<back to all web services

LoginRequest

The following routes are available for this service:
POST/v1/loginProcess GAS Authentication
LoginRequest Parameters:
NameParameterData TypeRequiredDescription
AuthCodebodystringNoGAS AuthCode
ErrorCodebodystringNoGAS ErrorCode
ClientIdbodystringNoClient Id
SecretbodystringNoSecret
CallbackUrlbodystringNoCallback Url
RedirectUrlbodystringNoRedirect Url
LoginResponse Parameters:
NameParameterData TypeRequiredDescription
RedirectUrlformstringNo
IsAuthenticatedformboolNo
UserTokenformstringNo
UserIdformstringNo
UserRoleIdformList<int>No
DefaultRetailerformstringNo
LoginStatusformLoginStatusNo
UserRoleRedirectformstringNo
DefaultVehicleTypeformstringNo
EntitlementGroupformList<string>No
LoginStatus Enum:
Authenticated
NotAuthenticated
Error

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

<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Auth.API.ServiceModel">
  <AuthCode>String</AuthCode>
  <CallbackUrl>String</CallbackUrl>
  <ClientId>String</ClientId>
  <ErrorCode>String</ErrorCode>
  <RedirectUrl>String</RedirectUrl>
  <Secret>String</Secret>
</LoginRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Auth.API.ServiceModel">
  <DefaultRetailer>String</DefaultRetailer>
  <DefaultVehicleType>String</DefaultVehicleType>
  <EntitlementGroup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EntitlementGroup>
  <IsAuthenticated>false</IsAuthenticated>
  <LoginStatus>Authenticated</LoginStatus>
  <RedirectUrl>String</RedirectUrl>
  <UserId>String</UserId>
  <UserRoleId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UserRoleId>
  <UserRoleRedirect>String</UserRoleRedirect>
  <UserToken>String</UserToken>
</LoginResponse>