GET api/v2/Service/WorkOrders/Retrieve?Id={Id}&Detail={Detail}

Retrieves a single Work Order with Detail or Summary information.

Request Information

URI Parameters

Name	Description	Type	Additional information
Id	The Work Order Id to retrieve	string	Required
Detail		boolean	Required

Body Parameters

None.

Response Information

Resource Description

WorkOrder

Name	Type	Additional information
Id	string	None.
CustomerID	string	None.
CustomerName	string	None.
CreationDate	string	None.
ClerkId	string	None.
Type	string	None.
StartDate	string	None.
Status	string	None.
TaxSchema	string	None.
BoatId	string	None.
BoatName	string	None.
BoatYear	string	None.
BoatMake	string	None.
BoatModel	string	None.
BoatSerialNumber	string	None.
BoatRegistration	string	None.
BoatWarrantyDate	string	None.
BoatLength	string	None.
EstCompDate	string	None.
TotalParts	decimal number	None.
TotalLabor	decimal number	None.
TotalLaborHours	decimal number	None.
TotalFreight	decimal number	None.
TotalEquipment	decimal number	None.
TotalSublet	decimal number	None.
TotalMileage	decimal number	None.
TotalMiscSupply	decimal number	None.
TotalBillCodes	decimal number	None.
TotalWOCharges	decimal number	None.
TotalPartsCost	decimal number	None.
TotalLaborCost	decimal number	None.
TotalSubletCost	decimal number	None.
TotalFreightCost	decimal number	None.
TotalForecastedParts	decimal number	None.
TotalForecastedLabor	decimal number	None.
TotalForecastedHours	decimal number	None.
CompleteDate	string	None.
Category	string	None.
LocationCode	string	None.
EstStartDate	string	None.
PromisedDate	string	None.
LastModDate	string	None.
LastModTime	string	None.
Comments	string	None.
IsEstimate	boolean	None.
RiggingId	string	None.
RiggingType	string	None.
Title	string	None.
Operations	Collection of WorkOrderOperation	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "CustomerID": "sample string 2",
  "CustomerName": "sample string 3",
  "CreationDate": "sample string 4",
  "ClerkId": "sample string 5",
  "Type": "sample string 6",
  "StartDate": "sample string 7",
  "Status": "sample string 8",
  "TaxSchema": "sample string 9",
  "BoatId": "sample string 10",
  "BoatName": "sample string 11",
  "BoatYear": "sample string 12",
  "BoatMake": "sample string 13",
  "BoatModel": "sample string 14",
  "BoatSerialNumber": "sample string 15",
  "BoatRegistration": "sample string 16",
  "BoatWarrantyDate": "sample string 17",
  "BoatLength": "sample string 18",
  "EstCompDate": "sample string 19",
  "TotalParts": 1.0,
  "TotalLabor": 1.0,
  "TotalLaborHours": 1.0,
  "TotalFreight": 1.0,
  "TotalEquipment": 1.0,
  "TotalSublet": 1.0,
  "TotalMileage": 1.0,
  "TotalMiscSupply": 1.0,
  "TotalBillCodes": 1.0,
  "TotalWOCharges": 1.0,
  "TotalPartsCost": 1.0,
  "TotalLaborCost": 1.0,
  "TotalSubletCost": 1.0,
  "TotalFreightCost": 1.0,
  "TotalForecastedParts": 1.0,
  "TotalForecastedLabor": 1.0,
  "TotalForecastedHours": 1.0,
  "CompleteDate": "sample string 20",
  "Category": "sample string 21",
  "LocationCode": "sample string 22",
  "EstStartDate": "sample string 23",
  "PromisedDate": "sample string 24",
  "LastModDate": "sample string 25",
  "LastModTime": "sample string 26",
  "Comments": "sample string 27",
  "IsEstimate": true,
  "RiggingId": "sample string 29",
  "RiggingType": "sample string 30",
  "Title": "sample string 31",
  "Operations": [
    {
      "Id": "sample string 1",
      "Opcode": "sample string 2",
      "OpcodeDesc": "sample string 3",
      "Status": "sample string 4",
      "Type": "sample string 5",
      "Category": "sample string 6",
      "TotalCharges": 1.0,
      "TotalParts": 1.0,
      "TotalLabor": 1.0,
      "TotalLaborHours": 1.0,
      "TotalFreight": 1.0,
      "TotalEquipment": 1.0,
      "TotalSublet": 1.0,
      "TotalMileage": 1.0,
      "TotalMiscSupply": 1.0,
      "TotalBillCodes": 1.0,
      "LaborBilled": 1.0,
      "TotalToComplete": 1.0,
      "EstStartDate": "sample string 7",
      "EstCompleteDate": "sample string 8",
      "ReqCompDate": "sample string 9",
      "StandardHours": 1.0,
      "LongDesc": "sample string 10",
      "TechDesc": "sample string 11",
      "EstimatedCharges": 12.0,
      "EstimatedParts": 1.0,
      "EstimatedLabor": 1.0,
      "EstimatedLaborHours": 1.0,
      "EstimatedFreight": 1.0,
      "EstimatedEquipment": 1.0,
      "EstimatedSublet": 1.0,
      "EstimatedMileage": 1.0,
      "EstimatedMiscSupply": 1.0,
      "EstimatedBillCodes": 1.0,
      "IsOpcodeApproved": true,
      "FlatRateAmount": 1.0,
      "FlatRatePerFootRate": 1.0,
      "FlatRatePerFootMethod": "sample string 14",
      "ForecastedPartsCharges": 1.0,
      "ForecastedLaborCharges": 1.0,
      "ForecastedLaborHours": 1.0
    },
    {
      "Id": "sample string 1",
      "Opcode": "sample string 2",
      "OpcodeDesc": "sample string 3",
      "Status": "sample string 4",
      "Type": "sample string 5",
      "Category": "sample string 6",
      "TotalCharges": 1.0,
      "TotalParts": 1.0,
      "TotalLabor": 1.0,
      "TotalLaborHours": 1.0,
      "TotalFreight": 1.0,
      "TotalEquipment": 1.0,
      "TotalSublet": 1.0,
      "TotalMileage": 1.0,
      "TotalMiscSupply": 1.0,
      "TotalBillCodes": 1.0,
      "LaborBilled": 1.0,
      "TotalToComplete": 1.0,
      "EstStartDate": "sample string 7",
      "EstCompleteDate": "sample string 8",
      "ReqCompDate": "sample string 9",
      "StandardHours": 1.0,
      "LongDesc": "sample string 10",
      "TechDesc": "sample string 11",
      "EstimatedCharges": 12.0,
      "EstimatedParts": 1.0,
      "EstimatedLabor": 1.0,
      "EstimatedLaborHours": 1.0,
      "EstimatedFreight": 1.0,
      "EstimatedEquipment": 1.0,
      "EstimatedSublet": 1.0,
      "EstimatedMileage": 1.0,
      "EstimatedMiscSupply": 1.0,
      "EstimatedBillCodes": 1.0,
      "IsOpcodeApproved": true,
      "FlatRateAmount": 1.0,
      "FlatRatePerFootRate": 1.0,
      "FlatRatePerFootMethod": "sample string 14",
      "ForecastedPartsCharges": 1.0,
      "ForecastedLaborCharges": 1.0,
      "ForecastedLaborHours": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<WorkOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <BoatId>sample string 10</BoatId>
  <BoatLength>sample string 18</BoatLength>
  <BoatMake>sample string 13</BoatMake>
  <BoatModel>sample string 14</BoatModel>
  <BoatName>sample string 11</BoatName>
  <BoatRegistration>sample string 16</BoatRegistration>
  <BoatSerialNumber>sample string 15</BoatSerialNumber>
  <BoatWarrantyDate>sample string 17</BoatWarrantyDate>
  <BoatYear>sample string 12</BoatYear>
  <Category>sample string 21</Category>
  <ClerkId>sample string 5</ClerkId>
  <Comments>sample string 27</Comments>
  <CompleteDate>sample string 20</CompleteDate>
  <CreationDate>sample string 4</CreationDate>
  <CustomerID>sample string 2</CustomerID>
  <CustomerName>sample string 3</CustomerName>
  <EstCompDate>sample string 19</EstCompDate>
  <EstStartDate>sample string 23</EstStartDate>
  <Id>sample string 1</Id>
  <IsEstimate>true</IsEstimate>
  <LastModDate>sample string 25</LastModDate>
  <LastModTime>sample string 26</LastModTime>
  <LocationCode>sample string 22</LocationCode>
  <Operations>
    <WorkOrderOperation>
      <Category>sample string 6</Category>
      <EstCompleteDate>sample string 8</EstCompleteDate>
      <EstStartDate>sample string 7</EstStartDate>
      <EstimatedBillCodes>1</EstimatedBillCodes>
      <EstimatedCharges>12</EstimatedCharges>
      <EstimatedEquipment>1</EstimatedEquipment>
      <EstimatedFreight>1</EstimatedFreight>
      <EstimatedLabor>1</EstimatedLabor>
      <EstimatedLaborHours>1</EstimatedLaborHours>
      <EstimatedMileage>1</EstimatedMileage>
      <EstimatedMiscSupply>1</EstimatedMiscSupply>
      <EstimatedParts>1</EstimatedParts>
      <EstimatedSublet>1</EstimatedSublet>
      <FlatRateAmount>1</FlatRateAmount>
      <FlatRatePerFootMethod>sample string 14</FlatRatePerFootMethod>
      <FlatRatePerFootRate>1</FlatRatePerFootRate>
      <ForecastedLaborCharges>1</ForecastedLaborCharges>
      <ForecastedLaborHours>1</ForecastedLaborHours>
      <ForecastedPartsCharges>1</ForecastedPartsCharges>
      <Id>sample string 1</Id>
      <IsOpcodeApproved>true</IsOpcodeApproved>
      <LaborBilled>1</LaborBilled>
      <LongDesc>sample string 10</LongDesc>
      <Opcode>sample string 2</Opcode>
      <OpcodeDesc>sample string 3</OpcodeDesc>
      <ReqCompDate>sample string 9</ReqCompDate>
      <StandardHours>1</StandardHours>
      <Status>sample string 4</Status>
      <TechDesc>sample string 11</TechDesc>
      <TotalBillCodes>1</TotalBillCodes>
      <TotalCharges>1</TotalCharges>
      <TotalEquipment>1</TotalEquipment>
      <TotalFreight>1</TotalFreight>
      <TotalLabor>1</TotalLabor>
      <TotalLaborHours>1</TotalLaborHours>
      <TotalMileage>1</TotalMileage>
      <TotalMiscSupply>1</TotalMiscSupply>
      <TotalParts>1</TotalParts>
      <TotalSublet>1</TotalSublet>
      <TotalToComplete>1</TotalToComplete>
      <Type>sample string 5</Type>
    </WorkOrderOperation>
    <WorkOrderOperation>
      <Category>sample string 6</Category>
      <EstCompleteDate>sample string 8</EstCompleteDate>
      <EstStartDate>sample string 7</EstStartDate>
      <EstimatedBillCodes>1</EstimatedBillCodes>
      <EstimatedCharges>12</EstimatedCharges>
      <EstimatedEquipment>1</EstimatedEquipment>
      <EstimatedFreight>1</EstimatedFreight>
      <EstimatedLabor>1</EstimatedLabor>
      <EstimatedLaborHours>1</EstimatedLaborHours>
      <EstimatedMileage>1</EstimatedMileage>
      <EstimatedMiscSupply>1</EstimatedMiscSupply>
      <EstimatedParts>1</EstimatedParts>
      <EstimatedSublet>1</EstimatedSublet>
      <FlatRateAmount>1</FlatRateAmount>
      <FlatRatePerFootMethod>sample string 14</FlatRatePerFootMethod>
      <FlatRatePerFootRate>1</FlatRatePerFootRate>
      <ForecastedLaborCharges>1</ForecastedLaborCharges>
      <ForecastedLaborHours>1</ForecastedLaborHours>
      <ForecastedPartsCharges>1</ForecastedPartsCharges>
      <Id>sample string 1</Id>
      <IsOpcodeApproved>true</IsOpcodeApproved>
      <LaborBilled>1</LaborBilled>
      <LongDesc>sample string 10</LongDesc>
      <Opcode>sample string 2</Opcode>
      <OpcodeDesc>sample string 3</OpcodeDesc>
      <ReqCompDate>sample string 9</ReqCompDate>
      <StandardHours>1</StandardHours>
      <Status>sample string 4</Status>
      <TechDesc>sample string 11</TechDesc>
      <TotalBillCodes>1</TotalBillCodes>
      <TotalCharges>1</TotalCharges>
      <TotalEquipment>1</TotalEquipment>
      <TotalFreight>1</TotalFreight>
      <TotalLabor>1</TotalLabor>
      <TotalLaborHours>1</TotalLaborHours>
      <TotalMileage>1</TotalMileage>
      <TotalMiscSupply>1</TotalMiscSupply>
      <TotalParts>1</TotalParts>
      <TotalSublet>1</TotalSublet>
      <TotalToComplete>1</TotalToComplete>
      <Type>sample string 5</Type>
    </WorkOrderOperation>
  </Operations>
  <PromisedDate>sample string 24</PromisedDate>
  <RiggingId>sample string 29</RiggingId>
  <RiggingType>sample string 30</RiggingType>
  <StartDate>sample string 7</StartDate>
  <Status>sample string 8</Status>
  <TaxSchema>sample string 9</TaxSchema>
  <Title>sample string 31</Title>
  <TotalBillCodes>1</TotalBillCodes>
  <TotalEquipment>1</TotalEquipment>
  <TotalForecastedHours>1</TotalForecastedHours>
  <TotalForecastedLabor>1</TotalForecastedLabor>
  <TotalForecastedParts>1</TotalForecastedParts>
  <TotalFreight>1</TotalFreight>
  <TotalFreightCost>1</TotalFreightCost>
  <TotalLabor>1</TotalLabor>
  <TotalLaborCost>1</TotalLaborCost>
  <TotalLaborHours>1</TotalLaborHours>
  <TotalMileage>1</TotalMileage>
  <TotalMiscSupply>1</TotalMiscSupply>
  <TotalParts>1</TotalParts>
  <TotalPartsCost>1</TotalPartsCost>
  <TotalSublet>1</TotalSublet>
  <TotalSubletCost>1</TotalSubletCost>
  <TotalWOCharges>1</TotalWOCharges>
  <Type>sample string 6</Type>
</WorkOrder>