NAV

<back to all web services

ProfileUpdate

The following routes are available for this service:
PUT/profile/{BeeNumber}
import java.math.*
import java.util.*
import net.servicestack.client.*


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

open class NAVAddressUpdate
{
    var firstName:String? = null
    var lastName:String? = null
    var addressLine1:String? = null
    var addressLine2:String? = null
    var addressLine3:String? = null
    var addressLine4:String? = null
    var addressLine5:String? = null
    var city:String? = null
    var stateCode:String? = null
    var postalCode:String? = null
    var countryCode:String? = null
}

open class NAVPhoneUpdate
{
    var number:String? = null
    var extension:String? = null
    var codeIdPhoneType:String? = null
    var countryCode:String? = null
}

open class NAVBankAccountUpdate
{
    var accountName:String? = null
    var bankName:String? = null
    var accountNumber:String? = null
    var routingNumber:String? = null
}

open class NAVTermsUpdate
{
    var version:String? = null
    var date:Date? = null
}

open class NAVCASLTermsUpdate
{
    var agree:String? = null
    var date:Date? = null
}

open class ProfileUpdateResponse
{
    var responseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}