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 4 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

List<Campus>

[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "Main Campus",
  "description" : "Main campus"},
 {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "North Campus",
  "description" : "North campus"},
 ...
]

 

 

### Get a Campus

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

### Returns

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Main Campus",
"description" : "Main campus"}

***

### Create a Campus

POST /ssp/api/1/reference/campus

### Sample Post

{"description" : "Main campus.",
"name" : "Main Campus"}

### Returns

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Main Campus",
"description" : "Main campus"}

***

### Save a Campus

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

### Sample Post

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Main Campus",
"description" : "Main campus"}

### Returns

{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Main Campus",
"description" : "Main campus"}

***

### Delete a Campus

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

### Returns

{"ServiceResponse" :
{"success" : "true"}}

or

{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}}

  • No labels