api-docs v5.116.0

API Docs

Table of contents

Ward_Room

Ward Room - Delete

Back to top

Delete a specific ward room

DELETE /ward-rooms/: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-rooms/<ward-room-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

facility id
floor number
wing string
name string
description string
private boolean

Success response example

Success response example - Success-Response:

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

Ward Room - Find

Back to top

Get list of ward rooms

GET /ward-rooms

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-rooms" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
wardRooms object[]

array of wardRoom
wardRooms.id string
wardRooms.createdAt number
wardRooms.createdBy string
wardRooms.facility string

facility id
wardRooms.floor number
wardRooms.wing string
wardRooms.name string
wardRooms.description string
wardRooms.private 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 Room - Get

Back to top

Get a specific ward room

GET /ward-rooms/: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-rooms/<ward-room-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

facility id
floor number
wing string
name string
description string
private boolean

Success response example

Success response example - Success-Response:

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

Ward Room - Patch

Back to top

Update ward room

PATCH /ward-rooms/: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
floor number
wing string optional
name string optional
description string optional
private boolean optional

Examples

Example usage:

curl "https://yourdomain.com/ward-rooms/<ward-room-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "discharge": true
  }'

Parameters examples

json - Request-Example

{
  "discharge": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
floor number
wing string
name string
description string
private boolean

Success response example

Success response example - Success-Response:

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

Ward Room - Post

Back to top

Create ward room

POST /ward-rooms

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
facility string

facility id
floor number
wing string optional
name string optional
description string optional
private boolean optional

Examples

Example usage:

curl "https://yourdomain.com/ward-rooms" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "floor": 1
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "floor": 1
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string

facility id
floor number
wing string
name string
description string
private 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 ""