Get All Journal Sources
GET /ssp/api/1/reference/journalSource
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",
"results" : "100",
"rows" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Appointment",
"description" : "Appointment."},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Email",
"description" : "Email."},
...
]
}
Get one Journal Source
GET /ssp/api/1/reference/journalSource/{id}
Security
SERVICE_REFERENCE_READ
Returns
JournalSource
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Appointment",
"description" : "Appointment."}
Create a Journal Source
POST /ssp/api/1/reference/journalSource
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"name" : "Appointment",
"description" : "Appointment."}
Returns
JournalSource
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Appointment",
"description" : "Appointment."}
Save a Journal Source
PUT /ssp/api/1/reference/journalSource/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Appointment",
"description" : "Appointment."}
Returns
JournalSource
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "1332216000000",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Appointment",
"description" : "Appointment."}
Delete a Journal Source
DELETE /ssp/api/1/reference/journalSource/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}