Success Indicator Evaluation API

Get Success Indicator Evaluation Criteria

GET /ssp/api/1/ssp/api/1/reference/successIndicator

Security

REFERENCE_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{
  "success": "true",
  "message": "",
  "results": 10,
  "rows": [
    {
      "id": "c12b49f8-594b-11e4-bdb3-406c8f22c3ce",
      "createdDate": 1413892800000,
      "createdBy": {
        "id": "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName": "System",
        "lastName": "Administrator",
        "fullName": "System Administrator"
      },
      "modifiedDate": 1414800734196,
      "modifiedBy": {
        "id": "0a0f1071-4961-18f7-8149-61e9de180005",
        "firstName": "Amy",
        "lastName": "Administrator",
        "fullName": "Amy Administrator"
      },
      "objectStatus": "ACTIVE",
      "name": "GPA",
      "description": "Cumulative grade point average",
      "modelCode": "system.student",
      "modelName": "Student Indicators",
      "indicatorGroup": "STUDENT",
      "code": "system.student.gpa",
      "instruction": "Evaluated against the value of external_student_transcript.grade_point_average.\n\nTypically evaluated with a SCALE rule.",
      "evaluationType": "SCALE",
      "scaleEvaluationHighFrom": 3,
      "scaleEvaluationHighTo": 4,
      "scaleEvaluationMediumFrom": 2.5,
      "scaleEvaluationMediumTo": 2.99,
      "scaleEvaluationLowFrom": 0,
      "scaleEvaluationLowTo": 2.49,
      "stringEvaluationHigh": "",
      "stringEvaluationMedium": "",
      "stringEvaluationLow": "",
      "noDataExistsEvaluation": "DEFAULT",
      "noDataMatchesEvaluation": "DEFAULT",
      "sortOrder": 10
    },
    {
      "id": "707fe4d1-594d-11e4-90be-406c8f22c3ce",
      "createdDate": 1413892800000,
      "createdBy": {
        "id": "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName": "System",
        "lastName": "Administrator",
        "fullName": "System Administrator"
      },
      "modifiedDate": 1413892800000,
      "modifiedBy": {
        "id": "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName": "System",
        "lastName": "Administrator",
        "fullName": "System Administrator"
      },
      "objectStatus": "ACTIVE",
      "name": "Registered",
      "description": "Current and future term registration status",
      "modelCode": "system.student",
      "modelName": "Student Indicators",
      "indicatorGroup": "STUDENT",
      "code": "system.student.registration",
      "instruction": "Evaluated against the values found in external_term and external_registration_status_by_term.\n\nPossible values: 'NONE', 'CURRENT', 'FUTURE', 'CURRENT_AND_FUTURE'.\n\nTypically evaluated with a STRING rule matching on those values. If the system is unaware of any current and\/or future terms, this indicator has no value. If those terms do exist, but user has zero registrations in them, this indicator's value is 'NONE'.",
      "evaluationType": "STRING",
      "scaleEvaluationHighFrom": null,
      "scaleEvaluationHighTo": null,
      "scaleEvaluationMediumFrom": null,
      "scaleEvaluationMediumTo": null,
      "scaleEvaluationLowFrom": null,
      "scaleEvaluationLowTo": null,
      "stringEvaluationHigh": "CURRENT,FUTURE,CURRENT_AND_FUTURE",
      "stringEvaluationMedium": null,
      "stringEvaluationLow": "NONE",
      "noDataExistsEvaluation": "DEFAULT",
      "noDataMatchesEvaluation": "LOW",
      "sortOrder": 20
    }
  ]
}

Get a Success Indicator Evaluation

GET /ssp/api/1/ssp/api/1/reference/successIndicator/<uuid>

Security

REFERENCE_READ

Returns

{
  "id": "",
  "createdDate": null,
  "modifiedDate": null,
  "objectStatus": "ACTIVE",
  "name": "New Indicator",
  "description": "This is a new indicator description",
  "modelCode": "new.model.1",
  "modelName": "New Model",
  "indicatorGroup": "RISK",
  "code": "new.indicator.1",
  "instruction": "These are instructions for the new indicator",
  "evaluationType": "SCALE",
  "scaleEvaluationHighFrom": 10,
  "scaleEvaluationHighTo": null,
  "scaleEvaluationMediumFrom": 7,
  "scaleEvaluationMediumTo": 9,
  "scaleEvaluationLowFrom": null,
  "scaleEvaluationLowTo": 6,
  "stringEvaluationHigh": "",
  "stringEvaluationMedium": "",
  "stringEvaluationLow": "",
  "noDataExistsEvaluation": "DEFAULT",
  "noDataMatchesEvaluation": "LOW",
  "sortOrder": 180,
  "createdBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  },
  "modifiedBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  }
}

Create a Success Indicator Evaluation

POST /ssp/api/1/ssp/api/1/reference/successIndicator

Security

REFERENCE_WRITE

Sample Post

{"description" : "College Degree - 2 Year",
 "name" : "College Degree - 2 Year"}

Returns

{
  "id": "",
  "createdDate": null,
  "modifiedDate": null,
  "objectStatus": "ACTIVE",
  "name": "New Indicator",
  "description": "This is a new indicator description",
  "modelCode": "new.model.1",
  "modelName": "New Model",
  "indicatorGroup": "RISK",
  "code": "new.indicator.1",
  "instruction": "These are instructions for the new indicator",
  "evaluationType": "SCALE",
  "scaleEvaluationHighFrom": 10,
  "scaleEvaluationHighTo": null,
  "scaleEvaluationMediumFrom": 7,
  "scaleEvaluationMediumTo": 9,
  "scaleEvaluationLowFrom": null,
  "scaleEvaluationLowTo": 6,
  "stringEvaluationHigh": "",
  "stringEvaluationMedium": "",
  "stringEvaluationLow": "",
  "noDataExistsEvaluation": "DEFAULT",
  "noDataMatchesEvaluation": "LOW",
  "sortOrder": 180,
  "createdBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  },
  "modifiedBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  }
}

Save a Success Indicator Evaluation

PUT /ssp/api/1/ssp/api/1/reference/successIndicator/<uuid>

Security

REFERENCE_WRITE

Sample Post

{
  "id": "7f000001-4977-1bd3-8149-7802a8930000",
  "createdDate": "2014-11-03T16:34:40",
  "modifiedDate": "2014-11-03T16:34:40",
  "objectStatus": "ACTIVE",
  "name": "New Indicator Edit",
  "description": "This is an edited indicator description",
  "modelCode": "new.model.1.edit",
  "modelName": "New Model Edit",
  "indicatorGroup": "RISK",
  "code": "new.indicator.1.edit",
  "instruction": "These are edited instructions for the edited indicator",
  "evaluationType": "SCALE",
  "scaleEvaluationHighFrom": 10.1,
  "scaleEvaluationHighTo": null,
  "scaleEvaluationMediumFrom": 7.1,
  "scaleEvaluationMediumTo": 9.1,
  "scaleEvaluationLowFrom": null,
  "scaleEvaluationLowTo": 6.1,
  "stringEvaluationHigh": "",
  "stringEvaluationMedium": "",
  "stringEvaluationLow": "",
  "noDataExistsEvaluation": "LOW",
  "noDataMatchesEvaluation": "LOW",
  "sortOrder": 190,
  "createdBy": {
    "id": "0a0f1071-4961-18f7-8149-61e9de180005",
    "firstName": "Amy",
    "lastName": "Administrator"
  },
  "modifiedBy": {
    "id": "0a0f1071-4961-18f7-8149-61e9de180005",
    "firstName": "Amy",
    "lastName": "Administrator"
  }
}

Returns

{
  "id": "",
  "createdDate": null,
  "modifiedDate": null,
  "objectStatus": "ACTIVE",
  "name": "New Indicator",
  "description": "This is an edited indicator description",
  "modelCode": "new.model.1",
  "modelName": "New Model",
  "indicatorGroup": "RISK",
  "code": "new.indicator.1",
  "instruction": "These are edited instructions for the edited indicator",
  "evaluationType": "SCALE",
  "scaleEvaluationHighFrom": 10.1,
  "scaleEvaluationHighTo": null,
  "scaleEvaluationMediumFrom": 7.1,
  "scaleEvaluationMediumTo": 9.1,
  "scaleEvaluationLowFrom": null,
  "scaleEvaluationLowTo": 6.1,
  "stringEvaluationHigh": "",
  "stringEvaluationMedium": "",
  "stringEvaluationLow": "",
  "noDataExistsEvaluation": "DEFAULT",
  "noDataMatchesEvaluation": "LOW",
  "sortOrder": 190,
  "createdBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  },
  "modifiedBy": {
    "id": "",
    "firstName": "",
    "lastName": ""
  }
}

Delete a Success Indicator Evaluation

DELETE /ssp/api/1/ssp/api/1/reference/successIndicator/<uuid>

Security

REFERENCE_WRITE

Returns

{"success" : "true"}

or

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