...
status : ALL, ACTIVE, INACTIVE, DELETED
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)
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "6c892a1c-ca07-11e1-8c61-0026b9e7ff4c",
"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",
"startTime" : 1332216000000,
"endTime" : 1332219600000,
"expirationDate" : 1332219600000},
{"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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null},
...
]
} |
Get an Appointment
...
| 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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null} |
Get Current Appointment
This method will return the next future, active appointment that is not expired. If there is not a future appointment it will return the last active appointment based on date that hasn't been expired.
GET /ssp/api/1/person/{id}/appointment/current
...
| 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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null} |
Create an Appointment
POST /ssp/api/1/person/{id}/appointment
...
| 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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null} |
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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null} |
Returns
Appointment
| 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",
"startTime" : 1332326000000,
"endTime" : 1332339600000,
"expirationDate" : null} |
Delete an Appointment
DELETE /ssp/api/1/person/{id}/appointment/{id}
...