POST 17.0/database/maintenancerequests/list

Description

Retrieve a list of Maintenance Requests

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 MaintenanceRequestsUpdate
Name Description Type Additional information
ID

integer

None.
AddedDate

date

None.
Subject

string

String length: inclusive between 0 and 100
Body

string

None.
ContactID

integer

None.
ContactFirstNames

string

String length: inclusive between 0 and 30
ContactLastName

string

String length: inclusive between 0 and 30
ContactEmail

string

String length: inclusive between 0 and 50
ContactTelephone

string

String length: inclusive between 0 and 30
PropertyID

integer

None.
PropertyStreet

string

String length: inclusive between 0 and 50
PropertyPostcode

string

String length: inclusive between 0 and 30
SiteID

integer

None.
WorkOrderTypeID

integer

None.
Status

byte

None.
StatusDate

date

None.
UserID

integer

None.
Pictures

integer

None.
ExternalID

integer

None.
WorkOrderID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "addedDate": "2025-01-09T20:12",
    "subject": "sample string 1",
    "body": "sample string 2",
    "contactID": 1,
    "contactFirstNames": "sample string 3",
    "contactLastName": "sample string 4",
    "contactEmail": "sample string 5",
    "contactTelephone": "sample string 6",
    "propertyID": 1,
    "propertyStreet": "sample string 7",
    "propertyPostcode": "sample string 8",
    "siteID": 1,
    "workOrderTypeID": 1,
    "status": 64,
    "statusDate": "2025-01-09T20:12",
    "userID": 1,
    "pictures": 1,
    "externalID": 1,
    "workOrderID": 1
  },
  {
    "id": 1,
    "addedDate": "2025-01-09T20:12",
    "subject": "sample string 1",
    "body": "sample string 2",
    "contactID": 1,
    "contactFirstNames": "sample string 3",
    "contactLastName": "sample string 4",
    "contactEmail": "sample string 5",
    "contactTelephone": "sample string 6",
    "propertyID": 1,
    "propertyStreet": "sample string 7",
    "propertyPostcode": "sample string 8",
    "siteID": 1,
    "workOrderTypeID": 1,
    "status": 64,
    "statusDate": "2025-01-09T20:12",
    "userID": 1,
    "pictures": 1,
    "externalID": 1,
    "workOrderID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfMaintenanceRequestsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MaintenanceRequestsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:12:09.1230612+00:00</AddedDate>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <ContactID>1</ContactID>
    <ContactFirstNames>sample string 3</ContactFirstNames>
    <ContactLastName>sample string 4</ContactLastName>
    <ContactEmail>sample string 5</ContactEmail>
    <ContactTelephone>sample string 6</ContactTelephone>
    <PropertyID>1</PropertyID>
    <PropertyStreet>sample string 7</PropertyStreet>
    <PropertyPostcode>sample string 8</PropertyPostcode>
    <SiteID>1</SiteID>
    <WorkOrderTypeID>1</WorkOrderTypeID>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:12:09.1230612+00:00</StatusDate>
    <UserID>1</UserID>
    <Pictures>1</Pictures>
    <ExternalID>1</ExternalID>
    <WorkOrderID>1</WorkOrderID>
  </MaintenanceRequestsUpdate>
  <MaintenanceRequestsUpdate>
    <ID>1</ID>
    <AddedDate>2025-01-09T20:12:09.1230612+00:00</AddedDate>
    <Subject>sample string 1</Subject>
    <Body>sample string 2</Body>
    <ContactID>1</ContactID>
    <ContactFirstNames>sample string 3</ContactFirstNames>
    <ContactLastName>sample string 4</ContactLastName>
    <ContactEmail>sample string 5</ContactEmail>
    <ContactTelephone>sample string 6</ContactTelephone>
    <PropertyID>1</PropertyID>
    <PropertyStreet>sample string 7</PropertyStreet>
    <PropertyPostcode>sample string 8</PropertyPostcode>
    <SiteID>1</SiteID>
    <WorkOrderTypeID>1</WorkOrderTypeID>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:12:09.1230612+00:00</StatusDate>
    <UserID>1</UserID>
    <Pictures>1</Pictures>
    <ExternalID>1</ExternalID>
    <WorkOrderID>1</WorkOrderID>
  </MaintenanceRequestsUpdate>
</ArrayOfMaintenanceRequestsUpdate>