POST api/rightsrestrictionsdescription/Save

Save or update a RightsRestrictions Description

Request Information

URI Parameters

None.

Body Parameters

The RightsRestrictions description to save

RightsRestrictionsDescriptionSaveDataContract
NameDescriptionTypeAdditional information
IsListed

boolean

None.

Restrictions

boolean

None.

RequiredAccess

boolean

None.

RightsOfWay

boolean

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:
{
  "IsListed": true,
  "Restrictions": true,
  "RequiredAccess": true,
  "RightsOfWay": true,
  "Name": "sample string 5",
  "Notes": "sample string 6",
  "PropertyId": 7,
  "RoleId": 8,
  "ForceUpdate": true,
  "Id": 10
}

Response Information

Resource Description

RightsRestrictionsDescriptionDataContract
NameDescriptionTypeAdditional information
IsListed

boolean

None.

Restrictions

boolean

None.

RequiredAccess

boolean

None.

RightsOfWay

boolean

None.

Name

string

None.

Order

integer

None.

Type

EnumDataContract

None.

PropertyId

integer

None.

Notes

string

None.

Roles

Collection of DescriptionRoleDataContract

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "IsListed": true,
  "Restrictions": true,
  "RequiredAccess": true,
  "RightsOfWay": true,
  "Name": "sample string 5",
  "Order": 6,
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PropertyId": 7,
  "Notes": "sample string 8",
  "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": "2025-06-14T20:51:08.9443918Z",
  "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": 10
}