POST api/bfg/v1/persons/{personId}/address

Updates a person's residential or postal address in Paris. Calls <see cref="M:TPP.DataAccess.LLB.EntityClasses.PersonEntity.UpdateAddress(TPP.Utilities.enAddressType,TPP.DataAccess.LLB.DataClasses.AddressData,System.Int32)" /> directly to avoid changeAddress notification email.

Request Information

URI Parameters

Name	Description	Type	Additional information
personId	Paris PersonID of the person being updated.	integer	Required

Body Parameters

Address fields and actor performing the update.

UpdatePersonAddressRequest

Name	Type	Additional information
ActorId	integer	Required
AddressType	byte	Required
Address1	string	Required String length: inclusive between 0 and 30
Address2	string	String length: inclusive between 0 and 30
Suburb	string	Required String length: inclusive between 0 and 30
State	string	Required String length: inclusive between 0 and 30
Postcode	string	Required String length: inclusive between 0 and 20
Country	string	String length: inclusive between 0 and 60

Request Formats

application/json, text/json

Sample:

{
  "ActorId": 1,
  "AddressType": 64,
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Suburb": "sample string 5",
  "State": "sample string 6",
  "Postcode": "sample string 7",
  "Country": "sample string 8"
}

application/xml, text/xml

Sample:

<UpdatePersonAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person">
  <ActorId>1</ActorId>
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <AddressType>64</AddressType>
  <Country>sample string 8</Country>
  <Postcode>sample string 7</Postcode>
  <State>sample string 6</State>
  <Suburb>sample string 5</Suburb>
</UpdatePersonAddressRequest>

Response Information

Resource Description

<see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Person.UpdatePersonAddressResponse" /> on success.

UpdatePersonAddressResponse

Name	Description	Type	Additional information
Success		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true
}

application/xml, text/xml

Sample:

<UpdatePersonAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person">
  <Success>true</Success>
</UpdatePersonAddressResponse>

Error Response Information

Resource Description

<see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Person.UpdatePersonAddressResponse" /> on success.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>