### Get Guest Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a paginated collection of Guest resources.
```APIDOC
## GET /api/v1/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/guests
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Guest collection response** (array of Guest-guest_read objects) - Description of the response schema.
#### Error Response
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Reservations
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a collection of Reservation resources.
```APIDOC
## GET /api/v1/reservations
### Description
Retrieves the collection of Reservation resources.
### Method
GET
### Endpoint
/api/v1/reservations
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Reservation collection response** (array) - An array of Reservation resources.
#### Error Responses
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Guest Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Guest resource by its ID.
```APIDOC
## GET /api/v1/guests/{id}
### Description
Retrieves a Guest resource.
### Method
GET
### Endpoint
/api/v1/guests/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Guest resource.
### Response
#### Success Response (200)
- **Guest resource response** (Guest-guest_read object) - Description of the response schema.
#### Error Response
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Guest Collection for Checkin
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a paginated collection of Guest resources associated with a specific Checkin.
```APIDOC
## GET /api/v1/checkins/{id}/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/checkins/{id}/guests
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Checkin resource.
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Guest collection response** (array of Guest-guest_read objects) - Description of the response schema.
#### Error Response
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Property Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a paginated collection of Property resources.
```APIDOC
## GET /api/v1/properties
### Description
Retrieves the collection of Property resources.
### Method
GET
### Endpoint
/api/v1/properties
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Property collection response** (array of Property-property_read objects) - Description of the response schema.
#### Error Response
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Checkin Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a paginated collection of Checkin resources.
```APIDOC
## GET /api/v1/checkins
### Description
Retrieves the collection of Checkin resources.
### Method
GET
### Endpoint
/api/v1/checkins
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Checkin collection response** (array of Checkin-checkin_read objects) - Description of the response schema.
#### Error Response
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Checkin Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Checkin resource by its ID.
```APIDOC
## GET /api/v1/checkins/{id}
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/checkins/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Checkin resource.
### Response
#### Success Response (200)
- **Checkin resource response** (Checkin-checkin_read object) - Description of the response schema.
#### Error Response
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Property Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Property resource by its ID.
```APIDOC
## GET /api/v1/properties/{id}
### Description
Retrieves a Property resource.
### Method
GET
### Endpoint
/api/v1/properties/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the property to retrieve.
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Property resource response** (object) - Details of the property resource.
#### Error Responses
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Property Rooms
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a collection of Room resources associated with a specific Property.
```APIDOC
## GET /api/v1/properties/{id}/rooms
### Description
Retrieves the collection of Room resources for a given property.
### Method
GET
### Endpoint
/api/v1/properties/{id}/rooms
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the property.
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **Room collection response** (array) - An array of Room resources.
#### Error Responses
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Reservation Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Reservation resource by its ID.
```APIDOC
## GET /api/v1/reservations/{id}
### Description
Retrieves a Reservation resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reservation to retrieve.
### Response
#### Success Response (200)
- **Reservation resource response** (object) - Details of the reservation resource.
#### Error Responses
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Police Station Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a paginated collection of PoliceStation resources.
```APIDOC
## GET /api/v1/police_stations
### Description
Retrieves the collection of PoliceStation resources.
### Method
GET
### Endpoint
/api/v1/police_stations
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Response
#### Success Response (200)
- **PoliceStation collection response** (array of PoliceStation-police_station_read objects) - Description of the response schema.
#### Error Response
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Get Police Station Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific PoliceStation resource by its ID.
```APIDOC
## GET /api/v1/police_stations/{id}
### Description
Retrieves a PoliceStation resource.
### Method
GET
### Endpoint
/api/v1/police_stations/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the PoliceStation resource.
### Response
#### Success Response (200)
- **PoliceStation resource response** (PoliceStation-police_station_read object) - Description of the response schema.
#### Error Response
- **404** - Resource not found
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Create Reservation
Source: https://api.checkinscan.com/api/v1/docs.json
Creates a new Reservation resource.
```APIDOC
## POST /api/v1/reservations
### Description
Creates a Reservation resource.
### Method
POST
### Endpoint
/api/v1/reservations
### Parameters
#### Request Body
- **reservation** (object) - Required - The new Reservation resource.
- **description** (string) - Max length 25 characters.
- **channelManagerLocator** (string) - Max length 100 characters.
### Response
#### Success Response (201)
- **Reservation resource created** (object) - The created Reservation resource.
#### Error Responses
- **400** - Invalid input:
- description cannot be greater than 25 characters
- channelManagerLocator cannot be greater than 100 characters
- **404** - Resource not found
- **409** - Conflict: You cannot create a reservation on a property that is rented as a whole if it contains rooms. You must choose a room.
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Entrypoint Operations
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations available through the API entrypoint for various resource collections.
```APIDOC
## GET /entrypoint/checkin
### Description
Retrieves the collection of Checkin resources.
### Method
GET
### Endpoint
/entrypoint/checkin
## GET /entrypoint/checkin/guest
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/entrypoint/checkin/guest
## GET /entrypoint/policeStation
### Description
Retrieves the collection of PoliceStation resources.
### Method
GET
### Endpoint
/entrypoint/policeStation
## GET /entrypoint/reservation
### Description
Retrieves the collection of Reservation resources.
### Method
GET
### Endpoint
/entrypoint/reservation
## POST /entrypoint/reservation
### Description
Creates a Reservation resource.
### Method
POST
### Endpoint
/entrypoint/reservation
## GET /entrypoint/reservation/checkin
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/entrypoint/reservation/checkin
## GET /entrypoint/reservation/guest
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/entrypoint/reservation/guest
## GET /entrypoint/property
### Description
Retrieves the collection of Property resources.
### Method
GET
### Endpoint
/entrypoint/property
## GET /entrypoint/property/room
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/entrypoint/property/room
```
--------------------------------
### Guest Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for managing guest information.
```APIDOC
## GET /api/v1/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/guests
## GET /api/v1/guests/{id}
### Description
Retrieves a Guest resource.
### Method
GET
### Endpoint
/api/v1/guests/{id}
## DELETE /api/v1/guests/{id}
### Description
Removes the Guest resource.
### Method
DELETE
### Endpoint
/api/v1/guests/{id}
```
--------------------------------
### Guest Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the Guest resource.
```APIDOC
## GET /api/v1/guests
### Description
Retrieves a collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/guests
### Response
#### Success Response (200)
- **Collection**: A collection of Guest objects.
```
```APIDOC
## GET /api/v1/guests/{id}
### Description
Retrieves a specific Guest resource by its ID.
### Method
GET
### Endpoint
/api/v1/guests/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Guest resource.
### Response
#### Success Response (200)
- **Guest**: The requested Guest object.
```
--------------------------------
### Property Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for retrieving property and room information.
```APIDOC
## GET /api/v1/properties
### Description
Retrieves the collection of Property resources.
### Method
GET
### Endpoint
/api/v1/properties
## GET /api/v1/properties/{id}
### Description
Retrieves a Property resource.
### Method
GET
### Endpoint
/api/v1/properties/{id}
## GET /api/v1/properties/{id}/rooms
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/api/v1/properties/{id}/rooms
```
--------------------------------
### Retrieves PoliceStation resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
This operation retrieves a specific PoliceStation resource.
```APIDOC
## GET /PoliceStation
### Description
Retrieves a PoliceStation resource.
### Method
GET
### Endpoint
/PoliceStation
```
--------------------------------
### Reservation Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Details about the Reservation resource, including its properties and supported operations.
```APIDOC
## Reservation Resource
### Description
Represents a reservation with various details such as check-in information, property, room, and guest information.
### Properties
- **checkin** (Checkin): Information about the check-in.
- **property** (Property): The property associated with the reservation.
- **room** (Room): The room associated with the reservation.
- **pmsLocator** (string): Locator for the Property Management System.
- **channelManagerLocator** (string): Locator for the Channel Manager.
- **estimatedGuestNumber** (integer): The estimated number of guests.
- **checkinscanLocator** (string): Locator for CheckinScan.
- **startDate** (dateTime): The start date of the reservation.
- **endDate** (dateTime): The end date of the reservation.
- **status** (string): The status of the reservation.
- **description** (string): A description of the reservation.
- **extraDataApi** (string): Additional data for the API.
- **urlCheckin** (string): URL for the guest to check in. This URL detects the language if applicable.
- **urlCheckinLanguages** (string): An object containing URLs for different languages. Example: `["en":"{urlCheckin}/en", "es":"{urlCheckin}/es", "it":"{urlCheckin}/it", "pt":"{urlCheckin}/pt", "ca":"{urlCheckin}/ca"]`
```
--------------------------------
### Guest Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to Guest resources.
```APIDOC
## GET /api/v1/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/guests
```
```APIDOC
## GET /api/v1/guests/{id}
### Description
Retrieves a Guest resource.
### Method
GET
### Endpoint
/api/v1/guests/{id}
```
```APIDOC
## DELETE /api/v1/guests/{id}
### Description
Removes the Guest resource.
### Method
DELETE
### Endpoint
/api/v1/guests/{id}
```
--------------------------------
### Guest Resource Operations
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations available for the Guest resource, including retrieval and deletion.
```APIDOC
## GET /guest
### Description
Retrieves a Guest resource.
### Method
GET
### Endpoint
/guest
## DELETE /guest
### Description
Deletes the Guest resource.
### Method
DELETE
### Endpoint
/guest
```
--------------------------------
### Retrieve Guest Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a collection of Guest resources associated with a reservation's check-in.
```APIDOC
## GET /api/v1/reservations/{id}/checkin/guests
### Description
Retrieves the collection of Guest resources associated with a reservation's check-in.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin/guests
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reservation.
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
```
--------------------------------
### Update Reservation
Source: https://api.checkinscan.com/api/v1/docs.json
Replaces an existing Reservation resource.
```APIDOC
## PUT /api/v1/reservations/{id}
### Description
Replaces the Reservation resource.
### Method
PUT
### Endpoint
/api/v1/reservations/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reservation to update.
#### Request Body
- **reservation** (object) - Required - The updated Reservation resource.
- **description** (string) - Max length 25 characters.
- **channelManagerLocator** (string) - Max length 100 characters.
### Response
#### Success Response (200)
- **Reservation resource updated** (object) - The updated Reservation resource.
#### Error Responses
- **400** - Invalid input:- description cannot be greater than 25 characters
- channelManagerLocator cannot be greater than 100 characters
- **404** - Resource not found
- **409** - Conflict:- You can only update a reservation that has no guest sent and whose status is Open
- It is not possible to update a reservation in which the property of your room does not match the property of the reservation
- It is not possible to assign a reservation to a property that is rented as a whole if it contains rooms. You must choose a room
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Create SendReservation
Source: https://api.checkinscan.com/api/v1/docs.json
Creates a new sendReservation resource.
```APIDOC
## POST /api/v1/send_reservation
### Description
Creates a sendReservation resource.
### Method
POST
### Endpoint
/api/v1/send_reservation
### Parameters
#### Request Body
- **sendReservation** (object) - Required - The new sendReservation resource. Schema reference: #/definitions/sendReservation-reservas_guests_write
```
--------------------------------
### Reservation Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for managing reservation resources.
```APIDOC
## GET /api/v1/reservations
### Description
Retrieves the collection of Reservation resources.
### Method
GET
### Endpoint
/api/v1/reservations
## POST /api/v1/reservations
### Description
Creates a Reservation resource.
### Method
POST
### Endpoint
/api/v1/reservations
## GET /api/v1/reservations/{id}
### Description
Retrieves a Reservation resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}
## PUT /api/v1/reservations/{id}
### Description
Replaces the Reservation resource.
### Method
PUT
### Endpoint
/api/v1/reservations/{id}
## DELETE /api/v1/reservations/{id}
### Description
Removes the Reservation resource.
### Method
DELETE
### Endpoint
/api/v1/reservations/{id}
```
--------------------------------
### Retrieve Room Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a collection of Room resources.
```APIDOC
## GET /api/v1/rooms
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/api/v1/rooms
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
```
--------------------------------
### Checkin Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for retrieving check-in information.
```APIDOC
## GET /api/v1/checkins
### Description
Retrieves the collection of Checkin resources.
### Method
GET
### Endpoint
/api/v1/checkins
## GET /api/v1/checkins/{id}
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/checkins/{id}
## GET /api/v1/checkins/{id}/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/checkins/{id}/guests
## GET /api/v1/reservations/{id}/checkin
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin
## GET /api/v1/reservations/{id}/checkin/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin/guests
```
--------------------------------
### Room Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for retrieving room information.
```APIDOC
## GET /api/v1/rooms
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/api/v1/rooms
## GET /api/v1/rooms/{id}
### Description
Retrieves a Room resource.
### Method
GET
### Endpoint
/api/v1/rooms/{id}
```
--------------------------------
### PoliceStation Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the PoliceStation resource.
```APIDOC
## GET /api/v1/police_stations
### Description
Retrieves a collection of PoliceStation resources.
### Method
GET
### Endpoint
/api/v1/police_stations
### Response
#### Success Response (200)
- **Collection**: A collection of PoliceStation objects.
```
```APIDOC
## GET /api/v1/police_stations/{id}
### Description
Retrieves a specific PoliceStation resource by its ID.
### Method
GET
### Endpoint
/api/v1/police_stations/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the PoliceStation resource.
### Response
#### Success Response (200)
- **PoliceStation**: The requested PoliceStation object.
```
--------------------------------
### Property Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the Property resource.
```APIDOC
## GET /api/v1/properties
### Description
Retrieves a collection of Property resources.
### Method
GET
### Endpoint
/api/v1/properties
### Response
#### Success Response (200)
- **Collection**: A collection of Property objects.
```
```APIDOC
## GET /api/v1/properties/{id}
### Description
Retrieves a specific Property resource by its ID.
### Method
GET
### Endpoint
/api/v1/properties/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Property resource.
### Response
#### Success Response (200)
- **Property**: The requested Property object.
```
--------------------------------
### Checkin Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the Checkin resource.
```APIDOC
## GET /api/v1/checkins
### Description
Retrieves a collection of Checkin resources.
### Method
GET
### Endpoint
/api/v1/checkins
### Response
#### Success Response (200)
- **Collection**: A collection of Checkin objects.
```
```APIDOC
## GET /api/v1/checkins/{id}
### Description
Retrieves a specific Checkin resource by its ID.
### Method
GET
### Endpoint
/api/v1/checkins/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Checkin resource.
### Response
#### Success Response (200)
- **Checkin**: The requested Checkin object.
```
--------------------------------
### Retrieve Room Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Room resource using its ID.
```APIDOC
## GET /api/v1/rooms/{id}
### Description
Retrieves a Room resource.
### Method
GET
### Endpoint
/api/v1/rooms/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the room to retrieve.
```
--------------------------------
### PoliceStation Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for retrieving police station information.
```APIDOC
## GET /api/v1/police_stations
### Description
Retrieves the collection of PoliceStation resources.
### Method
GET
### Endpoint
/api/v1/police_stations
## GET /api/v1/police_stations/{id}
### Description
Retrieves a PoliceStation resource.
### Method
GET
### Endpoint
/api/v1/police_stations/{id}
```
--------------------------------
### Retrieve Checkin Resource
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific Checkin resource using its ID.
```APIDOC
## GET /api/v1/reservations/{id}/checkin
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reservation to retrieve the check-in resource for.
```
--------------------------------
### sendReservation Operation
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Sends a reservation, potentially creating or updating it.
```APIDOC
## POST /sendReservation
### Description
Sends a reservation resource.
### Method
POST
### Endpoint
/sendReservation
### Request Body
- **reservation** (#Reservation) - The Reservation resource to send.
### Response
#### Success Response (200)
- **reservation** (#Reservation) - The sent Reservation resource.
```
--------------------------------
### Room Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the Room resource.
```APIDOC
## GET /api/v1/rooms
### Description
Retrieves a collection of Room resources.
### Method
GET
### Endpoint
/api/v1/rooms
### Response
#### Success Response (200)
- **Collection**: A collection of Room objects.
```
```APIDOC
## GET /api/v1/rooms/{id}
### Description
Retrieves a specific Room resource by its ID.
### Method
GET
### Endpoint
/api/v1/rooms/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Room resource.
### Response
#### Success Response (200)
- **Room**: The requested Room object.
```
--------------------------------
### Reservation Resource
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Operations related to the Reservation resource.
```APIDOC
## GET /api/v1/reservations
### Description
Retrieves a collection of Reservation resources.
### Method
GET
### Endpoint
/api/v1/reservations
### Response
#### Success Response (200)
- **Collection**: A collection of Reservation objects.
```
```APIDOC
## GET /api/v1/reservations/{id}
### Description
Retrieves a specific Reservation resource by its ID.
### Method
GET
### Endpoint
/api/v1/reservations/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Reservation resource.
### Response
#### Success Response (200)
- **Reservation**: The requested Reservation object.
```
--------------------------------
### PoliceStation Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to PoliceStation resources.
```APIDOC
## GET /api/v1/police_stations
### Description
Retrieves the collection of PoliceStation resources.
### Method
GET
### Endpoint
/api/v1/police_stations
```
```APIDOC
## GET /api/v1/police_stations/{id}
### Description
Retrieves a PoliceStation resource.
### Method
GET
### Endpoint
/api/v1/police_stations/{id}
```
--------------------------------
### Property Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to Property resources.
```APIDOC
## GET /api/v1/properties
### Description
Retrieves the collection of Property resources.
### Method
GET
### Endpoint
/api/v1/properties
```
```APIDOC
## GET /api/v1/properties/{id}
### Description
Retrieves a Property resource.
### Method
GET
### Endpoint
/api/v1/properties/{id}
```
```APIDOC
## GET /api/v1/properties/{id}/rooms
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/api/v1/properties/{id}/rooms
```
--------------------------------
### SendReservation Operations
Source: https://api.checkinscan.com/api/v1/docs.jsonld
Provides operations for interacting with sendReservation resources, including retrieval and creation.
```APIDOC
## GET /sendReservation
### Description
Retrieves the collection of sendReservation resources.
### Method
GET
### Endpoint
/sendReservation
### Response
#### Success Response (200)
- **Collection**: A collection of sendReservation resources.
## POST /sendReservation
### Description
Creates a sendReservation resource.
### Method
POST
### Endpoint
/sendReservation
### Request Body
- **sendReservation**: The sendReservation resource to create.
### Response
#### Success Response (200)
- **sendReservation**: The created sendReservation resource.
```
--------------------------------
### Checkin Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to Checkin resources.
```APIDOC
## GET /api/v1/checkins
### Description
Retrieves the collection of Checkin resources.
### Method
GET
### Endpoint
/api/v1/checkins
```
```APIDOC
## GET /api/v1/checkins/{id}
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/checkins/{id}
```
```APIDOC
## GET /api/v1/checkins/{id}/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/checkins/{id}/guests
```
```APIDOC
## GET /api/v1/reservations/{id}/checkin
### Description
Retrieves a Checkin resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin
```
```APIDOC
## GET /api/v1/reservations/{id}/checkin/guests
### Description
Retrieves the collection of Guest resources.
### Method
GET
### Endpoint
/api/v1/reservations/{id}/checkin/guests
```
--------------------------------
### Room Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to Room resources.
```APIDOC
## GET /api/v1/rooms
### Description
Retrieves the collection of Room resources.
### Method
GET
### Endpoint
/api/v1/rooms
```
```APIDOC
## GET /api/v1/rooms/{id}
### Description
Retrieves a Room resource.
### Method
GET
### Endpoint
/api/v1/rooms/{id}
```
--------------------------------
### Delete Guest Item
Source: https://api.checkinscan.com/api/v1/docs.json
Removes a specific Guest resource by its ID. This operation has restrictions on when a guest can be deleted.
```APIDOC
## DELETE /api/v1/guests/{id}
### Description
Removes the Guest resource.
### Method
DELETE
### Endpoint
/api/v1/guests/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Guest resource.
### Response
#### Success Response (204)
- **Guest resource deleted** - Indicates successful deletion.
#### Error Response
- **404** - Resource not found
- **409** - It is not possible to delete a guest that has already been sent to the police or belongs to a reservation whose status is not Open or Blocked
- **429** - Too many requests, 100 requests every 60 seconds
```
--------------------------------
### Reservation Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to Reservation resources.
```APIDOC
## GET /api/v1/reservations
### Description
Retrieves the collection of Reservation resources.
### Method
GET
### Endpoint
/api/v1/reservations
```
```APIDOC
## POST /api/v1/reservations
### Description
Creates a Reservation resource.
### Method
POST
### Endpoint
/api/v1/reservations
```
```APIDOC
## GET /api/v1/reservations/{id}
### Description
Retrieves a Reservation resource.
### Method
GET
### Endpoint
/api/v1/reservations/{id}
```
```APIDOC
## PUT /api/v1/reservations/{id}
### Description
Replaces the Reservation resource.
### Method
PUT
### Endpoint
/api/v1/reservations/{id}
```
```APIDOC
## DELETE /api/v1/reservations/{id}
### Description
Removes the Reservation resource.
### Method
DELETE
### Endpoint
/api/v1/reservations/{id}
```
--------------------------------
### sendReservation Endpoints
Source: https://api.checkinscan.com/api/v1/docs
Endpoints for creating, retrieving, updating, and deleting sendReservation resources.
```APIDOC
## POST /api/v1/send_reservation
### Description
Creates a sendReservation resource.
### Method
POST
### Endpoint
/api/v1/send_reservation
## GET /api/v1/send_reservation/{id}
### Description
Retrieves a sendReservation resource.
### Method
GET
### Endpoint
/api/v1/send_reservation/{id}
## PUT /api/v1/send_reservation/{id}
### Description
Replaces the sendReservation resource.
### Method
PUT
### Endpoint
/api/v1/send_reservation/{id}
## DELETE /api/v1/send_reservation/{id}
### Description
Removes the sendReservation resource.
### Method
DELETE
### Endpoint
/api/v1/send_reservation/{id}
## GET /api/v1/send_reservations
### Description
Retrieves the collection of sendReservation resources.
### Method
GET
### Endpoint
/api/v1/send_reservations
```
--------------------------------
### Retrieve Send Reservation Collection
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a collection of sendReservation resources. This endpoint can be used to fetch a list of reservations that are ready to be sent.
```APIDOC
## GET /v1/send_reservations
### Description
Retrieves the collection of sendReservation resources.
### Method
GET
### Endpoint
/v1/send_reservations
### Parameters
#### Query Parameters
- **page** (integer) - Optional - The collection page number.
### Responses
#### Success Response (200)
- **sendReservation collection response** (array) - Contains a list of sendReservation resources.
#### Error Response (429)
- **Too many requests** - Indicates that the rate limit has been exceeded (100 requests every 60 seconds).
### Security
- **X-DEVELOPER-UUID** (apiKey) - Required header for developer authentication.
- **X-API-KEY** (apiKey) - Required header for API key authentication.
```
--------------------------------
### sendReservation Operations
Source: https://api.checkinscan.com/api/v1/docs.html
Operations related to sendReservation resources.
```APIDOC
## POST /api/v1/send_reservation
### Description
Creates a sendReservation resource.
### Method
POST
### Endpoint
/api/v1/send_reservation
```
```APIDOC
## GET /api/v1/send_reservation/{id}
### Description
Retrieves a sendReservation resource.
### Method
GET
### Endpoint
/api/v1/send_reservation/{id}
```
```APIDOC
## PUT /api/v1/send_reservation/{id}
### Description
Replaces the sendReservation resource.
### Method
PUT
### Endpoint
/api/v1/send_reservation/{id}
```
```APIDOC
## DELETE /api/v1/send_reservation/{id}
### Description
Removes the sendReservation resource.
### Method
DELETE
### Endpoint
/api/v1/send_reservation/{id}
```
```APIDOC
## GET /api/v1/send_reservations
### Description
Retrieves the collection of sendReservation resources.
### Method
GET
### Endpoint
/api/v1/send_reservations
```
--------------------------------
### Retrieve SendReservation Item
Source: https://api.checkinscan.com/api/v1/docs.json
Retrieves a specific sendReservation resource using its ID.
```APIDOC
## GET /api/v1/send_reservation/{id}
### Description
Retrieves a sendReservation resource.
### Method
GET
### Endpoint
/api/v1/send_reservation/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the sendReservation to retrieve.
```
--------------------------------
### Delete Reservation
Source: https://api.checkinscan.com/api/v1/docs.json
Removes a Reservation resource.
```APIDOC
## DELETE /api/v1/reservations/{id}
### Description
Removes the Reservation resource.
### Method
DELETE
### Endpoint
/api/v1/reservations/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the reservation to delete.
### Response
#### Success Response (204)
- **Reservation resource deleted**
#### Error Responses
- **404** - Resource not found
- **409** - Conflict: It is not possible to delete a reservation that has
```
--------------------------------
### Update SendReservation Item
Source: https://api.checkinscan.com/api/v1/docs.json
Replaces an existing sendReservation resource using its ID.
```APIDOC
## PUT /api/v1/send_reservation/{id}
### Description
Replaces the sendReservation resource.
### Method
PUT
### Endpoint
/api/v1/send_reservation/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the sendReservation to update.
#### Request Body
- **sendReservation** (object) - Required - The updated sendReservation resource. Schema reference: #/definitions/sendReservation-reservas_guests_write
```
--------------------------------
### Delete SendReservation Item
Source: https://api.checkinscan.com/api/v1/docs.json
Removes a specific sendReservation resource using its ID.
```APIDOC
## DELETE /api/v1/send_reservation/{id}
### Description
Removes the sendReservation resource.
### Method
DELETE
### Endpoint
/api/v1/send_reservation/{id}
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the sendReservation to delete.
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.