Blurb (Intake Labels) API

Owned by Jason Elwood
Last updated: Feb 17, 2014Version comment
2 min read

Get All Blurb Items

GET /ssp/api/1/blurb

Security

REFERENCE_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{"success":"true",
"message":"",
"results":76,
"rows":[
{"id":"1a92f3e6-9364-4e6f-8388-aee95a3af55d",
    "createdDate":1383004800000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1392057427677,
    "modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Intake Tab 1 Label",
    "description":"Person tab label",
    "code":"intake.tab1.label",
    "value":"Personal Info"},
{"id":"343eede9-b777-4d63-84f7-c65c71eee052",
    "createdDate":1383004800000,
    "createdBy":{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1392057462648,
    "modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
    "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Intake Tab 2 Label",
    "description":"Demographics tab label",
    "code":"intake.tab2.label",
    "value":"Demo Info"},
{"id":"eb189389-3112-4214-85c2-c406c773d245",
    "createdDate":1383004800000,
    "createdBy":{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1391282363730,
    "modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Intake Childcare Arrangements Label",
    "description":"",
    "code":"intake.tab2.label.childcare-arrangements",
    "value":"1-If yes, what are your childcare arrangements?"},
    ...
  ]
}

 

Save a Blurb Item

PUT /ssp/api/1/blurb/{id}

Security

REFERENCE_WRITE

Sample Post

{"id":"1a92f3e6-9364-4e6f-8388-aee95a3af55d",
    "createdDate":"2013-10-28T20:00:00",
    "modifiedDate":"2014-02-10T13:37:07",
    "name":"Intake Tab 1 Label",
    "description":"Person tab label",
    "value":"Personal Info",
    "code":"intake.tab1.label",
    "createdBy":{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "active":true}

Returns

{"id":"1a92f3e6-9364-4e6f-8388-aee95a3af55d",
    "createdDate":"2013-10-28T20:00:00",
    "createdBy":{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":"2014-02-10T13:37:07",
    "modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Intake Tab 1 Label",
    "description":"Person tab label",
    "value":"Personal Info",
    "code":"intake.tab1.label"
}