Versions Compared

Old Version 5

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Security

PERSON_APPOINTMENT_READ

Parameters

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)

Returns

Code Block
{  
   "success" : "true",
   "message"results:"",
  : "100results":1,
   "rows":[  
:      [{{  
         "id" : "6c892a1c0a9001d0-ca074953-11e11033-8c61-0026b9e7ff4c"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",
 : "ACTIVE",        "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
         "startTime":1414472400000,
:  1332216000000,       "endTime":1414481400000,
         "attended": 1332219600000,false,
         "studentIntakeRequested":false,
         "expirationDate" : 1332219600000},intakeEmail":null
      }
   ]
}


Get an Appointment

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

Security

PERSON_APPOINTMENT_READ

Returns

Appointment

Code Block
{  
   {"id" : "467113550a9001d0-5a404953-41151033-b5b98149-0bd06986c9e1535416e80001",
   "createdDate":1414442260201,
   "createdBy" : 
{  
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
   
      "firstName" : "JohnAmy",
  
       "lastName" : "DoeAdministrator"},
      "createdDatefullName":"Amy Administrator"
:   1332216000000},
   "modifiedDate":1414442260201,
   "modifiedBy" : {  
       {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
  
       "firstName" : "JohnAmy",

         "lastName" : "DoeAdministrator"},
      "modifiedDatefullName":"Amy :Administrator"
1332216000000,   },
   "objectStatus" : "ACTIVE",
   "personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime" : 13323260000001414472400000,
  
   "endTime" : 13323396000001414481400000,
  
   "expirationDateattended" : null}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/{id}current

Security

PERSON_APPOINTMENT_READ

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"},
      "modifiedDatefullName":"Amy Administrator"
:   1332216000000},
   "objectStatus":"ACTIVE",
   "personId": "ACTIVE"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
: 1332326000000,  "endTime":1414481400000,
   "attended": 1332339600000,false,
   "studentIntakeRequested":false,
   "expirationDateintakeEmail" :null
null}

...


Create an Appointment

This method will return the next future appointment that is not expired.  If there is not a future appointment it will return the last appointment based on date that hasn't been expired.

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

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

Returns

Appointment

Security

PERSON_APPOINTMENT_WRITE

Sample Post

Code Block
{  
   "id":null,
:   "46711355-5a40-4115-b5b9-0bd06986c9e1",createdDate":null,
   "createdBy":{  
:      {"id":null,
      "firstName": "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstNamelastName" : "John",
      "lastNamefullName" :" "Doe"
   },
   "createdDatemodifiedDate":null,
: 1332216000000,  "modifiedBy":{ : 
      {"id":null,
: "91f46e39-cea8-422b-b215-00f6bcf5d280",     "firstName" : "John",
      "lastName" : "Doe"},
      "fullName":"modifiedDate "
  : 1332216000000},
   "objectStatus":"ACTIVE",
  : "ACTIVEpersonId":null,
   "startTime":1414472400000,
: 1332326000000,  "endTime":1414481400000,
: 1332339600000,  "expirationDateattended":false,
  : null}

...

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

Sample Post

Code Block
{"startTime" : 1332326000000,
 "endTime" : 1332339600000"studentIntakeRequested":true,
   "intakeEmail":""
}

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",
   "personId": "ACTIVE"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
: 1332326000000,  "endTime":1414481400000,
   "attended": 1332339600000,false,
   "studentIntakeRequested":false,
   "expirationDateintakeEmail" :null
null}


Save an Appointment

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

Security

PERSON_APPOINTMENT_WRITE

Sample Post

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",
 "personId": "ACTIVE"77fdcb55-05e8-4508-9461-5004b811dbcd",
 "startTime" : 13323260000001414472400000,
 "endTime":1414481400000,
 "attended": 1332339600000false,
 "studentIntakeRequested":false,
 "expirationDateintakeEmail" :null
null}

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",
   "personId": "ACTIVE"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
: 1332326000000,  "endTime":1414481400000,
   "attended": 1332339600000,false,
   "studentIntakeRequested":false,
   "expirationDateintakeEmail" :null
null}

 

Delete an Appointment

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

Security

PERSON_APPOINTMENT_DELETE

Returns

Code Block
{"success" : "true"}

...