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

« Previous Version 5 Current »

Get All Ethnicities

GET /ssp/api/1/reference/ethnicity

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" : "African American/Black",
      "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "African American/Black",
      "objectStatus" : "ACTIVE"},
     {"createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "Caucasian/White",
      "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Caucasian/White",
      "objectStatus" : "ACTIVE"},
     ...
    ]
}

 

Get an Ethnicity

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

Security

SERVICE_REFERENCE_READ

Returns

VeteranStatus

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Caucasian/White",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/White",
 "objectStatus" : "ACTIVE"}

 

Create an Ethnicity

POST /ssp/api/1/reference/ethnicity

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"description" : "Veteran",
 "name" : "Veteran"}

Returns

Ethnicity

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Caucasian/White",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/White",
 "objectStatus" : "ACTIVE"}

 

Save an Ethnicity

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Caucasian/White",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/White",
 "objectStatus" : "ACTIVE"}

Returns

Ethnicity

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Caucasian/White",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/White",
 "objectStatus" : "ACTIVE"}

 

Delete a Ethnicity

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

Security

SERVICE_REFERENCE_WRITE

Returns

{"ServiceResponse" : 
    {"success" : "true"}}

or

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