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

Add Tenant to the tenant group and create relevant tenant info for them.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantRoleId

The id of the tenant role

integer

Required

Body Parameters

The details of the person

Dezrez.Core.DataContracts.External.Api.Group.Command.AddGroup.AddGroupMemberCommandDataContract
NameDescriptionTypeAdditional information
Person

Dezrez.Core.DataContracts.External.Api.Group.Command.AddGroup.AddGroupPersonCommandDataContract

None.

RelationshipType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "2024-10-04T17:46:22.2621093Z",
        "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": "2024-10-04T17:46:22.2621093Z",
        "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
      }
    ],
    "ExternalApplicantReference": "sample string 4",
    "Id": 5
  },
  "RelationshipType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 1
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupMemberDataContract
NameDescriptionTypeAdditional information
Person

Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupMemberPersonDataContract

None.

RelationshipType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

SystemStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Order

integer

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Person": {
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactName": "sample string 4",
    "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
    },
    "Addresses": [
      {
        "AddressType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ContactOrder": 1,
        "Location": {
          "CenterPoint": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Extent": [
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            }
          ],
          "ViewPoints": [
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            },
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            }
          ],
          "Id": 1
        },
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 2",
        "OrganizationName": "sample string 3",
        "Number": "sample string 4",
        "BuildingName": "sample string 5",
        "Street": "sample string 6",
        "Town": "sample string 7",
        "Locality": "sample string 8",
        "County": "sample string 9",
        "Postcode": "sample string 10",
        "CreatedDate": "2024-10-04T17:46:22.2621093Z",
        "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": 12
      },
      {
        "AddressType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ContactOrder": 1,
        "Location": {
          "CenterPoint": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Extent": [
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            }
          ],
          "ViewPoints": [
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            },
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            }
          ],
          "Id": 1
        },
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 2",
        "OrganizationName": "sample string 3",
        "Number": "sample string 4",
        "BuildingName": "sample string 5",
        "Street": "sample string 6",
        "Town": "sample string 7",
        "Locality": "sample string 8",
        "County": "sample string 9",
        "Postcode": "sample string 10",
        "CreatedDate": "2024-10-04T17:46:22.2621093Z",
        "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": 12
      }
    ],
    "ContactItems": [
      {
        "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
      },
      {
        "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
      }
    ],
    "MarketingPreferences": [
      {
        "ServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ServiceStatusType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Referral": true,
        "ReferralStatusType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 2
      },
      {
        "ServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ServiceStatusType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Referral": true,
        "ReferralStatusType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 2
      }
    ],
    "ExternalApplicantReference": "sample string 5",
    "Id": 6
  },
  "RelationshipType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Order": 1,
  "Id": 2
}