POST api/property/{id}/keys/add
Add keys for a property
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The property id |
integer |
Required |
Body Parameters
A collection of keys to add
Collection of Dezrez.Core.DataContracts.External.Api.Property.Command.AddKey.PropertyKeyAddDataContractName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Code | string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
[ { "Name": "sample string 1", "Code": "sample string 2" }, { "Name": "sample string 1", "Code": "sample string 2" } ]
Response Information
Resource Description
Collection of Dezrez.Core.DataContracts.External.Api.Property.Query.Get.PropertyKeyDataContractName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Code | string |
None. |
|
IsCheckedOut | boolean |
None. |
|
IsPermanent | boolean |
None. |
|
CheckedInAt | date |
None. |
|
CheckedInBy | Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyNegotiatorDataContract |
None. |
|
NoteOnCheckIn | string |
None. |
|
CheckedOutAt | date |
None. |
|
CheckedOutBy | Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyNegotiatorDataContract |
None. |
|
NoteOnCheckOut | string |
None. |
|
RecipientDetails | Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyRecipientDetailsDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Name": "sample string 1", "Code": "sample string 2", "IsCheckedOut": true, "IsPermanent": true, "CheckedInAt": "2024-10-11T17:52:14.1708006Z", "CheckedInBy": { "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "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 4", "Id": 5 }, "NoteOnCheckIn": "sample string 5", "CheckedOutAt": "2024-10-11T17:52:14.1708006Z", "CheckedOutBy": { "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "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 4", "Id": 5 }, "NoteOnCheckOut": "sample string 6", "RecipientDetails": { "RecipientId": 1, "RecipientName": "sample string 2", "RecipientGroupName": "sample string 3", "RecipientType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } }, "Id": 7 }, { "Name": "sample string 1", "Code": "sample string 2", "IsCheckedOut": true, "IsPermanent": true, "CheckedInAt": "2024-10-11T17:52:14.1708006Z", "CheckedInBy": { "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "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 4", "Id": 5 }, "NoteOnCheckIn": "sample string 5", "CheckedOutAt": "2024-10-11T17:52:14.1708006Z", "CheckedOutBy": { "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "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 4", "Id": 5 }, "NoteOnCheckOut": "sample string 6", "RecipientDetails": { "RecipientId": 1, "RecipientName": "sample string 2", "RecipientGroupName": "sample string 3", "RecipientType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } }, "Id": 7 } ]