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 10 Next »

Get All Campuses

GET /ssp/api/1/reference/campus

Parameters

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

{"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",
      "earlyAlertRoutings" :
         [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
           "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
           "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
           "groupName" : null,
           "groupEmail" : null},
          {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
           "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
           "personId" : null,
           "groupName" : "Excessive Absences Email Group",
           "groupEmail" : "excessive-absences@university.edu"},
          ...
         ]},
     {"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",
      "earlyAlertRoutings" :
         [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
           "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
           "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
           "groupName" : null,
           "groupEmail" : null},
          {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
           "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
           "personId" : null,
           "groupName" : "Excessive Absences Email Group",
           "groupEmail" : "excessive-absences@university.edu"},
          ...
         ]},
     ...
    ]
}

 

Get a Campus

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

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",
 "earlyAlertRoutings" :
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

 

Create a Campus

POST /ssp/api/1/reference/campus

Sample Post

{"description" : "Main campus.",
 "name" : "Main Campus",
 "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "earlyAlertRoutings" :
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

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",
 "earlyAlertRoutings" :
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

 

Save a Campus

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

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",
 "earlyAlertRoutings" :
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

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",
 "earlyAlertRoutings" :
    [{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
      "earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
      "groupName" : null,
      "groupEmail" : null},
     {"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
      "earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "personId" : null,
      "groupName" : "Excessive Absences Email Group",
      "groupEmail" : "excessive-absences@university.edu"},
     ...
    ]
}

 

Delete a Campus

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

Returns

{"success" : "true"}

or

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