...
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" success: "6201b18d-9d1d-48d3-82d4-092e52ad676btrue",
message: "createdBy",
results: 13,
rows: [
{"id" : "91f46e39e99ff3c7-cea86a59-422b4812-b215b3b1-00f6bcf5d280285fa8764d3a",
createdDate: 1337878800000,
"firstName" createdBy: "John",
{id: "lastName" 58ba5ee3-734e-4ae9-b9c5-943774b4de41",
firstName: "DoeSystem"},
lastName: "createdDateAdministrator"},
modifiedDate: "1332216000000"1337878800000,
" modifiedBy" :
{"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"firstName" : "JohnSystem",
lastName: "Administrator"},
"lastName" objectStatus: "DoeACTIVE"},
"modifiedDate" name: "1332216000000inst_name",
"objectStatus" description: "ACTIVEInstitution name",
"defaultEarlyAlertCoordinatorPersonId" value: "91f46e39-cea8-422b-b215-00f6bcf5d280My Edu",
"documentStorageLocation" valueValidation: "C:\SSP\Documents"null,
"institutionName" defaultValue: "SinclairMy Community CollegeEdu",
"termToRepresentEarlyAlert" sortOrder: "Early Alert"} |
Save Configuration
...
99}
]
}
|
Get Configuration by Parameter
GET /ssp/api/1/reference/configuration/{id}config?name='parameter'
Security
SERVICE_REFERENCE_WRITESample PostREAD
Returns
Configuration Values by Parameters
| Code Block |
|---|
{"id" : "6201b18d59dbcf48-9d1d9be3-48d311e1-82d4bded-092e52ad676b0026b9e7ff4c",
createdDate: 1336417200000,
"createdBy" :
{"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"firstName" firstName: "JohnSystem",
"lastName" lastName: "DoeAdministrator"},
"createdDate" modifiedDate: "1332216000000"1336417200000,
"modifiedBy" :
{"id" : "91f46e3958ba5ee3-cea8734e-422b4ae9-b215b9c5-00f6bcf5d280943774b4de41",
"firstName" firstName: "JohnSystem",
"lastName" lastName: "DoeAdministrator"},
objectStatus:
"modifiedDateACTIVE",
name: "1332216000000bcc_email_address",
description: "objectStatus" : "ACTIVE",
"defaultEarlyAlertCoordinatorPersonId" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"documentStorageLocation" : "C:\SSP\Documents",
"institutionName" : "Sinclair Community College",
"termToRepresentEarlyAlert" : "Early Alert"} |
Returns
Configuration
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}
Note that default values cannot be modified via this resource.
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdByname" : "bcc_email_address",
{"iddescription" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
The email address to blind carbon copy on every message",
"value": "noone@test.com",
"valueValidation": null,
"sortOrder": 100} |
Returns
Configuration
| Code Block |
|---|
{"id" : "91f46e396201b18d-cea89d1d-422b48d3-b21582d4-00f6bcf5d280092e52ad676b",
"firstNamename" : "Johnbcc_email_address",
"lastNamedescription" : "Doe"},The email address to "modifiedDate"blind : "1332216000000",
"objectStatus" : "ACTIVE"carbon copy on every message",
"defaultEarlyAlertCoordinatorPersonIdvalue" : "91f46e39-cea8-422b-b215-00f6bcf5d280noone@test.com",
"documentStorageLocationvalueValidation" : "C:\SSP\Documents"null,
"institutionNamesortOrder" : "Sinclair Community College",
"termToRepresentEarlyAlert" : "Early Alert"100} |