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

Checkout a collection of keys for a property

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The property id

integer

Required

Body Parameters

The details of the keys to checkout

Collection of PropertyKeyCheckOutDataContract
NameDescriptionTypeAdditional information
KeyId

integer

None.

GroupId

integer

None.

RecipientId

integer

None.

RecipientType

EnumDataContract

None.

Note

string

None.

IsPermanent

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

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.