NAV

<back to all web services

ProfileBasicInformationCreate

The following routes are available for this service:
POST/profile/{BeeNumber}/basic-information
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 ProfileBasicInformationCreateResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressCreateViewModel:
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    city: Optional[str] = None
    state_code: Optional[str] = None
    postal_code: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileBasicInformationCreate(IPost):
    bee_number: Optional[Decimal] = None
    primary_phone: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    address: Optional[AddressCreateViewModel] = None
    bee_number_mentor: Optional[Decimal] = None

Python ProfileBasicInformationCreate 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 /profile/{BeeNumber}/basic-information HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	primaryPhone: String,
	birthDate: 0001-01-01T00:00:00,
	address: 
	{
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		city: String,
		stateCode: String,
		postalCode: String,
		countryCode: String
	},
	beeNumberMentor: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}