GET api/portalstorelocations/{networkID}/{id}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
networkID | integer |
Required |
|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PortalStoreLocationModelName | Description | Type | Additional information |
---|---|---|---|
Id |
The unique identifier of the pharmacy store. |
integer |
None. |
NetworkID |
The value that represents the network ID of the pharmacy store (this is referred to as the pharmacy HQ ID internally). |
integer |
None. |
StoreNCPDP |
The unique NCPDP (National Council for Prescription Drug Programs) identifier for the pharmacy store. |
string |
None. |
StoreNPI |
The National Provider Identifier (NPI) for the pharmacy store. |
string |
None. |
StoreName |
The name of the pharmacy store. |
string |
None. |
Latitude |
The latitude coordinate of the pharmacy store's location. |
decimal number |
None. |
Longitude |
The longitude coordinate of the pharmacy store's location. |
decimal number |
None. |
Distance |
The distance from the search origin to the pharmacy store, in miles. |
decimal number |
None. |
Address1 |
The primary street address of the pharmacy store. |
string |
None. |
Address2 |
The secondary address information for the pharmacy store (e.g., suite or unit number). |
string |
None. |
City |
The city where the pharmacy store is located. |
string |
None. |
State |
The state or province where the pharmacy store is located. |
string |
None. |
Zip |
The postal (ZIP) code of the pharmacy store's location. |
string |
None. |
TelephoneNumber |
The telephone number of the pharmacy store. |
string |
None. |
FaxNumber |
The fax number of the pharmacy store. |
string |
None. |
Hours |
The encoded operating hours of the pharmacy store. **Decoding Instructions:** - The `Hours` field is a 35-character string divided into 7 segments, each representing a day of the week from **Sunday (`1`)** to **Saturday (`7`)**. - Each segment is **5 characters long**: - **First character**: Day identifier (`1` = Sunday, `2` = Monday, ..., `7` = Saturday). - **Next four characters**: Opening and closing times in 24-hour format (`HHHH`) or blank spaces if the store is closed on that day. - **First two digits**: Opening hour (`HH`). - **Last two digits**: Closing hour (`HH`). - If the store is **closed** on a day, the four characters are blank spaces. **Example:** ``` Hours = "1 210193101941019510196101971018" ``` This represents: - **Sunday (`1`)**: Closed - **Monday (`2`)**: Open from **10 AM** to **7 PM** - **Tuesday (`3`)**: Open from **10 AM** to **7 PM** - **Wednesday (`4`)**: Open from **10 AM** to **7 PM** - **Thursday (`5`)**: Open from **10 AM** to **7 PM** - **Friday (`6`)**: Open from **10 AM** to **7 PM** - **Saturday (`7`)**: Open from **10 AM** to **6 PM** **Notes:** - If the entire `Hours` string is blank, no operating hours information is available. - The encoded string does not explicitly include a 24-hour flag. - If a store is open 24 hours, the `Hours` string may be entirely blank |
string |
None. |
CustomAttribute1 |
Custom attribute 1 for additional store information. |
string |
None. |
CustomAttribute2 |
Custom attribute 2 for additional store information. |
string |
None. |
CustomAttribute3 |
Custom attribute 3 for additional store information. |
string |
None. |
PrimaryPharmacyType |
The primary type of the pharmacy store (e.g., Retail, Specialty). |
string |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{ "id": 1, "networkID": 2, "storeNCPDP": "sample string 3", "storeNPI": "sample string 4", "storeName": "sample string 5", "latitude": 1.0, "longitude": 1.0, "distance": 1.0, "address1": "sample string 6", "address2": "sample string 7", "city": "sample string 8", "state": "sample string 9", "zip": "sample string 10", "telephoneNumber": "sample string 11", "faxNumber": "sample string 12", "hours": "sample string 13", "customAttribute1": "sample string 14", "customAttribute2": "sample string 15", "customAttribute3": "sample string 16", "primaryPharmacyType": "sample string 17" }