...
GET /ssp/api/1/reference/citizenship
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>return
limit : Maximum number of results to return<br>return
sort : Property name<br>name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
List<Citizenship>
| Code Block |
|---|
| Code Block |
{"success" : "true", "results" : "100", "rows" : [{"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "International.", "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "International", "objectStatus" : "ACTIVE"}, {"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "description" : "Naturalized Citizen.", "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "1332216000000", "name" : "Naturalized Citizen", "objectStatus" : "ACTIVE"}, ... ] } |
Get a Citizenship
GET /ssp/api/1/reference/citizenship/{id}
Security
SERVICE_REFERENCE_READ
Returns
Citizenship
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Naturalized Citizen.",
"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Naturalized Citizen",
"objectStatus" : "ACTIVE"} |
...
POST /ssp/api/1/reference/citizenship
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"description" : "Naturalized Citizen",
"name" : "Naturalized Citizen"} |
...
PUT /ssp/api/1/reference/citizenship/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Naturalized Citizen.",
"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Naturalized Citizen",
"objectStatus" : "ACTIVE"} |
...
DELETE /ssp/api/1/reference/citizenship/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...