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/config
Security
SERVICE_REFERENCE_READ
Returns
All Configuration Values
{id: "e99ff3c7-6a59-4812-b3b1-285fa8764d3a",
createdDate: 1337878800000,
createdBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
modifiedDate: 1337878800000,
modifiedBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
objectStatus: "ACTIVE",
name: "inst_name",
description: "Institution name",
value: "My Edu",
valueValidation: null,
defaultValue: "My Edu",
sortOrder: 99}
Get Configuration by Parameter
GET /ssp/api/1/reference/config?name='parameter'
Security
SERVICE_REFERENCE_READ
Returns
Configuration Values by Parameters
{id: "59dbcf48-9be3-11e1-bded-0026b9e7ff4c",
createdDate: 1336417200000,
createdBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
modifiedDate: 1336417200000,
modifiedBy:
{id: "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "System",
lastName: "Administrator"},
objectStatus: "ACTIVE",
name: "bcc_email_address",
description: "The email 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/config/{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",
"coachSetFromExternalData" : false}
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",
"coachSetFromExternalData" : false}