SEservicechannel
WorkOrders

Perform a check-out

Creates a check-out record of the indicated work type: travel, repair, or custom. Returns MechanicId for a successful request. See the Check-In/Out guide for code snippets and detailed instructions. <br />Note: Special permission is required for the Travel and Repair work types. <br />Example Request

            POST /workorders/{workorderId}/universalCheckOut
            {
              "WorkTypeId": 1,
              "PrimaryStatus": "InProgress",
              "ExtendedStatus": "string",
              "ActionStatus": "Complete",
              "Resolution": "We need more time to complete this job.",
              "UserId": 1544987,
              "Latitude": 40.736618,
              "Longitude": -73.991806,
              "CheckOutTime": "2018-10-23T09:30:00Z"
            }
post/workorders/{workorderId}/universalCheckOut

Request

Path parameters

workorderIdinteger required

The unique ID of the work order for which you want to report a check-out.

Request body

WorkTypeIdinteger

The unique ID of the work type. Possible values: 1 — Repair, 2 — Travel. Other values are possible when custom types are set up for the subscriber. Default value: 1.

PrimaryStatus'NoStatusChange' | 'InProgress' | 'Completed' | 'WaitingForQuote' | 'PartsOnOrder' | 'Incomplete'

The status that is set for the WO when checking out. Required for the Repair type. Ignored for the Travel and custom types as well when ActionStatus = Cancel. Default value: NoStatusChange.

ExtendedStatusstring

The extended status that is set for the WO when checking out. Optional for the Repair type. Ignored for the Travel and custom types, when ActionStatus = Cancel, and for 'Completed' PrimaryStatus (generated automatically). Refrigerant WO with 'Completed' PrimaryStatus — special case by RefrigerationTracking feature.

ActionStatus'Complete' | 'Cancel'

The status of the activity. Possible values: Complete, Cancel. Both values result in recording a check-out. Complete means that the technician has finished the activity. Cancel means the technician needs to pause the activity, for example, to have a break outside of the location. GPS coordinates are not required. Default value: Complete.

Resolutionstring

The comment entered when checking out. Usually describes what was done during the recorded time. Ignored for the Travel and custom types as well as when ActionStatus = Cancel. Default value: empty.

UserIdinteger

The user ID of the technician that is checking out. Use the same UserId for one pair of check-in and check-out records. Default value: ID of the current user.

TechsCountinteger

The number of technicians that are checking out. Default value: 1.

Latitudenumber double required

The latitude of the technician’s current position. Required for the Repair and Travel type. Not required for custom types, for the Repair and Travel types when the XML check-in/out permission is enabled, and when ActionStatus = Cancel.

Longitudenumber double required

The longitude of the technician’s current position. Required for the Repair and Travel type. Not required for custom types, for the Repair and Travel types when the XML check-in/out permission is enabled, and when ActionStatus = Cancel.

CheckOutTimestring date-time

The date and time of the check-out. Either indicate in UTC or pass the current time and add the UTC offset. You can pass this value only when the XML check-in/out permission is enabled. Default value: current date and time.

CheckoutAllboolean
Actorstring

Optional, Actor

SignatureAttachmentIdinteger

Optional, SignatureAttachmentId Default value: null

UnableObtainSignatureNoteIdinteger

Optional, UnableObtainSignatureNoteId Default value: null

UnableObtainSignatureNoteDocumentIdstring

Optional, UnableObtainSignatureNoteDocumentId Default value: null

Response

The check-out record is created.

MechanicIdinteger

The unique ID of the reported check-in/out action.

Changes

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