Alleva Room API
The Room API from Alleva — 4 operation(s) for room.
Documentation
Documentation
https://api.helloalleva.com/swagger/index.html
APIReference
https://api.helloalleva.com/swagger/index.html
OpenAPI Specification
openapi: 3.2.0
info:
title: Alleva Rest Room API
version: '1.0'
security:
- Bearer: []
tags:
- name: Room
paths:
/rooms:
post:
tags:
- Room
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
get:
tags:
- Room
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
/v{version}/rooms:
post:
tags:
- Room
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
get:
tags:
- Room
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Room'
/rooms/{id}:
delete:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
patch:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
get:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
/v{version}/rooms/{id}:
delete:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
patch:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
get:
tags:
- Room
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Room'
components:
schemas:
JToken:
type: array
items:
$ref: '#/components/schemas/JToken'
Room:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
facilityId:
type: integer
format: int32
roomName:
type:
- string
- 'null'
isActive:
type: boolean
totalBeds:
type: integer
format: int32
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
\ your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header
servers:
- url: https://api.helloalleva.com
description: Base URL reconciled from apis.yml