Facility
GET api/Facility/{systemID}/FacilityList?facilityName={facilityName}
Search and retrieve all facility records matching the facilityName. Exclude the facilityName to retrieve all facility records.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| systemID | Unique ID for system |
Define this parameter in the request URI. |
| facilityName | Facility Name (partials allowed)(optional) |
Define this parameter in the request URI. |
Response Codes
- OK (200)
- BadRequest (400)
- NotFound (404)
- InternalServerError (500)
Response Information
Facility Information
Response body formats
application/json, text/json
Sample:
[
{
"FacilityIDCode": "sample string 1",
"FacilityNPI": "sample string 2",
"FacilityID": "sample string 3",
"ReportGroup": "sample string 4",
"DeliveryRoute": "sample string 5",
"MainContact": "sample string 6",
"ContactTitle": "sample string 7",
"FacilityName": "sample string 8",
"Address": "sample string 9",
"Address2": "sample string 10",
"City": "sample string 11",
"State": "sample string 12",
"Zip": "sample string 13",
"Phone": "sample string 14",
"Fax": "sample string 15",
"FlaggedForDeletion": true,
"MovedToAxys": true
},
{
"FacilityIDCode": "sample string 1",
"FacilityNPI": "sample string 2",
"FacilityID": "sample string 3",
"ReportGroup": "sample string 4",
"DeliveryRoute": "sample string 5",
"MainContact": "sample string 6",
"ContactTitle": "sample string 7",
"FacilityName": "sample string 8",
"Address": "sample string 9",
"Address2": "sample string 10",
"City": "sample string 11",
"State": "sample string 12",
"Zip": "sample string 13",
"Phone": "sample string 14",
"Fax": "sample string 15",
"FlaggedForDeletion": true,
"MovedToAxys": true
},
{
"FacilityIDCode": "sample string 1",
"FacilityNPI": "sample string 2",
"FacilityID": "sample string 3",
"ReportGroup": "sample string 4",
"DeliveryRoute": "sample string 5",
"MainContact": "sample string 6",
"ContactTitle": "sample string 7",
"FacilityName": "sample string 8",
"Address": "sample string 9",
"Address2": "sample string 10",
"City": "sample string 11",
"State": "sample string 12",
"Zip": "sample string 13",
"Phone": "sample string 14",
"Fax": "sample string 15",
"FlaggedForDeletion": true,
"MovedToAxys": true
}
]
text/javascript
Sample:
[{"FacilityIDCode":"sample string 1","FacilityNPI":"sample string 2","FacilityID":"sample string 3","ReportGroup":"sample string 4","DeliveryRoute":"sample string 5","MainContact":"sample string 6","ContactTitle":"sample string 7","FacilityName":"sample string 8","Address":"sample string 9","Address2":"sample string 10","City":"sample string 11","State":"sample string 12","Zip":"sample string 13","Phone":"sample string 14","Fax":"sample string 15","FlaggedForDeletion":true,"MovedToAxys":true},{"FacilityIDCode":"sample string 1","FacilityNPI":"sample string 2","FacilityID":"sample string 3","ReportGroup":"sample string 4","DeliveryRoute":"sample string 5","MainContact":"sample string 6","ContactTitle":"sample string 7","FacilityName":"sample string 8","Address":"sample string 9","Address2":"sample string 10","City":"sample string 11","State":"sample string 12","Zip":"sample string 13","Phone":"sample string 14","Fax":"sample string 15","FlaggedForDeletion":true,"MovedToAxys":true},{"FacilityIDCode":"sample string 1","FacilityNPI":"sample string 2","FacilityID":"sample string 3","ReportGroup":"sample string 4","DeliveryRoute":"sample string 5","MainContact":"sample string 6","ContactTitle":"sample string 7","FacilityName":"sample string 8","Address":"sample string 9","Address2":"sample string 10","City":"sample string 11","State":"sample string 12","Zip":"sample string 13","Phone":"sample string 14","Fax":"sample string 15","FlaggedForDeletion":true,"MovedToAxys":true}]
application/xml, text/xml
Sample:
<ArrayOfFacilityInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
<FacilityInformation>
<Address>sample string 9</Address>
<Address2>sample string 10</Address2>
<City>sample string 11</City>
<ContactTitle>sample string 7</ContactTitle>
<DeliveryRoute>sample string 5</DeliveryRoute>
<FacilityID>sample string 3</FacilityID>
<FacilityIDCode>sample string 1</FacilityIDCode>
<FacilityNPI>sample string 2</FacilityNPI>
<FacilityName>sample string 8</FacilityName>
<Fax>sample string 15</Fax>
<FlaggedForDeletion>true</FlaggedForDeletion>
<MainContact>sample string 6</MainContact>
<MovedToAxys>true</MovedToAxys>
<Phone>sample string 14</Phone>
<ReportGroup>sample string 4</ReportGroup>
<State>sample string 12</State>
<Zip>sample string 13</Zip>
</FacilityInformation>
<FacilityInformation>
<Address>sample string 9</Address>
<Address2>sample string 10</Address2>
<City>sample string 11</City>
<ContactTitle>sample string 7</ContactTitle>
<DeliveryRoute>sample string 5</DeliveryRoute>
<FacilityID>sample string 3</FacilityID>
<FacilityIDCode>sample string 1</FacilityIDCode>
<FacilityNPI>sample string 2</FacilityNPI>
<FacilityName>sample string 8</FacilityName>
<Fax>sample string 15</Fax>
<FlaggedForDeletion>true</FlaggedForDeletion>
<MainContact>sample string 6</MainContact>
<MovedToAxys>true</MovedToAxys>
<Phone>sample string 14</Phone>
<ReportGroup>sample string 4</ReportGroup>
<State>sample string 12</State>
<Zip>sample string 13</Zip>
</FacilityInformation>
<FacilityInformation>
<Address>sample string 9</Address>
<Address2>sample string 10</Address2>
<City>sample string 11</City>
<ContactTitle>sample string 7</ContactTitle>
<DeliveryRoute>sample string 5</DeliveryRoute>
<FacilityID>sample string 3</FacilityID>
<FacilityIDCode>sample string 1</FacilityIDCode>
<FacilityNPI>sample string 2</FacilityNPI>
<FacilityName>sample string 8</FacilityName>
<Fax>sample string 15</Fax>
<FlaggedForDeletion>true</FlaggedForDeletion>
<MainContact>sample string 6</MainContact>
<MovedToAxys>true</MovedToAxys>
<Phone>sample string 14</Phone>
<ReportGroup>sample string 4</ReportGroup>
<State>sample string 12</State>
<Zip>sample string 13</Zip>
</FacilityInformation>
</ArrayOfFacilityInformation>