...
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
| Code Block |
|---|
{
"success" : "true",
"resultsmessage" : "100",
"rowsresults" :1,
[{"idrows":[ :
"6c892a1c-ca07-11e1-8c61-0026b9e7ff4c", { "createdBy" :
{"id" : "91f46e390a9001d0-cea84953-422b1033-b2158149-00f6bcf5d280535416e80001",
"firstNamecreatedDate" : "John"1414442260201,
"lastNamecreatedBy" : "Doe"},
"createdDate" : 1332216000000,
:{
"modifiedBy" : {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate" : 1332216000000, "objectStatusfullName" :"Amy Administrator"ACTIVE",
"startTime" : 2013-04-13T00:00:00 },
"endTimemodifiedDate" : 2013-04-13T00:30:00:1414442260201,
"attended" : true}, {"idmodifiedBy" : "46711355-5a40-4115-b5b9-0bd06986c9e1",{
"createdBy" :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"createdDate" : 1332216000000, "modifiedByfullName" :"Amy Administrator"
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
},
"firstNameobjectStatus" : "JohnACTIVE",
"lastNamepersonId" : "Doe"}"77fdcb55-05e8-4508-9461-5004b811dbcd",
"modifiedDatestartTime" :1414472400000,
1332216000000, "objectStatus" : "ACTIVEendTime":1414481400000,
"startTimeattended":false,
: 2013-04-13T00:00:00, "endTimestudentIntakeRequested":false,
: 2013-04-13T00:30:00, "attendedintakeEmail" :null
false}, ...}
]
} |
Get an Appointment
GET /ssp/api/1/person/{id}/appointment/{id}
...
Returns
Appointment
| Code Block |
|---|
{
"id" : "467113550a9001d0-5a404953-41151033-b5b98149-0bd06986c9e1535416e80001",
"createdDate":1414442260201,
"createdBy":{
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName":"Administrator",
"fullName":"Amy "Doe"Administrator"
},
"createdDatemodifiedDate":1414442260201,
: 1332216000000, "modifiedBy":{ :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate "fullName":"Amy Administrator"
: 1332216000000},
"objectStatus" : "ACTIVE",
"startTimepersonId" : 2013-04-13T00:00:00,:"77fdcb55-05e8-4508-9461-5004b811dbcd",
"startTime":1414472400000,
"endTime":1414481400000,
"attended": 2013-04-13T00:30:00,
"attended" : falsefalse,
"studentIntakeRequested":false,
"intakeEmail":null
} |
Get Current Appointment
This method will return the appointment with the most recent modifiedDate.
...
Returns
Appointment
| Code Block |
|---|
{
"id" : "467113550a9001d0-5a404953-41151033-b5b9-0bd06986c9e1"8149-535416e80001",
"createdDate":1414442260201,
"createdBy":{
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName":"Administrator",
"fullName":"Amy "Doe"Administrator"
},
"createdDatemodifiedDate":1414442260201,
: 1332216000000, "modifiedBy":{
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate "fullName":"Amy Administrator"
: 1332216000000},
"objectStatus" : "ACTIVE",
"startTimepersonId" : 2013-04-13T00:00:00,
"endTime" : 2013-04-13T00:30:00,
"attended" : false:"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.
...
PERSON_APPOINTMENT_WRITE
Sample Post
| Code Block |
|---|
{ "id":null, "createdDate":null, "createdBy":{ "id":null, "firstName":"", "lastName":"", "fullName":" " }, "modifiedDate":null, "modifiedBy":{"startTime" : 2013-04-13T00:00:00, "endTime" : 2013-04-13T00:30:00, "id":null, "firstName":"", "lastName":"", "fullName":" " }, "objectStatus":"ACTIVE", "personId":null, "startTime":1414472400000, "endTime":1414481400000, "attended":false, "studentIntakeRequested": falsetrue, "intakeEmail":"" } |
Returns
Appointment
| Code Block |
|---|
{
"id" : "467113550a9001d0-5a404953-41151033-b5b98149-0bd06986c9e1535416e80001",
"createdDate":1414442260201,
"createdBy":{
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName":"Administrator",
"fullName":"Amy "Doe"Administrator"
},
"createdDatemodifiedDate":1414442260201,
: 1332216000000, "modifiedBy":{ :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate" : 1332216000000 "fullName":"Amy Administrator"
},
"objectStatus" : "ACTIVE",
"startTimepersonId" : 2013-04-13T00:00:00,:"77fdcb55-05e8-4508-9461-5004b811dbcd",
"startTime":1414472400000,
"endTime":1414481400000,
"attended": 2013-04-13T00:30:00,false,
"studentIntakeRequested":false,
"attendedintakeEmail" :null
false} |
Save an Appointment
PUT /ssp/api/1/person/{id}/appointment/{id}
...
| Code Block |
|---|
{"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",
"startTimepersonId" : 2013-04-13T00:00:00:"77fdcb55-05e8-4508-9461-5004b811dbcd",
"startTime":1414472400000,
"endTime":1414481400000,
"attended": 2013-04-13T00:30:00false,
"studentIntakeRequested":false,
"attendedintakeEmail" :null
false} |
Returns
Appointment
| Code Block |
|---|
{
"id" : "467113550a9001d0-5a404953-41151033-b5b9-0bd06986c9e1",
8149-535416e80001",
"createdDate":1414442260201,
"createdBy":{
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName":"Administrator",
"fullName":"Amy "Doe"Administrator"
},
"createdDatemodifiedDate":1414442260201,
: 1332216000000, "modifiedBy":{ :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate" : 1332216000000 "fullName":"Amy Administrator"
},
"objectStatus" : "ACTIVE",
"startTimepersonId" : 2013-04-13T00:00:00:"77fdcb55-05e8-4508-9461-5004b811dbcd",
"startTime":1414472400000,
"endTime":1414481400000,
"attended": 2013-04-13T00:30:00false,
"studentIntakeRequested":false,
"attendedintakeEmail" :null
false} |
Delete an Appointment
DELETE /ssp/api/1/person/{id}/appointment/{id}
...