addAppointmentV1

Deprecated

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

Legacy V1 was fixed-appointment-only (resourceId mandatory). Payload structure has changed; consult the new request schema.

Open POST /v1/appointments in the new API →

View legacy reference

/rest/rs/addAppointment/

POST

Adds fixed appointment with given activities to a job. Uses override priorities to allow to book conflicting appointments.

acceptable request representations:

• application/json

{
    "jobRef" : "1234",
    "activities" : [{"id":"3"}, {"id":"42"}], //list of unassigned activity ids
    "startDate" : "12/02/2012",
    "startTime" : "9:23",
    "duration" : "60", //in minutes
    "resourceId" : "253", 
    "notes": "Additional app required due to ..."

}

success response representation:

• application/json

{
    "appoitnemntId" : "1234",
    "result" : "success",
    "result_msg" : ""
}

error response representation:

• application/json

{
    "appoitnemntId" : "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.