POST api/v2/Service/WorkOrders/Update?OverwriteComments={OverwriteComments}

Create a new or Update an existing Work Order.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OverwriteComments

If set to true, current comments are overwritten by comments on the provided ServiceRequest

 boolean

Default value is False

Body Parameters

ServiceRequest
NameDescriptionTypeAdditional information
WOId

Optional: The Work Order Id to update if updating and existing Work Order

 string

None.
ClerkId

Optional: The Clerk Id for the clerk maintaining the Work Order.

 string

None.
CustId

Required: Customer Id to create Work Order for.

 string

None.
CustIntegrationId

INTERNAL USE ONLY

 string

None.
BoatId

Optional: Boat Id to create Work Order for.

 string

None.
BoatIntegrationId

INTERNAL USE ONLY

 string

None.
BoatName

Optional: Name of the Boat this Work Order is For

 string

None.
CustomerPhone

Optional: Customers primary phone number

 string

None.
CustomerEmail

Optional: Customer primary email address

 string

None.
Comments

Optional: Any comments to add to the Work Order

 string

None.
LocationCode

Required: The Location Code for this Work Order

 string

None.
TaskGroupId

INTERNAL USE ONLY

 string

None.
EstCompDate

Optional: Estimated date work will be complete.

 string

None.
EstStartDate

Optional: Estimated date work will start.

 string

None.
CustPromiseDate

Optional: Date work has been promised to be complete.

 string

None.
CategoryCode

Optional: Work Order Category Code

 string

None.
Title

Optional: A title or description for this Work Order/Estimate

 string

None.
OperationCodes

Optional: A list of Operation to add to this Work Order

 Collection of OperationCode

None.

Request Formats

application/json, text/json

Sample: 
{
  "WOId": "sample string 1",
  "ClerkId": "sample string 2",
  "CustId": "sample string 3",
  "CustIntegrationId": "sample string 4",
  "BoatId": "sample string 5",
  "BoatIntegrationId": "sample string 6",
  "BoatName": "sample string 7",
  "CustomerPhone": "sample string 8",
  "CustomerEmail": "sample string 9",
  "Comments": "sample string 10",
  "LocationCode": "sample string 11",
  "TaskGroupId": "sample string 12",
  "EstCompDate": "sample string 13",
  "EstStartDate": "sample string 14",
  "CustPromiseDate": "sample string 15",
  "CategoryCode": "sample string 16",
  "Title": "sample string 17",
  "OperationCodes": [
    {
      "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
    },
    {
      "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

Sample: 
<ServiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <BoatId>sample string 5</BoatId>
  <BoatIntegrationId>sample string 6</BoatIntegrationId>
  <BoatName>sample string 7</BoatName>
  <CategoryCode>sample string 16</CategoryCode>
  <ClerkId>sample string 2</ClerkId>
  <Comments>sample string 10</Comments>
  <CustId>sample string 3</CustId>
  <CustIntegrationId>sample string 4</CustIntegrationId>
  <CustPromiseDate>sample string 15</CustPromiseDate>
  <CustomerEmail>sample string 9</CustomerEmail>
  <CustomerPhone>sample string 8</CustomerPhone>
  <EstCompDate>sample string 13</EstCompDate>
  <EstStartDate>sample string 14</EstStartDate>
  <LocationCode>sample string 11</LocationCode>
  <OperationCodes>
    <OperationCode>
      <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>
    <OperationCode>
      <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>
  </OperationCodes>
  <TaskGroupId>sample string 12</TaskGroupId>
  <Title>sample string 17</Title>
  <WOId>sample string 1</WOId>
</ServiceRequest>

Response Information

Resource Description

SubmitServiceRequestResult
NameDescriptionTypeAdditional information
WOId

string

None.
Operations

Collection of string

None.
Result

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "WOId": "sample string 1",
  "Operations": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": "sample string 2"
}

application/xml, text/xml

Sample: 
<SubmitServiceRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <Operations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Operations>
  <Result>sample string 2</Result>
  <WOId>sample string 1</WOId>
</SubmitServiceRequestResult>