GET api/Specimen/GetOrderableEntities?LabOrgid={LabOrgid}&LabAccountID={LabAccountID}&OFOrgID={OFOrgID}&OFAccountID={OFAccountID}&OFUserID={OFUserID}&SearchParam={SearchParam}

Request Information

URI Parameters

Name	Type	Additional information
LabOrgid	integer	Required
LabAccountID	integer	Required
OFOrgID	integer	Required
OFAccountID	integer	Required
OFUserID	integer	Required
SearchParam	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of APOrderCodes

Name	Type	Additional information
OrderCodeID	integer	None.
OrderCode	string	None.
OrderCodeName	string	None.
DisplayName	string	None.
OrderCodeType	string	None.
Aliases	string	None.
VOAliases	string	None.
TestCategory	string	None.
isOrderable	boolean	None.
isVOOrderable	boolean	None.
isEditable	boolean	None.
isVOEditable	boolean	None.
RequisitionProfileID	integer	None.
RequisitionProfileStatus	string	None.
LabOrgID	integer	None.
OFOrgID	integer	None.
OFAccountID	integer	None.
OFUserID	integer	None.
Casetype	string	None.
CasetypeDisplayName	string	None.
ParentID	integer	None.
SiteID	integer	None.
SiteName	string	None.
isFavourite	boolean	None.
isFrequentlyUsed	boolean	None.
isUserLevel	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderCodeID": 1,
    "OrderCode": "sample string 2",
    "OrderCodeName": "sample string 3",
    "DisplayName": "sample string 4",
    "OrderCodeType": "sample string 5",
    "Aliases": "sample string 6",
    "VOAliases": "sample string 7",
    "TestCategory": "sample string 8",
    "isOrderable": true,
    "isVOOrderable": true,
    "isEditable": true,
    "isVOEditable": true,
    "RequisitionProfileID": 13,
    "RequisitionProfileStatus": "sample string 14",
    "LabOrgID": 15,
    "OFOrgID": 16,
    "OFAccountID": 17,
    "OFUserID": 18,
    "Casetype": "sample string 19",
    "CasetypeDisplayName": "sample string 20",
    "ParentID": 21,
    "SiteID": 22,
    "SiteName": "sample string 23",
    "isFavourite": true,
    "isFrequentlyUsed": true,
    "isUserLevel": true
  },
  {
    "OrderCodeID": 1,
    "OrderCode": "sample string 2",
    "OrderCodeName": "sample string 3",
    "DisplayName": "sample string 4",
    "OrderCodeType": "sample string 5",
    "Aliases": "sample string 6",
    "VOAliases": "sample string 7",
    "TestCategory": "sample string 8",
    "isOrderable": true,
    "isVOOrderable": true,
    "isEditable": true,
    "isVOEditable": true,
    "RequisitionProfileID": 13,
    "RequisitionProfileStatus": "sample string 14",
    "LabOrgID": 15,
    "OFOrgID": 16,
    "OFAccountID": 17,
    "OFUserID": 18,
    "Casetype": "sample string 19",
    "CasetypeDisplayName": "sample string 20",
    "ParentID": 21,
    "SiteID": 22,
    "SiteName": "sample string 23",
    "isFavourite": true,
    "isFrequentlyUsed": true,
    "isUserLevel": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfAPOrderCodes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VitalOrder_v2_ServerApp.DTO">
  <APOrderCodes>
    <Aliases>sample string 6</Aliases>
    <Casetype>sample string 19</Casetype>
    <CasetypeDisplayName>sample string 20</CasetypeDisplayName>
    <DisplayName>sample string 4</DisplayName>
    <LabOrgID>15</LabOrgID>
    <OFAccountID>17</OFAccountID>
    <OFOrgID>16</OFOrgID>
    <OFUserID>18</OFUserID>
    <OrderCode>sample string 2</OrderCode>
    <OrderCodeID>1</OrderCodeID>
    <OrderCodeName>sample string 3</OrderCodeName>
    <OrderCodeType>sample string 5</OrderCodeType>
    <ParentID>21</ParentID>
    <RequisitionProfileID>13</RequisitionProfileID>
    <RequisitionProfileStatus>sample string 14</RequisitionProfileStatus>
    <SiteID>22</SiteID>
    <SiteName>sample string 23</SiteName>
    <TestCategory>sample string 8</TestCategory>
    <VOAliases>sample string 7</VOAliases>
    <isEditable>true</isEditable>
    <isFavourite>true</isFavourite>
    <isFrequentlyUsed>true</isFrequentlyUsed>
    <isOrderable>true</isOrderable>
    <isUserLevel>true</isUserLevel>
    <isVOEditable>true</isVOEditable>
    <isVOOrderable>true</isVOOrderable>
  </APOrderCodes>
  <APOrderCodes>
    <Aliases>sample string 6</Aliases>
    <Casetype>sample string 19</Casetype>
    <CasetypeDisplayName>sample string 20</CasetypeDisplayName>
    <DisplayName>sample string 4</DisplayName>
    <LabOrgID>15</LabOrgID>
    <OFAccountID>17</OFAccountID>
    <OFOrgID>16</OFOrgID>
    <OFUserID>18</OFUserID>
    <OrderCode>sample string 2</OrderCode>
    <OrderCodeID>1</OrderCodeID>
    <OrderCodeName>sample string 3</OrderCodeName>
    <OrderCodeType>sample string 5</OrderCodeType>
    <ParentID>21</ParentID>
    <RequisitionProfileID>13</RequisitionProfileID>
    <RequisitionProfileStatus>sample string 14</RequisitionProfileStatus>
    <SiteID>22</SiteID>
    <SiteName>sample string 23</SiteName>
    <TestCategory>sample string 8</TestCategory>
    <VOAliases>sample string 7</VOAliases>
    <isEditable>true</isEditable>
    <isFavourite>true</isFavourite>
    <isFrequentlyUsed>true</isFrequentlyUsed>
    <isOrderable>true</isOrderable>
    <isUserLevel>true</isUserLevel>
    <isVOEditable>true</isVOEditable>
    <isVOOrderable>true</isVOOrderable>
  </APOrderCodes>
</ArrayOfAPOrderCodes>