PUT api/role/lettings/{id}/settobsigned
Set the terms of business for a landlord on a PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
The set tob signed command data contract supplied with the request.
SetTOBSignedCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId |
The unique identifier of the related person resource. |
integer |
None. |
| TOBSigned |
Indicates whether tob signed is true. |
boolean |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"PersonId": 1,
"TOBSigned": true
}
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional 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. |