Optional Incoming Parameters

Table 1. Additional Parameters
Intake Element Map to Parameter Schema Type
address.addressLine2 addressData.addressLine2 bt:addressdata
address.addressLine3 addressData.addressLine3 bt:addressdata
address.addressLine4 addressData.addressLine4 bt:addressdata
address.addressLine5 addressData.addressLine5 bt:addressdata
address.city addressData.city bt:string
address.county addressData.county bt:codetablecode
address.country addressData.country bt:codetablecode
address.postalCode addressData.postalCode bt:codetablecode
address.statecode addressData.statecode bt:codetablecode
address.comments addressData.comments bt:string
address.statusCode addressData.statusCode bt:codetablecode
address.zipCode addressData.zipCode bt:codetablecode
addressType addressType bt:codetablecode
addressIndicator addressIndicator bt:boolean
mailingAddress.addressLayout mailingAddressData.addressLayoutType bt:codetablecode
mailingAddress.addressLine1 mailingAddressData.addressLine1 bt:addressdata
mailingAddress.addressLine2 mailingAddressData.addressLine2 bt:addressdata
mailingAddress.addressLine3 mailingAddressData.addressLine3 bt:addressdata
mailingAddress.addressLine4 mailingAddressData.addressLine4 bt:addressdata
mailingAddress.addressLine5 mailingAddressData.addressLine5 bt:addressdata
mailingAddress.city mailingAddressData.city bt:string
mailingAddress.county mailingAddressData.county bt:codetablecode
mailingAddress.country mailingAddressData.country bt:codetablecode
formattedAddress formattedAddressData bt:addressData
othername otherForename bt:string
type type bt:codetablecode
title title bt:codetablecode
initials initials bt:string
suffix nameSiffix bt:string
ssn socialSecurityNumber bt:string
motherBirthSurname motherBirthSurname bt:string
preferredName preferredName bt:string
verifiedDateOfBirth dateOfBirthVerified bt:boolean
dateOfDeath dateOfDeath bt:date
verifiedDateOfDeath dateOfDeathVerified bt:boolean
specialInterest specialInterest bt:codetablecode
phoneType phoneType bt:string
phoneCountry phoneCountryCode bt:codetablecode
phoneAreaCode phoneAreaCode bt:int32
phoneNumber phoneNumber bt:int32
phoneExtension phoneExtension bt:int32
contactPhoneNumber contactPhoneNumber bt:int32
contactPhoneCountry contactPhoneCountryCode bt:codetablecode
contactPhoneArea contactPhoneAreaCode bt:int32
contactName contactName bt:string
contactPhoneExtension contactPhoneExtension bt:int32
contactEmail contactEmailAddress bt:string
contactEmailType contactEmailType bt:codetablecode
contactTitle contactTitle bt:string
publicOffice publicOfficeID bt:int16
preferredPOfficeContact preferredPublicOfficeContact bt:string
preferredPOfficeName preferredPublicOfficeName bt:string
preferredLanguage preferredLanguage bt:codetablecode
placeOfBirth birthPlace bt:string
concernID concernID bt:long
ethnicOrigin ethnicOriginCode bt:codetablecode
exceptionMethod commExceptionMethodCode bt:codetablecode
exceptionReason commExceptionReasonCode bt:codetablecode
exceptionFromDate commExceptionFromDate bt:date
exceptionToDate commExceptionToDate bt:date
foreignResidencyCountry foreignResidencyCountryCode bt:codetablecode
foreignResidencyReason foreignResidencyReasonCode bt:codetablecode
foreignResidencyFromDate foreignResidencyFromDate bt:date
foreignResidencyToDate foreignResidencyToDate bt:date
citizenshipCountry citizenshipCountryCode bt:codetablecode
citizenshipReason citizenshipReasonCode bt:codetablecode
citizenshipFromDate citizenshipFromDate bt:date
citizenshipToDate citizenshipToDate bt:date
preferredCommMethod preCommMethod bt:codetablecode
relatedClientID relatedConcernRoleID bt:clientIdentifier
paymentFrequency paymentFrequency bt:frequencyPattern
nextPaymentDate nextPaymentDate bt:date
paymentMethod methodOfPmtCode bt:string
Figure 1. Inbound Example : Register Person.

This figure displays an example of the inbound register person xml message.

Inbound example - register person