Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Get All

...

Marital Statuses

GET /ssp/api/1/reference/ethnicitymaritalStatus

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<Ethnicity>List<MaritalStatus>

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"createdBy" : 
        {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "African American/BlackDivorced",
      "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "modifiedBy" : 
        {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "African American/BlackDivorced",
      "objectStatus" : "ACTIVE"},
     {"createdBy" : 
        {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "Caucasian/WhiteMarried",
      "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "modifiedById    "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Caucasian/WhiteMarried",
      "objectStatus" : "ACTIVE"},
     ...
    ]
}

 

Get

...

a Marital Status

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

Security

SERVICE_REFERENCE_READ

Returns

VeteranStatusMaritalStatus

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

 

Create

...

a Marital Status

POST /ssp/api/1/reference/ethnicitymaritalStatus

Security

SERVICE_REFERENCE_WRITE

Sample Post

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

Returns

EthnicityMaritalStatus

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

 

Save

...

a Marital Status

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

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

Returns

EthnicityMaritalStatus

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

 

Delete a

...

Marital Status

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

Security

SERVICE_REFERENCE_WRITE

Returns

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

...