Internal API-Guide

GET api/WorkOrderQueue/WorkGroups/{id}/Preview?getAll={getAll}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required
getAll

boolean

Required

Body Parameters

None

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>