Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

...

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"}

...