GET API/V1/Customization/Locations

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

Direct lookup by location id. When provided, all other filters are ignored; a non-matching id yields 404.

 integer

None.
MedicationId

Restricts to the locations used by the specified medication. Mutually exclusive with PdpId/ProductId/ProcessId.

 integer

None.
PdpId

Restricts to the locations used by the specified Partial Data Product (PDP). Mutually exclusive with MedicationId/ProductId/ProcessId.

 integer

None.
ProductId

Restricts to the locations used by the specified product. Mutually exclusive with MedicationId/PdpId/ProcessId.

 integer

None.
ProcessId

Restricts to the locations used by the specified task/process. Mutually exclusive with MedicationId/PdpId/ProductId.

 integer

None.
ExternalCode

Exact, case-sensitive match on the location external code. Locations with a null code are excluded.

 string

None.
DoseFormId

AND-combinable narrowing filter: restricts to the locations associated with the specified dose form.

 integer

None.
RouteId

AND-combinable narrowing filter: restricts to the locations associated with the specified route.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Customization.Location
NameDescriptionTypeAdditional information
Identifier

Primary identifier: Id (LocationID), Code (ExternalCode, may be null), Description (LocationName).

 iMDsoft.API.Metavision.Data.Data.CodedElement

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    }
  },
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    }
  }
]