POST api/person/client-person/{personID}

Update a person account

Request Information

URI Parameters

Name	Description	Type	Additional information
personID	Unique person identifier	integer	Required

Body Parameters

New values of person attributes

ClientPersonUpdate

Name	Description	Type	Additional information
Salutation	Salutation of the person	Salutation	None.
FirstName	First name of the person	string	String length: inclusive between 0 and 100
LastName	Last name of the person	string	String length: inclusive between 0 and 50
Email	Email address	string	String length: inclusive between 0 and 255
TFN	Tax file number	string	String length: inclusive between 0 and 24
TFNExemptionType	Tax file number exemption reason if no tax file number	enTaxExemptionCode	None.
Externalreference	Reference used to identify the person in an external system	string	None.
FATCACRS	Details of foreign tax residences for accounts of individual and joint persons	Collection of ClientPersonUpdate+TINInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "Salutation": "Mr",
  "FirstName": "John",
  "LastName": "Smith",
  "Email": "johnsmith@sample.com",
  "TFN": "81854402",
  "Externalreference": "125930",
  "FATCACRS": [
    {
      "Country": "AUS",
      "TIN": "123456"
    },
    {
      "Country": "USA",
      "TINExemptionReason": 2
    },
    {
      "Country": "GBR",
      "TIN": "456789",
      "TINExemptionReason": 2
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'TPP.Utilities.enTINExemptionCode' with data contract name 'enTINExemptionCode:http://schemas.datacontract.org/2004/07/TPP.Utilities' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'TPP.Utilities.enTINExemptionCode' with data contract name 'enTINExemptionCode:http://schemas.datacontract.org/2004/07/TPP.Utilities' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

Response Information

Resource Description

ClientPersonUpdateResult

Name	Description	Type	Additional information
PersonID	An identifier of updated person	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "PersonID": 100500
}

application/xml, text/xml

Sample:

<ClientPersonUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Person">
  <PersonID>100500</PersonID>
</ClientPersonUpdateResult>

Error Response Information

Resource Description

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 1,
      "Description": "sample string 1"
    },
    {
      "Code": 1,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BadRequestResultOfenPersonUpdateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenPersonUpdateErrorYd1IcMMv>
      <Code>InvalidRequest</Code>
      <Description>sample string 1</Description>
    </ErrorOfenPersonUpdateErrorYd1IcMMv>
    <ErrorOfenPersonUpdateErrorYd1IcMMv>
      <Code>InvalidRequest</Code>
      <Description>sample string 1</Description>
    </ErrorOfenPersonUpdateErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenPersonUpdateErrorYd1IcMMv>