POST api/progression/lettings/referenceguarantor?id={id}&guarantorPersonId={guarantorPersonId}&referenceStatus={referenceStatus}&name={name}&notes={notes}&referenceDate={referenceDate}

Reference a guarantor on a tenant role 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 id of the tenant role	integer	Required
guarantorPersonId	The id of the person to reference	integer	Required
referenceStatus	Whether the guarantor has passed referencing or not	string	Required
name	The id of the tenant role	string	Required
notes	Notes of reference	string	None.
referenceDate	Date of the reference if null today is used	date	None.

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

ReferenceDataContract

Name	Description	Type	Additional information
Negotiator	The negotiator value.	NegotiatorDataContract	None.
ReferenceDate	The reference date, expressed as a date and time.	date	None.
Documents	The collection of documents.	Collection of DocumentDataContract	None.
ReferenceName	The reference name value.	string	None.
ReferenceType	The reference type value.	EnumDataContract	None.
ReferenceStatus	The reference status value.	EnumDataContract	None.
Notes	The notes value.	string	None.
PersonId	The unique identifier of the related person resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.