SEservicechannel
CheckLists

Get standard checklists

Returns standard checklists along with their parameters, configured questions, and answer options. <br />You can filter checklists by:  • Trade. Specify either tradeid or tradeName.  • Category. Enter either categoryid or categoryName.  • Location. Provide either locationId or storeId if the feature that allows creating checklists for specific locations is enabled for a subscriber.  • Checklist. Pass either checklistid or checkListName to get a specific checklist, and ignore other parameters. <br />Providers should pass subscriberId to retrieve checklists created by the desired subscriber. <br />The NumericInput and LessMoreOption fields in the response are obsolete and should not be used. <br />Navigate to ServiceChannel University to find out how subscribers can configure checklists.

get/checklists/detail

Request

Query parameters

tradeidinteger

Trade ID. To get a list of trades with their IDs, send the GET /odata/trades request.

checklistidinteger

Checklist ID.

categoryidinteger

Category ID. Subscribers can retrieve category IDs using the GET /categories method.

subscriberIdinteger

Unique ID of the subscriber who configured checklists. Should be passed by providers.

tradeNamestring

Trade name. A trade is an area of work for which a service is performed, such as Lighting, Refrigeration, or Plumbing.

checkListNamestring

Checklist name.

categoryNamestring

Category name. A category is the overall classification of a work order, such as Maintenance, Repair, or CAPEX.

locationIdinteger

Unique ID of a subscriber’s location. This parameter is ignored if the feature that allows creating checklists for specific locations is disabled for a subscriber.

storeIdstring

Non-unique ID of a subscriber’s location that may appear as a store number. This parameter is ignored if the feature that allows creating checklists for specific locations is disabled for a subscriber.

workOrderIdinteger

Work Order ID

Response

The requested standard checklists are in the response.

HasTransferedCheckListboolean

Gets or sets a value indicating whether there is a transferred checklist.

Changes

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