Races API

Owned by Jason Elwood
Last updated: Aug 28, 2013Version comment
1 min read

Get All Races

GET /ssp/api/1/reference/race

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",
"message":"",
"results":2,
"rows":
[{"id":"0a90940a-4097-1690-8140-97e1c70e0002",
"createdDate":1376937690894,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086525193,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"White",
"description":"White",
"code":"WHT"},
{"id":"0a90940a-4097-1690-8140-97f35519000f",
"createdDate":1376938841369,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086534223,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Hispanic",
"description":"Hispanic",
"code":"HSP"},
 ]
}

 

Get a Race

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

Security

SERVICE_REFERENCE_READ

Returns

Race

{[
{"id":"0a90940a-4097-1690-8140-97e1c70e0002",
"createdDate":1376937690894,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086525193,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"White",
"description":"White",
"code":"WHT"},
 ]}

 

Create a Race

POST /ssp/api/1/reference/race

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"description" : "White",
 "name" : "White",
 "code" : "WHT"}

Returns

Race

{[
{"id":"0a90940a-4097-1690-8140-97e1c70e0002",
"createdDate":1376937690894,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086525193,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"White",
"description":"White",
"code":"WHT"},]}

 

Save a Race

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

{[
{"id":"0a90940a-4097-1690-8140-97e1c70e0002",
"createdDate":1376937690894,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086525193,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"White",
"description":"White",
"code":"WHT"},
 ]}

Returns

Race

{[
{"id":"0a90940a-4097-1690-8140-97e1c70e0002",
"createdDate":1376937690894,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1377086525193,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"White",
"description":"White",
"code":"WHT"},
 ]}

 

Delete a Race

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

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

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