POST api/occupierallowancedescription/Save

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Descriptions.Command.OccupierAllowanceDescriptionSaveDataContract
NameDescriptionTypeAdditional information
Pairs

Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.TriStatePairDataContract

None.

Name

string

None.

Notes

string

None.

PropertyId

integer

None.

RoleId

integer

None.

ForceUpdate

boolean

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Descriptions.Query.OccupierAllowanceDescriptionDataContract
NameDescriptionTypeAdditional information
EnumName

string

None.

Pairs

Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.TriStatePairDataContract

None.

Name

string

None.

Order

integer

None.

Type

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

None.

PropertyId

integer

None.

Notes

string

None.

Roles

Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.DescriptionRoleDataContract

None.

CreatedDate

date

None.

CreatedBy

Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EnumName": "sample string 1",
  "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 2",
  "Order": 3,
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PropertyId": 4,
  "Notes": "sample string 5",
  "Roles": [
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    }
  ],
  "CreatedDate": "2024-02-25T15:03:41.7640201Z",
  "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": 7
}