POST api/progression/lettings/{id}/addpermittedoccupier

Add Permitted Occupier. Processes this lettings progression 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 permitted occupier data contract supplied with the request.

SetPermittedOccupierDataContract

Name	Description	Type	Additional information
DateOfBirth	The date of birth, expressed as a date and time.	date	None.
Relationship	The relationship value.	string	None.
Name	The name value.	string	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "DateOfBirth": "2026-07-23T08:24:55.8871464Z",
  "Relationship": "sample string 2",
  "Name": "sample string 3",
  "Id": 4
}

Response Information

Resource Description

The response returned after the operation completes.

PermittedOccupierDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
DateOfBirth	The date of birth, expressed as a date and time.	date	None.
Relationship	The relationship value.	string	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "DateOfBirth": "2026-07-23T08:24:55.8871464Z",
  "Relationship": "sample string 3",
  "Id": 4
}