Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Current »

Get All Campuses

GET /ssp/api/1/reference/campus

Security

SERVICE_REFERENCE_READ

Parameters

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

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "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" : "Main Campus",
      "description" : "Main campus",
      "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"},
     {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "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" : "North Campus",
      "description" : "North campus",
      "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"},
     ...
    ]
}

 

Get a Campus

GET /ssp/api/1/reference/campus/{id}

Security

SERVICE_REFERENCE_READ

Returns

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "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" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

 

Create a Campus

POST /ssp/api/1/reference/campus

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"description" : "Main campus.",
 "name" : "Main Campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Returns

Campus

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "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" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

 

Save a Campus

PUT /ssp/api/1/reference/campus/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "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" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

Returns

Campus

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "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" : "Main Campus",
 "description" : "Main campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}

 

Delete a Campus

DELETE /ssp/api/1/reference/campus/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels