Versions Compared

Key

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

...

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

Returns

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "cb9ae287-0b28-4a3b-aece-2c6d1d974443",

     "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",   
    "name" : "High School Transcript",
   
  "note" : "This is Billy's high school transcript from Oakwood High School",
   
  "confidentialityLevel" : "EVERYONE"},

    {"id" : "3a9d3bee-1acf-4af2-92b6-10bf6d6b4da0",
 
    "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",
  
   "name" : "Email",
   
  "note" : "Email received from Billy on 04/12/12 outlining struggles during Spring term.",
   
  "confidentialityLevel" : "EVERYONE"},

    ...
 
  ]
}

Get a Document 

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

...