...
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/configurationconfig
Security
SERVICE_REFERENCE_READ
Returns
All Configuration Values
| Code Block |
|---|
{"id" : "6201b18de99ff3c7-9d1d6a59-48d34812-82d4b3b1-092e52ad676b285fa8764d3a",
createdDate: 1337878800000,
"createdBy" :
{"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"firstName" firstName: "System",
lastName: "JohnAdministrator"},
modifiedDate: 1337878800000,
modifiedBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "lastNameSystem",
lastName: "DoeAdministrator"},
objectStatus:
"ACTIVE",
name: "createdDateinst_name",
description: "1332216000000Institution name",
value: "My Edu"modifiedBy",
valueValidation: null,
defaultValue: "My Edu",
sortOrder: 99}
{"id" |
Get Configuration by Parameter
GET /ssp/api/1/reference/config?name='parameter'
Security
SERVICE_REFERENCE_READ
Returns
Configuration Values by Parameters
| Code Block |
|---|
{id: "91f46e3959dbcf48-cea89be3-422b11e1-b215bded-00f6bcf5d2800026b9e7ff4c", createdDate: 1336417200000, createdBy: {id: "firstName" "58ba5ee3-734e-4ae9-b9c5-943774b4de41", firstName: "JohnSystem", "lastName" lastName: "DoeAdministrator"}, modifiedDate: "modifiedDate" 1336417200000, modifiedBy: {id: "133221600000058ba5ee3-734e-4ae9-b9c5-943774b4de41", firstName: "objectStatusSystem", lastName: "ACTIVEAdministrator"}, objectStatus: "defaultEarlyAlertCoordinatorPersonIdACTIVE", name: "91f46e39-cea8-422b-b215-00f6bcf5d280bcc_email_address", description: "documentStorageLocation"The : "C:\SSP\Documents", "institutionName" : "Sinclair Community College", "termToRepresentEarlyAlert" : "Early Alert", "coachSetFromExternalData" : falseemail address to blind carbon copy on every message", value: "noone@test.com", valueValidation: null, defaultValue: "noone@test.com", sortOrder: 100} |
Save Configuration
PUT /ssp/api/1/reference/configurationconfig/{id}
Security
SERVICE_REFERENCE_WRITE
...