Service Provider API-Guide

Download As PDF

POST api/WorkOrders/{id}/CheckOut

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

CheckoutViewModel
NameDescriptionTypeAdditional information
StatusId

integer None.
UpdatedETA

date None.

Request Formats

application/json, text/json

Sample: 
{
  "StatusId": 1,
  "UpdatedETA": "2025-11-02T01:51:25.9791098Z"
}

application/xml, text/xml

Sample: 
<CheckoutViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Vendor.Models">
  <StatusId>1</StatusId>
  <UpdatedETA>2025-11-02T01:51:25.9791098+00:00</UpdatedETA>
</CheckoutViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExternalWorkOrder
NameDescriptionTypeAdditional information
Id

integer None.
WorkOrderNumber

string None.
Type

string None.
WorkType

string None.
WorkTypeId

integer None.
Status

string None.
StatusCode

string None.
Description

string None.
Priority

string None.
DateReported

date None.
DateModified

date None.
TargetDate

date None.
ScheduledStartDateTime

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.
RequestTypeId

integer None.
RequestType

string None.
DepartmentId

integer None.
Department

string None.
TradeId

integer None.
RequestCodeId

integer None.
RequestCode

string None.
ServiceLocationName

string None.
DNE

decimal number None.
Provider

IExternalVendor None.
Client

IExternalClient None.
Cause

ICause None.
Remedy

IRemedy None.
Equipment

IEquipmentStub None.
WorkTypeGLCode

string None.
RequestGLCode

string None.
DispatchMatrixGLCode

string None.
AvailableVendorAction

VendorAction None.
AlternateWorkOrderNumber

string None.
IsETAMissed

boolean None.
MissedETAMessage

string None.
IsEmergency

boolean None.
IsVendorOnSite

boolean None.
HasAttachments

boolean None.
TargetCompleteDate

date None.
IsSnow

boolean 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.
IFMServiceProviderName

string None.
ShowOnMyWay

boolean None.
CreateUser

string None.
ParentWorkOrderNumber

string None.
GroupName

string None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "WorkOrderNumber": "sample string 2",
  "Type": "sample string 3",
  "WorkType": "sample string 4",
  "WorkTypeId": 5,
  "Status": "sample string 6",
  "StatusCode": "sample string 7",
  "Description": "sample string 8",
  "Priority": "sample string 9",
  "DateReported": "2025-11-02T01:51:25.9947454Z",
  "DateModified": "2025-11-02T01:51:25.9947454Z",
  "TargetDate": "2025-11-02T01:51:25.9947454Z",
  "ScheduledStartDateTime": "2025-11-02T01:51:25.9947454Z",
  "ScheduledCompleteDateTime": "2025-11-02T01:51:25.9947454Z",
  "ActualStartDateTime": "2025-11-02T01:51:25.9947454Z",
  "ActualCompleteDateTime": "2025-11-02T01:51:25.9947454Z",
  "NextFollowUpDateTime": "2025-11-02T01:51:25.9947454Z",
  "LatestInteractiveVoiceResponseIn": "2025-11-02T01:51:25.9947454Z",
  "LatestInteractiveVoiceResponseOut": "2025-11-02T01:51:25.9947454Z",
  "GLCode": "sample string 10",
  "HasGroups": true,
  "Location": null,
  "RequestingContact": "sample string 11",
  "AlternateContact": "sample string 12",
  "RequestTypeId": 1,
  "RequestType": "sample string 13",
  "DepartmentId": 1,
  "Department": "sample string 14",
  "TradeId": 15,
  "RequestCodeId": 1,
  "RequestCode": "sample string 16",
  "ServiceLocationName": "sample string 17",
  "DNE": 18.0,
  "Provider": null,
  "Client": null,
  "Cause": null,
  "Remedy": null,
  "Equipment": null,
  "WorkTypeGLCode": "sample string 19",
  "RequestGLCode": "sample string 20",
  "DispatchMatrixGLCode": "sample string 21",
  "AvailableVendorAction": 0,
  "AlternateWorkOrderNumber": "sample string 22",
  "IsETAMissed": true,
  "MissedETAMessage": "sample string 24",
  "IsEmergency": true,
  "IsVendorOnSite": true,
  "HasAttachments": true,
  "TargetCompleteDate": "2025-11-02T01:51:25.9947454Z",
  "IsSnow": true,
  "ProjectNumber": "sample string 29",
  "ProjectOther": "sample string 30",
  "CurrencyCode": "sample string 31",
  "IsComplianceAvailable": true,
  "ComplianceStatus": "sample string 33",
  "HasNotAnsweredAutomatedSurveys": true,
  "HasAnsweredAutomatedSurveys": true,
  "IsDneVisible": true,
  "CompletionDateTime": "2025-11-02T01:51:25.9947454Z",
  "WorkDoneDescription": "sample string 37",
  "IFMServiceProviderName": "sample string 38",
  "ShowOnMyWay": true,
  "CreateUser": "sample string 40",
  "ParentWorkOrderNumber": "sample string 41",
  "GroupName": "sample string 42"
}

application/xml, text/xml

Sample: 
<ExternalWorkOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.BE.Entities.WorkOrder">
  <ActualCompleteDateTime>2025-11-02T01:51:25.9947454+00:00</ActualCompleteDateTime>
  <ActualStartDateTime>2025-11-02T01:51:25.9947454+00:00</ActualStartDateTime>
  <AlternateContact>sample string 12</AlternateContact>
  <AlternateWorkOrderNumber>sample string 22</AlternateWorkOrderNumber>
  <AvailableVendorAction>None</AvailableVendorAction>
  <Cause i:nil="true" />
  <Client i:nil="true" />
  <CompletionDateTime>2025-11-02T01:51:25.9947454+00:00</CompletionDateTime>
  <ComplianceStatus>sample string 33</ComplianceStatus>
  <CreateUser>sample string 40</CreateUser>
  <CurrencyCode>sample string 31</CurrencyCode>
  <DNE>18</DNE>
  <DateModified>2025-11-02T01:51:25.9947454+00:00</DateModified>
  <DateReported>2025-11-02T01:51:25.9947454+00:00</DateReported>
  <Department>sample string 14</Department>
  <DepartmentId>1</DepartmentId>
  <Description>sample string 8</Description>
  <DispatchMatrixGLCode>sample string 21</DispatchMatrixGLCode>
  <Equipment i:nil="true" />
  <GLCode>sample string 10</GLCode>
  <GroupName>sample string 42</GroupName>
  <HasAnsweredAutomatedSurveys>true</HasAnsweredAutomatedSurveys>
  <HasAttachments>true</HasAttachments>
  <HasGroups>true</HasGroups>
  <HasNotAnsweredAutomatedSurveys>true</HasNotAnsweredAutomatedSurveys>
  <IFMServiceProviderName>sample string 38</IFMServiceProviderName>
  <Id>1</Id>
  <IsComplianceAvailable>true</IsComplianceAvailable>
  <IsDneVisible>true</IsDneVisible>
  <IsETAMissed>true</IsETAMissed>
  <IsEmergency>true</IsEmergency>
  <IsSnow>true</IsSnow>
  <IsVendorOnSite>true</IsVendorOnSite>
  <LatestInteractiveVoiceResponseIn>2025-11-02T01:51:25.9947454+00:00</LatestInteractiveVoiceResponseIn>
  <LatestInteractiveVoiceResponseOut>2025-11-02T01:51:25.9947454+00:00</LatestInteractiveVoiceResponseOut>
  <Location i:nil="true" />
  <MissedETAMessage>sample string 24</MissedETAMessage>
  <NextFollowUpDateTime>2025-11-02T01:51:25.9947454+00:00</NextFollowUpDateTime>
  <ParentWorkOrderNumber>sample string 41</ParentWorkOrderNumber>
  <Priority>sample string 9</Priority>
  <ProjectNumber>sample string 29</ProjectNumber>
  <ProjectOther>sample string 30</ProjectOther>
  <Provider i:nil="true" />
  <Remedy i:nil="true" />
  <RequestCode>sample string 16</RequestCode>
  <RequestCodeId>1</RequestCodeId>
  <RequestGLCode>sample string 20</RequestGLCode>
  <RequestType>sample string 13</RequestType>
  <RequestTypeId>1</RequestTypeId>
  <RequestingContact>sample string 11</RequestingContact>
  <ScheduledCompleteDateTime>2025-11-02T01:51:25.9947454+00:00</ScheduledCompleteDateTime>
  <ScheduledStartDateTime>2025-11-02T01:51:25.9947454+00:00</ScheduledStartDateTime>
  <ServiceLocationName>sample string 17</ServiceLocationName>
  <ShowOnMyWay>true</ShowOnMyWay>
  <Status>sample string 6</Status>
  <StatusCode>sample string 7</StatusCode>
  <TargetCompleteDate>2025-11-02T01:51:25.9947454+00:00</TargetCompleteDate>
  <TargetDate>2025-11-02T01:51:25.9947454+00:00</TargetDate>
  <TradeId>15</TradeId>
  <Type>sample string 3</Type>
  <WorkDoneDescription>sample string 37</WorkDoneDescription>
  <WorkOrderNumber>sample string 2</WorkOrderNumber>
  <WorkType>sample string 4</WorkType>
  <WorkTypeGLCode>sample string 19</WorkTypeGLCode>
  <WorkTypeId>5</WorkTypeId>
</ExternalWorkOrder>