NAV

<back to all web services

ProfileSignUpCreate

The following routes are available for this service:
POST/profile/sign-up
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 ProfileSignUpCreateResponse:
    response_status: Optional[ResponseStatus] = None
    bee_number: Optional[Decimal] = None
    access_token: Optional[str] = None
    timestamp: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVPhoneUpdate:
    number: Optional[str] = None
    extension: Optional[str] = None
    code_id_phone_type: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVCASLTermsUpdate:
    agree: Optional[str] = None
    date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileSignUpCreate(IPost):
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    email_address: Optional[str] = None
    customer_type: Optional[str] = None
    culture_name: Optional[str] = None
    phone: Optional[NAVPhoneUpdate] = None
    casl_statement_agreement: Optional[NAVCASLTermsUpdate] = None

Python ProfileSignUpCreate 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 /profile/sign-up HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProfileSignUpCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <CASLStatementAgreement>
    <Agree>String</Agree>
    <Date>0001-01-01T00:00:00</Date>
  </CASLStatementAgreement>
  <CultureName>String</CultureName>
  <CustomerType>String</CustomerType>
  <EmailAddress>String</EmailAddress>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Phone>
    <CodeIdPhoneType>String</CodeIdPhoneType>
    <CountryCode>String</CountryCode>
    <Extension>String</Extension>
    <Number>String</Number>
  </Phone>
</ProfileSignUpCreate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProfileSignUpCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <AccessToken>String</AccessToken>
  <BeeNumber>0</BeeNumber>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Timestamp>0001-01-01T00:00:00</Timestamp>
</ProfileSignUpCreateResponse>