Service Provider API-Guide

Download As PDF

API Details for POST WorkOrder by workOrderId

This endpoint retrieves the WorkOrder information of given workorderid, This will tell about the WorkOrder attributes like WorkOrderNumber,Type of WorkOrder, status of work, Status code,WorkOrder description, priority et. This API giving the response in Json/Xml.

POST api/WorkOrders/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

WorkOrderUpdateDTO
NameDescriptionTypeAdditional information
Id

integer None.
StatusCode

string None.
CreateUser

string None.
UserID

integer None.
DNE

decimal number None.
UpdateScheduledStartDateTime

boolean None.
UpdateScheduledCompleteDateTime

boolean None.
ZeroInvoice

boolean None.
QuoteApprovedContactID

integer None.
QuoteApprovedDateTime

date None.
QuoteCreateUser

string None.
ScheduledStartDateTime

date None.
ScheduledCompleteDateTime

date None.
ActualStartDateTime

date None.
ActualCompleteDateTime

date None.
CauseID

integer None.
RemedyID

integer None.
UpdateRemedyToNull

boolean None.
EquipmentID

integer None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "StatusCode": "sample string 2",
  "CreateUser": "sample string 3",
  "UserID": 1,
  "DNE": 1.0,
  "UpdateScheduledStartDateTime": true,
  "UpdateScheduledCompleteDateTime": true,
  "ZeroInvoice": true,
  "QuoteApprovedContactID": 1,
  "QuoteApprovedDateTime": "2025-04-30T02:20:01.4444526Z",
  "QuoteCreateUser": "sample string 4",
  "ScheduledStartDateTime": "2025-04-30T02:20:01.4444526Z",
  "ScheduledCompleteDateTime": "2025-04-30T02:20:01.4444526Z",
  "ActualStartDateTime": "2025-04-30T02:20:01.4444526Z",
  "ActualCompleteDateTime": "2025-04-30T02:20:01.4444526Z",
  "CauseID": 1,
  "RemedyID": 1,
  "UpdateRemedyToNull": true,
  "EquipmentID": 1
}

application/xml, text/xml

Sample: 
<WorkOrderUpdateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.BE.Entities.WorkOrder">
  <ActualCompleteDateTime>2025-04-30T02:20:01.4444526+00:00</ActualCompleteDateTime>
  <ActualStartDateTime>2025-04-30T02:20:01.4444526+00:00</ActualStartDateTime>
  <CauseID>1</CauseID>
  <CreateUser>sample string 3</CreateUser>
  <DNE>1</DNE>
  <EquipmentID>1</EquipmentID>
  <Id>1</Id>
  <NextFollowUpDateTime>2025-04-30T02:20:01.4444526+00:00</NextFollowUpDateTime>
  <QuoteApprovedContactID>1</QuoteApprovedContactID>
  <QuoteApprovedDateTime>2025-04-30T02:20:01.4444526+00:00</QuoteApprovedDateTime>
  <QuoteCreateUser>sample string 4</QuoteCreateUser>
  <RemedyID>1</RemedyID>
  <ScheduledCompleteDateTime>2025-04-30T02:20:01.4444526+00:00</ScheduledCompleteDateTime>
  <ScheduledStartDateTime>2025-04-30T02:20:01.4444526+00:00</ScheduledStartDateTime>
  <StatusCode>sample string 2</StatusCode>
  <TargetCompleteDateTime>2025-04-30T02:20:01.4444526+00:00</TargetCompleteDateTime>
  <TargetStartDateTime>2025-04-30T02:20:01.4444526+00:00</TargetStartDateTime>
  <UpdateRemedyToNull>true</UpdateRemedyToNull>
  <UpdateScheduledCompleteDateTime>true</UpdateScheduledCompleteDateTime>
  <UpdateScheduledStartDateTime>true</UpdateScheduledStartDateTime>
  <UserID>1</UserID>
  <ZeroInvoice>true</ZeroInvoice>
</WorkOrderUpdateDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IExternalWorkOrder
NameDescriptionTypeAdditional information
WorkOrderNumber

string None.
Type

string None.
WorkType

string None.
WorkTypeId

integer None.
Status

string None.
Description

string None.
Priority

string None.
DateReported

date None.
DateModified

date None.
TargetCompleteDate

date None.
TargetDate

date None.
ScheduledCompleteDateTime

date None.
ActualStartDateTime

date None.
ActualCompleteDateTime

date None.
NextFollowUpDateTime

date None.
LatestInteractiveVoiceResponseIn

date None.
LatestInteractiveVoiceResponseOut

date None.
GLCode

string None.
HasGroups

boolean None.
Location

IExternalLocation None.
RequestingContact

string None.
AlternateContact

string None.
DepartmentId

integer None.
Department

string None.
RequestTypeId

integer None.
RequestType

string None.
TradeId

integer None.
RequestCodeId

integer None.
RequestCode

string None.
ServiceLocationName

string None.
DNE

decimal number None.
Provider

IExternalVendor None.
Client

IExternalClient None.
WorkTypeGLCode

string None.
RequestGLCode

string None.
DispatchMatrixGLCode

string None.
Cause

ICause None.
Remedy

IRemedy None.
Equipment

IEquipmentStub None.
AvailableVendorAction

VendorAction None.
AlternateWorkOrderNumber

string None.
IsETAMissed

boolean None.
IsVendorOnSite

boolean None.
IsSnow

boolean None.
HasAttachments

boolean None.
MissedETAMessage

string None.
ProjectNumber

string None.
ProjectOther

string None.
CurrencyCode

string None.
IsComplianceAvailable

boolean None.
ComplianceStatus

string None.
HasNotAnsweredAutomatedSurveys

boolean None.
HasAnsweredAutomatedSurveys

boolean None.
IsDneVisible

boolean None.
CompletionDateTime

date None.
WorkDoneDescription

string None.
LinkedClientId

integer None.
IFMServiceProviderName

string None.
LinkedWorkOrderId

integer None.
ShowOnMyWay

boolean None.
CreateUser

string None.
ParentWorkOrderNumber

string None.
GroupName

string None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.