Internal API-Guide

GET api/WorkOrders/VendorByWorkGroup/{workGroupQueueId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workGroupQueueId

string

Required
RequireTotalCount

boolean None.
RequireGroupCount

boolean None.
IsCountQuery

boolean None.
Skip

integer None.
Take

integer None.
Sort

Collection of SortingInfo None.
Group

Collection of GroupingInfo None.
Filter

Collection of Object None.
TotalSummary

Collection of SummaryInfo None.
GroupSummary

Collection of SummaryInfo None.
Select

Collection of string None.
RemoteGrouping

boolean None.
PrimaryKey

Collection of string None.
DefaultSort

string None.

Body Parameters

None

Response Information

Resource Description

ListResultOfWorkOrderExtendedFragment
NameDescriptionTypeAdditional information
TotalCount

integer None.
Data

Collection of WorkOrderExtendedFragment None.

Response Formats

application/json, text/json

Sample: 
{
  "totalCount": 1,
  "data": [
    {
      "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-11-01T13:28:05.2020665Z",
      "scheduledCompleteDateTime": "2025-11-01T13:28:05.2020665Z",
      "createDateTime": "2025-11-01T13:28:05.2020665Z",
      "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-11-01T13:28:05.2020665Z",
      "completionDate": "2025-11-01T13:28:05.2020665Z",
      "enteredDate": "2025-11-01T13:28:05.2020665Z",
      "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-11-01T13:28:05.2020665Z",
      "scheduledCompleteDateTime": "2025-11-01T13:28:05.2020665Z",
      "createDateTime": "2025-11-01T13:28:05.2020665Z",
      "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-11-01T13:28:05.2020665Z",
      "completionDate": "2025-11-01T13:28:05.2020665Z",
      "enteredDate": "2025-11-01T13:28:05.2020665Z",
      "timeZoneOffset": 25.0,
      "timeZone": "sample string 26"
    }
  ]
}

application/xml, text/xml

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