POST api/progression/lettings/assignguarantortotenant?id={id}

Assign guarantor to a tenant and vice versa 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

Body Parameters

The data contract

AssignGuarantorToTenantCommandDataContract

Name	Description	Type	Additional information
GuarantorGroupId	The unique identifier of the related guarantor group resource.	integer	None.
Relationship	The relationship value.	string	None.
TenantIds	The unique identifiers of the related tenant resources.	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "GuarantorGroupId": 1,
  "Relationship": "sample string 2",
  "TenantIds": [
    1,
    2
  ]
}

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.