Get Facilities

GET 
/api/v2/public/facilities

Returns an array of facilities which the user has connection to.

Request

Query Parameters

limit number
Possible values: <= 100
Default value: 10
Pagination parameter, use to specify the quantity of records returned
Example: 10
offset number
Default value: 0
Pagination parameter, use to specify the number of records to skip before starting to return results
Example: 10
sortDirection string
Possible values: [ASC, DESC]
Default value: DESC
Pagination parameter, use to specify the order of records by creation date, either 'asc' for ascending or 'desc' for descending
Example: DESC

Responses

201

application/json

Schema

Schema

data object[]
Array [
facilityId stringrequired
Nursa id of the facility
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 object[]required
Data related to the facility specialty
Array [
title stringrequired
Title of the specialty
description stringrequired
Description of the Specialty
]
websiteUrl string
Website URL of the facility
healthCareSystem string
Healthcare System of the facility
]
meta object

limit numberrequired

Number of items returned

offset numberrequired

Starting position

sortDirection objectrequired

Sorting direction

total numberrequired

Total records found

Example (from schema)

{
  "data": [
    {
      "facilityId": "124345",
      "name": "Facility name",
      "type": "Freestanding Hospice",
      "category": "Hospice",
      "numberOfBeds": 10,
      "streetAddress": "Idaho address",
      "cityName": "Hayden",
      "zipCode": "83835",
      "stateCode": "ID",
      "county": "Idaho County",
      "contactPhone": "+12345678910",
      "billingInformation": {
        "contactName": "John Doe",
        "contactEmail": "john.doe@email.com",
        "contactPhone": "+11234567890"
      },
      "specialty": [
        {
          "title": "Intensive Care Unit",
          "description": "Intensive Care Unit"
        }
      ],
      "websiteUrl": "https://example.com",
      "healthCareSystem": "string"
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "sortDirection": {},
    "total": 0
  }
}

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": [
    "limit must be a number conforming to the specified constraints",
    "limit must not be less than 0",
    "limit must not be greater than 50",
    "offset must be a number conforming to the specified constraints",
    "offset must not be less than 0",
    "sortDirection must be one of the following values: ASC, DESC"
  ],
  "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...