PUT api/property/{id}/keys/checkout

Checkout a collection of keys for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The property id	integer	Required

Body Parameters

The details of the keys to checkout

Collection of PropertyKeyCheckOutDataContract

Name	Description	Type	Additional information
KeyId	The unique identifier of the related key resource.	integer	None.
GroupId	The unique identifier of the related group resource.	integer	None.
RecipientId	The unique identifier of the related recipient resource.	integer	None.
RecipientType	The recipient type value.	EnumDataContract	None.
Note	The note value.	string	None.
IsPermanent	Indicates whether this item is permanent.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

[
  {
    "KeyId": 1,
    "GroupId": 2,
    "RecipientId": 3,
    "RecipientType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Note": "sample string 4",
    "IsPermanent": true
  },
  {
    "KeyId": 1,
    "GroupId": 2,
    "RecipientId": 3,
    "RecipientType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Note": "sample string 4",
    "IsPermanent": true
  }
]

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.