Get All Marital Statuses
GET /ssp/api/1/reference/maritalStatus
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)
Returns
List<MaritalStatus>
{"success" : "true",
"results" : "100",
"rows" :
[{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Divorced",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Divorced",
"objectStatus" : "ACTIVE"},
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Married",
"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Married",
"objectStatus" : "ACTIVE"},
...
]
}
Get a Marital Status
GET /ssp/api/1/reference/maritalStatus/{id}
Security
SERVICE_REFERENCE_READ
Returns
MaritalStatus
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Married",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Married",
"objectStatus" : "ACTIVE"}
Create a Marital Status
POST /ssp/api/1/reference/maritalStatus
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"description" : "Married",
"name" : "Married"}
Returns
MaritalStatus
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Married",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Married",
"objectStatus" : "ACTIVE"}
Save a Marital Status
PUT /ssp/api/1/reference/maritalStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Married",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Married",
"objectStatus" : "ACTIVE"}
Returns
MaritalStatus
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Married",
"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Married",
"objectStatus" : "ACTIVE"}
Delete a Marital Status
DELETE /ssp/api/1/reference/maritalStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"ServiceResponse" :
{"success" : "true"}}
or
{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}}