SEservicechannel
WorkOrders

Perform a check-in

Creates a check-in 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}/universalCheckIn
            {
              "WorkTypeId": 1,
              "UserId": 1544987,
              "TechsCount": 2,
              "Latitude": 40.736618,
              "Longitude": -73.991806,
              "CheckInTime": "2018-10-23T08:30:00Z"
            }
post/workorders/{workorderId}/universalCheckIn

Request

Path parameters

workorderIdinteger required

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

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.

UserIdinteger

The user ID of the technician that is checking in. 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 in. Default value: 1.

Latitudenumber double required

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

Longitudenumber double required

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

CheckInTimestring date-time

The date and time of the check-in. 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.

Actorstring

Optional, Actor

Response

The check-in 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.