Page Comparison

...

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",
   "resultsmessage" : "100",
   "rowsresults" : 
1,
   [{"createdByrows" : [  
       {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", 
         "firstNameid" : "John"0a9001d0-4953-1033-8149-535416e80001",
          "lastNamecreatedDate" :1414442260201,
"Doe"},       "createdDate" : "1332216000000createdBy",:{  
    "description" : "International.",       "id" : "6201b18d0a90940a-9d1d3efc-48d3175f-82d4813e-092e52ad676bfc1ac581000b",
      "modifiedBy" :           {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280","firstName":"Amy",
            "firstNamelastName" : "JohnAdministrator",
            "lastNamefullName" :"Amy Administrator"Doe"},
       "modifiedDate" : "1332216000000"},
       "objectStatus" : "ACTIVEmodifiedDate":1414442260201,
       "name" : "Earn a 2.0 Fall Term",
 modifiedBy":{  
  "confidentialityLevel" :          {"id" : "c57f11e10a90940a-7ef23efc-4989175f-9ac2813e-7b0690563995fc1ac581000b",
            "namefirstName" : "EVERYONEAmy"},
      },      {"createdByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280","Administrator",
            "createdDatefullName" :"Amy Administrator"1332216000000",
       "description" : "Graduate"},
         "idobjectStatus" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"ACTIVE",
         "modifiedByIdpersonId" : "91f46e3977fdcb55-cea805e8-422b4508-b2159461-00f6bcf5d2805004b811dbcd",
       "modifiedDate" : "1332216000000startTime":1414472400000,
      "objectStatus"  : "ACTIVEendTime":1414481400000,
      "name" : "Graduate",
      "confidentialityLevelattended" :false,
         {"idstudentIntakeRequested" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
:false,
         "nameintakeEmail" :null
"EVERYONE"}      },
     ...
    ]
}

...

Get an Appointment

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

Security

PERSON_APPOINTMENT_READ

Returns

Appointment

Code Block

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{  
:      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
  "createdDate" : "1332216000000",  "descriptionfullName" :"Amy Administrator"Naturalized Citizen."
   },
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",modifiedDate":1414442260201,
   "modifiedBy":{ : 
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
      "modifiedDatefullName" :"Amy "1332216000000"Administrator"
   },
   "objectStatus" : "ACTIVE",
   "namepersonId" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" :
:"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   {"idattended":false,
  : "c57f11e1-7ef2-4989-9ac2-7b0690563995"studentIntakeRequested":false,
     "nameintakeEmail" :null
"EVERYONE"}
}

Get Current Appointment

This method will return the next future appointment. If there is not a future appointment set it will return the last appointment based on dateappointment with the most recent modifiedDate.

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

Security

PERSON_APPOINTMENT_READ

Returns

Appointment

Code Block

{  
   "id":"0a9001d0-4953-1033-8149-535416e80001",
   "createdDate":1414442260201,
   "createdBy":{ : 
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
 "createdDate"  : "1332216000000",  "descriptionfullName" :"Amy Administrator"Naturalized Citizen."
   },
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",modifiedDate":1414442260201,
   "modifiedBy":{  :
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
      "modifiedDatefullName" :"Amy "1332216000000"Administrator"
   },
   "objectStatus" : "ACTIVE",
   "namepersonId" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" ::"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
    {"idattended":false,
  : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 studentIntakeRequested":false,
   "nameintakeEmail" :null
"EVERYONE"}
}

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

Code Block

{"confidentialityLevel" :  
   "id":null,
   "createdDate":null,
   "createdBy":{  
    {  "id":null,
      "firstName":"",
      "lastName":"",
  "c57f11e1-7ef2-4989-9ac2-7b0690563995",    "fullName":" "
   },
   "modifiedDate":null,
   "modifiedBy":{  
      "nameid":null,
      "firstName":"",
"EVERYONE"},
 "name" : "Earn a 2.0 Fall Term",
 "description" : "Earn a 2.0 Fall Term"      "lastName":"",
      "fullName":" "
   },
   "objectStatus":"ACTIVE",
   "personId":null,
   "startTime":1414472400000,
   "endTime":1414481400000,
   "attended":false,
   "studentIntakeRequested":true,
   "intakeEmail":""
}

Returns

Appointment

Code Block

{  
   "id" : "5a8ecb010a9001d0-e5994953-45a21033-8d698149-5e53aff3a4bc535416e80001",
   "createdDate":1414442260201,
: "2008-04-09T12:07:56",  "createdBy":{  
:      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
      "descriptionfullName" :"Amy Administrator"Earn
a 2.0 Fall Term"},
   "modifiedDate":1414442260201,
: "2008-04-09T12:07:56",  "modifiedBy":{ : 
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"},
"objectStatus"   : "Active",  "namefullName" :"Amy Administrator"Earn
a 2.0 Fall Term"},
   "confidentialityLevelobjectStatus" :"ACTIVE",
    {"idpersonId" : "c57f11e177fdcb55-7ef205e8-49894508-9ac2-7b0690563995"9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
   "name" : "EVERYONE"}attended":false,
   "studentIntakeRequested":false,
   "intakeEmail":null
}

Save an Appointment

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

Security

PERSON_APPOINTMENT_WRITE

Sample Post

Code Block

{"id" : "5a8ecb0146711355-e5995a40-45a24115-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56b5b9-0bd06986c9e1",
 "createdBy" :  
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",

    "firstName" : "John",

    "lastName" : "Doe"}, 
 "modifiedDatecreatedDate" : "2008-04-09T12:07:56"1332216000000,
 "modifiedBy" :  
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "descriptionmodifiedDate" : "Earn a 2.0 Fall Term"1332216000000,
 "objectStatus" : "ActiveACTIVE",
 "namepersonId" : "Earn a 2.0 Fall Term"77fdcb55-05e8-4508-9461-5004b811dbcd",
 "confidentialityLevelstartTime" :
 1414472400000,
  {"idendTime":1414481400000,
: "c57f11e1-7ef2-4989-9ac2-7b0690563995"attended":false,
     "namestudentIntakeRequested":false,
: "EVERYONEintakeEmail"}:null
}

Returns

Appointment

Code Block

{  
   "id" : "5a8ecb010a9001d0-e5994953-45a21033-8d698149-5e53aff3a4bc535416e80001",
   "createdDate":1414442260201,
: "2008-04-09T12:07:56",  "createdBy":{ : 
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName":"Administrator",
      "fullName":"Amy "Doe"Administrator"
   }, 
   "modifiedDate":1414442260201,
: "2008-04-09T12:07:56",  "modifiedBy":{ : 
      {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
      "firstName" : "JohnAmy",
      "lastName" : "DoeAdministrator"}, 
      "descriptionfullName" :"Amy Administrator"Earn
a 2.0 Fall Term"},
   "objectStatus" : "ActiveACTIVE",
   "namepersonId" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" ::"77fdcb55-05e8-4508-9461-5004b811dbcd",
   "startTime":1414472400000,
   "endTime":1414481400000,
    {"idattended":false,
:   "c57f11e1-7ef2-4989-9ac2-7b0690563995"studentIntakeRequested":false,
     "nameintakeEmail" :null
"EVERYONE"}
}

Delete an Appointment

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

Security

PERSON_APPOINTMENT_DELETE

Returns

Code Block
{"success" : "true"}

...

Versions Compared

Old Version 1

New Version Current

Key

Get an Appointment

Get Current Appointment

Create an Appointment

Save an Appointment

Delete an Appointment