Description
Configuration is where install specific data will be housed. This will represent a single row in a Configuration database table. A default Configuration record will be loaded on initial startup/deployment of the SSP application.
Get Configuration
GET /ssp/api/1/reference/configuration
Security
SERVICE_REFERENCE_READ
Returns
Configuration
{"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",
"defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"documentStorageLocation" : "C:\SSP\Documents",
"institutionName" : "Sinclair Community College",
"termToRepresentEarlyAlert" : "Early Alert"}
Save Configuration
PUT /ssp/api/1/reference/configuration/{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",
"defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"documentStorageLocation" : "C:\SSP\Documents",
"institutionName" : "Sinclair Community College",
"termToRepresentEarlyAlert" : "Early Alert"}
Returns
Configuration
{"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",
"defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"documentStorageLocation" : "C:\SSP\Documents",
"institutionName" : "Sinclair Community College",
"termToRepresentEarlyAlert" : "Early Alert"}