Receiving new work orders

You can receive new work orders by:

• Listening for new work order event notifications
• Polling for new work orders

Receiving new work order event notifications

If you are subscribed to WebHook notifications an event will fire every time you receive a new work order. For details on how to configure WebHook notifications, see Configuration. For more details about the event contents, see Work order received notification.

Polling for new work orders

While event notifications are the preferred method for receiving new work orders you can also poll. You achieve this by using the work order search method. You should typically search for all work orders in the new status created in the last n minutes. For guidance on how to search for work orders, see searching for work orders.

Searching for work orders

Use this method to receive basic information about all work orders that correspond to the specified search criteria. For a detailed API reference, see POST /api/workorder/search.
To find which search criteria are available, see SearchModel.

If the API returns an error, see Error Codes section of this documentation.

📘

Note:

Search returns only basic information about a work order.
To request detailed information about a work order see Getting work order details.

Getting work order details

You can receive detailed information about work orders if you know their IDs. For a detailed API reference, see GET /api/workorder.

🚧

Warning

You can receive information about no more than 50 work orders in a single call.

The expected response model and its description are available in GET /api/workorder/ reference of the CorrigoPro Direct API.

🚧

Attachments

When retrieving work order details using GET /api/workorder/, attachment data is not automatically included within the work order data.

You may call GET /api/attachments to return a list of attachments for a given work order.

See Working with attachments for more information.

If the API returns an error, see Error Codes section of this documentation.