PUT api/progression/lettings/addguarantor?tenantRoleId={tenantRoleId}&groupId={groupId}

Add Guarantor to the letting group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantRoleId

The id of the tenant role

integer

Required

groupId

The id for guarantor if guarantor person in multiple groups

integer

None.

Body Parameters

The details of the person

AddGuarantorCommandDataContract
NameDescriptionTypeAdditional information
Person

AddGroupPersonCommandDataContract

None.

Relationship

string

None.

TenantIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Person": {
    "PersonId": 1,
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Addresses": [
      {
        "ContactOrder": 1,
        "AddressType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Latitude": 2.1,
        "Longitude": 3.1,
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 4",
        "OrganizationName": "sample string 5",
        "Number": "sample string 6",
        "BuildingName": "sample string 7",
        "Street": "sample string 8",
        "Town": "sample string 9",
        "Locality": "sample string 10",
        "County": "sample string 11",
        "Postcode": "sample string 12",
        "CreatedDate": "2020-11-25T03:17:43.4657406Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 14
      },
      {
        "ContactOrder": 1,
        "AddressType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Latitude": 2.1,
        "Longitude": 3.1,
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 4",
        "OrganizationName": "sample string 5",
        "Number": "sample string 6",
        "BuildingName": "sample string 7",
        "Street": "sample string 8",
        "Town": "sample string 9",
        "Locality": "sample string 10",
        "County": "sample string 11",
        "Postcode": "sample string 12",
        "CreatedDate": "2020-11-25T03:17:43.4657406Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 14
      }
    ],
    "ContactItems": [
      {
        "Id": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 2",
        "Notes": "sample string 3",
        "ContactOrder": 4,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "NormalisedRegionCode": "sample string 5"
      },
      {
        "Id": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 2",
        "Notes": "sample string 3",
        "ContactOrder": 4,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "NormalisedRegionCode": "sample string 5"
      }
    ],
    "ServiceTypes": [
      {
        "Service": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Referral": true
      },
      {
        "Service": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Referral": true
      }
    ],
    "Id": 4
  },
  "Relationship": "sample string 1",
  "TenantIds": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of GuarantorDataContract
NameDescriptionTypeAdditional information
GroupMembers

Collection of PersonDataContract

None.

TenantIds

Collection of integer

None.

References

Collection of ReferenceDataContract

None.

DeedSigned

boolean

None.

Relationship

string

None.

Documents

Collection of DocumentDataContract

None.

GroupId

integer

None.

Group

PeopleGroupDataContract

None.

GroupRoleId

integer

None.

Id

integer

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.