Search Facilities
GET/api/v2/public/facilities/search
Returns an array of all the facilities registered in the application. Only publicly available information about each facility will be returned through this endpoint.
You can use this endpoint to search for a specific facility to check if it already exists in the application. Instead of using the Request Facility Creation endpoint, you can use the Request Facility Connection endpoint if the facility is found.
Request
Query Parameters
Possible values: >= 1
Default value: 1
Use to paginate the results
Use to filter the search based on the facility name
Responses
- 201
- 400
- 401
- 403
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
Nursa id of the facility
Name of the facility
Street address of the facility
Name of the city where the facility is located
Zip code of the facility
State Abbreviation of the facility in ANSI standard
URL of the facility image
Website URL of the facility
{
"data": [
{
"facilityId": "124345",
"name": "Facility name",
"streetAddress": "Idaho address",
"cityName": "City name",
"zipCode": "12345",
"stateCode": "AL",
"imageUrl": "string",
"websiteUrl": "string"
}
]
}
Bad request
- application/json
- Schema
- Example (from schema)
- Request Validation
Schema
Error description
The type of error
Status code of the error
{
"message": [
"Property must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Request Validation Error
{
"message": [
"page must not be less than 1",
"page must be a number conforming to the specified constraints",
"name must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error description
Status code of the error
{
"message": "Unauthorized",
"statusCode": 401
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error description
The type of error
Status code of the error
{
"message": "Forbidden Resource",
"error": "Forbidden",
"statusCode": 403
}