RAPP.Mercedes.VanCustomerAccount.Api

<back to all web services

Subscribe

The following routes are available for this service:
POST/subscribe/
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 ReturnStatus:
    return_code: Optional[str] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscribeResponse:
    status: Optional[ReturnStatus] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    email_address: Optional[str] = None
    mobile_telephone_number: Optional[str] = None
    home_address__building_number_name: Optional[str] = None
    home_address__line1: Optional[str] = None
    home_address__line2: Optional[str] = None
    home_address__town_city: Optional[str] = None
    home_address__county: Optional[str] = None
    home_address__postcode: Optional[str] = None
    company_name: Optional[str] = None
    company_type: Optional[str] = None
    company_registration_number: Optional[str] = None
    vat_number: Optional[str] = None
    business_address__building_number_name: Optional[str] = None
    business_address__line1: Optional[str] = None
    business_address__line2: Optional[str] = None
    business_address__town_city: Optional[str] = None
    business_address__county: Optional[str] = None
    business_address__postcode: Optional[str] = None
    business_industry_type: Optional[str] = None
    fleet_size: Optional[str] = None
    email_opt_in: Optional[str] = None
    telephone_opt_in: Optional[str] = None
    sms_opt_in: Optional[str] = None
    post_opt_in: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscribe:
    ciam_id: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    email_address: Optional[str] = None
    mobile_telephone_number: Optional[str] = None

Python Subscribe 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 /subscribe/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CiamId: String,
	FirstName: String,
	LastName: String,
	EmailAddress: String,
	MobileTelephoneNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: 
	{
		ReturnCode: String,
		Message: String
	},
	FirstName: String,
	LastName: String,
	EmailAddress: String,
	MobileTelephoneNumber: String,
	HomeAddress_BuildingNumberName: String,
	HomeAddress_Line1: String,
	HomeAddress_Line2: String,
	HomeAddress_TownCity: String,
	HomeAddress_County: String,
	HomeAddress_Postcode: String,
	CompanyName: String,
	CompanyType: String,
	CompanyRegistrationNumber: String,
	VATNumber: String,
	BusinessAddress_BuildingNumberName: String,
	BusinessAddress_Line1: String,
	BusinessAddress_Line2: String,
	BusinessAddress_TownCity: String,
	BusinessAddress_County: String,
	BusinessAddress_Postcode: String,
	BusinessIndustryType: String,
	FleetSize: String,
	EmailOptIn: String,
	TelephoneOptIn: String,
	SMSOptIn: String,
	PostOptIn: String
}