GET Orders/{id}

Gets an order by the ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the order.	integer	Required

Body Parameters

None.

Response Information

Resource Description

An SMM.DTO.Order object.

Order

Name	Description	Type	Additional information
ID	SMM's order ID which SMM uses to lookup orders.	integer	None.
StatusTypeID	An integer representation of the status of the order.	integer	None.
Status	A text representation of the status of the order.	string	None.
ScheduleDate	The date the order is scheduled to start at.	date	None.
ScheduleEnd	the date the order is scheduled to end at.	date	None.
ScheduleString		string	None.
Requirements	A string representation of what will be performed upon the exam taking place.	string	None.
Carrier	The insurance carrier assigned to this request.	string	None.
KitsRequired	A list of kit types that are required for the order.	string	None.
PrimaryPhone	The primary phone number that SMM will use to contact the applicant.	string	None.
SecondaryPhone	A secondary phone number that SMM can use to contact the applicant.	string	None.
Name	The applicant's name.	string	None.
Product	The product type of the insurance being applied for.	string	None.
PolicyNumber	The insurance company policy number for this order, can be N/A."	string	None.
PrimaryAddress	The address that the applicant will be seen at.	string	None.
Latitude	The latitude for the primary address	decimal number	None.
Longitude	The longitude for the primary address.	decimal number	None.
RepExtension	The SMM extension of the SMM customer service representative for this order.	string	None.
isDirectOrder		boolean	None.
isGoParamed		boolean	None.
Viewed		boolean	None.
Division		integer	None.
Airbill		string	None.
Barcode		string	None.
StatusList		Collection of OrderStatus	None.
Instructions		string	None.
MailOriginalsTo		string	None.
MailCopiesTo		string	None.
FaxTo		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "StatusTypeID": 2,
  "Status": "sample string 3",
  "ScheduleDate": "2024-09-19T13:37:27.8710294-05:00",
  "ScheduleEnd": "2024-09-19T13:37:27.8710294-05:00",
  "ScheduleString": "sample string 4",
  "Requirements": "sample string 5",
  "Carrier": "sample string 6",
  "KitsRequired": "sample string 7",
  "PrimaryPhone": "sample string 8",
  "SecondaryPhone": "sample string 9",
  "Name": "sample string 10",
  "Product": "sample string 11",
  "PolicyNumber": "sample string 12",
  "PrimaryAddress": "sample string 13",
  "Latitude": 1.1,
  "Longitude": 1.1,
  "RepExtension": "sample string 14",
  "isDirectOrder": true,
  "isGoParamed": true,
  "Viewed": true,
  "Division": 18,
  "Airbill": "sample string 19",
  "Barcode": "sample string 20",
  "StatusList": [
    {
      "ID": 1,
      "OrderID": 2,
      "Date": "sample string 3",
      "ForDate": "sample string 4",
      "Notes": "sample string 5",
      "StatusType": "sample string 6",
      "SystemComment": "sample string 7"
    },
    {
      "ID": 1,
      "OrderID": 2,
      "Date": "sample string 3",
      "ForDate": "sample string 4",
      "Notes": "sample string 5",
      "StatusType": "sample string 6",
      "SystemComment": "sample string 7"
    }
  ],
  "Instructions": "sample string 21",
  "MailOriginalsTo": "sample string 22",
  "MailCopiesTo": "sample string 23",
  "FaxTo": "sample string 24"
}

application/xml, text/xml

Sample:

<Order xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>1</ID>
  <StatusTypeID>2</StatusTypeID>
  <Status>sample string 3</Status>
  <ScheduleDate>2024-09-19T13:37:27.8710294-05:00</ScheduleDate>
  <ScheduleEnd>2024-09-19T13:37:27.8710294-05:00</ScheduleEnd>
  <ScheduleString>sample string 4</ScheduleString>
  <Requirements>sample string 5</Requirements>
  <Carrier>sample string 6</Carrier>
  <KitsRequired>sample string 7</KitsRequired>
  <PrimaryPhone>sample string 8</PrimaryPhone>
  <SecondaryPhone>sample string 9</SecondaryPhone>
  <Name>sample string 10</Name>
  <Product>sample string 11</Product>
  <PolicyNumber>sample string 12</PolicyNumber>
  <PrimaryAddress>sample string 13</PrimaryAddress>
  <Latitude>1.1</Latitude>
  <Longitude>1.1</Longitude>
  <RepExtension>sample string 14</RepExtension>
  <isDirectOrder>true</isDirectOrder>
  <isGoParamed>true</isGoParamed>
  <Viewed>true</Viewed>
  <Division>18</Division>
  <Airbill>sample string 19</Airbill>
  <Barcode>sample string 20</Barcode>
  <StatusList>
    <OrderStatus>
      <ID>1</ID>
      <OrderID>2</OrderID>
      <Date>sample string 3</Date>
      <ForDate>sample string 4</ForDate>
      <Notes>sample string 5</Notes>
      <StatusType>sample string 6</StatusType>
      <SystemComment>sample string 7</SystemComment>
    </OrderStatus>
    <OrderStatus>
      <ID>1</ID>
      <OrderID>2</OrderID>
      <Date>sample string 3</Date>
      <ForDate>sample string 4</ForDate>
      <Notes>sample string 5</Notes>
      <StatusType>sample string 6</StatusType>
      <SystemComment>sample string 7</SystemComment>
    </OrderStatus>
  </StatusList>
  <Instructions>sample string 21</Instructions>
  <MailOriginalsTo>sample string 22</MailOriginalsTo>
  <MailCopiesTo>sample string 23</MailCopiesTo>
  <FaxTo>sample string 24</FaxTo>
</Order>