POST 17.0/database/workorders/list

Description

Retrieve a list of Work Orders

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of WorkOrdersUpdate
Name Description Type Additional information
ID

integer

None.
UserID

integer

None.
AssignedUserID

integer

None.
AddedDate

date

None.
DueDate

date

None.
CompletedDate

date

None.
UpdatedDate

date

None.
WorkOrderTypeID

integer

None.
Status

byte

None.
Priority

byte

None.
PropertyID

integer

None.
ContractorID

integer

None.
ContactID

integer

None.
Subject

string

String length: inclusive between 0 and 50
Body

string

None.
Notes

string

None.
Amount

decimal number

None.
Reference

string

String length: inclusive between 0 and 50
CompanyID

integer

None.
Pictures

string

None.
ExternalID

integer

None.
StatusDate

date

None.
CertificateID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "userID": 1,
    "assignedUserID": 1,
    "addedDate": "2025-01-09T20:17",
    "dueDate": "2025-01-09T20:17",
    "completedDate": "2025-01-09T20:17",
    "updatedDate": "2025-01-09T20:17",
    "workOrderTypeID": 1,
    "status": 64,
    "priority": 64,
    "propertyID": 1,
    "contractorID": 1,
    "contactID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "notes": "sample string 3",
    "amount": 1.0,
    "reference": "sample string 4",
    "companyID": 1,
    "pictures": "sample string 5",
    "externalID": 1,
    "statusDate": "2025-01-09T20:17",
    "certificateID": 1
  },
  {
    "id": 1,
    "userID": 1,
    "assignedUserID": 1,
    "addedDate": "2025-01-09T20:17",
    "dueDate": "2025-01-09T20:17",
    "completedDate": "2025-01-09T20:17",
    "updatedDate": "2025-01-09T20:17",
    "workOrderTypeID": 1,
    "status": 64,
    "priority": 64,
    "propertyID": 1,
    "contractorID": 1,
    "contactID": 1,
    "subject": "sample string 1",
    "body": "sample string 2",
    "notes": "sample string 3",
    "amount": 1.0,
    "reference": "sample string 4",
    "companyID": 1,
    "pictures": "sample string 5",
    "externalID": 1,
    "statusDate": "2025-01-09T20:17",
    "certificateID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfWorkOrdersUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WorkOrdersUpdate>
    <ID>1</ID>
    <UserID>1</UserID>
    <AssignedUserID>1</AssignedUserID>
    <AddedDate>2025-01-09T20:17:58.0428253+00:00</AddedDate>
    <DueDate>2025-01-09T20:17:58.0428253+00:00</DueDate>
    <CompletedDate>2025-01-09T20:17:58.0428253+00:00</CompletedDate>
    <UpdatedDate>2025-01-09T20:17:58.0428253+00:00</UpdatedDate>
    <WorkOrderTypeID>1</WorkOrderTypeID>
    <Status>64</Status>
    <Priority>64</Priority>
    <PropertyID>1</PropertyID>
    <ContractorID>1</ContractorID>
    <ContactID>1</ContactID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <Notes>sample string 3</Notes>
    <Amount>1</Amount>
    <Reference>sample string 4</Reference>
    <CompanyID>1</CompanyID>
    <Pictures>sample string 5</Pictures>
    <ExternalID>1</ExternalID>
    <StatusDate>2025-01-09T20:17:58.0428253+00:00</StatusDate>
    <CertificateID>1</CertificateID>
  </WorkOrdersUpdate>
  <WorkOrdersUpdate>
    <ID>1</ID>
    <UserID>1</UserID>
    <AssignedUserID>1</AssignedUserID>
    <AddedDate>2025-01-09T20:17:58.0428253+00:00</AddedDate>
    <DueDate>2025-01-09T20:17:58.0428253+00:00</DueDate>
    <CompletedDate>2025-01-09T20:17:58.0428253+00:00</CompletedDate>
    <UpdatedDate>2025-01-09T20:17:58.0428253+00:00</UpdatedDate>
    <WorkOrderTypeID>1</WorkOrderTypeID>
    <Status>64</Status>
    <Priority>64</Priority>
    <PropertyID>1</PropertyID>
    <ContractorID>1</ContractorID>
    <ContactID>1</ContactID>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <Notes>sample string 3</Notes>
    <Amount>1</Amount>
    <Reference>sample string 4</Reference>
    <CompanyID>1</CompanyID>
    <Pictures>sample string 5</Pictures>
    <ExternalID>1</ExternalID>
    <StatusDate>2025-01-09T20:17:58.0428253+00:00</StatusDate>
    <CertificateID>1</CertificateID>
  </WorkOrdersUpdate>
</ArrayOfWorkOrdersUpdate>