PUT api/property/{id}/addgrouptoproperty

Creates/Adds a group to the CurrentOwners of the supplied PropertyId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The property id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Property.Command.AddGroupToProperty.AddGroupToPropertyCommandDataContract
NameDescriptionTypeAdditional information
Group

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

None.

OwnedSince

date

None.

ForceUpdate

boolean

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Group": {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Members": [
      {
        "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-03-27T05:46:18.0418233Z",
              "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-03-27T05:46:18.0418233Z",
              "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
      },
      {
        "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-03-27T05:46:18.0418233Z",
              "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-03-27T05:46:18.0418233Z",
              "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
      }
    ],
    "GroupType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Origin": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Grade": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ExternalProviderTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "VATNumber": "sample string 3",
    "AdditionalQuestions": {
      "ArrangedMortgage": true,
      "MortgageProvider": "sample string 1",
      "HowLongToMove": "sample string 2",
      "ReasonForMoving": "sample string 3",
      "HowHeard": "sample string 4",
      "EnquiryMethod": "sample string 5",
      "BestTimeToCall": "sample string 6",
      "WhenCanView": "sample string 7",
      "HappyToReceivePropertyEmails": true,
      "ViewedAnyProperties": true,
      "LocalOwnToSell": true,
      "AskingPrice": "sample string 8",
      "Bedrooms": 1,
      "CurrentlyOnMarket": true,
      "SellingWith": "sample string 9",
      "OnMarketSince": "2024-03-27T05:46:18.0418233Z",
      "ReasonForSale": "sample string 10",
      "OfferedMA": true,
      "CurrentStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Financial": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Reason": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    },
    "BranchId": 1,
    "Id": 4
  },
  "OwnedSince": "2024-03-27T05:46:18.0418233Z",
  "ForceUpdate": true
}

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.