Get All Veteran Statuses
GET /ssp/api/1/reference/veteranStatus
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
{"success" : "true", "results" : "100", "rows" : [{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Dependent of Veteran", "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Dependent of Veteran", "objectStatus" : "ACTIVE"}, {"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Veteran", "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Veteran", "objectStatus" : "ACTIVE"}, ... ] }
Get a Veteran Status
GET /ssp/api/1/reference/veteranStatus/{id}
Security
SERVICE_REFERENCE_READ
Returns
VeteranStatus
{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Veteran", "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Veteran", "objectStatus" : "ACTIVE"}
Create a Veteran Status
POST /ssp/api/1/reference/veteranStatus
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"description" : "Veteran", "name" : "Veteran"}
Returns
VeteranStatus
{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Veteran", "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Veteran", "objectStatus" : "ACTIVE"}
Save a Veteran Status
PUT /ssp/api/1/reference/veteranStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "name" : "Main Campus", "description" : "Main campus"}
Returns
VeteranStatus
{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Veteran", "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Veteran", "objectStatus" : "ACTIVE"}
Delete a Veteran Status
DELETE /ssp/api/1/reference/veteranStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"ServiceResponse" : {"success" : "true"}}
or
{"ServiceResponse" : {"success" : "false", "message" : "Message when success is false."}}