POST api/crmconnect/property/occupierallowance

Get the occupier allowance for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

A value usable to identify the item in the crm, this key is generated by the selected domain service

Object

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{}

Response Information

Resource Description

The response returned after the operation completes.

OccupierAllowanceDescriptionSaveDataContract

Name	Description	Type	Additional information
Pairs	The collection of pairs.	Collection of TriStatePairDataContract	None.
Name	The name value.	string	None.
Notes	The notes value.	string	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
RoleId	The unique identifier of the related role resource.	integer	None.
ForceUpdate	Indicates whether force update is true.	boolean	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Pairs": [
    {
      "Key": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 1
    },
    {
      "Key": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 1
    }
  ],
  "Name": "sample string 1",
  "Notes": "sample string 2",
  "PropertyId": 3,
  "RoleId": 4,
  "ForceUpdate": true,
  "Id": 6
}