POST api/role/lettings/{id}/addlandlordinfo

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The marketing letting role Id.

integer

Required

Body Parameters

The

Dezrez.Core.DataContracts.External.Api.Role.Command.AddLandlordInfo.AddLandlordInfoDataContract
NameDescriptionTypeAdditional information
GroupPerson

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

None.

HeadLandlord

boolean

None.

RentShare

decimal number

None.

TOBSigned

boolean

None.

NRLStatus

boolean

None.

NRLNumber

string

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "GroupPerson": {
    "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-04T18:08:21.3539218Z",
          "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-04T18:08:21.3539218Z",
          "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
  },
  "HeadLandlord": true,
  "RentShare": 1.1,
  "TOBSigned": true,
  "NRLStatus": true,
  "NRLNumber": "sample string 3"
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.