Skip to content

completeAppointment

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to PATCH /v1/appointments/{id} in the new API; the migration guide has the recommended order of work and the important model differences.

Two-call migration:

sequenceDiagram
    autonumber
    participant Client
    participant API as Oneserve API
    Client->>API: PATCH /v1/appointments/{id}<br/>{status: COMPLETED,<br/>actualStartDate, actualEndDate}
    API-->>Client: 200 OK
    Client->>API: POST /v1/jobs/{jobId}/notes<br/>{date, notes: "completed by ..."}
    API-->>Client: 201 Created

actualEndDate replaces the legacy URL-positional {cDate}. The noted-by user (legacy notedId) is now implicit from the JWT — capture any human context in the note body on step 2.

Open PATCH /v1/appointments/{id} in the new API →

View legacy reference

/rest/rs/completeAppointment/{appointmentId}/{notedId}/{cDate}

POST
Completes an appointment.


success response representation:

  • application/json
{
    "result" : "success",
    "result_msg" : ""
}


error response representation:

  • application/json
{
    "appointmentId" : "1234",
    "result" : "fail",
    "result_msg" : "<Oneserve error code>",
    "result_error_msg" : "<Oneserve error details>"

}


Notes 

See the Resource Scheduler API matrix for the full list of endpoints in this category.