Internal API-Guide

POST api/WorkOrders

Request Information

URI Parameters

None.

Body Parameters

Collection of WorkPathDTOOfWorkOrderQueueMaintenanceViewModel
NameDescriptionTypeAdditional information
WorkUserDTO

WorkUserDTO None.
WorkGroupDTO

WorkGroupDTO None.
WorkOrderQueueDTO

WorkOrderQueueDTO None.
MergedResult

WorkOrderQueueMaintenanceViewModel None.
NextWorkOrders

Pair of string [key] and Collection of WorkOrder [value] None.
SortedByAgeWorkOrders

Pair of string [key] and Collection of WorkOrder [value] None.
Count

integer None.
IsPublished

boolean None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'fmPilot.Services.DTO.WorkOrderQueue.WorkUserDTO'. Path '[0].workUserDTO.workGroups[0].workUsers'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'fmPilot.Services.DTO.WorkOrderQueue.WorkUserDTO'. Path '[0].workUserDTO.workGroups[0].workUsers'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[fmPilot.Services.DTO.WorkOrderQueue.WorkOrderQueueDTO, fmPilot.Services, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[fmPilot.Services.DTO.WorkOrderQueue.WorkOrderQueueDTO, fmPilot.Services, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Collection of WorkOrderExtendedFragment
NameDescriptionTypeAdditional information
Id

integer None.
WorkOrderNumber

string None.
ClientId

integer None.
Priority

string None.
ClientDomainName

string None.
VendorCode

string None.
WorkOrderStatusId

integer None.
WorkOrderStatusAbbreviation

string None.
MappedStatus

string None.
ScheduledStartDateTime

date None.
ScheduledCompleteDateTime

date None.
CreateDateTime

date None.
TradeId

integer None.
RequestCodeId

integer None.
RequestCode

string None.
RequestTypeId

integer None.
RequestType

string None.
LocationName

string None.
LocationId

integer None.
LocationNumber

string None.
Address

string None.
City

string None.
State

string None.
InvoiceId

integer None.
InvoiceNumber

string None.
InvoiceTotal

decimal number None.
InvoiceTax

decimal number None.
IsSnowWorkOrder

boolean None.
DNE

decimal number None.
Vendor

string None.
VendorPhone

string None.
OnsiteDate

date None.
CompletionDate

date None.
EnteredDate

date None.
TimeZoneOffset

decimal number None.
TimeZone

string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "workOrderNumber": "sample string 2",
    "clientId": 3,
    "priority": "sample string 4",
    "clientDomainName": "sample string 5",
    "vendorCode": "sample string 6",
    "workOrderStatusId": 7,
    "workOrderStatusAbbreviation": "sample string 8",
    "mappedStatus": "sample string 9",
    "scheduledStartDateTime": "2025-01-06T08:37:55.0826391Z",
    "scheduledCompleteDateTime": "2025-01-06T08:37:55.0826391Z",
    "createDateTime": "2025-01-06T08:37:55.0826391Z",
    "tradeId": 1,
    "requestCodeId": 11,
    "requestCode": "sample string 12",
    "requestTypeId": 13,
    "requestType": "sample string 14",
    "locationName": "sample string 15",
    "locationId": 1,
    "locationNumber": "sample string 16",
    "address": "sample string 17",
    "city": "sample string 18",
    "state": "sample string 19",
    "invoiceId": 1,
    "invoiceNumber": "sample string 20",
    "invoiceTotal": 1.0,
    "invoiceTax": 1.0,
    "isSnowWorkOrder": true,
    "dne": 22.0,
    "vendor": "sample string 23",
    "vendorPhone": "sample string 24",
    "onsiteDate": "2025-01-06T08:37:55.0826391Z",
    "completionDate": "2025-01-06T08:37:55.0826391Z",
    "enteredDate": "2025-01-06T08:37:55.0826391Z",
    "timeZoneOffset": 25.0,
    "timeZone": "sample string 26"
  },
  {
    "id": 1,
    "workOrderNumber": "sample string 2",
    "clientId": 3,
    "priority": "sample string 4",
    "clientDomainName": "sample string 5",
    "vendorCode": "sample string 6",
    "workOrderStatusId": 7,
    "workOrderStatusAbbreviation": "sample string 8",
    "mappedStatus": "sample string 9",
    "scheduledStartDateTime": "2025-01-06T08:37:55.0826391Z",
    "scheduledCompleteDateTime": "2025-01-06T08:37:55.0826391Z",
    "createDateTime": "2025-01-06T08:37:55.0826391Z",
    "tradeId": 1,
    "requestCodeId": 11,
    "requestCode": "sample string 12",
    "requestTypeId": 13,
    "requestType": "sample string 14",
    "locationName": "sample string 15",
    "locationId": 1,
    "locationNumber": "sample string 16",
    "address": "sample string 17",
    "city": "sample string 18",
    "state": "sample string 19",
    "invoiceId": 1,
    "invoiceNumber": "sample string 20",
    "invoiceTotal": 1.0,
    "invoiceTax": 1.0,
    "isSnowWorkOrder": true,
    "dne": 22.0,
    "vendor": "sample string 23",
    "vendorPhone": "sample string 24",
    "onsiteDate": "2025-01-06T08:37:55.0826391Z",
    "completionDate": "2025-01-06T08:37:55.0826391Z",
    "enteredDate": "2025-01-06T08:37:55.0826391Z",
    "timeZoneOffset": 25.0,
    "timeZone": "sample string 26"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWorkOrderExtendedFragment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.BE.Entities.WorkOrder">
  <WorkOrderExtendedFragment>
    <Address>sample string 17</Address>
    <City>sample string 18</City>
    <ClientDomainName>sample string 5</ClientDomainName>
    <ClientId>3</ClientId>
    <CompletionDate>2025-01-06T08:37:55.0826391+00:00</CompletionDate>
    <CreateDateTime>2025-01-06T08:37:55.0826391+00:00</CreateDateTime>
    <DNE>22</DNE>
    <EnteredDate>2025-01-06T08:37:55.0826391+00:00</EnteredDate>
    <Id>1</Id>
    <InvoiceId>1</InvoiceId>
    <InvoiceNumber>sample string 20</InvoiceNumber>
    <InvoiceTax>1</InvoiceTax>
    <InvoiceTotal>1</InvoiceTotal>
    <IsSnowWorkOrder>true</IsSnowWorkOrder>
    <LocationId>1</LocationId>
    <LocationName>sample string 15</LocationName>
    <LocationNumber>sample string 16</LocationNumber>
    <MappedStatus>sample string 9</MappedStatus>
    <OnsiteDate>2025-01-06T08:37:55.0826391+00:00</OnsiteDate>
    <Priority>sample string 4</Priority>
    <RequestCode>sample string 12</RequestCode>
    <RequestCodeId>11</RequestCodeId>
    <RequestType>sample string 14</RequestType>
    <RequestTypeId>13</RequestTypeId>
    <ScheduledCompleteDateTime>2025-01-06T08:37:55.0826391+00:00</ScheduledCompleteDateTime>
    <ScheduledStartDateTime>2025-01-06T08:37:55.0826391+00:00</ScheduledStartDateTime>
    <State>sample string 19</State>
    <TimeZone>sample string 26</TimeZone>
    <TimeZoneOffset>25</TimeZoneOffset>
    <TradeId>1</TradeId>
    <Vendor>sample string 23</Vendor>
    <VendorCode>sample string 6</VendorCode>
    <VendorPhone>sample string 24</VendorPhone>
    <WorkOrderNumber>sample string 2</WorkOrderNumber>
    <WorkOrderStatusAbbreviation>sample string 8</WorkOrderStatusAbbreviation>
    <WorkOrderStatusId>7</WorkOrderStatusId>
  </WorkOrderExtendedFragment>
  <WorkOrderExtendedFragment>
    <Address>sample string 17</Address>
    <City>sample string 18</City>
    <ClientDomainName>sample string 5</ClientDomainName>
    <ClientId>3</ClientId>
    <CompletionDate>2025-01-06T08:37:55.0826391+00:00</CompletionDate>
    <CreateDateTime>2025-01-06T08:37:55.0826391+00:00</CreateDateTime>
    <DNE>22</DNE>
    <EnteredDate>2025-01-06T08:37:55.0826391+00:00</EnteredDate>
    <Id>1</Id>
    <InvoiceId>1</InvoiceId>
    <InvoiceNumber>sample string 20</InvoiceNumber>
    <InvoiceTax>1</InvoiceTax>
    <InvoiceTotal>1</InvoiceTotal>
    <IsSnowWorkOrder>true</IsSnowWorkOrder>
    <LocationId>1</LocationId>
    <LocationName>sample string 15</LocationName>
    <LocationNumber>sample string 16</LocationNumber>
    <MappedStatus>sample string 9</MappedStatus>
    <OnsiteDate>2025-01-06T08:37:55.0826391+00:00</OnsiteDate>
    <Priority>sample string 4</Priority>
    <RequestCode>sample string 12</RequestCode>
    <RequestCodeId>11</RequestCodeId>
    <RequestType>sample string 14</RequestType>
    <RequestTypeId>13</RequestTypeId>
    <ScheduledCompleteDateTime>2025-01-06T08:37:55.0826391+00:00</ScheduledCompleteDateTime>
    <ScheduledStartDateTime>2025-01-06T08:37:55.0826391+00:00</ScheduledStartDateTime>
    <State>sample string 19</State>
    <TimeZone>sample string 26</TimeZone>
    <TimeZoneOffset>25</TimeZoneOffset>
    <TradeId>1</TradeId>
    <Vendor>sample string 23</Vendor>
    <VendorCode>sample string 6</VendorCode>
    <VendorPhone>sample string 24</VendorPhone>
    <WorkOrderNumber>sample string 2</WorkOrderNumber>
    <WorkOrderStatusAbbreviation>sample string 8</WorkOrderStatusAbbreviation>
    <WorkOrderStatusId>7</WorkOrderStatusId>
  </WorkOrderExtendedFragment>
</ArrayOfWorkOrderExtendedFragment>