POST api/people/{id}/updateNrl

Update the NRL (Non-Resident Landlord) data for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the person to update

integer

Required

Body Parameters

The data to set

UpdateNrlDataContract
NameDescriptionTypeAdditional information
LandlordResidentStatus

The landlord resident status value.

EnumDataContract

None.

NrlReference

The nrl reference value.

string

None.

DeductNrlTax

Indicates whether deduct nrl tax is true.

boolean

None.

NrlTaxPercentage

The nrl tax percentage value.

decimal number

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "LandlordResidentStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "NrlReference": "sample string 1",
  "DeductNrlTax": true,
  "NrlTaxPercentage": 3.0
}

Response Information

Resource Description

The updated person

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

Version

None.

Content

The content value.

HttpContent

None.

StatusCode

The status code classification.

HttpStatusCode

None.

ReasonPhrase

The reason phrase value.

string

None.

Headers

The collection of headers.

Collection of Object

None.

RequestMessage

The request message value.

HttpRequestMessage

None.

IsSuccessStatusCode

Indicates whether this item is success status code.

boolean

None.