NAV

<back to all web services

ProfileUpdate

The following routes are available for this service:
PUT/profile/{BeeNumber}
import Foundation
import ServiceStack

public class ProfileUpdate : IPut, Codable
{
    public var beeNumber:Double?
    public var firstName:String?
    public var lastName:String?
    public var nickname:String?
    public var birthDate:Date?
    public var billingAddress:NAVAddressUpdate?
    public var shippingAddress:NAVAddressUpdate?
    public var governmentId:String?
    public var emailAddress:String?
    public var primaryPhone:NAVPhoneUpdate?
    public var additionalPhone:NAVPhoneUpdate?
    public var onlineStoreAddress:String?
    public var language:String?
    public var publicityPermission:String?
    public var findMeOnline:Bool?
    public var oldPassword:String?
    public var newPassword:String?
    public var passwordHint:String?
    public var bankAccount:NAVBankAccountUpdate?
    public var termsAgreement:NAVTermsUpdate?
    public var electronicAgreement:NAVTermsUpdate?
    public var agentId:String?
    public var taxExemptCode:String?
    public var customerType:String?
    public var customerTypeEffectiveDate:Date?
    public var repAttachmentNumber:Double?
    public var repRelationship:String?
    public var preferredDeliveryMethod:String?
    public var noCode21:String?
    public var noCode30:String?
    public var privacyPolicyAgreement:NAVTermsUpdate?
    public var websiteTermsOfUseAgreement:NAVTermsUpdate?
    public var ageVerificationAgreement:NAVTermsUpdate?
    public var caslStatementAgreement:NAVCASLTermsUpdate?

    required public init(){}
}

public class NAVAddressUpdate : Codable
{
    public var firstName:String?
    public var lastName:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var addressLine3:String?
    public var addressLine4:String?
    public var addressLine5:String?
    public var city:String?
    public var stateCode:String?
    public var postalCode:String?
    public var countryCode:String?

    required public init(){}
}

public class NAVPhoneUpdate : Codable
{
    public var number:String?
    public var `extension`:String?
    public var codeIdPhoneType:String?
    public var countryCode:String?

    required public init(){}
}

public class NAVBankAccountUpdate : Codable
{
    public var accountName:String?
    public var bankName:String?
    public var accountNumber:String?
    public var routingNumber:String?

    required public init(){}
}

public class NAVTermsUpdate : Codable
{
    public var version:String?
    public var date:Date?

    required public init(){}
}

public class NAVCASLTermsUpdate : Codable
{
    public var agree:String?
    public var date:Date?

    required public init(){}
}

public class ProfileUpdateResponse : Codable
{
    public var responseStatus:ResponseStatus?

    required public init(){}
}


Swift ProfileUpdate 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.

PUT /profile/{BeeNumber} HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	firstName: String,
	lastName: String,
	nickname: String,
	birthDate: 0001-01-01T00:00:00,
	billingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateCode: String,
		postalCode: String,
		countryCode: String
	},
	shippingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateCode: String,
		postalCode: String,
		countryCode: String
	},
	governmentId: String,
	emailAddress: String,
	primaryPhone: 
	{
		number: String,
		extension: String,
		codeIdPhoneType: String,
		countryCode: String
	},
	additionalPhone: 
	{
		number: String,
		extension: String,
		codeIdPhoneType: String,
		countryCode: String
	},
	onlineStoreAddress: String,
	language: String,
	publicityPermission: String,
	findMeOnline: False,
	oldPassword: String,
	newPassword: String,
	passwordHint: String,
	bankAccount: 
	{
		accountName: String,
		bankName: String,
		accountNumber: String,
		routingNumber: String
	},
	termsAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	electronicAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	agentId: String,
	taxExemptCode: String,
	customerType: String,
	customerTypeEffectiveDate: 0001-01-01T00:00:00,
	repAttachmentNumber: 0,
	repRelationship: String,
	preferredDeliveryMethod: String,
	noCode21: String,
	noCode30: String,
	privacyPolicyAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	websiteTermsOfUseAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	ageVerificationAgreement: 
	{
		version: String,
		date: 0001-01-01T00:00:00
	},
	caslStatementAgreement: 
	{
		agree: String,
		date: 0001-01-01T00:00:00
	}
}
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
		}
	}
}