Internal API-Guide

GET api/WorkOrderQueue/WorkOrder/{workOrderId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workOrderId

string

Required

Body Parameters

None

Response Information

Resource Description

WorkOrder
NameDescriptionTypeAdditional information
WorkOrderId

string None.
CreateDateTime

date None.
Description

string None.
RequestingContact

string None.
Company

string None.
Trade

string None.
Status

string None.
StatusOrder

integer None.
VendorId

integer None.
Vendor

string None.
VendorCode

string None.
Priority

string None.
FSPriority

integer None.
RequestType

string None.
RequestCode

string None.
ServiceLocation

string None.
WorkType

string None.
Emergency

string None.
ZoneName

string None.
ActualStart

date None.
ActualComplete

date None.
ScheduledStart

date None.
ScheduledComplete

date None.
TargetStart

date None.
TargetComplete

date None.
StatusAge

integer None.
LocationPhoneNumber

string None.
VendorPhoneNumber

string None.
LocationTimeZone

string None.
LocationTimeZoneOffset

decimal number None.
DNE

decimal number None.
LocationId

integer None.
StoreNumber

string None.
WorkOrderNumber

string None.
City

string None.
State

string None.
Address

string None.
ProjectOther

string None.
ProjectNumber

string None.
WOURL

string None.
ClientId

integer None.
ClientDomain

string None.
Isfmp1

boolean None.
StoreCompanyCode

string None.
Hierarchy

Collection of Hierarchy None.
EnteredDate

date None.
EnteredAge

integer None.
ExpirationDate

date None.
ActualStartString

string None.
ActualCompleteString

string None.
ScheduledStartString

string None.
ScheduledCompleteString

string None.
TargetStartString

string None.
TargetCompleteString

string None.
FormattedDNE

string None.
FormattedHierarhcy

string None.
WorkOrderAge

string None.
Id

integer None.
ExpirationDateString

string None.

Response Formats

application/json, text/json

Sample: 
{
  "workOrderId": "sample string 1",
  "createDateTime": "2024-05-19T22:18:58.4178536Z",
  "description": "sample string 2",
  "requestingContact": "sample string 3",
  "company": "sample string 4",
  "trade": "sample string 5",
  "status": "sample string 6",
  "statusOrder": 1,
  "vendorId": 1,
  "vendor": "sample string 7",
  "vendorCode": "sample string 8",
  "priority": "sample string 9",
  "fsPriority": 1,
  "requestType": "sample string 10",
  "requestCode": "sample string 11",
  "serviceLocation": "sample string 12",
  "workType": "sample string 13",
  "emergency": "sample string 14",
  "zoneName": "sample string 15",
  "actualStart": "2024-05-19T22:18:58.4178536Z",
  "actualComplete": "2024-05-19T22:18:58.4178536Z",
  "scheduledStart": "2024-05-19T22:18:58.4178536Z",
  "scheduledComplete": "2024-05-19T22:18:58.4178536Z",
  "targetStart": "2024-05-19T22:18:58.4178536Z",
  "targetComplete": "2024-05-19T22:18:58.4178536Z",
  "statusAge": 1,
  "locationPhoneNumber": "sample string 16",
  "vendorPhoneNumber": "sample string 17",
  "locationTimeZone": "sample string 18",
  "locationTimeZoneOffset": 1.0,
  "dne": 1.0,
  "locationId": 1,
  "storeNumber": "sample string 19",
  "workOrderNumber": "sample string 20",
  "city": "sample string 21",
  "state": "sample string 22",
  "address": "sample string 23",
  "projectOther": "sample string 24",
  "projectNumber": "sample string 25",
  "wourl": "sample string 26",
  "clientId": 27,
  "clientDomain": "sample string 28",
  "isfmp1": true,
  "storeCompanyCode": "sample string 30",
  "hierarchy": [
    {
      "clientId": 1,
      "locationId": 2,
      "name": "sample string 3",
      "hLevel": 1
    },
    {
      "clientId": 1,
      "locationId": 2,
      "name": "sample string 3",
      "hLevel": 1
    }
  ],
  "enteredDate": "2024-05-19T22:18:58.4178536Z",
  "enteredAge": 1,
  "expirationDate": "2024-05-19T22:18:58.4178536Z",
  "actualStartString": "5/19/2024 10:18:58 PM sample string 18",
  "actualCompleteString": "5/19/2024 10:18:58 PM sample string 18",
  "scheduledStartString": "5/19/2024 10:18:58 PM sample string 18",
  "scheduledCompleteString": "5/19/2024 10:18:58 PM sample string 18",
  "targetStartString": "5/19/2024 10:18:58 PM sample string 18",
  "targetCompleteString": "5/19/2024 10:18:58 PM sample string 18",
  "formattedDNE": "1",
  "formattedHierarhcy": "sample string 3>sample string 3",
  "workOrderAge": "1",
  "id": 1,
  "expirationDateString": "5/19/2024 10:18:58 PM sample string 18"
}

application/xml, text/xml

Sample: 
<WorkOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.WorkOrderQueue">
  <ActualComplete>2024-05-19T22:18:58.4178536+00:00</ActualComplete>
  <ActualStart>2024-05-19T22:18:58.4178536+00:00</ActualStart>
  <Address>sample string 23</Address>
  <City>sample string 21</City>
  <ClientDomain>sample string 28</ClientDomain>
  <ClientId>27</ClientId>
  <Company>sample string 4</Company>
  <CreateDateTime>2024-05-19T22:18:58.4178536+00:00</CreateDateTime>
  <DNE>1</DNE>
  <Description>sample string 2</Description>
  <Emergency>sample string 14</Emergency>
  <EnteredAge>1</EnteredAge>
  <EnteredDate>2024-05-19T22:18:58.4178536+00:00</EnteredDate>
  <ExpirationDate>2024-05-19T22:18:58.4178536+00:00</ExpirationDate>
  <FSPriority>1</FSPriority>
  <Hierarchy>
    <Hierarchy>
      <ClientId>1</ClientId>
      <HLevel>1</HLevel>
      <LocationId>2</LocationId>
      <Name>sample string 3</Name>
    </Hierarchy>
    <Hierarchy>
      <ClientId>1</ClientId>
      <HLevel>1</HLevel>
      <LocationId>2</LocationId>
      <Name>sample string 3</Name>
    </Hierarchy>
  </Hierarchy>
  <Isfmp1>true</Isfmp1>
  <LocationId>1</LocationId>
  <LocationPhoneNumber>sample string 16</LocationPhoneNumber>
  <LocationTimeZone>sample string 18</LocationTimeZone>
  <LocationTimeZoneOffset>1</LocationTimeZoneOffset>
  <Priority>sample string 9</Priority>
  <ProjectNumber>sample string 25</ProjectNumber>
  <ProjectOther>sample string 24</ProjectOther>
  <RequestCode>sample string 11</RequestCode>
  <RequestType>sample string 10</RequestType>
  <RequestingContact>sample string 3</RequestingContact>
  <ScheduledComplete>2024-05-19T22:18:58.4178536+00:00</ScheduledComplete>
  <ScheduledStart>2024-05-19T22:18:58.4178536+00:00</ScheduledStart>
  <ServiceLocation>sample string 12</ServiceLocation>
  <State>sample string 22</State>
  <Status>sample string 6</Status>
  <StatusAge>1</StatusAge>
  <StatusOrder>1</StatusOrder>
  <StoreCompanyCode>sample string 30</StoreCompanyCode>
  <StoreNumber>sample string 19</StoreNumber>
  <TargetComplete>2024-05-19T22:18:58.4178536+00:00</TargetComplete>
  <TargetStart>2024-05-19T22:18:58.4178536+00:00</TargetStart>
  <Trade>sample string 5</Trade>
  <Vendor>sample string 7</Vendor>
  <VendorCode>sample string 8</VendorCode>
  <VendorId>1</VendorId>
  <VendorPhoneNumber>sample string 17</VendorPhoneNumber>
  <WOURL>sample string 26</WOURL>
  <WorkOrderId>sample string 1</WorkOrderId>
  <WorkOrderNumber>sample string 20</WorkOrderNumber>
  <WorkType>sample string 13</WorkType>
  <ZoneName>sample string 15</ZoneName>
</WorkOrder>