Internal API-Guide

POST api/WorkOrderQueue

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 WorkOrderPreviewViewModel
NameDescriptionTypeAdditional information
WorkUserName

string None.
WorkGroupName

string None.
WorkOrderQueueName

string None.
WorkOrderId

string None.
WorkOrderNumber

string None.
ClientDomain

string None.
Company

string None.
Status

string None.
Vendor

string None.
State

string None.
ZoneName

string None.
Trade

string None.
RequestType

string None.
RequestCode

string None.
WorkType

string None.
Emergency

string None.
ActualStartString

string None.
ScheduledStartString

string None.
TargetStartString

string None.
TargetCompleteString

string None.
WorkOrderAge

string None.
Priority

string None.
ExpirationDateString

string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "workUserName": "sample string 1",
    "workGroupName": "sample string 2",
    "workOrderQueueName": "sample string 3",
    "workOrderId": "sample string 4",
    "workOrderNumber": "sample string 5",
    "clientDomain": "sample string 6",
    "company": "sample string 7",
    "status": "sample string 8",
    "vendor": "sample string 9",
    "state": "sample string 10",
    "zoneName": "sample string 11",
    "trade": "sample string 12",
    "requestType": "sample string 13",
    "requestCode": "sample string 14",
    "workType": "sample string 15",
    "emergency": "sample string 16",
    "actualStartString": "sample string 17",
    "scheduledStartString": "sample string 18",
    "targetStartString": "sample string 19",
    "targetCompleteString": "sample string 20",
    "workOrderAge": "sample string 21",
    "priority": "sample string 22",
    "expirationDateString": "sample string 23"
  },
  {
    "workUserName": "sample string 1",
    "workGroupName": "sample string 2",
    "workOrderQueueName": "sample string 3",
    "workOrderId": "sample string 4",
    "workOrderNumber": "sample string 5",
    "clientDomain": "sample string 6",
    "company": "sample string 7",
    "status": "sample string 8",
    "vendor": "sample string 9",
    "state": "sample string 10",
    "zoneName": "sample string 11",
    "trade": "sample string 12",
    "requestType": "sample string 13",
    "requestCode": "sample string 14",
    "workType": "sample string 15",
    "emergency": "sample string 16",
    "actualStartString": "sample string 17",
    "scheduledStartString": "sample string 18",
    "targetStartString": "sample string 19",
    "targetCompleteString": "sample string 20",
    "workOrderAge": "sample string 21",
    "priority": "sample string 22",
    "expirationDateString": "sample string 23"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWorkOrderPreviewViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Internal.Areas.WorkOrderQueue.Models">
  <WorkOrderPreviewViewModel>
    <ActualStartString>sample string 17</ActualStartString>
    <ClientDomain>sample string 6</ClientDomain>
    <Company>sample string 7</Company>
    <Emergency>sample string 16</Emergency>
    <ExpirationDateString>sample string 23</ExpirationDateString>
    <Priority>sample string 22</Priority>
    <RequestCode>sample string 14</RequestCode>
    <RequestType>sample string 13</RequestType>
    <ScheduledStartString>sample string 18</ScheduledStartString>
    <State>sample string 10</State>
    <Status>sample string 8</Status>
    <TargetCompleteString>sample string 20</TargetCompleteString>
    <TargetStartString>sample string 19</TargetStartString>
    <Trade>sample string 12</Trade>
    <Vendor>sample string 9</Vendor>
    <WorkGroupName>sample string 2</WorkGroupName>
    <WorkOrderAge>sample string 21</WorkOrderAge>
    <WorkOrderId>sample string 4</WorkOrderId>
    <WorkOrderNumber>sample string 5</WorkOrderNumber>
    <WorkOrderQueueName>sample string 3</WorkOrderQueueName>
    <WorkType>sample string 15</WorkType>
    <WorkUserName>sample string 1</WorkUserName>
    <ZoneName>sample string 11</ZoneName>
  </WorkOrderPreviewViewModel>
  <WorkOrderPreviewViewModel>
    <ActualStartString>sample string 17</ActualStartString>
    <ClientDomain>sample string 6</ClientDomain>
    <Company>sample string 7</Company>
    <Emergency>sample string 16</Emergency>
    <ExpirationDateString>sample string 23</ExpirationDateString>
    <Priority>sample string 22</Priority>
    <RequestCode>sample string 14</RequestCode>
    <RequestType>sample string 13</RequestType>
    <ScheduledStartString>sample string 18</ScheduledStartString>
    <State>sample string 10</State>
    <Status>sample string 8</Status>
    <TargetCompleteString>sample string 20</TargetCompleteString>
    <TargetStartString>sample string 19</TargetStartString>
    <Trade>sample string 12</Trade>
    <Vendor>sample string 9</Vendor>
    <WorkGroupName>sample string 2</WorkGroupName>
    <WorkOrderAge>sample string 21</WorkOrderAge>
    <WorkOrderId>sample string 4</WorkOrderId>
    <WorkOrderNumber>sample string 5</WorkOrderNumber>
    <WorkOrderQueueName>sample string 3</WorkOrderQueueName>
    <WorkType>sample string 15</WorkType>
    <WorkUserName>sample string 1</WorkUserName>
    <ZoneName>sample string 11</ZoneName>
  </WorkOrderPreviewViewModel>
</ArrayOfWorkOrderPreviewViewModel>