Request Facility Creation

POST 
/api/v2/public/facilities/request

This endpoint allows users to request a facility to be created in our application. Once the request is submitted, a Nursa employee will review and either accept or reject the request.

If the request is accepted the connection between the user and the facility will be created automatically Therefore, there is no need to Request a Facility Connection for the user who created the facility.

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

Request

application/json

Body

required

name stringrequired

Name of the facility

type stringrequired

Type of the facility

category stringrequired

Category of the facility

numberOfBeds integerrequired

Possible values: <= 999

Number of beds in the facility

streetAddress stringrequired

Street address of the facility

cityName stringrequired

Name of the city where the facility is located

zipCode ##### | #####-####required

Zip code of the facility

stateCode stringrequired

State Abbreviation of the facility in ANSI standard

county stringrequired

Name of the county where the facility is located

contactPhone +1##########required

Telephone number of the facility

billingInformation objectrequired

contactName stringrequired

Name of the contact

contactEmail stringrequired

Email of the contact

contactPhone +1##########required

Telephone number of the contact

specialty stringrequired

Name of the facility specialty

websiteUrl string

Website URL of the facility

Responses

201

application/json

Schema

Schema

data object

requestId stringrequired

Id of the Facility Creation Request

name stringrequired

Name of the facility

type stringrequired

Type of the facility

category stringrequired

Category of the facility

numberOfBeds numberrequired

Possible values: <= 999

Number of beds in the facility

streetAddress stringrequired

Street address of the facility

cityName stringrequired

Name of the city where the facility is located

zipCode ##### | #####-####required

Zip code of the facility

stateCode stringrequired

State Abbreviation of the facility in ANSI standard

county stringrequired

Name of the county where the facility is located

contactPhone +1##########required

Telephone number of the facility

billingInformation objectrequired

contactName stringrequired

Name of the contact

contactEmail stringrequired

Email of the contact

contactPhone +1##########required

Telephone number of the contact

specialty stringrequired

Name of the facility specialty

websiteUrl stringrequired

Website URL of the facility

Example (from schema)

{
  "data": {
    "requestId": "c2ab05f3-b279-430f-9d4b-cbaea0b904f8",
    "name": "Facility name",
    "type": "Long Term Care",
    "category": "Assisted Living",
    "numberOfBeds": 0,
    "streetAddress": "string",
    "cityName": "1108 Ross Clark Cir",
    "zipCode": "12345",
    "stateCode": "AL",
    "county": "Houston County",
    "contactPhone": "+11234567890",
    "billingInformation": {
      "contactName": "John Doe",
      "contactEmail": "john.doe@email.com",
      "contactPhone": "+11234567890"
    },
    "specialty": "string",
    "websiteUrl": "string"
  }
}

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": [
    "name must be a string",
    "type must be a string",
    "category must be a string",
    "numberOfBeds must not be greater than 999",
    "numberOfBeds must not be less than 0",
    "numberOfBeds must be an integer number",
    "streetAddress must be a string",
    "cityName must be a string",
    "zipCode must be a string",
    "stateCode must be a string",
    "county must be a string",
    "contactPhone must be a string",
    "contactName must be a string",
    "contactName should not be empty",
    "contactEmail must be an email",
    "contactEmail should not be empty",
    "contactPhone must be a string",
    "contactPhone should not be empty",
    "specialty must be a string",
    "websiteUrl must be a URL address"
  ],
  "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
}

404

Not Found

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": "Not Found",
  "error": "Not Found",
  "statusCode": 404
}

Specialty Not Found

Specialty was not found

{
  "message": "Specialty Wound Care not found",
  "error": "Not Found",
  "statusCode": 404
}

Loading...