api-docs v5.116.0

API Docs

Table of contents

Ward_Bed

Ward Bed - Delete

Back to top

Delete a specific ward bed

DELETE /ward-beds/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-beds/<ward-bed-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
room string

room id
label string
number number
forMaintenance boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Bed - Find

Back to top

Get list of ward beds

GET /ward-beds

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-beds" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
wardBeds object[]

array of wardBed
wardBeds.id string
wardBeds.createdAt number
wardBeds.createdBy string
wardBeds.facility string
wardBeds.room string

room id
wardBeds.label string
wardBeds.number number
wardBeds.forMaintenance boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Ward Bed - Get

Back to top

Get a specific ward bed

GET /ward-beds/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-beds/<ward-bed-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
room string

room id
label string
number number
forMaintenance boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Bed - Patch

Back to top

Update ward bed

PATCH /ward-beds/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional Default value: currentTime
label string optional
number number optional
forMaintenance boolean optional

Examples

Example usage:

curl "https://yourdomain.com/ward-beds/<ward-bed-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "number": 12
  }'

Parameters examples

json - Request-Example

{
  "number": 12
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
room string

room id
label string
number number
forMaintenance boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Bed - Post

Back to top

Create ward bed

POST /ward-beds

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional Default value: currentTime
room string

room id
label string optional
number number optional
forMaintenance boolean optional

Examples

Example usage:

curl "https://yourdomain.com/ward-beds" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "room": "room-id",
    "label": "some label"
  }'

Parameters examples

json - Request-Example

{
  "room": "room-id",
  "label": "some label"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
room string

room id
label string
number number
forMaintenance boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""