WorkOrders

Get work order statuses that relate to a specific work order.

Returns work order statuses based on the user role and Admin permissions. <br />Use the returned ID value as an alternative to the primary status name when updating a status via the PUT/workorders/{workorderId}/status method.

get/workorders/{workorderId}/statuses

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workorders/:workorderId/statuses/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workorderIdinteger required

Numeric identifier of a work order to retrieve statuses for.

Query parameters

subscriberIdinteger

Unique numeric identifier of the subscriber. This parameter is required only for providers.

tradeIdinteger

Numeric identifier of the trade. Works only if the LimitStatusesByTrade FF is on. It returns extended statuses that are available for the specified trade. Entering the tradeId will show which statuses are available based on the Excluded Trades setting in Admin. <br />To get a trade ID, run the GET/trades/GetExistsTrades method.

Response

The request succeeded, and the requested information is in response.

Id'NotSet' | 'Open' | 'InProgress' | 'Completed' | 'Incomplete'

Unique numeric identifier of the primary work order status. Possible response values: • 0: NotSet • 1: Open • 2: InProgress • 3: Completed

Namestring

Name of the main status.

Extendedstring[]

List of available extended statuses.

Changes

No recorded changes to this operation across all 1 revision of this API.