Versions Compared

Key

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

Get All

...

Marital Statuses

GET /ssp/api/1/reference/ethnicitymaritalStatus

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)

Returns

List<Ethnicity>List<MaritalStatus>

Code Block
[{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "description" : "African American/BlackDivorced",
  "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "name" : "African American/BlackDivorced",
  "objectStatus" : "ACTIVE"},
 {"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "description" : "Caucasian/WhiteMarried",
  "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "name" : "Caucasian/WhiteMarried",
  "objectStatus" : "ACTIVE"},
 ...
]

 

Get

...

a Marital Status

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

Returns

VeteranStatusMaritalStatus

Code Block
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Caucasian/WhiteMarried",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/WhiteMarried",
 "objectStatus" : "ACTIVE"}

 

Create

...

a Marital Status

POST /ssp/api/1/reference/ethnicitymaritalStatus

Sample Post

Code Block
{"description" : "VeteranMarried",
 "name" : "VeteranMarried"}

Returns

EthnicityMaritalStatus

Code Block
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Caucasian/WhiteMarried",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/WhiteMarried",
 "objectStatus" : "ACTIVE"}

 

Save

...

a Marital Status

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

Sample Post

Code Block
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Caucasian/WhiteMarried",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/WhiteMarried",
 "objectStatus" : "ACTIVE"}

Returns

EthnicityMaritalStatus

Code Block
{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Caucasian/WhiteMarried",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "name" : "Caucasian/WhiteMarried",
 "objectStatus" : "ACTIVE"}

 

Delete a

...

Marital Status

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

Returns

Code Block
{"ServiceResponse" : 
    {"success" : "true"}}

...