Request Facility Connection

POST 
/api/v2/public/facilities/connection

This endpoint allows users to request a connection to an existing facility in our application. The user must provide the facilityId in the request body payload. Once the request is submitted, a Nursa employee will review and either accept or reject the request.

A verified facility connection is required to act on behalf of the facility, such as using endpoints to Create Shifts and Schedule Clinicians.

Users can also create a Webhook in our system to receive notifications when the facility connection request is accepted or rejected.

Request

application/json

Body

required

facilityId stringrequired

Id of the Facility

Responses

201

Empty Response

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "facilityId must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Already Exists

Facility connection request already exists

{
  "message": "Facility connection request already exists",
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...