POST api/keys/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Code	string	None.
KeyCabinetId	integer	None.
ResponsibleLoginId	integer	None.
Status	KeyStatus	None.

Request Formats

application/json, text/json

Sample:

{
  "code": "sample string 1",
  "keyCabinetId": 1,
  "responsibleLoginId": 1,
  "status": "IN"
}

application/xml, text/xml

Sample:

<KeysSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Code>sample string 1</Code>
  <KeyCabinetId>1</KeyCabinetId>
  <ResponsibleLoginId>1</ResponsibleLoginId>
  <Status>IN</Status>
</KeysSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of KeySet

Name	Type	Additional information
Id	integer	None.
Code	string	None.
Row	integer	None.
EstateId	integer	None.
Column	integer	None.
NumberOfKeys	integer	None.
Color	string	None.
Description	string	None.
Status	KeyStatus	None.
Reserved	boolean	None.
Address	string	None.
KeyCabinetName	string	None.
Created	date	None.
Modified	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "code": "sample string 1",
    "row": 1,
    "estateId": 2,
    "column": 1,
    "numberOfKeys": 3,
    "color": "sample string 4",
    "description": "sample string 5",
    "status": "IN",
    "reserved": true,
    "address": "sample string 7",
    "keyCabinetName": "sample string 8",
    "created": "2024-09-19T12:45:58.9937742+02:00",
    "modified": "2024-09-19T12:45:58.9937742+02:00"
  },
  {
    "id": 1,
    "code": "sample string 1",
    "row": 1,
    "estateId": 2,
    "column": 1,
    "numberOfKeys": 3,
    "color": "sample string 4",
    "description": "sample string 5",
    "status": "IN",
    "reserved": true,
    "address": "sample string 7",
    "keyCabinetName": "sample string 8",
    "created": "2024-09-19T12:45:58.9937742+02:00",
    "modified": "2024-09-19T12:45:58.9937742+02:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfKeySet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <KeySet>
    <Address>sample string 7</Address>
    <Code>sample string 1</Code>
    <Color>sample string 4</Color>
    <Column>1</Column>
    <Created>2024-09-19T12:45:58.9937742+02:00</Created>
    <Description>sample string 5</Description>
    <EstateId>2</EstateId>
    <Id>1</Id>
    <KeyCabinetName>sample string 8</KeyCabinetName>
    <Modified>2024-09-19T12:45:58.9937742+02:00</Modified>
    <NumberOfKeys>3</NumberOfKeys>
    <Reserved>true</Reserved>
    <Row>1</Row>
    <Status>IN</Status>
  </KeySet>
  <KeySet>
    <Address>sample string 7</Address>
    <Code>sample string 1</Code>
    <Color>sample string 4</Color>
    <Column>1</Column>
    <Created>2024-09-19T12:45:58.9937742+02:00</Created>
    <Description>sample string 5</Description>
    <EstateId>2</EstateId>
    <Id>1</Id>
    <KeyCabinetName>sample string 8</KeyCabinetName>
    <Modified>2024-09-19T12:45:58.9937742+02:00</Modified>
    <NumberOfKeys>3</NumberOfKeys>
    <Reserved>true</Reserved>
    <Row>1</Row>
    <Status>IN</Status>
  </KeySet>
</ArrayOfKeySet>