Specimen Management API

Locations

Server

Look up specimen pickup locations for an account.


Get specimen pickup locations for an account.

GET
https://specimen-service.services.{domain}
/locations/{accountNumber}

Return the specimen pickup locations associated with the given partner account number. See the response schema for the returned fields.

sendingFacility and sendingApplication are required query parameters. This service matches them (after trim, case-sensitive) to a unique ACTIVE client config on this request's service subscription, then authorizes the request account for that config before returning locations.

Get specimen pickup locations for an account. › path Parameters

accountNumber
​string · pattern: ^\d+$ · required

Partner account number whose pickup locations are being retrieved. After trim, must be digits-only (/^\d+$/); leading zeros are allowed.

Get specimen pickup locations for an account. › query Parameters

sendingFacility
​string · required

The sending facility identifier. Must match the partner's active service subscription configuration.

sendingApplication
​string · required

The sending application identifier (mnemonic). Must match the partner's active service subscription configuration.

Get specimen pickup locations for an account. › Responses

Pickup locations for the account.

Response body containing pickup locations for an account.
​SpecimenPickUpLocation[] · required

List of pickup locations for the account.