Confidentiality Level API

Owned by Alexander Leader
Last updated: Jun 18, 2014 by Jason Elwood
3 min read

Changelog:

  • Datapermission changed to permission in v2.5.0

Get All Confidentiality Levels

GET /ssp/api/1/reference/confidentialityLevel

Note

Filter by assigned user confidentiality levels

Security

SERVICE_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":12,
"rows":[
{"id":"b2d077a7-4055-0510-7957-4a09f93a0346",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1381508171405,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Academic Resource Center",
    "description":"",
	"acronym":"ARC",
    "permission":"DATA_ACADEMIC_RESOURCE_CENTER"},{
"id":"b2d07935-5056-a51a-80db-caa0dadd3f2e",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1337281200000,
    "modifiedBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Counseling Services",
    "description":"",
	"acronym":"CNSL",
    "permission":"DATA_COUNSELING_SERVICES"},
    ...
  ]
}

 

Get a Confidentiality Level

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

Security

SERVICE_REFERENCE_READ

Returns

ConfidentialityLevel

{"id":"b2d077a7-4055-0510-7957-4a09f93a0346",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1381508171405,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Academic Resource Center",
    "description":"",
	"acronym":"ARC",
    "permission":"DATA_ACADEMIC_RESOURCE_CENTER"}

 

Create a ConfidentialityLevel

POST /ssp/api/1/reference/confidentialityLevel

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"name":"Athletics",
    "description":"Athletics Department",
    "acronym":"ATH",
    "permission":"DATA_CL_01"}

Returns

ConfidentialityLevel

{"id":"b2d077a7-4055-0510-7957-4a09f93a0346",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1381508171405,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Athletics",
    "description":"Athletics Department",
	"acronym":"ATH",
    "permission":"DATA_CL_01"}

 

Save a ConfidentialityLevel

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"id":"b2d077a7-4055-0510-7957-4a09f93a0346",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1381508171405,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Athletics",
    "description":"Athletics Department",
	"acronym":"ATH",
    "permission":"DATA_CL_01"}

Returns

ConfidentialityLevel

{"id":"b2d077a7-4055-0510-7957-4a09f93a0346",
    "createdDate":1337281200000,
    "createdBy":
        {"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
        "firstName":"System",
        "lastName":"Administrator"},
    "modifiedDate":1381508171405,
    "modifiedBy":
        {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "firstName":"Amy",
        "lastName":"Administrator"},
    "objectStatus":"ACTIVE",
    "name":"Athletics",
    "description":"Athletics Department",
	"acronym":"ATH",
    "permission":"DATA_CL_01"}

 

Delete a Confidentiality Level

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

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}