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

Reference a guarantor on a tenant role

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

ReferenceDataContract

Name	Type	Additional information
Negotiator	NegotiatorDataContract	None.
ReferenceDate	date	None.
Documents	Collection of DocumentDataContract	None.
ReferenceName	string	None.
ReferenceType	EnumDataContract	None.
ReferenceStatus	EnumDataContract	None.
Notes	string	None.
PersonId	integer	None.
Id	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Documents[0].Attachments'.