logo
API docs by Redocly

Field Service Management (1.03)

Download OpenAPI specification:Download

The Field Service Management API provides developers a way to view and manage the status of the field service system.

System Integrity

Resources related to System Integrity.

Health Check

Use to check whether or not the Field Service system is up and running.

Authorizations:
SWT

Responses

Attached Document

Resources related to Work Order.

Search Attached Document

Search for Attached Documents associated to a Work Order.

Available Fields

  • Filterable : attachedDocumentID, category, confidential, createdDate, createUser, documentStorageExternalID, lastModifiedDate, lastModifiedUser, markedForDelete, name, size
  • Sortable : attachedDocumentID, category, confidential, createdDate, createUser, documentStorageExternalID, lastModifiedDate, lastModifiedUser, markedForDelete, name, size
Authorizations:
SWT
path Parameters
workOrderID
required
integer

Unique ID of the Work Order to get attached documents from

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach a Document to a Work Order

Attach a Document to a Work Order.

Authorizations:
SWT
path Parameters
workOrderID
required
integer

Unique ID of the Work Order to attach a document to

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
category
required
string

Category of the document in Document Storage

confidential
boolean

Indicates if the document is confidential

documentStorageExternalID
required
string

External ID of the document in the storage system

extension
string

File extension of the document

markedForDelete
boolean

Indicates if the document is marked for deletion

name
required
string

Name of the document

notes
string

Notes associated with the document

size
required
integer

Size of the document in bytes

Responses

Request samples

Content type
application/json
{
  • "category": "Work Order",
  • "confidential": false,
  • "documentStorageExternalID": "123456",
  • "extension": ".pdf",
  • "markedForDelete": false,
  • "name": "WorkOrderReport",
  • "notes": "This is a report of the work order",
  • "size": 1024
}

Response samples

Content type
application/json
{
  • "attachedDocumentID": 0,
  • "category": "Work Order",
  • "confidential": "false",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createUser": "string",
  • "documentStorageExternalID": "123456",
  • "extension": ".pdf",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "markedForDelete": false,
  • "name": "WorkOrderReport.pdf",
  • "notes": "This is a report of the work order",
  • "size": 1024
}

Update Attached Document

Update an Attached Document associated to a Work Order.

Authorizations:
SWT
path Parameters
workOrderID
required
integer

Unique ID of the Work Order to attach a document to

attachedDocumentID
required
integer

Unique ID of the attached document to delete

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
category
required
string

Category of the document in Document Storage

confidential
boolean

Indicates if the document is confidential

documentStorageExternalID
required
string

External ID of the document in the storage system

extension
string

File extension of the document

markedForDelete
boolean

Indicates if the document is marked for deletion

name
required
string

Name of the document

notes
string

Notes associated with the document

size
required
integer

Size of the document in bytes

Responses

Request samples

Content type
application/json
{
  • "category": "Work Order",
  • "confidential": false,
  • "documentStorageExternalID": "123456",
  • "extension": ".pdf",
  • "markedForDelete": false,
  • "name": "WorkOrderReport",
  • "notes": "This is a report of the work order",
  • "size": 1024
}

Response samples

Content type
application/json
{
  • "attachedDocumentID": 0,
  • "category": "Work Order",
  • "confidential": "false",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "createUser": "string",
  • "documentStorageExternalID": "123456",
  • "extension": ".pdf",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "markedForDelete": false,
  • "name": "WorkOrderReport.pdf",
  • "notes": "This is a report of the work order",
  • "size": 1024
}

Delete Attached Document

Deletes an Attached Document associated to a Work Order.

Authorizations:
SWT
path Parameters
workOrderID
required
integer

Unique ID of the Work Order associated to the attached document

attachedDocumentID
required
integer

Unique ID of the attached document to delete

header Parameters
Content-Type
required
string
Example: application/json

Responses

Data Type

Resources related to Data Type.

Search Data Type

Provides a list of Data types in the system. [Rev 1.01]

Available Fields

  • Filterable : dataTypeID, name, description, validation, validationRegex, validationRegexStrict
  • Sortable : dataTypeID, name, description, validation, validationRegex, validationRegexStrict
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Work Order

Resources related to Work Order.

Cancel Work Order

Cancel a Work Order

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to cancel

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "workOrderID": 1,
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "customerID": 1,
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderStatusID": 1,
  • "workOrderStatus": "In Progress",
  • "completeDate": "2024-02-20T14:01:51.295Z",
  • "externalWorkOrderID": "1",
  • "workOrderCustomerID": 1,
  • "workOrderCustomerName": "Customer Name",
  • "workOrderProviderID": 2,
  • "siteID": 1,
  • "description": "Work Order Description",
  • "workOrderTypeID": 2,
  • "workOrderTypeName": "Simple Order Type",
  • "workOrderProviderName": "Zinier",
  • "linkReferences": [
    ],
  • "extendedInformationID": 1,
  • "extendedInformationItems": [
    ],
  • "providerExtendedInformationID": 1,
  • "providerExtendedInformationItems": [
    ],
  • "primaryLinkReferenceType": "Customer",
  • "primaryLinkReferenceID": "123",
  • "primaryLinkReferenceDisplayName": "Primary Customer"
}

Close Work Order

Close a Work Order

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to close

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "workOrderID": 1,
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "customerID": 1,
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderStatusID": 1,
  • "workOrderStatus": "In Progress",
  • "completeDate": "2024-02-20T14:01:51.295Z",
  • "externalWorkOrderID": "1",
  • "workOrderCustomerID": 1,
  • "workOrderCustomerName": "Customer Name",
  • "workOrderProviderID": 2,
  • "siteID": 1,
  • "description": "Work Order Description",
  • "workOrderTypeID": 2,
  • "workOrderTypeName": "Simple Order Type",
  • "workOrderProviderName": "Zinier",
  • "linkReferences": [
    ],
  • "extendedInformationID": 1,
  • "extendedInformationItems": [
    ],
  • "providerExtendedInformationID": 1,
  • "providerExtendedInformationItems": [
    ],
  • "primaryLinkReferenceType": "Customer",
  • "primaryLinkReferenceID": "123",
  • "primaryLinkReferenceDisplayName": "Primary Customer"
}

Create Work Order

Used to create a new Work Order.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
workOrderTypeID
required
number

Unique identifier for the type of the Work Order.

workOrderCustomerID
required
number

Unique identifier for the customer of the Work Order.

siteID
required
number

Unique identifier for the site of the Work Order.

description
string

Description of the Work Order.

Array of objects (WorkOrderLinkReference)
Array of objects (ExtendedInformationItem)

Responses

Request samples

Content type
application/json
{
  • "workOrderTypeID": 2,
  • "workOrderCustomerID": 1,
  • "siteID": 1,
  • "description": "Work Order Description",
  • "linkReferences": [
    ],
  • "extendedInformationItems": [
    ]
}

Response samples

Content type
application/json
{
  • "workOrderID": 1,
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "customerID": 1,
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderStatusID": 1,
  • "workOrderStatus": "In Progress",
  • "completeDate": "2024-02-20T14:01:51.295Z",
  • "externalWorkOrderID": "1",
  • "workOrderCustomerID": 1,
  • "workOrderCustomerName": "Customer Name",
  • "workOrderProviderID": 2,
  • "siteID": 1,
  • "description": "Work Order Description",
  • "workOrderTypeID": 2,
  • "workOrderTypeName": "Simple Order Type",
  • "workOrderProviderName": "Zinier",
  • "linkReferences": [
    ],
  • "extendedInformationID": 1,
  • "extendedInformationItems": [
    ],
  • "providerExtendedInformationID": 1,
  • "providerExtendedInformationItems": [
    ],
  • "primaryLinkReferenceType": "Customer",
  • "primaryLinkReferenceID": "123",
  • "primaryLinkReferenceDisplayName": "Primary Customer"
}

Search Work Order

Provides a list of Work orders in the system.

Available Fields

  • Filterable : workOrderID, createDate, createUser, lastModifiedDate, lastModifiedUser, workOrderStatusID, workOrderStatus, completeDate, externalWorkOrderID, workOrderCustomerID, workOrderCustomerName, workOrderProviderID, siteID, workOrderTypeID, workOrderTypeName, workOrderProviderName, linkReferences, primaryLinkReferenceType, primaryLinkReferenceID, primaryLinkReferenceDisplayName

  • Sortable : workOrderID, createDate, createUser, lastModifiedDate, lastModifiedUser, workOrderStatusID, workOrderStatus, completeDate, externalWorkOrderID, workOrderCustomerID, workOrderCustomerName, workOrderProviderID, siteID, workOrderTypeID, workOrderTypeName, workOrderProviderName, primaryLinkReferenceType, primaryLinkReferenceID, primaryLinkReferenceDisplayName

Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Work Order Link Reference

Used to create, update, or delete link references for a Work Order. If the combination of the supplied LinkReferenceType and LinkReferenceID already exists, the Link Reference will be updated. If not, a new one will be created. If Remove is set to true, then the link reference will be deleted. [Rev 1.01]

  • Customer: CustomerID if the Work Order is associated with a Customer
  • Order: OrderID if the Work Order is associated with an Order
  • Service: ServiceID if the Work Order is associated with a Service
  • Ticket: TicketID if the Work Order is associated with a Ticket
  • WorkflowInstance: WorkflowInstanceID if the Work Order is created from a Workflow Instance
  • WorkflowSignal: Workflow Signal Name if the Work Order is associated with a Workflow Signal
Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to update

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
linkReferenceType
required
string

The description of the link reference type.

linkReferenceID
required
string

Unique identifier of the link reference type.

linkReferenceDisplayName
string

Display name of the link reference type.

isPrimary
boolean

Indicates if this link reference is the primary link reference for the Work Order. [Rev 1.01]

remove
boolean

Indicates if this link reference should be removed from the Work Order.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Search Work Order Link Reference Types

Provides a list of Link Reference Types associated with a Work Order.

Available Fields

  • Filterable : linkReferenceType, linkReferenceID, displayName, isPrimary
  • Sortable : linkReferenceType, linkReferenceID, displayName, isPrimary
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Retrieve Work Order

Retrieves a Work Order by the WorkOrderID

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to retrieve

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "workOrderID": 1,
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "customerID": 1,
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderStatusID": 1,
  • "workOrderStatus": "In Progress",
  • "completeDate": "2024-02-20T14:01:51.295Z",
  • "externalWorkOrderID": "1",
  • "workOrderCustomerID": 1,
  • "workOrderCustomerName": "Customer Name",
  • "workOrderProviderID": 2,
  • "siteID": 1,
  • "description": "Work Order Description",
  • "workOrderTypeID": 2,
  • "workOrderTypeName": "Simple Order Type",
  • "workOrderProviderName": "Zinier",
  • "linkReferences": [
    ],
  • "extendedInformationID": 1,
  • "extendedInformationItems": [
    ],
  • "providerExtendedInformationID": 1,
  • "providerExtendedInformationItems": [
    ],
  • "primaryLinkReferenceType": "Customer",
  • "primaryLinkReferenceID": "123",
  • "primaryLinkReferenceDisplayName": "Primary Customer"
}

Search Work Order Provider Tasks

Retrieves a Work Order Tasks by the WorkOrderID

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order associated to the Provider Tasks to retrieve

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Work Order Extended Information

Used to create, update, or delete Extended Information for a Work Order. If the supplied Key already exists, the Extended Information will be updated. If not, a new one will be created. If Remove is set to true, then the Extended Information will be deleted. [Rev 1.02]

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to update

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
key
required
string

The key of the extended information.

value
string

The value of the extended information.

remove
boolean

Indicates if this extended information should be removed from the Work Order.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Sync Work Order

Synchronize Work Order state with the external provider. [Rev 1.02]

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order to update

header Parameters
Content-Type
required
string
Example: application/json

Responses

Recompute Extended Information

Used to recompute the extended information associated to the work order. [Rev 1.02]

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
notifyProvider
boolean

Notify the provider on callback.

signalName
string

Name of the signal included in the callback URL.

workflowInstanceID
number

Unique identifier for the workflow instance.

Responses

Request samples

Content type
application/json
{
  • "notifyProvider": true,
  • "signalName": "Signal Name",
  • "workflowInstanceID": 1
}

Receive Computed Work Order Extended Information

Used to receive computed extended information and update the Work Order extended information items. Optionally sends a request to signal/receive endpoint in WorkflowManagement which will complete the Set Work Order Extended Data Workflow action task if there is one in progress [Rev 1.02]

Authorizations:
SWT
path Parameters
workOrderId
required
integer

Unique ID of the Work Order

query Parameters
workflowInstanceId
integer

Unique ID of the Workflow Instance to which signal is associated. If not provided, the signal will not be sent to Workflow Management.

signalName
string

Unique ID of the Signal. If not provided, the signal will not be sent to Workflow Management.

requestedDate
string

Date and time when the extended information was requested. If not provided, the current date and time will be used.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
required
Array of objects (ExtendedInformationItem)

Responses

Request samples

Content type
application/json
{
  • "extendedInformationItems": [
    ]
}

Work Order Customer

Resources related to Work Order Customer

Create Work Order Customer

Creates a Work Order Customer

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
customerID
integer

Unique identifier for the IDI Customer the Work Order Customer is associated to.

customerName
required
string

Name of the customer associated to the Work Order Customer

Responses

Request samples

Content type
application/json
{
  • "customerID": 1,
  • "customerName": "Customer Name"
}

Response samples

Content type
application/json
{
  • "workOrderCustomerID": 1,
  • "customerID": 1,
  • "customerName": "Customer Name",
  • "createDate": "2024-02-20T16:11:53.116Z",
  • "createUser": "Example User",
  • "lastModifiedDate": "2024-02-20T16:11:53.116Z",
  • "lastModifiedUser": "Example User"
}

Search Work Order Customer

Provides a list of Work order customers in the system.

Available Fields

  • Filterable : workOrderCustomerID, customerID, customerName, createDate, createUser, lastModifiedDate, lastModifiedUser
  • Sortable : workOrderCustomerID, customerID, customerName, createDate, createUser, lastModifiedDate, lastModifiedUser
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Work Order Customer

Retrieves a Work Order Customer by the WorkOrderCustomerID

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "workOrderCustomerID": 1,
  • "customerID": 1,
  • "customerName": "Customer Name",
  • "createDate": "2024-02-20T16:11:53.116Z",
  • "createUser": "Example User",
  • "lastModifiedDate": "2024-02-20T16:11:53.116Z",
  • "lastModifiedUser": "Example User"
}

Work Order Type

Resources related to Work Order Type.

Search Work Order Type

Provides a list of Work order types in the system.

Available Fields

  • Filterable : workOrderTypeID, name, description, enabled, workOrderProviderID, workOrderProvider, workOrderProviderName, providerWorkOrderType
  • Sortable : workOrderTypeID, name, description, enabled, workOrderProviderID, workOrderProvider, workOrderProviderName, providerWorkOrderType
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Work Order Type

Creates a new Work Order Type in the system.

Authorizations:
SWT
Request Body schema: application/json
name
required
string

The name of the Work Order Type.

enabled
boolean

Whether the Work Order Type is enabled. Defaults to false.

Array of objects (DataDefinitionsModelReq)

List of data definitions associated with the Work Order Type. [Rev 1.01]

description
string

Description of the Work Order Type.

workOrderProviderID
required
number

Unique identifier for the provider of the Work Order. IDI = 1, Zinier = 2.

workOrderProviderType
string

Work Order field specific to the provider.

Responses

Request samples

Content type
application/json
{
  • "name": "Installation",
  • "enabled": false,
  • "dataDefinitions": [
    ],
  • "description": "Simple Installation",
  • "workOrderProviderID": 2,
  • "workOrderProviderType": "Work Order Template"
}

Response samples

Content type
application/json
{
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "description": "Simple Installation",
  • "enabled": false,
  • "environmentID": 1,
  • "name": "Installation",
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderProviderID": 2,
  • "workOrderProviderType": "Work Order Template",
  • "workOrderProviderName": "IDI",
  • "workOrderTypeID": 2
}

Delete Work Order Type

Deletes a Work Order Type by the WorkOrderTypeID

Authorizations:
SWT
path Parameters
workOrderTypeId
required
integer

Unique ID of the Work Order Type to delete

header Parameters
Content-Type
required
string
Example: application/json

Responses

Retrieve Work Order Type

Retrieves a Work Order Type by the WorkOrderTypeID

Authorizations:
SWT
path Parameters
workOrderTypeId
required
integer

Unique ID of the Work Order Type to retrieve

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "description": "Simple Installation",
  • "enabled": false,
  • "environmentID": 1,
  • "name": "Installation",
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderProviderID": 2,
  • "workOrderProviderType": "Work Order Template",
  • "workOrderProviderName": "IDI",
  • "workOrderTypeID": 2
}

Update Work Order Type

Update an existing Work Order Type

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
name
required
string

The name of the Work Order Type.

enabled
boolean

Whether the Work Order Type is enabled. Defaults to false.

description
string

Description of the Work Order Type.

Array of objects (DataDefinitionsModifyReq)

List of data definitions associated with the Work Order Type. [Rev 1.01]

workOrderProviderID
required
number

Unique identifier for the provider of the Work Order. IDI = 1, Zinier = 2.

workOrderProviderType
string

Work Order field specific to the provider.

Responses

Request samples

Content type
application/json
{
  • "name": "Installation",
  • "enabled": false,
  • "description": "Simple Installation",
  • "dataDefinitions": [
    ],
  • "workOrderProviderID": 2,
  • "workOrderProviderType": "Work Order Template"
}

Response samples

Content type
application/json
{
  • "createDate": "2024-02-20T14:01:51.295Z",
  • "createUser": "Test User",
  • "description": "Simple Installation",
  • "enabled": false,
  • "environmentID": 1,
  • "name": "Installation",
  • "lastModifiedDate": "2024-02-20T14:01:51.295Z",
  • "lastModifiedUser": "Test User",
  • "workOrderProviderID": 2,
  • "workOrderProviderType": "Work Order Template",
  • "workOrderProviderName": "IDI",
  • "workOrderTypeID": 2
}

Search Data Definition for Work Order Type

Retrieves a list of Data Definitions for a Work Order Type by the WorkOrderTypeID. [Rev 1.01]

Available Fields

  • Filterable : dataDefinitionID, name, description, dataType, dataTypeID, defaultValue, listID, hookType, synchronizeDate, isRequired, sequenceNumber
  • Sortable : dataDefinitionID, name, description, dataType, dataTypeID, defaultValue, listID, hookType, synchronizeDate, isRequired, sequenceNumber
Authorizations:
SWT
path Parameters
workOrderTypeId
required
integer

Unique ID of the Work Order Type to retrieve data definitions for

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Work Order Status

Resources related to Work Order Status.

Search Work Order Status

Provides a list of Work order statuses in the system.

Available Fields

  • Filterable : workOrderStatusID, description
  • Sortable : workOrderStatusID, description
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Work Order Summary

Resources related to Work Order.

Search Work Order Summary

Provides a list of Work Order Summaries in the system.

Available Fields

  • Filterable : createDate, workOrderID, workOrderStatus, workOrderStatusID, completeDate, externalWorkOrderID, workOrderCustomerID, workOrderTypeID, workOrderTypeName, siteID, Description, workOrderProviderName, workOrderProviderID, street1, street2, street3, region, city, state, zipcode, country, contactName, contactPhone, contactEmail, customerName, customerID, siteName
  • Sortable : createDate, workOrderID, workOrderStatus, workOrderStatusID, completeDate, externalWorkOrderID, workOrderCustomerID, workOrderTypeID, workOrderTypeName, siteID, Description, workOrderProviderName, workOrderProviderID, street1, street2, street3, region, city, state, zipcode, country, contactName, contactPhone, contactEmail, customerName, customerID, siteName
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Work Order Extended Information

Resources related to Work Order Extended Information.

Search Work Order Extended Information

Provides a list of Work Order Extended Information in the system.

Available Fields

  • Filterable : workOrderID, extendedInformationID, extendedInformationItemID, key, value, computedValue, LastComputedDate, isProvider, displayName (Rev. 1.04)
  • Sortable : workOrderID, extendedInformationID, extendedInformationItemID, key, value, computedValue, LastComputedDate, isProvider, displayName (Rev. 1.04)
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Site

Resources related to Sites

Create Site

Creates a Site

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
address1
required
string

The first address field for the site.

address2
string

The second address field for the site.

address3
string

The third address field for the site.

city
string

The city for the site.

idiAddressReferenceID
string

Unique identifier for the address reference associated to the site

country
string

The country for the site.

email
string

The email for the site.

phoneNumber
string

The phone number for the site.

region
string

The region for the site.

siteID
number

Unique identifier used for updating an existing site.

siteName
required
string

The name of the site.

state
string

The state for the site.

workOrderCustomerID
required
number

Unique identifier for the WorkOrderCustomer.

zip
string

The zip code for the site.

Responses

Request samples

Content type
application/json
{
  • "address1": "123 Street",
  • "address2": "Apartment 10",
  • "address3": "P.O. Box 100",
  • "city": "Sacramento",
  • "idiAddressReferenceID": "5",
  • "country": "USA",
  • "email": "test@gmail.com",
  • "phoneNumber": "585-555-1234",
  • "region": "Region",
  • "siteID": 1,
  • "siteName": "Site Name",
  • "state": "NY",
  • "workOrderCustomerID": 1,
  • "zip": "14564"
}

Response samples

Content type
application/json
{
  • "address1": "123 Street",
  • "address2": "Apartment 10",
  • "address3": "P.O. Box 100",
  • "city": "Sacramento",
  • "idiAddressReferenceID": "5",
  • "country": "USA",
  • "createDate": "2024-02-20T16:11:53.116Z",
  • "createUser": "Example User",
  • "email": "test@gmail.com",
  • "lastModifiedDate": "2024-02-20T16:11:53.116Z",
  • "lastModifiedUser": "Example User",
  • "phoneNumber": "585-555-1234",
  • "region": "Region",
  • "state": "NY",
  • "siteID": 1,
  • "siteName": "Site Name",
  • "workOrderCustomerID": 1,
  • "zip": "14564"
}

Search Site

Provides a list of sites in the system.

Available Fields

  • Filterable : SiteID, WorkOrderCustomerID, IDIAddressReferenceID, Address1, Address2, Address3, PhoneNumber, Email, Region, City, State, Country, Zip, CreateDate, CreateUser, LastModifiedDate, LastModifiedUser, SiteName
  • Sortable : SiteID, WorkOrderCustomerID, IDIAddressReferenceID, Address1, Address2, Address3, PhoneNumber, Email, Region, City, State, Country, Zip, CreateDate, CreateUser, LastModifiedDate, LastModifiedUser, SiteName
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Site

Retrieves a site by siteID

Authorizations:
SWT
path Parameters
SiteID
required
number
Example: 1

Unique identifier of the site to retrieve.

Responses

Response samples

Content type
application/json
{
  • "address1": "123 Street",
  • "address2": "Apartment 10",
  • "address3": "P.O. Box 100",
  • "city": "Sacramento",
  • "idiAddressReferenceID": "5",
  • "country": "USA",
  • "createDate": "2024-02-20T16:11:53.116Z",
  • "createUser": "Example User",
  • "email": "test@gmail.com",
  • "lastModifiedDate": "2024-02-20T16:11:53.116Z",
  • "lastModifiedUser": "Example User",
  • "phoneNumber": "585-555-1234",
  • "region": "Region",
  • "state": "NY",
  • "siteID": 1,
  • "siteName": "Site Name",
  • "workOrderCustomerID": 1,
  • "zip": "14564"
}

Zinier Webhooks

Resources related to Webhooks

Zinier Work Order Webhook

Send Work Order Status and Task Status Updates

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
zinierWorkOrderID
required
string

Unique identifier of the Zinier Work Order. This field maps to the externalWorkOrderID of a IDI Work Order

workOrderStatus
required
string

The status of the Work Order in Zinier

taskStatus
string

The status of the task in Zinier

zinierTaskID
string

Unique identifier of the Zinier task

Responses

Request samples

Content type
application/json
{
  • "zinierWorkOrderID": "1",
  • "workOrderStatus": "Closed",
  • "taskStatus": "Completed",
  • "zinierTaskID": "1"
}

Zinier

Resources related to Zinier

Zinier Get Available Appointment Slots

Gets the available Appointment Slots for a Work Order Task from Zinier

Authorizations:
SWT
path Parameters
confirmationNumber
required
string

The UID of the Work Order Task that the appointment is for

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
scheduleDate
required
DateTimeOffset

The desired date of the appointment in Local Time

numberOfWeeks
number

The number of weeks to get the appointment slots for. If this is not provided, it defaults to 1 week.

Responses

Request samples

Content type
application/json
{
  • "scheduleDate": "2021-01-01T08:00:00-04:00",
  • "numberOfWeeks": 1
}

Response samples

Content type
application/json
{
  • "appointmentWindows": [
    ]
}

Search Zinier Templates

Provides a list of work order templates from Zinier.

Available Fields

  • Filterable : description, name, priority, templateId
  • Sortable : description, name, priority, templateId
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Zinier Work Order Details

Gets the Work Order Information from Zinier

Authorizations:
SWT
path Parameters
externalWorkOrderID
required
string

The Work Order ID from Zinier

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "tasksDetails": [
    ],
  • "techDetails": [
    ]
}

Zinier Confirm Appointment

Confirms an appointment for a Zinier Work Order Task

Authorizations:
SWT
path Parameters
confirmationNumber
required
string

The UID of the Work Order Task that the appointment is for

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
appointmentWindowId
required
string

The unique identifier of the appointment window

endTime
required
DateTime

The end time of the appointment in Local Time

startTime
required
DateTime

The start time of the appointment in Local Time

Responses

Request samples

Content type
application/json
{
  • "appointmentWindowId": "123456",
  • "endTime": "2021-01-01T10:00:00-04:00",
  • "startTime": "2021-01-01T08:00:00-04:00"
}

Response samples

Content type
application/json
{
  • "responseMessage": "cp_receive_conformation_shortly",
  • "responseTitle": "cp_appointment_successfully_booked",
  • "slotUnavailable": false,
  • "status": true
}

Download Zinier Closeout Package

Downloads the Zinier Closeout Package associated with a Work Order.

Authorizations:
SWT
path Parameters
externalWorkOrderID
required
string

The ID of the external Work Order

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
timezone
required
string

The timezone used to request the Closeout Package. This should be a valid IANA timezone identifier from the tz database (e.g., "America/New_York").

Responses

Request samples

Content type
application/json
{
  • "timezone": "America/New_York"
}

Zinier Cancel Appointment

Cancels an appointment for a Zinier Work Order Task

Authorizations:
SWT
path Parameters
confirmationNumber
required
string

The UID of the Work Order Task that the appointment is for

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "responseMessage": "cp_receive_conformation_shortly",
  • "responseTitle": "Appointment Successfully Cancelled ",
  • "status": true
}

Get Regions

Provides a list of regions from Zinier.

Available Fields

  • Filterable : regionName, regionId
  • Sortable : regionName, regionId
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Release Notes

Release Notes 1.04

Release Notes 1.00

  • Initial Release