WorkOrders

Validate Check-Out action

get/workorders/{workorderId}/validateCheckOut

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/validateCheckOut/get.ts
A function with typed inputs. Its response is checked against the schema.

workorderIdinteger required

Numeric Id of the Work order to perform action with.

workTypeIdinteger

Optional, type work Id. 1 - 'Repair', 2 - 'Travel' Default value is 1 ('Repair'). Supports custom types.

latitudenumber double required

Global position. Latitude

longitudenumber double required

Global position. Longitude

Indicates that the request succeeded and that the requested information is in the response.

IsBadgeScanRequiredboolean

Is Badge Scan Required

IsLoginTypeAllowedboolean

Is Current Login type Allowed to perform check-in action

IsOutsideAcceptableTimeframeboolean

Is Outside Acceptable Timeframe

IsOutsideGeolocationboolean

Is Outside Geolocation

OutsideOperationalHoursMessagestring

Outside Operational Hours Message

IsMaskRequiredboolean

Is Mask Required

CheckInOutsideGPSAllowedboolean

Is Check In Outside Geolocation Radius Allowed

CheckOutOutsideGPSAllowedboolean

Is Check Out Outside Geolocation Radius Allowed

IsCompliantNonCompliantCheckInEnabledboolean

Is Compliant Non-Compliant Check In/Out Enabled

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