GET api/HeadquarterPharmacyLocations?pharmacyheadquarterid={pharmacyheadquarterid}&page={page}&pagesize={pagesize}&lastModifiedAfter={lastModifiedAfter}

Gets a collection of pharmacy locations associated with a pharmacy headquarter, paged.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pharmacyheadquarterid

Pharmacy Headquarter's identifier

integer

Required

page

1-based page index indicating which page of the results should be returned (optional, default is 1)

integer

Default value is 1

pagesize

The number of results to return per page (optional, default is 100, max is 250)

integer

Default value is 100

lastModifiedAfter

This parameter is obsolete and is no longer functional. It will be removed completely in a future release

date

None.

Body Parameters

None.

Response Information

Resource Description

A paged collection of headquarter pharmacy locations

PagedResultModelOfHeadquarterPharmacyLocationModel
NameDescriptionTypeAdditional information
PageNumber

integer

None.

PageCount

integer

None.

PageSize

integer

None.

Items

Collection of HeadquarterPharmacyLocationModel

None.

TotalRecordCount

integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "pageNumber": 1,
  "pageCount": 2,
  "pageSize": 3,
  "items": [
    {
      "id": 1,
      "npi": "sample string 2",
      "locationName": "sample string 3",
      "city": "sample string 4",
      "stateCode": "sample string 5",
      "comment": "sample string 6",
      "primaryPharmacyType": "sample string 7",
      "ncpdp": "sample string 8",
      "primaryRelationshipCode": "sample string 9",
      "pharmacyHeadquarterNo": 10
    },
    {
      "id": 1,
      "npi": "sample string 2",
      "locationName": "sample string 3",
      "city": "sample string 4",
      "stateCode": "sample string 5",
      "comment": "sample string 6",
      "primaryPharmacyType": "sample string 7",
      "ncpdp": "sample string 8",
      "primaryRelationshipCode": "sample string 9",
      "pharmacyHeadquarterNo": 10
    }
  ],
  "totalRecordCount": 4
}