Delete

Delete a calendar booking

Delete

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacalendar.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesID or UUID"calDiaryInternal":56568

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/calendar.json?&version=6&action=delete&input={
  "data": [
    {
      "calDiaryInternal": 56568
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/calendar.json?&version=6&action=delete&input={
  "data": [
    {
      "calDiaryInternal": 56568
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "calUniqueSelect": "16/0050015.001#16/W0000000918##16/ALT",
      "calEstimatedSelect": 0,
      "calBookedSelect": 7.5,
      "calRemainingSelect": -7.5,
      "calTimesheetsSelect": 7,
      "calDraftSelect": 0,
      "calInitialsSelect": "MP",
      "calDiaryInternal": 56568,
      "calUuid": "DE97D556CB0EF444993F1CD594B18444"
    }
  ]
}