GET api/v2/Service/WorkOrders/OperationDesc?Opcode={Opcode}
Retrieve the Operation Long Description from the Opcode Template
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Opcode |
Opcode Id to retrieve |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
OperationCode| Name | Description | Type | Additional information |
|---|---|---|---|
| Opcode |
The Operation Code Id. |
string |
None. |
| Desc |
Operation short description. |
string |
None. |
| LongDesc |
Operation long description. |
string |
None. |
| TechDesc |
Operation Technician description |
string |
None. |
| CategoryCode |
Operation Category Code. |
string |
None. |
| EstimatedParts |
For Estimates Operations only. The estimated total Parts Charges. |
decimal number |
None. |
| EstimatedLabor |
For Estimates Operations only. The estimated total Labor Charges. |
decimal number |
None. |
| EstimatedLaborHours |
For Estimates Operations only. The estimated total number of Labor Hours. |
decimal number |
None. |
| EstimatedFreight |
For Estimates Operations only. The estimated total Freight Charges. |
decimal number |
None. |
| EstimatedEquipment |
For Estimates Operations only. The estimated total Equipment Charges. |
decimal number |
None. |
| EstimatedSublet |
For Estimates Operations only. The estimated total Sublet Charges. |
decimal number |
None. |
| EstimatedMileage |
For Estimates Operations only. The estimated total Mileage Charges. |
decimal number |
None. |
| EstimatedMiscSupply |
For Estimates Operations only. The estimated total Miscellaneous Charges. |
decimal number |
None. |
| EstimatedBillCodes |
For Estimates Operations only. The estimated total BillCode Charges. |
decimal number |
None. |
| Approved |
Customer has approved/not approved this operation. |
boolean |
None. |
| FlatRateAmount |
Flat Rate Amount if Operation is flat rated. |
decimal number |
None. |
| FlatRatePerFootRate |
Per Foot Rate if Operation is flat rated per foot. |
decimal number |
None. |
| FlatRatePerFootMethod |
Per Foot Method if Operation is flat rated per foot. LOA (Length Overall), LWL (Length at Water Line), FOS (Feet of Spar), Area (LOA x Beam) |
string |
None. |
| LaborFinished |
Flag as all labor has been completed. |
boolean |
None. |
| StandardHours |
Standard length of time (hours) to complete this Operation. |
decimal number |
None. |
| EstCompDate |
Optional: Estimated date work will be complete. |
string |
None. |
| EstStartDate |
Optional: Estimated date work will start. |
string |
None. |
| CustPromiseDate |
Optional: Date opcode work has been promised to be complete. |
string |
None. |
| ForecastedPartsCharges |
Optional: Total forecasted parts charges. |
decimal number |
None. |
| ForecastedLaborCharges |
Optional: Total forecasted labor charges. |
decimal number |
None. |
| ForecastedLaborHours |
Optional: Total forecasted labor hours. |
decimal number |
None. |
Response Formats
application/json, text/json
{
"Opcode": "sample string 1",
"Desc": "sample string 2",
"LongDesc": "sample string 3",
"TechDesc": "sample string 4",
"CategoryCode": "sample string 5",
"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,
"Approved": true,
"FlatRateAmount": 1.0,
"FlatRatePerFootRate": 1.0,
"FlatRatePerFootMethod": "sample string 6",
"LaborFinished": true,
"StandardHours": 1.0,
"EstCompDate": "sample string 8",
"EstStartDate": "sample string 9",
"CustPromiseDate": "sample string 10",
"ForecastedPartsCharges": 1.0,
"ForecastedLaborCharges": 1.0,
"ForecastedLaborHours": 1.0
}
application/xml, text/xml
<OperationCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models"> <Approved>true</Approved> <CategoryCode>sample string 5</CategoryCode> <CustPromiseDate>sample string 10</CustPromiseDate> <Desc>sample string 2</Desc> <EstCompDate>sample string 8</EstCompDate> <EstStartDate>sample string 9</EstStartDate> <EstimatedBillCodes>1</EstimatedBillCodes> <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 6</FlatRatePerFootMethod> <FlatRatePerFootRate>1</FlatRatePerFootRate> <ForecastedLaborCharges>1</ForecastedLaborCharges> <ForecastedLaborHours>1</ForecastedLaborHours> <ForecastedPartsCharges>1</ForecastedPartsCharges> <LaborFinished>true</LaborFinished> <LongDesc>sample string 3</LongDesc> <Opcode>sample string 1</Opcode> <StandardHours>1</StandardHours> <TechDesc>sample string 4</TechDesc> </OperationCode>