Get All FinancialAidFilesAll Financial Aid Files
GET /ssp/api/1/reference/financialAidFile
Security
SERVICE_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
| Code Block |
|---|
{"success" : "true",
"resultsmessage" :"",
"100results":3,
"rows":[
{"id":"0a90940a-43dd-19d4-8143-e0ea430300df",
[{"createdBycreatedDate" :1391047885571,
"createdBy":
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate":1391052953346,
"createdDate" : "1332216000000modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"descriptionfirstName" : "African American/BlackAmy",
"idlastName" : "6201b18d-9d1d-48d3-82d4-092e52ad676b""Administrator"},
"objectStatus":"ACTIVE",
"modifiedBy" : "name":"FAFSA",
"description":"FAFSA document",
"code":"FAFSA"},
{"id" : "91f46e390a90940a-cea843dd-422b19d4-b2158143-00f6bcf5d280e0eab59600e1",
"createdDate":1391047914902,
"firstNamecreatedBy" :
"John", {"lastNameid" : "Doe"}"0a90940a-3efc-175f-813e-fc1ac581000b",
"modifiedDatefirstName" : "1332216000000Amy",
"namelastName" : "African American/BlackAdministrator"},
"objectStatusmodifiedDate" : "ACTIVE"}1391052974028,
{"createdBymodifiedBy" :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"objectStatus":"ACTIVE",
"createdDatename" :"MARITAL "1332216000000STATUS",
"description" : "Caucasian/White":"Proof of Marital Status",
"code":"MARITAL"},
{"id" : "c57f11e10a90940a-7ef243dd-498919d4-9ac28143-7b0690563995e0ea816f00e0",
"createdDate":1391047901551,
"modifiedBycreatedBy" :
{"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDate":1391052962817,
"modifiedDatemodifiedBy":
: "1332216000000", {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"namefirstName" : "Caucasian/WhiteAmy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name": "ACTIVERESIDENCY"},
"description":"Proof of Residency",
... "code":"RESIDENCY"}
]
} |
Get
...
a Financial Aid File
GET /ssp/api/1/reference/financialaidfilefinancialAidFile/{id}
Security
SERVICE_REFERENCE_READ
Returns
VeteranStatus
| Code Block |
|---|
{"success"createdBy:"true",
"message":"",
"results":3,
"rows":[
{"id" : "91f46e390a90940a-cea843dd-422b19d4-b2158143-00f6bcf5d280e0ea430300df",
"firstNamecreatedDate" ::1391047885571,
"JohncreatedBy",:
{"lastNameid" : "Doe"},"0a90940a-3efc-175f-813e-fc1ac581000b",
"createdDatefirstName" : "1332216000000Amy",
"descriptionlastName" : "Caucasian/WhiteAdministrator"},
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b"modifiedDate":1391052953346,
"modifiedBy":
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDateobjectStatus" : "1332216000000ACTIVE",
"name":"FAFSA",
"description":"FAFSA document"Caucasian/White",
"objectStatuscode" : "ACTIVE"FAFSA"}
]
} |
Create
...
a Financial Aid File
POST /ssp/api/1/reference/financialaidfilefinancialAidFile
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"descriptionname" : "VeteranRESIDENCY",
"description"name:"Proof :of "VeteranResidency"} |
ReturnsFinancialAidFile
| Code Block |
|---|
{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
"createdDate":1391047901551,
"createdBy":
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"createdDatemodifiedDate" : "1332216000000"1391052962817,
"description" : "Caucasian/White", "idmodifiedBy" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" : {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDateobjectStatus" : "1332216000000ACTIVE",
"name":"RESIDENCY",
"description":"Proof "Caucasian/White"of Residency",
"objectStatuscode" : "ACTIVERESIDENCY"}
} |
Save
...
a Financial Aid File
PUT /ssp/api/1/reference/financialAidFile/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
"createdDate":1391047901551,
"createdBy":
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"createdDatemodifiedDate" : "1332216000000"1391052962817,
"description" : "Caucasian/White", "idmodifiedBy" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" : {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDateobjectStatus" : "1332216000000ACTIVE",
"name":"RESIDENCY",
"description": "Caucasian/White"Proof of Residency",
"objectStatuscode" : "ACTIVERESIDENCY"}
} |
Returns
FinancialAidFile
| Code Block |
|---|
{"id":"0a90940a-43dd-19d4-8143-e0ea816f00e0",
"createdDate":1391047901551,
"createdBy":
: {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"createdDatemodifiedDate" : "1332216000000"1391052962817,
"description" : "Caucasian/White", "idmodifiedBy" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" : {"id" : "91f46e390a90940a-cea83efc-422b175f-b215813e-00f6bcf5d280fc1ac581000b",
"firstName" : "JohnAmy",
"lastName" : "DoeAdministrator"},
"modifiedDateobjectStatus" : "1332216000000ACTIVE",
"name":"RESIDENCY",
"description": "Caucasian/White"Proof of Residency",
"objectStatuscode" : "ACTIVERESIDENCY"}
} |
Delete a FinancialAidFilea Financial Aid File
DELETE /ssp/api/1/reference/financialAidFile/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"ServiceResponse" : {"success" : "true"}} |
or
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}} |