POST api/CreateWorkOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
workOrderDetail		Collection of DSMWorkOrderDetail	None.
orgId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "workOrderDetail": [
    {
      "SQLRefId": "sample string 1",
      "territoryId": "sample string 2",
      "workOrderId": "sample string 3",
      "latitude": 4.1,
      "longitude": 5.1,
      "serviceTimeSlot": "sample string 6",
      "serviceDate": "2025-10-29T17:18:30.4634905+00:00",
      "serviceDuration": 8,
      "serviceAddress": "sample string 9",
      "city": "sample string 10",
      "state": "sample string 11",
      "country": "sample string 12",
      "postalCode": "sample string 13",
      "planDate": [
        "2025-10-29T17:18:30.4634905+00:00",
        "2025-10-29T17:18:30.4634905+00:00"
      ],
      "planTimeSlots": [
        "sample string 1",
        "sample string 2"
      ],
      "workTeamId": [
        "sample string 1",
        "sample string 2"
      ],
      "employeeId": [
        "sample string 1",
        "sample string 2"
      ],
      "sessionID": "sample string 14",
      "serviceWorkTeamId": "sample string 15",
      "ManualWorkOrder": true,
      "IsFixedResource": true,
      "isFixedTime": true,
      "workOrderStatus": "sample string 19",
      "timeOfDay": "sample string 20",
      "dayNames": "sample string 21",
      "VisitTimeSlot": "sample string 22",
      "serviceFinishTime": "sample string 23",
      "arrivalTime": "sample string 24",
      "earlyArrivalTime": "sample string 25",
      "lateArrivalTime": "sample string 26",
      "nextAvailableTime": "sample string 27",
      "employeeSkillWeight": [
        1,
        2
      ],
      "orgId": "sample string 28",
      "timeDiff": 29,
      "inspectorId": [
        "sample string 1",
        "sample string 2"
      ],
      "serviceInspectorId": "sample string 30",
      "isSelfScheduling": true,
      "isSkipDriveTime": true,
      "OverrideConfig": true,
      "MaxAppointmentPerDay": 34,
      "IsVirtual": true
    },
    {
      "SQLRefId": "sample string 1",
      "territoryId": "sample string 2",
      "workOrderId": "sample string 3",
      "latitude": 4.1,
      "longitude": 5.1,
      "serviceTimeSlot": "sample string 6",
      "serviceDate": "2025-10-29T17:18:30.4634905+00:00",
      "serviceDuration": 8,
      "serviceAddress": "sample string 9",
      "city": "sample string 10",
      "state": "sample string 11",
      "country": "sample string 12",
      "postalCode": "sample string 13",
      "planDate": [
        "2025-10-29T17:18:30.4634905+00:00",
        "2025-10-29T17:18:30.4634905+00:00"
      ],
      "planTimeSlots": [
        "sample string 1",
        "sample string 2"
      ],
      "workTeamId": [
        "sample string 1",
        "sample string 2"
      ],
      "employeeId": [
        "sample string 1",
        "sample string 2"
      ],
      "sessionID": "sample string 14",
      "serviceWorkTeamId": "sample string 15",
      "ManualWorkOrder": true,
      "IsFixedResource": true,
      "isFixedTime": true,
      "workOrderStatus": "sample string 19",
      "timeOfDay": "sample string 20",
      "dayNames": "sample string 21",
      "VisitTimeSlot": "sample string 22",
      "serviceFinishTime": "sample string 23",
      "arrivalTime": "sample string 24",
      "earlyArrivalTime": "sample string 25",
      "lateArrivalTime": "sample string 26",
      "nextAvailableTime": "sample string 27",
      "employeeSkillWeight": [
        1,
        2
      ],
      "orgId": "sample string 28",
      "timeDiff": 29,
      "inspectorId": [
        "sample string 1",
        "sample string 2"
      ],
      "serviceInspectorId": "sample string 30",
      "isSelfScheduling": true,
      "isSkipDriveTime": true,
      "OverrideConfig": true,
      "MaxAppointmentPerDay": 34,
      "IsVirtual": true
    }
  ],
  "orgId": "sample string 1"
}

application/xml, text/xml

Sample:

<WorkOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <orgId>sample string 1</orgId>
  <workOrderDetail>
    <DSMWorkOrderDetail>
      <IsFixedResource>true</IsFixedResource>
      <IsVirtual>true</IsVirtual>
      <ManualWorkOrder>true</ManualWorkOrder>
      <MaxAppointmentPerDay>34</MaxAppointmentPerDay>
      <OverrideConfig>true</OverrideConfig>
      <SQLRefId>sample string 1</SQLRefId>
      <VisitTimeSlot>sample string 22</VisitTimeSlot>
      <arrivalTime>sample string 24</arrivalTime>
      <city>sample string 10</city>
      <country>sample string 12</country>
      <dayNames>sample string 21</dayNames>
      <earlyArrivalTime>sample string 25</earlyArrivalTime>
      <employeeId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </employeeId>
      <employeeSkillWeight xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </employeeSkillWeight>
      <inspectorId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </inspectorId>
      <isFixedTime>true</isFixedTime>
      <isSelfScheduling>true</isSelfScheduling>
      <isSkipDriveTime>true</isSkipDriveTime>
      <lateArrivalTime>sample string 26</lateArrivalTime>
      <latitude>4.1</latitude>
      <longitude>5.1</longitude>
      <nextAvailableTime>sample string 27</nextAvailableTime>
      <orgId>sample string 28</orgId>
      <planDate xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:dateTime>2025-10-29T17:18:30.4634905+00:00</d4p1:dateTime>
        <d4p1:dateTime>2025-10-29T17:18:30.4634905+00:00</d4p1:dateTime>
      </planDate>
      <planTimeSlots xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </planTimeSlots>
      <postalCode>sample string 13</postalCode>
      <serviceAddress>sample string 9</serviceAddress>
      <serviceDate>2025-10-29T17:18:30.4634905+00:00</serviceDate>
      <serviceDuration>8</serviceDuration>
      <serviceFinishTime>sample string 23</serviceFinishTime>
      <serviceInspectorId>sample string 30</serviceInspectorId>
      <serviceTimeSlot>sample string 6</serviceTimeSlot>
      <serviceWorkTeamId>sample string 15</serviceWorkTeamId>
      <sessionID>sample string 14</sessionID>
      <state>sample string 11</state>
      <territoryId>sample string 2</territoryId>
      <timeDiff>29</timeDiff>
      <timeOfDay>sample string 20</timeOfDay>
      <workOrderId>sample string 3</workOrderId>
      <workOrderStatus>sample string 19</workOrderStatus>
      <workTeamId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </workTeamId>
    </DSMWorkOrderDetail>
    <DSMWorkOrderDetail>
      <IsFixedResource>true</IsFixedResource>
      <IsVirtual>true</IsVirtual>
      <ManualWorkOrder>true</ManualWorkOrder>
      <MaxAppointmentPerDay>34</MaxAppointmentPerDay>
      <OverrideConfig>true</OverrideConfig>
      <SQLRefId>sample string 1</SQLRefId>
      <VisitTimeSlot>sample string 22</VisitTimeSlot>
      <arrivalTime>sample string 24</arrivalTime>
      <city>sample string 10</city>
      <country>sample string 12</country>
      <dayNames>sample string 21</dayNames>
      <earlyArrivalTime>sample string 25</earlyArrivalTime>
      <employeeId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </employeeId>
      <employeeSkillWeight xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </employeeSkillWeight>
      <inspectorId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </inspectorId>
      <isFixedTime>true</isFixedTime>
      <isSelfScheduling>true</isSelfScheduling>
      <isSkipDriveTime>true</isSkipDriveTime>
      <lateArrivalTime>sample string 26</lateArrivalTime>
      <latitude>4.1</latitude>
      <longitude>5.1</longitude>
      <nextAvailableTime>sample string 27</nextAvailableTime>
      <orgId>sample string 28</orgId>
      <planDate xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:dateTime>2025-10-29T17:18:30.4634905+00:00</d4p1:dateTime>
        <d4p1:dateTime>2025-10-29T17:18:30.4634905+00:00</d4p1:dateTime>
      </planDate>
      <planTimeSlots xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </planTimeSlots>
      <postalCode>sample string 13</postalCode>
      <serviceAddress>sample string 9</serviceAddress>
      <serviceDate>2025-10-29T17:18:30.4634905+00:00</serviceDate>
      <serviceDuration>8</serviceDuration>
      <serviceFinishTime>sample string 23</serviceFinishTime>
      <serviceInspectorId>sample string 30</serviceInspectorId>
      <serviceTimeSlot>sample string 6</serviceTimeSlot>
      <serviceWorkTeamId>sample string 15</serviceWorkTeamId>
      <sessionID>sample string 14</sessionID>
      <state>sample string 11</state>
      <territoryId>sample string 2</territoryId>
      <timeDiff>29</timeDiff>
      <timeOfDay>sample string 20</timeOfDay>
      <workOrderId>sample string 3</workOrderId>
      <workOrderStatus>sample string 19</workOrderStatus>
      <workTeamId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </workTeamId>
    </DSMWorkOrderDetail>
  </workOrderDetail>
</WorkOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WorkOrderResult

Name	Type	Additional information
workOrderMsg	Collection of string	None.
error	string	None.
success	boolean	None.
workOrderRefId	string	None.
refIdResult	Collection of workOrderRefIdResult	None.

Response Formats

application/json, text/json

Sample:

{
  "workOrderMsg": [
    "sample string 1",
    "sample string 2"
  ],
  "error": "sample string 1",
  "success": true,
  "workOrderRefId": "sample string 3",
  "refIdResult": [
    {
      "workOrderId": "sample string 1",
      "workOrderRefId": "sample string 2",
      "success": true,
      "error": "sample string 4"
    },
    {
      "workOrderId": "sample string 1",
      "workOrderRefId": "sample string 2",
      "success": true,
      "error": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<WorkOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <error>sample string 1</error>
  <refIdResult>
    <workOrderRefIdResult>
      <error>sample string 4</error>
      <success>true</success>
      <workOrderId>sample string 1</workOrderId>
      <workOrderRefId>sample string 2</workOrderRefId>
    </workOrderRefIdResult>
    <workOrderRefIdResult>
      <error>sample string 4</error>
      <success>true</success>
      <workOrderId>sample string 1</workOrderId>
      <workOrderRefId>sample string 2</workOrderRefId>
    </workOrderRefIdResult>
  </refIdResult>
  <success>true</success>
  <workOrderMsg xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </workOrderMsg>
  <workOrderRefId>sample string 3</workOrderRefId>
</WorkOrderResult>