Appointment API

Owned by Alexander Leader
Last updated: Oct 27, 2014 by Jason Elwood
4 min read

Get All Appointments

GET /ssp/api/1/person/{id}/appointment

Security

PERSON_APPOINTMENT_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{  
   "success":"true",
   "message":"",
   "results":1,
   "rows":[  
      {  
         "id":"0a9001d0-4953-1033-8149-535416e80001",
         "createdDate":1414442260201,
         "createdBy":{  
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "modifiedDate":1414442260201,
         "modifiedBy":{  
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "objectStatus":"ACTIVE",
         "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
         "startTime":1414472400000,
         "endTime":1414481400000,
         "attended":false,
         "studentIntakeRequested":false,
         "intakeEmail":null
      }
   ]
}


Get an Appointment

GET /ssp/api/1/person/{id}/appointment/{id}

Security

PERSON_APPOINTMENT_READ

Returns

Appointment

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1414442260201,
   "modifiedBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":false,
   "intakeEmail":null
}


Get Current Appointment

This method will return the appointment with the most recent modifiedDate.

GET /ssp/api/1/person/{id}/appointment/current

Security

PERSON_APPOINTMENT_READ

Returns

Appointment

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1414442260201,
   "modifiedBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":false,
   "intakeEmail":null
}


Create an Appointment

Appointments in the past are not allowed and will throw an exception.

POST /ssp/api/1/person/{id}/appointment

Security

PERSON_APPOINTMENT_WRITE

Sample Post

{  
   "id":null,
   "createdDate":null,
   "createdBy":{  
      "id":null,
      "firstName":"",
      "lastName":"",
      "fullName":" "
   },
   "modifiedDate":null,
   "modifiedBy":{  
      "id":null,
      "firstName":"",
      "lastName":"",
      "fullName":" "
   },
   "objectStatus":"ACTIVE",
   "personId":null,
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":true,
   "intakeEmail":""
}

Returns

Appointment

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1414442260201,
   "modifiedBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":false,
   "intakeEmail":null
}


Save an Appointment

PUT /ssp/api/1/person/{id}/appointment/{id}

Security

PERSON_APPOINTMENT_WRITE

Sample Post

{"id" : "46711355-5a40-4115-b5b9-0bd06986c9e1",
 "createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},
 "createdDate" : 1332216000000,
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "objectStatus":"ACTIVE",
 "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
 "startTime":1414472400000,
 "endTime":1414481400000,
 "attended":false,
 "studentIntakeRequested":false,
 "intakeEmail":null
}

Returns

Appointment

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1414442260201,
   "modifiedBy":{  
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":false,
   "intakeEmail":null
}

 

Delete an Appointment

DELETE /ssp/api/1/person/{id}/appointment/{id}

Security

PERSON_APPOINTMENT_DELETE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}