POST api/SyncWorkOrder
Request Information
URI Parameters
None.
Body Parameters
WorkOrderSyncRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| syncFromDate | date |
None. |
|
| syncToDate | date |
None. |
|
| Location | Collection of string |
None. |
|
| timeZoneName | string |
None. |
|
| loginDetail | clsLoginDetail |
None. |
|
| workOrderStatus | string |
None. |
|
| reviewItem | string |
None. |
|
| updateToSchedule | boolean |
None. |
|
| doNotIncludeReviewItem | boolean |
None. |
|
| workOrderIds | Collection of string |
None. |
|
| updateRefIdToSalesForce | boolean |
None. |
|
| updateRequireReviewItemStatus | boolean |
None. |
|
| orgId | string |
None. |
|
| isDaylightSaving | boolean |
None. |
|
| onlyManualWorkOrder | boolean |
None. |
|
| fixEarlyTimeWindow | boolean |
None. |
|
| skipAddressCheck | boolean |
None. |
|
| CustomCondition | string |
None. |
|
| FieldValueConversions | Collection of FieldValueConversion |
None. |
Request Formats
application/json, text/json
Sample:
{
"syncFromDate": "2025-10-29T15:50:00.8981719+00:00",
"syncToDate": "2025-10-29T15:50:00.8981719+00:00",
"Location": [
"sample string 1",
"sample string 2"
],
"timeZoneName": "sample string 3",
"loginDetail": {
"sessionID": "sample string 1",
"serverURL": "sample string 2",
"orgID": "sample string 3",
"userName": "sample string 4",
"password": "sample string 5",
"securityToken": "sample string 6",
"connectionString": "sample string 7",
"MetadataServerURL": "sample string 8"
},
"workOrderStatus": "sample string 4",
"reviewItem": "sample string 5",
"updateToSchedule": true,
"doNotIncludeReviewItem": true,
"workOrderIds": [
"sample string 1",
"sample string 2"
],
"updateRefIdToSalesForce": true,
"updateRequireReviewItemStatus": true,
"orgId": "sample string 10",
"isDaylightSaving": true,
"onlyManualWorkOrder": true,
"fixEarlyTimeWindow": true,
"skipAddressCheck": true,
"CustomCondition": "sample string 15",
"FieldValueConversions": [
{
"ConversionField": "sample string 1",
"FromValue": "sample string 2",
"ToValue": "sample string 3"
},
{
"ConversionField": "sample string 1",
"FromValue": "sample string 2",
"ToValue": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<WorkOrderSyncRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
<CustomCondition>sample string 15</CustomCondition>
<FieldValueConversions>
<FieldValueConversion>
<ConversionField>sample string 1</ConversionField>
<FromValue>sample string 2</FromValue>
<ToValue>sample string 3</ToValue>
</FieldValueConversion>
<FieldValueConversion>
<ConversionField>sample string 1</ConversionField>
<FromValue>sample string 2</FromValue>
<ToValue>sample string 3</ToValue>
</FieldValueConversion>
</FieldValueConversions>
<Location xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Location>
<doNotIncludeReviewItem>true</doNotIncludeReviewItem>
<fixEarlyTimeWindow>true</fixEarlyTimeWindow>
<isDaylightSaving>true</isDaylightSaving>
<loginDetail>
<MetadataServerURL>sample string 8</MetadataServerURL>
<connectionString>sample string 7</connectionString>
<orgID>sample string 3</orgID>
<password>sample string 5</password>
<securityToken>sample string 6</securityToken>
<serverURL>sample string 2</serverURL>
<sessionID>sample string 1</sessionID>
<userName>sample string 4</userName>
</loginDetail>
<onlyManualWorkOrder>true</onlyManualWorkOrder>
<orgId>sample string 10</orgId>
<reviewItem>sample string 5</reviewItem>
<skipAddressCheck>true</skipAddressCheck>
<syncFromDate>2025-10-29T15:50:00.8981719+00:00</syncFromDate>
<syncToDate>2025-10-29T15:50:00.8981719+00:00</syncToDate>
<timeZoneName>sample string 3</timeZoneName>
<updateRefIdToSalesForce>true</updateRefIdToSalesForce>
<updateRequireReviewItemStatus>true</updateRequireReviewItemStatus>
<updateToSchedule>true</updateToSchedule>
<workOrderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</workOrderIds>
<workOrderStatus>sample string 4</workOrderStatus>
</WorkOrderSyncRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
WorkOrderSyncResult| Name | Description | Type | Additional information |
|---|---|---|---|
| success | boolean |
None. |
|
| error | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"error": "sample string 2"
}
application/xml, text/xml
Sample:
<WorkOrderSyncResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models"> <error>sample string 2</error> <success>true</success> </WorkOrderSyncResult>