PUT api/progression/lettings/removeguarantors?tenantRoleId={tenantRoleId}

Add Guarantor to the letting group. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantRoleId

The id of the tenant role

integer

Required

Body Parameters

The guarantor IDS to remove

RemoveGuarantorsCommandDataContract
NameDescriptionTypeAdditional information
GuarantorIds

The unique identifiers of the related guarantor resources.

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "GuarantorIds": [
    1,
    2
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage
NameDescriptionTypeAdditional 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.