Financial Aid File API

Owned by James Stanley (Deactivated)
Last updated: Feb 17, 2014 by Jason ElwoodVersion comment
3 min read

Get All Financial Aid Files

GET /ssp/api/1/reference/financialAidFile

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":3,
"rows":[
{"id":"0a90940a-43dd-19d4-8143-e0ea430300df",
    "createdDate":1391047885571,
    "createdBy":
    {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052953346,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"FAFSA",
    "description":"FAFSA document",
    "code":"FAFSA"},
{"id":"0a90940a-43dd-19d4-8143-e0eab59600e1",
    "createdDate":1391047914902,
    "createdBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052974028,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"MARITAL STATUS",
    "description":"Proof of Marital Status",
    "code":"MARITAL"},
{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
    "createdDate":1391047901551,
    "createdBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052962817,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"RESIDENCY",
    "description":"Proof of Residency",
    "code":"RESIDENCY"}
  ]
}

 

Get a Financial Aid File

GET /ssp/api/1/reference/financialAidFile/{id}

Security

REFERENCE_READ

Returns

{"success":"true",
"message":"",
"results":3,
"rows":[
{"id":"0a90940a-43dd-19d4-8143-e0ea430300df",
    "createdDate":1391047885571,
    "createdBy":
    {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052953346,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"FAFSA",
    "description":"FAFSA document",
    "code":"FAFSA"}
  ]
}

 

Create a Financial Aid File

POST /ssp/api/1/reference/financialAidFile

Security

REFERENCE_WRITE

Sample Post

{"name":"RESIDENCY",
 "description":"Proof of Residency"}

Returns

{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
    "createdDate":1391047901551,
    "createdBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052962817,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"RESIDENCY",
    "description":"Proof of Residency",
    "code":"RESIDENCY"}
}

 

Save a Financial Aid File

PUT /ssp/api/1/reference/financialAidFile/{id}

Security

REFERENCE_WRITE

Sample Post

{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
    "createdDate":1391047901551,
    "createdBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052962817,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"RESIDENCY",
    "description":"Proof of Residency",
    "code":"RESIDENCY"}
}

Returns

{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
    "createdDate":1391047901551,
    "createdBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "modifiedDate":1391052962817,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"RESIDENCY",
    "description":"Proof of Residency",
    "code":"RESIDENCY"}
}

 

Delete a Financial Aid File

DELETE /ssp/api/1/reference/financialAidFile/{id}

Security

REFERENCE_WRITE

Returns

{"success" : "true"}

or

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