Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Get All Funding Sources

GET /ssp/api/1/reference/fundingSource

Parameters

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

Returns

List<FundingSource>

[{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "description" : "Assistance Needed",
  "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "name" : "Assistance Needed",
  "objectStatus" : "ACTIVE"},
 {"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "description" : "Military Tuition Assistance",
  "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "name" : "Military Tuition Assistance",
  "objectStatus" : "ACTIVE"},
 ...
]

 

Get a Funding Source

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

Returns

FundingSource

{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Military Tuition Assistance",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Military Tuition Assistance",
 "objectStatus" : "ACTIVE"}

 

Create a FundingSource

POST /ssp/api/1/reference/fundingSource

Sample Post

{"description" : "Military Tuition Assistance",
 "name" : "Military Tuition Assistance"}

Returns

FundingSource

{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Military Tuition Assistance",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Military Tuition Assistance",
 "objectStatus" : "ACTIVE"}

 

Save a Funding Source

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

Sample Post

{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Military Tuition Assistance",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Military Tuition Assistance",
 "objectStatus" : "ACTIVE"}

Returns

FundingSource

{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Military Tuition Assistance",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Military Tuition Assistance",
 "objectStatus" : "ACTIVE"}

 

Delete a Funding Source

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

Returns

{"success" : "true"}

or

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