GET v1/organization/orderentrysettings?serviceprovidername={serviceprovidername}

Get Order Entry Settings: Get a set of Order Entry Settings that can be used to control the order entry behavior for a given service provider.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceprovidername

Must match a lab connection name in the organization's lab list.

string

Required

Body Parameters

None.

Response Information

Resource Description

OrderEntrySettingsResponse
NameDescriptionTypeAdditional information
OrderEntrySettings

Container for Order Entry settings.

OrderEntrySettings

None.

Error

Will be set to True if any errors occur during the processing of the API method.

boolean

None.

ErrorMessage

Will contain an error message string if Error is True.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderEntrySettings": {
    "SendToLabBtnEnabled": true,
    "SendToLabBtnText": "sample string 2",
    "SendToLabBtnDesc": "sample string 3",
    "SendToLabBtnDefaultPrintActions": [
      "sample string 1",
      "sample string 2"
    ],
    "SendToPSCBtnEnabled": true,
    "SendToPSCBtnText": "sample string 5",
    "SendToPSCBtnDesc": "sample string 6",
    "SendToPSCBtnDefaultPrintActions": [
      "sample string 1",
      "sample string 2"
    ],
    "PrintReqOnlyBtnEnabled": "sample string 7",
    "PrintReqOnlyBtnText": "sample string 8",
    "PrintLabelsOnlyBtnEnabled": "sample string 9",
    "PrintLabelsOnlyBtnText": "sample string 10",
    "PrintABNOnlyBtnEnabled": "sample string 11",
    "PrintABNOnlyBtnText": "sample string 12",
    "OrderListFilters": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<OrderEntrySettingsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 2</ErrorMessage>
  <OrderEntrySettings>
    <SendToLabBtnEnabled>true</SendToLabBtnEnabled>
    <SendToLabBtnText>sample string 2</SendToLabBtnText>
    <SendToLabBtnDesc>sample string 3</SendToLabBtnDesc>
    <SendToLabBtnDefaultPrintActions>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </SendToLabBtnDefaultPrintActions>
    <SendToPSCBtnEnabled>true</SendToPSCBtnEnabled>
    <SendToPSCBtnText>sample string 5</SendToPSCBtnText>
    <SendToPSCBtnDesc>sample string 6</SendToPSCBtnDesc>
    <SendToPSCBtnDefaultPrintActions>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </SendToPSCBtnDefaultPrintActions>
    <PrintReqOnlyBtnEnabled>sample string 7</PrintReqOnlyBtnEnabled>
    <PrintReqOnlyBtnText>sample string 8</PrintReqOnlyBtnText>
    <PrintLabelsOnlyBtnEnabled>sample string 9</PrintLabelsOnlyBtnEnabled>
    <PrintLabelsOnlyBtnText>sample string 10</PrintLabelsOnlyBtnText>
    <PrintABNOnlyBtnEnabled>sample string 11</PrintABNOnlyBtnEnabled>
    <PrintABNOnlyBtnText>sample string 12</PrintABNOnlyBtnText>
    <OrderListFilters>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </OrderListFilters>
  </OrderEntrySettings>
</OrderEntrySettingsResponse>