GET API/V1/Customization/Routes

Request Information

URI Parameters

Name	Description	Type	Additional information
Id	Direct lookup by Identifier.Id. When provided, all other filters are ignored; a non-matching id yields 404.	integer	None.
MedicationId	Filters to the routes valid for the specified medication. Mutually exclusive with and .	integer	None.
PdpId	Filters to the routes valid for the specified Partial Data Product (PDP). Mutually exclusive with and .	integer	None.
ProductId	Filters to the routes valid for the specified product. Mutually exclusive with and .	integer	None.
DoseFormId	Filters to the routes associated with the specified dose form. Combined with the medication/PDP/product filter using AND logic when supplied together.	integer	None.
LocationId	Filters to the routes associated with the specified location. Combined with the medication/PDP/product filter using AND logic when supplied together.	integer	None.
ExternalCode	Exact, case-sensitive match on Identifier.Code. Routes with a null code are excluded.	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Customization.RouteCustomization

Name	Description	Type	Additional information
Identifier	Primary identifier: Id (RouteID), Code (external code, may be null), Description (route name, shown as "name" in the customization tool).	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
OrderingType	Ordering type configured for the route. One of: "infused", "nonInfused", "both". Maps from MvEnums.OrderingType (Infuse/NonInfuse/Both).	string	None.
Locations	Body-site locations associated with the route: each Id (MetaVision id), Code (external code, may be null), Description (location name). Present even when empty (returned as []).	Collection of 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"
    },
    "orderingType": "sample string 1",
    "locations": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      }
    ]
  },
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "orderingType": "sample string 1",
    "locations": [
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      }
    ]
  }
]