CSM API Documentation
API Endpoint
https://example-csm.symplicity.com/api/publicThe CSM API service is designed based on RESTful principles. All responses will be in JSON format and have a response code. Please review the Getting Started page in the Symplicity Developer site to learn how to use the APIs and see instructional videos that cover advanced topics such as custom fields, picklists, and pulling reports.
Call Limits
-
Rate limiting of the API’s are per-token basis. There are three effective rate limiters
-
100 calls with a leak rate of 10 calls per second. If your app averages up to 10 calls per second it will never receive a “429 Rate Limit Exceeded Error”.
-
10,000 calls for a period of 24 hours, which will reset at midnight.
-
1 bulk/batch update call at a time.
-
-
All Responses will consists of 3 rate limiting headers
-
X-Rate-Limit-Limit : Total rate limit for all calls in a day
-
X-Rate-Limit-Remaining : The number of requests left for the day
-
X-Rate-Limit-Reset : Time before the rate limit resets in UTC
-
Authentication
All routes require Authentication header with a word Token followed by an encrypted token. Please contact your Symplicity Help Desk to receive your tokens.
- Authentication Schema
- Token Authentication Header
- Authorization: Token Rj1QOCWLK6vMKoL…cqyfAgYjZoqrh9a9XVmU=
- Token Authentication Header
Restrictions
Only Symplicity customers and third party companies who are official Partners within the Symplicity Partner Program can access API(s).
-
Partner may not use or install the API(s) for any other purpose without Symplicity’s written consent, and may not copy, rent, adapt, disassemble, lease, assign, sublicense, reverse engineer, modify or decompile, the API(s) or any part thereof or attempt to utilize any APIs which are not published for use by members of the Program. Partner may not utilize the APIs to provide data from the APIs to third party applications except those third parties with valid API licenses with Symplicity.
-
Partner may not utilize data provided from a Symplicity API to publish student or user data on any publicly accessible website or within a directory of such students or users or to sell, rent or otherwise provide such student or user data to third parties.
-
Partner may not utilize data provided from a Symplicity API to market or send communications to any student or user of Symplicity products unless Partner has obtained the explicit consent of each such individual in advance of such marketing and communications activity.
Field Types Output Format
-
id (string): The ID of the model. Usually a 32 characters string. Sample: “5576f3049b65ae931e7c751bb90c51be”
-
boolean (boolean): true, false, or null (in cases null is allowed)
-
string (string): Sample: “Foo Bar”. Empty states “”, null allowed.
-
integer (number): Whole number without a decimal point. Sample: 49
-
decimal (string): Number with a decimal point that can not be represented as “floating point” because it requires precision. Sample: “3.61”
-
date (string): Date strings when time is not relevant. Sample: “2017-01-09”
-
time (string): Time strings when date is not relevant. Sample: “14:40:30”
-
datetime (string): Full datetime string in UTC format. Sample: “2017-01-09T14:40:30Z”
-
PickValue (object): Format for our system picklists. NULL if blank. If array of picklist values, [] if blank. Sample: {“id”: “0200”, “label”: “English Literature”}
-
RelationObject (object): short representation of a relational model with id, label and a route link. Sample: {“id”: “fda2e610c637622a808adf8f49d20517”, “label”: “Diane Riemer”, “link”: “/api/public/v1/staff/fda2e610c637622a808adf8f49d20517”}
Required Fields
POST statements must include data for required fields for the object type being created. PUT statements require inclusion of required field data only if the record being updated lacks data for the required field. Error will be presented if required field data is missing.
Configuration Dependent Fields
Certain fields will only be available if the specific instance is configured to support the field. See the individual models and their list of fields for more details.
Custom Fields
Adding customFields=1 parameter to any request adds a customFields array with all custom fields defined on a current instance. When writing to records with custom fields, no special parameters are required.
Custom fields vary by instance. Available custom field names can be found indirectly by using a get statement to pull an object of a given type, or directly by using a fields route documented below and checking the fieldCustom attribute.
Name Parsing
API calls impacting record name fields will be handled as follows. If only fullName is provided, it is parsed to first/middle/lastName. If first/middle/lastName fields are sent, but without full name, the fullName field is constructed. If full/first/middle/lastName are all provided, no parsing/construction occurs. If fullName and only some of the other name fields are provided, the missing name fields will be populated. Error will be presented if name components are not correctly provided. If attempting to PUT any firstName/middleName/lastName fields, it is also necessary to include fullName.
Datetime and filtering
Datetime fields which are presented in UTC have the standard “Z” timezone designation (e.g., 2019-01-09T14:40:30Z). When these fields are used in list filters, a range of two date or datetime strings can be used: ["2019-01-09T14:40:30Z","2019-01-09T15:00:00Z"]. If only a date part of the string is used, the first date in the range is assumed to have the time of “00:00:00”, and the second date in the range “23:59:59” (also in UTC.)
MSE Affiliations
For Multi School Environment instances, the affiliations array indicates the association between the record and the specific schools within the Multi School Environment.
Bulk Requests (Deprecated)
Note: Bulk requests will eventually be replaced by batch requests (see below) which supports processing ten times more records in a payload and improves system performance. Multi-record PUT/POST calls should follow the batch request method.
Adding bulk=1 parameter to a PUT/POST request indicates that the request takes the form of a bulk payload which can include up to 100 records in a single POST/PUT request. The bulk payload is an array of regular request objects. The response to a bulk payload request will contain a responses attribute, which is an array of object responses sequenced in the same order as the objects were presented in the payload. If any payload record updates fail, corresponding objects in the responses array will include errors or messages attribute.
Specific create (POST) bulk records in a payload are identical to regular create requests. Update (PUT) bulk request are different from regular update requests in that id of the record to update is not indicated in the route itself, but rather in each individual request in the array, along with other regular payload fields.
Batch Requests
Adding batch=1 parameter to a PUT/POST request indicates that the request takes the form of a batch payload which can include up to 1,000 records in a single POST/PUT request. The batch payload is an array of regular request objects. The response to a batch payload request will contain a status attribute, which can have a value of pending or processing and a results_url attribute, which is an api route. A GET request to the results_url route returns the current status of the batch request along with an array of responses if the process is complete. There are also className and total attributes similar to list responses.
Specific create (POST) batch records in a payload are identical to regular create requests. Update (PUT) batch request are different from regular update requests in that id of the record to update is not indicated in the route itself, but rather in each individual request in the array, along with other regular payload fields.
Object Fields ¶
Get Object Fields ¶
GET https://example-csm.symplicity.com/api/public/v1/fields/students
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"apiField": "name",
"objectType": "employer",
"fieldName": "name",
"fieldLabel": "Organization Name",
"fieldType": "general",
"fieldCustom": false
},
{
"apiField": "customField",
"objectType": "employer",
"fieldName": "custom_field",
"fieldLabel": "Custom Label",
"fieldType": "picklist",
"fieldCustom": true
}
]Get Object FieldsGET/v1/fields/{objectType}
Type of the field indicated here is the internal CSM field type. Public API fields are not always in a one-to-one relationship to their internal counterparts, so some discrepancies are expected.
URI Parameters
- objectType
string(required) Example: studentstype of the object to get the data from
Choices:
studentscontactsemployersjobsstaffaddressesfacultycareerfairscounselpronetcareer-outcomesocr-schedulesinfo-sessionsworkshopsexperiential-learningexperiential-learning-work-termemployer-registrationsnetwork-employer-registrationscalendar-events
Employer ¶
Employers are the recruiting organizations within a CSM system. Employers have a profile presence in the system, and various record types tie back to the employer. For instance, jobs are tied to employers in the system. Each organization can have one or more contacts in the system who are the system users who manage the organization’s recruiting activities.
Employer ¶
GET https://example-csm.symplicity.com/api/public/v1/employers?keywords=&active=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=name
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "employer",
"models": [
{
"id": "abc123",
"label": "",
"name": "",
"description": "",
"alias": "",
"importedId": "",
"taxId": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"parent": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"primaryContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": "",
"website": "",
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List EmployersGET/v1/employers{?keywords,active,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- active
number(optional)Filter Active Employers. Active Employers have current job postings or interview schedules.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: nameName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/employers/772c21111e8865b1ecc83b999caa4d2a
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"parent": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"primaryContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": string,
"website": string,
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type. Available only on a Symplicity Recruit Network Instance"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Parent"
},
"primaryContact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Primary Contact"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"overview": {
"type": "string",
"description": "Overview"
},
"website": {
"type": "string",
"description": "Web Site"
},
"industries": {
"type": "array",
"description": "Industries"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name",
"primaryContact"
]
}Get EmployerGET/v1/employers/{id}
URI Parameters
- id
string(required) Example: 772c21111e8865b1ecc83b999caa4d2aid of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/employers/industries
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Agriculture"
},
{
"id": "2",
"value": "Arts & Design"
},
{
"id": "3",
"value": "Information Technology"
},
{
"id": "4",
"value": "Media/Publishing"
},
{
"id": "5",
"value": "Sports/Fitness"
}
]Get Picklist keys and valuesGET/v1/picklists/employers/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: industriesname of a pick field
Choices:
industriesaccountManagertype
POST https://example-csm.symplicity.com/api/public/v1/employers
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"name": "Symplicity Corporation",
"alias": "Symplicity",
"importedId": "symp300",
"taxId": "67-3841259",
"type": "3",
"parent": "772c21111e8865b1ecc83b999caa4d2a",
"overview": "Symplicity is a cloud-based software platform designed for higher education institutions.",
"website": "http://symplicity.com",
"industries": [
"4"
],
"accountManager": "1",
"address": {
"street": "4040 Wilson Blvd #300",
"city": "Arlington",
"zip": "22203",
"state": "US-VA",
"country": "US"
},
"primaryContact": {
"salutation": "Mr.",
"firstName": "John",
"middleName": "Barry",
"lastName": "Old",
"fullName": "John Barry Old",
"suffix": "Jr.",
"title": "Senior Developer",
"email": "johnbold@test.com",
"importedId": "JBD890",
"types": [
4,
5
],
"phone": "458-990-1356",
"fax": "458-990-1359",
"cellPhone": "202-456-2300",
"website": "https://symplicity.com",
"employerDescription": "The market leader in student experience software",
"services": [
"profile",
"jobs"
],
"blockUserEmails": true,
"blockCampaignEmails": true,
"address": {
"street": "100 Main Street",
"city": "Purceville",
"zip": 20134,
"state": "US-VA",
"country": "US"
}
}
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"parent": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"primaryContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": string,
"website": string,
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type. Available only on a Symplicity Recruit Network Instance"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Parent"
},
"primaryContact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Primary Contact"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"overview": {
"type": "string",
"description": "Overview"
},
"website": {
"type": "string",
"description": "Web Site"
},
"industries": {
"type": "array",
"description": "Industries"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name",
"primaryContact"
]
}Create EmployerPOST/v1/employers
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema.
PUT https://example-csm.symplicity.com/api/public/v1/employers/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"name": "Symplicity Corp."
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"parent": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"primaryContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": string,
"website": string,
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type. Available only on a Symplicity Recruit Network Instance"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Parent"
},
"primaryContact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Primary Contact"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"overview": {
"type": "string",
"description": "Overview"
},
"website": {
"type": "string",
"description": "Web Site"
},
"industries": {
"type": "array",
"description": "Industries"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name",
"primaryContact"
]
}Update EmployerPUT/v1/employers/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/employers?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"name": "Acme, Inc.",
"importedId": "def456",
"taxId": "67-3841259",
"primaryContact": {
"firstName": "Mary",
"middleName": "Jane",
"lastName": "New",
"title": "Office Manager",
"email": "maryjnew@test.com"
},
"overview": "Acme Incorporated...",
"type": "1",
"accountManager": "1"
},
{
"name": "Employer with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create EmployersPOST/v1/employers?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"name": "",
"description": "",
"alias": "",
"importedId": "",
"taxId": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"parent": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"primaryContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": "",
"website": "",
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Update ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/employers?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"name": "Symplicity Corporation"
},
{
"id": "def456",
"name": "Acme Incorporated"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update EmployersPUT/v1/employers?batch=1
Employer Registration ¶
Employer Registrations are new contact/employer account requests that are pending administrative access approval. Note, CSM systems can be configured to automatically approve incoming contact/employer account registrations.
Employer Registration ¶
GET https://example-csm.symplicity.com/api/public/v1/employer-registrations?keywords=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=name
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "employer_registration",
"models": [
{
"id": "abc123",
"label": "",
"name": "",
"description": "",
"alias": "",
"importedId": "",
"taxId": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Employer RegistrationsGET/v1/employer-registrations{?keywords,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: nameName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/employer-registrations/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"types": {
"type": "array",
"description": "Types"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name"
]
}Get Employer RegistrationGET/v1/employer-registrations/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/employer-registrations/types
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": 1,
"value": "Staff"
},
{
"id": 2,
"value": "Alumnus"
},
{
"id": 3,
"value": "Recruiter"
},
{
"id": 4,
"value": "Teacher / Employee"
},
{
"id": 5,
"value": "Sponsor"
}
]Get Picklist keys and valuesGET/v1/picklists/employer-registrations/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typesname of a pick field
Choices:
typesaccountManager
Network Employer Registrations ¶
CSM instances can be set up to integrate with a variety of employer centered recruiting networks (e.g., Symplicity Recruit, CareerHub-Australia, CareerHub-UK, etc.). As employers within these recruiting networks want to begin recruiting at a CSM, a Network Registration (Employer/Contact) record is created at the targetted CSM instance. This API route allows the partner networks to send new network employers/contacts to CSM instances. CSM’s settings determine the network registration record’s approval status when received. Some schools choose to automatically approve these accounts, others review each registration.
Network Employer Registrations ¶
GET https://example-csm.symplicity.com/api/public/v1/network-employer-registrations?keywords=&network=&lastModified=["2020-11-22","2021-11-21"]&employerTaxId=705713639&employerImportedId=AX3456005&page=1&perPage=10&sort=fullName
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "contact",
"models": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"salutation": "",
"title": "",
"suffix": "",
"email": "",
"importedId": "",
"phone": "",
"cellPhone": "",
"fax": "",
"website": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"arpAccount": "",
"employer": {
"id": "abc123",
"label": "",
"name": "",
"description": "",
"alias": "",
"importedId": "",
"taxId": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": "",
"website": "",
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"jobBannerImage": "",
"hideFromStudents": false,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Network Employer RegistrationsGET/v1/network-employer-registrations{?keywords,network,lastModified,employerTaxId,employerImportedId,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- network
string(optional)Filter collection by network.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- employerTaxId
string(optional) Example: 705713639Filter collection by Employer Tax ID.
- employerImportedId
string(optional) Example: AX3456005Filter collection by Employer Imported ID.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: fullNameName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/network-employer-registrations/999networkcontact000333bbb444ddd
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"salutation": string,
"title": string,
"suffix": string,
"email": string,
"importedId": string,
"phone": string,
"cellPhone": string,
"fax": string,
"website": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"arpAccount": string,
"employer": {
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": string,
"website": string,
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"jobBannerImage": string,
"hideFromStudents": true,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": string
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"title": {
"type": "string",
"description": "Title"
},
"suffix": {
"type": "string",
"description": "Suffix"
},
"email": {
"type": "string",
"description": "Email"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"phone": {
"type": "string",
"description": "Phone"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network"
},
"networkStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network Status"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"services": {
"type": "array",
"description": "Services"
},
"arpAccount": {
"type": "string",
"description": "ARP Account. Available only on a Symplicity Recruit Network Instance"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type. Available only on a Symplicity Recruit Network Instance"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network"
},
"networkStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network Status"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"overview": {
"type": "string",
"description": "Overview"
},
"website": {
"type": "string",
"description": "Web Site"
},
"industries": {
"type": "array",
"description": "Industries"
},
"jobBannerImage": {
"type": "string",
"description": "Job Banner Image. Available only on a Symplicity Recruit Network Instance"
},
"hideFromStudents": {
"type": "boolean",
"description": "Hide from Students"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name"
],
"description": "Employer"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email",
"employer"
]
}Get Network Employer RegistrationGET/v1/network-employer-registrations/{id}
URI Parameters
- id
string(required) Example: 999networkcontact000333bbb444dddid of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/network-employer-registrations/network
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "recruit",
"value": "Symplicity Recruit"
}
]Get Picklist keys and valuesGET/v1/picklists/network-employer-registrations/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: networkname of a pick field
Choices:
affiliationsnetworknetworkStatustypesservices
POST https://example-csm.symplicity.com/api/public/v1/network-employer-registrations
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"salutation": "Ms.",
"firstName": "Natalie",
"middleName": "Sue",
"lastName": "Reggie",
"fullName": "Natalie Sue Reggie",
"suffix": "Jr.",
"title": "Executive Director",
"email": "natreggie3@test.com",
"phone": "248-762-0356",
"cellPhone": "703-762-0356",
"fax": "248-762-0357",
"importedId": "NSR56",
"network": "recruit",
"arpAccount": "OS-997",
"website": "https://www.test.com",
"types": [
2,
5
],
"services": [
"jobs",
"alum",
"cf"
],
"affiliations": [
"MNC-CSM"
],
"employer": {
"name": "Network Corp",
"alias": "NetWork",
"importedId": "JKL812",
"taxId": "712-3456789",
"type": "3",
"description": "Network Registration Employer",
"overview": "Network Registration Employer Profile",
"website": "https://www.test.com",
"industries": [
"4"
],
"accountManager": "1",
"address": {
"street": "3003 Wilson Blvd",
"city": "Arlington",
"zip": "22202",
"state": "US-VA",
"country": "US"
}
}
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"salutation": string,
"title": string,
"suffix": string,
"email": string,
"importedId": string,
"phone": string,
"cellPhone": string,
"fax": string,
"website": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"arpAccount": string,
"employer": {
"id": "abc123",
"label": string,
"name": string,
"description": string,
"alias": string,
"importedId": string,
"taxId": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": string,
"website": string,
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"jobBannerImage": string,
"hideFromStudents": true,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": string
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"title": {
"type": "string",
"description": "Title"
},
"suffix": {
"type": "string",
"description": "Suffix"
},
"email": {
"type": "string",
"description": "Email"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"phone": {
"type": "string",
"description": "Phone"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network"
},
"networkStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network Status"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"services": {
"type": "array",
"description": "Services"
},
"arpAccount": {
"type": "string",
"description": "ARP Account. Available only on a Symplicity Recruit Network Instance"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"name": {
"type": "string",
"description": "Name"
},
"description": {
"type": "string",
"description": "Description"
},
"alias": {
"type": "string",
"description": "Alias"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"taxId": {
"type": "string",
"description": "Tax ID"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type. Available only on a Symplicity Recruit Network Instance"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network"
},
"networkStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Network Status"
},
"accountManager": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Manager"
},
"overview": {
"type": "string",
"description": "Overview"
},
"website": {
"type": "string",
"description": "Web Site"
},
"industries": {
"type": "array",
"description": "Industries"
},
"jobBannerImage": {
"type": "string",
"description": "Job Banner Image. Available only on a Symplicity Recruit Network Instance"
},
"hideFromStudents": {
"type": "boolean",
"description": "Hide from Students"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"name"
],
"description": "Employer"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email",
"employer"
]
}Create Network Employer RegistrationPOST/v1/network-employer-registrations
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema.
POST https://example-csm.symplicity.com/api/public/v1/network-employer-registrations?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"fullName": "Nathaniel Reggie",
"firstName": "Nathaniel",
"lastName": "Reggie",
"email": "nreggie@vox.com",
"employer": {
"name": "NetReg Corp.",
"alias": "NetReg",
"importedId": "9990021",
"type": "3",
"description": "Network Registration Employer",
"overview": "Network Registration Employer Profile",
"website": "http://netreg.com",
"industries": [
"4"
],
"accountManager": "1"
}
},
{
"name": "Employer with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create Network Employer RegistrationsPOST/v1/network-employer-registrations?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"salutation": "",
"title": "",
"suffix": "",
"email": "",
"importedId": "",
"phone": "",
"cellPhone": "",
"fax": "",
"website": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"arpAccount": "",
"employer": {
"id": "abc123",
"label": "",
"name": "",
"description": "",
"alias": "",
"importedId": "",
"taxId": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"network": {
"id": "abc123",
"label": "Display Label"
},
"networkStatus": {
"id": "abc123",
"label": "Display Label"
},
"accountManager": {
"id": "abc123",
"label": "Display Label"
},
"overview": "",
"website": "",
"industries": [
{
"id": "abc123",
"label": "Display Label"
}
],
"jobBannerImage": "",
"hideFromStudents": false,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"lastModified": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
Contact ¶
Contacts are related to Employers and are individual system users who manage recruiting activities on behalf of a recruiting organization. These individuals do the actual coordination of specific recruiting activities (i.e., manage job postings, campus interviews, information sessions, fair registrations, review resume books, etc.). Contacts have user rights that determine what activities/access they will have within a CSM. One of the recruiting contacts can be designated as “primary contact” for the Employer.
Contact ¶
GET https://example-csm.symplicity.com/api/public/v1/contacts?keywords=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=title
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "contact",
"models": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"salutation": "",
"suffix": "",
"title": "",
"email": "",
"importedId": "",
"phone": "",
"cellPhone": "",
"fax": "",
"website": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"autoApproveJobs": false,
"blockUserEmails": false,
"blockCampaignEmails": false,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerDescription": "",
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List ContactsGET/v1/contacts{?keywords,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: titleName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/contacts/4669947417456f3ecb8707a13f6325c9
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"salutation": string,
"suffix": string,
"title": string,
"email": string,
"importedId": string,
"phone": string,
"cellPhone": string,
"fax": string,
"website": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"autoApproveJobs": true,
"blockUserEmails": true,
"blockCampaignEmails": true,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerDescription": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"suffix": {
"type": "string",
"description": "Suffix"
},
"title": {
"type": "string",
"description": "Title"
},
"email": {
"type": "string",
"description": "Email"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"phone": {
"type": "string",
"description": "Phone"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"autoApproveJobs": {
"type": "boolean",
"description": "Auto Approve Job Postings"
},
"blockUserEmails": {
"type": "boolean",
"description": "Block User Emails"
},
"blockCampaignEmails": {
"type": "boolean",
"description": "Block Campaign Emails"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"services": {
"type": "array",
"description": "Services"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"employerDescription": {
"type": "string",
"description": "Employer Description"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email",
"employer"
]
}Get ContactGET/v1/contacts/{id}
URI Parameters
- id
string(required) Example: 4669947417456f3ecb8707a13f6325c9id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/contacts/services
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "jobs",
"value": "Job Postings"
},
{
"id": "profile",
"value": "Profile"
},
{
"id": "cf",
"value": "Career Fair"
},
{
"id": "pres",
"value": "Information Sessions"
},
{
"id": "explearning",
"value": "Experiential Learning"
}
]Get Picklist keys and valuesGET/v1/picklists/contacts/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: servicesname of a pick field
Choices:
servicesaffiliationstypes
POST https://example-csm.symplicity.com/api/public/v1/contacts
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"firstName": "Theresa",
"middleName": "Mary",
"lastName": "James",
"fullName": "Theresa Mary James",
"email": "tmjames@test.com",
"importedId": "5AJ480Z",
"salutation": "Mrs",
"title": "Clerk",
"suffix": "Jr.",
"phone": "458-990-1356",
"fax": "458-990-1359",
"cellPhone": "202-456-2300",
"types": [
4,
5
],
"website": "https://symplicity.com",
"employer": "e880828b7cee4f01be76ab11e7e32166",
"employerDescription": "Your first choice for green foods home delivery",
"services": [
"profile",
"jobs"
],
"autoApproveJobs": false,
"blockUserEmails": false,
"blockCampaignEmails": false,
"address": {
"street": "320 W School St",
"city": "Purcellville",
"state": "US-VA",
"zip": 20132,
"country": "US"
}
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"salutation": string,
"suffix": string,
"title": string,
"email": string,
"importedId": string,
"phone": string,
"cellPhone": string,
"fax": string,
"website": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"autoApproveJobs": true,
"blockUserEmails": true,
"blockCampaignEmails": true,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerDescription": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"suffix": {
"type": "string",
"description": "Suffix"
},
"title": {
"type": "string",
"description": "Title"
},
"email": {
"type": "string",
"description": "Email"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"phone": {
"type": "string",
"description": "Phone"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"autoApproveJobs": {
"type": "boolean",
"description": "Auto Approve Job Postings"
},
"blockUserEmails": {
"type": "boolean",
"description": "Block User Emails"
},
"blockCampaignEmails": {
"type": "boolean",
"description": "Block Campaign Emails"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"services": {
"type": "array",
"description": "Services"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"employerDescription": {
"type": "string",
"description": "Employer Description"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email",
"employer"
]
}Create ContactPOST/v1/contacts
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema.
PUT https://example-csm.symplicity.com/api/public/v1/contacts/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Director"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": "",
"fullName": "Theresa Mary James",
"firstName": "Theresa",
"middleName": "Mary",
"lastName": "James",
"salutation": "",
"suffix": "",
"title": "Director",
"email": "tmjames@test.com",
"importedId": "",
"phone": "",
"cellPhone": "",
"fax": "",
"website": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"autoApproveJobs": false,
"blockUserEmails": false,
"blockCampaignEmails": false,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerDescription": "",
"lastModified": "2017-01-09T14:40:30Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"suffix": {
"type": "string",
"description": "Suffix"
},
"title": {
"type": "string",
"description": "Title"
},
"email": {
"type": "string",
"description": "Email"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"phone": {
"type": "string",
"description": "Phone"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"autoApproveJobs": {
"type": "boolean",
"description": "Auto Approve Job Postings"
},
"blockUserEmails": {
"type": "boolean",
"description": "Block User Emails"
},
"blockCampaignEmails": {
"type": "boolean",
"description": "Block Campaign Emails"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"services": {
"type": "array",
"description": "Services"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"employerDescription": {
"type": "string",
"description": "Employer Description"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email",
"employer"
]
}Update ContactPUT/v1/contacts/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/contacts?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"firstName": "Rachel",
"middleName": "Boven",
"lastName": "New",
"title": "Director",
"email": "rbnew@test.com",
"employer": "e880828b7cee4f01be76ab11e7e32166"
},
{
"firstName": "Contact with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create ContactsPOST/v1/contacts?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"salutation": "",
"suffix": "",
"title": "",
"email": "",
"importedId": "",
"phone": "",
"cellPhone": "",
"fax": "",
"website": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"autoApproveJobs": false,
"blockUserEmails": false,
"blockCampaignEmails": false,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"services": [
{
"id": "abc123",
"label": "Display Label"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerDescription": "",
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/contacts?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"title": "Manager"
},
{
"id": "def456",
"name": "Associate"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update ContactsPUT/v1/contacts?batch=1
Student ¶
Students are the users within a CSM who are being coached about careers by the school and are being recruited by Employers. These users would respond to job postings, attend Employers’ recruiting events, post resumes for inclusion in resume books, and attend other career center events. Students have user rights that determine what activities/access they will have within a CSM.
Systems can optionally be configured to allow for multiple selections for student work authorization(s). If the school has done so, then array format applies. Put/Post statements that are incorrectly formatted will be advised of “Invalid entry”.
CSM supports two degree structures: single and multiple degree/award.
Single Degree/Award
Most schools maintain one academic record per student, including major(s), minor(s), GPA, and graduation date tied to a single degree (Bachelor’s, Master’s, etc.).
API behavior: Full read/write access to all standard and custom fields via a single form.
Multiple Degree/Award
Some schools allow concurrent degree pursuits with distinct majors, minors, schools/colleges, GPAs, and graduation dates for each degree.
API behavior: Degrees are managed as array records. Full read/write access is available.
Requirements when writing degree arrays:
-
Include all degrees: Always include the entire array of degrees, even unchanged degrees.
-
Designate one primary degree: Set one degree’s “primary” field to TRUE. If omitted, the system auto-assigns one, but accuracy cannot be guaranteed.
-
Match degrees using IDs: Use the degree’s Object ID or Visual ID to update existing degrees. Without an ID, a new degree is created with an auto-assigned Visual ID.
-
Respect degree limits: System configuration determines the maximum degrees allowed per student.
Student ¶
GET https://example-csm.symplicity.com/api/public/v1/students?keywords=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=birthdate
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "student",
"models": [
{
"id": "abc123",
"label": "",
"schoolStudentId": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"preferredName": "",
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": "",
"email": "",
"permanentEmail": "",
"phone": "",
"birthdate": "2017-01-09",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": false,
"accountDisabled": false,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": "2017-01-09",
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": "1.23",
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": false,
"visualId": "",
"type": "",
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": "2017-01-09",
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": "2017-01-09T14:40:30Z",
"hasApprovedResume": false,
"advocateIncidentHistory": false,
"advocateCareHistory": false,
"accommodateAccessibility": false,
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List StudentsGET/v1/students{?keywords,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: birthdateName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/students/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Get StudentGET/v1/students/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/students/schoolStudentId/ZTAS5559
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Get Student By School IDGET/v1/students/schoolStudentId/{schoolStudentId}
URI Parameters
- schoolStudentId
string(required) Example: ZTAS5559school student id
GET https://example-csm.symplicity.com/api/public/v1/picklists/students/degreeLevel
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Bachelors"
},
{
"id": "2",
"value": "Masters"
},
{
"id": "3",
"value": "Doctorate"
}
]Get Picklist keys and valuesGET/v1/picklists/students/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: degreeLevelname of a pick field
Choices:
accountBlockedaffiliationsapplicantTypecertificatesclassLevelcounselorsdegreeLevelgendergeographicPreferenceslanguageProficienciesmajorsminorsprogramTyperightsstatusschoolsworkAuthorization
POST https://example-csm.symplicity.com/api/public/v1/students
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"schoolStudentId": "abc123",
"firstName": "Maria",
"middleName": "Blanca",
"lastName": "Smith",
"fullName": "Maria Blanca Smith",
"preferredName": "Marie",
"username": "mbsmith",
"email": "mbsmith@school.edu",
"permanentEmail": "mbsmith@test.com",
"phone": "456-789-0989",
"birthdate": "1984-09-22",
"gender": "M",
"address": {
"street": "123 Test St.",
"city": "Dallas",
"state": "US-TX",
"zip": 75001,
"country": "US"
},
"permanentAddress": {
"street": "2 Bodh Gaya 824231, Gaya",
"city": "Bodh Gaya",
"state": "IN-BR",
"country": "IN"
},
"advocateIncidentHistory": null,
"advocateCareHistory": null,
"accommodateAccessibility": null,
"alum": false,
"accountDisabled": false,
"accountBlocked": false,
"status": 1,
"counselors": [
"05d3d53e4c06f658bf26f8bb042fec37"
],
"gpa": "3.6",
"majors": [
"0040100"
],
"minors": [
"0080"
],
"classLevel": "1",
"degreeLevel": "1",
"workAuthorization": "1",
"graduationDate": "2021-06-11",
"programType": [
"3"
],
"applicantType": [
"1"
],
"schools": [
"0010"
],
"certificates": [
"0040"
],
"geographicPreferences": [
1,
7,
16
],
"degrees": [
{
"visualId": "82669444",
"primary": true,
"schools": [
"0010"
],
"award": "485",
"type": "Summer",
"mode": 1,
"level": 1,
"majors": [
"0170"
],
"minors": [
"0080"
],
"campus": "4",
"graduationDate": "2027-01-01",
"classLevel": "1"
}
],
"languageProficiencies": [
"ar-lim",
"en-nat"
],
"affiliations": [
"MNC-CSM"
]
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Create StudentPOST/v1/students
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema. counselors: Only Staff users with Counseling Advising rights can be Student Counselors
PUT https://example-csm.symplicity.com/api/public/v1/students/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"email": "mbsmith@school.edu",
"degreeLevel": "1",
"graduationDate": "2021-06-11",
"classLevel": "2",
"gpa": "3.8",
"languageProficiencies": [
"lv-ele",
"en-nat"
],
"workAuthorization": "1",
"programType": [
"3"
],
"applicantType": [
"1"
],
"address": {
"street": "123 Test St.",
"city": "Dallas",
"state": "US-TX",
"zip": 75098,
"country": "US"
}
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Update StudentPUT/v1/students/{id}
URI Parameters
- id
string(required) Example: abc123id of the updated record
PUT https://example-csm.symplicity.com/api/public/v1/students/schoolStudentId/ZTAS5559
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"fullname": "Test B. Student"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Update Student By School IDPUT/v1/students/schoolStudentId/{schoolStudentId}
URI Parameters
- schoolStudentId
string(required) Example: ZTAS5559school student id
POST https://example-csm.symplicity.com/api/public/v1/students?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"schoolStudentId": "def456",
"firstName": "John",
"middleName": "Brown",
"lastName": "Doe",
"email": "jbdoe@school.edu",
"majors": [
"0060"
],
"degreeLevel": "1",
"graduationDate": "2022-06-11",
"classLevel": "1",
"workAuthorization": "1",
"programType": [
"3"
],
"applicantType": [
"1"
]
},
{
"firstName": "Student with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create StudentsPOST/v1/students?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"schoolStudentId": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"preferredName": "",
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": "",
"email": "",
"permanentEmail": "",
"phone": "",
"birthdate": "2017-01-09",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": false,
"accountDisabled": false,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": "2017-01-09",
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": "1.23",
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": false,
"visualId": "",
"type": "",
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": "2017-01-09",
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": "2017-01-09T14:40:30Z",
"hasApprovedResume": false,
"advocateIncidentHistory": false,
"advocateCareHistory": false,
"accommodateAccessibility": false,
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/students?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"email": "mbsmith@school.edu",
"majors": [
"0040"
],
"degreeLevel": "2",
"graduationDate": "2021-06-11",
"classLevel": "2",
"workAuthorization": "1",
"programType": [
"3"
],
"applicantType": [
"1"
]
},
{
"id": "def456",
"email": "def.456@school.edu",
"gpa": "3.0"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"schoolStudentId": "abc123",
"email": "mbsmith@school.edu",
"majors": [
"0040"
],
"degreeLevel": "2",
"graduationDate": "2021-06-11",
"classLevel": "2",
"workAuthorization": "1",
"programType": [
"3"
],
"applicantType": [
"1"
]
},
{
"schoolStudentId": "def456",
"email": "def.456@school.edu",
"gpa": "3.0"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update StudentsPUT/v1/students?batch=1
Students in a batch may be looked up by schoolStudentId field if it is provided instead of the regular id field.
GET https://example-csm.symplicity.com/api/public/v1/students/abc123/applications
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "non_ocr_job_resume",
"models": [
{
"id": "abc123",
"label": "",
"category": "",
"position": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobLocations": [
{
"city": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
}
],
"submittedOn": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Student Job ApplicationsGET/v1/students/{id}/applications
List student non-OCR job application materials that have been posted in response to jobs posted within the CSM system. All jobs require students to submit a resume as part of their application, but various other types of documents can also be submitted by the applicant (e.g., cover letter, un-official transcript, writing sample, etc.). Note, CSM does not require that job postings require direct application through CSM. If the job requests/allows applicants to respond outside of CSM, those applications will not be reflected herein.
URI Parameters
- id
string(required) Example: abc123id of the requested record
POST https://example-csm.symplicity.com/api/public/v1/students/abc123/rights
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
"jobs",
"credentials"
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Add Student RightsPOST/v1/students/{id}/rights
A newly created student is awarded a default set of user rights as specified in system settings. Additional rights can be added using this route.
URI Parameters
- id
string(required) Example: abc123id of the requested record
DELETE https://example-csm.symplicity.com/api/public/v1/students/abc123/rights
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
"jobs",
"credentials"
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"schoolStudentId": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"preferredName": string,
"gender": {
"id": "abc123",
"label": "Display Label"
},
"username": string,
"email": string,
"permanentEmail": string,
"phone": string,
"birthdate": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"permanentAddress": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"alum": true,
"accountDisabled": true,
"accountBlocked": {
"id": "abc123",
"label": "Display Label"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"gpa": string,
"workAuthorization": {
"id": "abc123",
"label": "Display Label"
},
"degrees": [
{
"primary": true,
"visualId": string,
"type": string,
"award": {
"id": "abc123",
"label": "Display Label"
},
"mode": {
"id": "abc123",
"label": "Display Label"
},
"level": {
"id": "abc123",
"label": "Display Label"
},
"classLevel": {
"id": "abc123",
"label": "Display Label"
},
"graduationDate": string,
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"campus": [
{
"id": "abc123",
"label": "Display Label"
}
]
}
],
"programType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"applicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"status": [
{
"id": "abc123",
"label": "Display Label"
}
],
"languageProficiencies": [
{
"id": "abc123",
"label": "Display Label"
}
],
"geographicPreferences": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastLogin": string,
"hasApprovedResume": true,
"advocateIncidentHistory": true,
"advocateCareHistory": true,
"accommodateAccessibility": true,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"schoolStudentId": {
"type": "string",
"description": "School ID"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"preferredName": {
"type": "string",
"description": "Preferred Name"
},
"gender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Gender"
},
"username": {
"type": "string",
"description": "Username"
},
"email": {
"type": "string",
"description": "Email"
},
"permanentEmail": {
"type": "string",
"description": "Permanent Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"birthdate": {
"type": "string",
"description": "Birth Date"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "School Address"
},
"permanentAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Permanent Address"
},
"alum": {
"type": "boolean",
"description": "Alumni"
},
"accountDisabled": {
"type": "boolean",
"description": "Account Disabled"
},
"accountBlocked": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Account Blocked"
},
"counselors": {
"type": "array",
"description": "Counselors. Available only if instance uses Career Counseling module and the System Setting \"Activate Counseling Module\" is ON"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"degreeLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Degree Level"
},
"graduationDate": {
"type": "string",
"description": "Graduation Date"
},
"classLevel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Class Level"
},
"gpa": {
"type": "string",
"description": "GPA"
},
"workAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Authorization"
},
"degrees": {
"type": "array",
"description": "Degrees. Available only if instance uses the Multiple Degrees/Awards module"
},
"programType": {
"type": "array",
"description": "Program Type"
},
"applicantType": {
"type": "array",
"description": "Applicant Type"
},
"status": {
"type": "array",
"description": "Status"
},
"languageProficiencies": {
"type": "array",
"description": "Language Proficiencies"
},
"geographicPreferences": {
"type": "array",
"description": "Geographic Preferences. Available only on a Law instance"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastLogin": {
"type": "string",
"description": "Last Login"
},
"hasApprovedResume": {
"type": "boolean",
"description": "Has Approved Resume"
},
"advocateIncidentHistory": {
"type": "boolean",
"description": "Advocate Incident Case History"
},
"advocateCareHistory": {
"type": "boolean",
"description": "Advocate CARE Case History"
},
"accommodateAccessibility": {
"type": "boolean",
"description": "Accommodate Accessibility Case"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Remove Student RightsDELETE/v1/students/{id}/rights
A newly created student is awarded a default set of user rights as specified in system settings. Rights can be removed using this route.
URI Parameters
- id
string(required) Example: abc123id of the requested record
Faculty ¶
CSM provides focused faculty access to modules which can help faculty more effectively support and guide their students and alumni during career exploration. For instance, some systems allow faculty to be ProNet mentors, provide professional recommendations for students, or to send job recommendation messages to their students and alumni. Certain CSM work flows can also include a faculty approval requirement (e.g., Experiential Learning workflow). Faculty can also have access to the Employer database and the CSM calendar of activities.
Faculty ¶
GET https://example-csm.symplicity.com/api/public/v1/faculty?keywords=&college=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=email
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "faculty",
"models": [
{
"id": "abc123",
"label": "",
"facultyID": "",
"salutation": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"email": "",
"phone": "",
"fax": "",
"website": "",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"emailNotifications": false,
"currentCollegeInformation": {
"campus": {
"id": "abc123",
"label": "Display Label"
},
"college": {
"id": "abc123",
"label": "Display Label"
},
"department": {
"id": "abc123",
"label": "Display Label"
},
"positionTitle": "",
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"startDate": "2017-01-09",
"departmentPhone": ""
},
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List FacultyGET/v1/faculty{?keywords,college,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- college
string(optional)Filter collection by college.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: emailName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/faculty/009fac117ult990yyy888dddeeefffqq
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"facultyID": string,
"salutation": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"email": string,
"phone": string,
"fax": string,
"website": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"emailNotifications": true,
"currentCollegeInformation": {
"campus": {
"id": "abc123",
"label": "Display Label"
},
"college": {
"id": "abc123",
"label": "Display Label"
},
"department": {
"id": "abc123",
"label": "Display Label"
},
"positionTitle": string,
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"startDate": string,
"departmentPhone": string
},
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"facultyID": {
"type": "string",
"description": "School ID"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"emailNotifications": {
"type": "boolean",
"description": "Receive Email Notifications"
},
"currentCollegeInformation": {
"type": "object",
"properties": {
"campus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Campus"
},
"college": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "College"
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Department"
},
"positionTitle": {
"type": "string",
"description": "Position Title"
},
"majors": {
"type": "array",
"description": "Majors Taught (known as Practice Areas for Law Schools)"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"departmentPhone": {
"type": "string",
"description": "Department Phone"
}
},
"description": "Current College Information"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Get FacultyGET/v1/faculty/{id}
URI Parameters
- id
string(required) Example: 009fac117ult990yyy888dddeeefffqqid of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/faculty/types
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Staff"
},
{
"id": "2",
"value": "Faculty"
},
{
"id": "3",
"value": "Teaching Assistant"
}
]Get Picklist keys and valuesGET/v1/picklists/faculty/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typesname of a pick field
Choices:
typescampuscollegeschooldepartmentmajorsaffiliations
POST https://example-csm.symplicity.com/api/public/v1/faculty
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"facultyID": "FA98CUL",
"salutation": "Mr.",
"firstName": "John",
"middleName": "Charles",
"lastName": "Young",
"fullName": "John Charles Young",
"email": "jyoung@test.com",
"phone": "202-998-8990",
"fax": "202-998-8992",
"types": [
"1"
],
"emailNotifications": true,
"website": "http://symplicity.com",
"address": {
"street": "123 Main Street",
"city": "Steeleville",
"state": "US-AR",
"zip": "71602",
"country": "US"
},
"currentCollegeInformation": {
"college": "0020",
"campus": "0020",
"department": "0020",
"positionTitle": "Assistant",
"startDate": "2009-03-10",
"majors": [
"0070"
],
"departmentPhone": "315-663-6101"
},
"affiliations": [
"MNC-CSM"
]
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": "",
"facultyID": "",
"salutation": "",
"fullName": "John Charles Young",
"firstName": "John",
"middleName": "Charles",
"lastName": "Young",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"email": "jyoung@test.com",
"phone": "",
"fax": "",
"website": "",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"emailNotifications": false,
"currentCollegeInformation": {
"campus": {
"id": "abc123",
"label": "Display Label"
},
"college": {
"id": "abc123",
"label": "Display Label"
},
"department": {
"id": "abc123",
"label": "Display Label"
},
"positionTitle": "",
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"startDate": "2017-01-09",
"departmentPhone": ""
},
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"facultyID": {
"type": "string",
"description": "School ID"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"emailNotifications": {
"type": "boolean",
"description": "Receive Email Notifications"
},
"currentCollegeInformation": {
"type": "object",
"properties": {
"campus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Campus"
},
"college": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "College"
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Department"
},
"positionTitle": {
"type": "string",
"description": "Position Title"
},
"majors": {
"type": "array",
"description": "Majors Taught (known as Practice Areas for Law Schools)"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"departmentPhone": {
"type": "string",
"description": "Department Phone"
}
},
"description": "Current College Information"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Create FacultyPOST/v1/faculty
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema.
PUT https://example-csm.symplicity.com/api/public/v1/faculty/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"email": "jyoung@test.com",
"website": "https://www.symplicity.com"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": "",
"facultyID": "",
"salutation": "",
"fullName": "John Charles Young",
"firstName": "John",
"middleName": "Charles",
"lastName": "Young",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"email": "jyoung@test.com",
"phone": "",
"fax": "",
"website": "https://www.symplicity.com",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"emailNotifications": false,
"currentCollegeInformation": {
"campus": {
"id": "abc123",
"label": "Display Label"
},
"college": {
"id": "abc123",
"label": "Display Label"
},
"department": {
"id": "abc123",
"label": "Display Label"
},
"positionTitle": "",
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"startDate": "2017-01-09",
"departmentPhone": ""
},
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"facultyID": {
"type": "string",
"description": "School ID"
},
"salutation": {
"type": "string",
"description": "Salutation"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"types": {
"type": "array",
"description": "Contact Types"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax"
},
"website": {
"type": "string",
"description": "Web Site"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Address"
},
"emailNotifications": {
"type": "boolean",
"description": "Receive Email Notifications"
},
"currentCollegeInformation": {
"type": "object",
"properties": {
"campus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Campus"
},
"college": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "College"
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Department"
},
"positionTitle": {
"type": "string",
"description": "Position Title"
},
"majors": {
"type": "array",
"description": "Majors Taught (known as Practice Areas for Law Schools)"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"departmentPhone": {
"type": "string",
"description": "Department Phone"
}
},
"description": "Current College Information"
},
"proNetProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Professional Network Mentor Profile. Available only if instance uses Professional Network module"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Update FacultyPUT/v1/faculty/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/faculty?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"firstName": "Rachel",
"middleName": "Boven",
"lastName": "New",
"title": "Director",
"email": "rbnew@test.com"
},
{
"firstName": "Faculty with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create FacultyPOST/v1/faculty?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"facultyID": "",
"salutation": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"email": "",
"phone": "",
"fax": "",
"website": "",
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"emailNotifications": false,
"currentCollegeInformation": {
"campus": {
"id": "abc123",
"label": "Display Label"
},
"college": {
"id": "abc123",
"label": "Display Label"
},
"department": {
"id": "abc123",
"label": "Display Label"
},
"positionTitle": "",
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"startDate": "2017-01-09",
"departmentPhone": ""
},
"proNetProfile": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/faculty?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"email": "abc.123@school.edu",
"title": "Manager"
},
{
"id": "def456",
"email": "def.456@school.edu",
"name": "Associate"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update FacultyPUT/v1/faculty?batch=1
Staff ¶
Staff users are the Career Center staff that manage or control system configuration and various modules’ workflows within the system. For instance, if student resume approval is required, or job posting approval is required, staff users would be the users that provide those types of workflow reviews. Staff user access is determined based on staff user right assignments. The available staff user rights reflect the system’s modules. An overall system administrator would be given “Administrator Access”, whereas a more limited user might given a subset of available rights (e.g, Event Coordinator staff user might be given only the “Events” user rights). Rights can also be award via “group membership” where the staff user is awarded rights based on their membership in a user group, and the portfolio of rights that are designated for the user group. Staff users access the system via the {{URL}}/manager interface.
Staff ¶
GET https://example-csm.symplicity.com/api/public/v1/staff?keywords=&lastModified=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=email
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "staff",
"models": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"email": "",
"ssoUsername": "",
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": "",
"externalConsultant": false,
"accessibleMode": false,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List StaffGET/v1/staff{?keywords,lastModified,perPage,page,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: emailName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/staff/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"email": string,
"ssoUsername": string,
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": string,
"externalConsultant": true,
"accessibleMode": true,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"email": {
"type": "string",
"description": "Email"
},
"ssoUsername": {
"type": "string",
"description": "SSO Username. Available only if instance uses Shibboleth Single Sign-On system for Manager Users and the System Setting \"Enable SSO Username for manager users\" is ON"
},
"locations": {
"type": "array",
"description": "Locations"
},
"emailSignature": {
"type": "string",
"description": "Email Signature"
},
"externalConsultant": {
"type": "boolean",
"description": "External Consultant. Available only if instance uses Career Counseling module"
},
"accessibleMode": {
"type": "boolean",
"description": "Accessible Mode"
},
"groupMembership": {
"type": "array",
"description": "Group Membership. Available only if instance uses Granular User Rights"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Get StaffGET/v1/staff/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/staff/rights
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "events_create",
"value": "Staff Events (Create)"
},
{
"id": "events_edit",
"value": "Staff Events (Edit)"
},
{
"id": "cf_reporting",
"value": "Career Fairs (Reporting)"
},
{
"id": "document_approval",
"value": "Document Approval"
},
{
"id": "use_pronet",
"value": "Pronet (Manage)"
}
]Get Picklist keys and valuesGET/v1/picklists/staff/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: rightsname of a pick field
Choices:
rightsgroupMembershipaffiliationslocations
POST https://example-csm.symplicity.com/api/public/v1/staff
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"firstName": "Zane",
"middleName": "Young",
"lastName": "Taylor",
"fullName": "Zane Young Taylor",
"email": "ztaylor@aol.com",
"ssoUsername": "ztaylor",
"emailSignature": "Have a good day",
"externalConsultant": false,
"accessibleMode": true,
"locations": [
"4",
"7"
],
"groupMembership": [
"faculty_manager"
],
"rights": [
"pronet_mailer",
"announce_create",
"announce_edit"
],
"affiliations": [
"MNC-CSM"
]
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"email": string,
"ssoUsername": string,
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": string,
"externalConsultant": true,
"accessibleMode": true,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"email": {
"type": "string",
"description": "Email"
},
"ssoUsername": {
"type": "string",
"description": "SSO Username. Available only if instance uses Shibboleth Single Sign-On system for Manager Users and the System Setting \"Enable SSO Username for manager users\" is ON"
},
"locations": {
"type": "array",
"description": "Locations"
},
"emailSignature": {
"type": "string",
"description": "Email Signature"
},
"externalConsultant": {
"type": "boolean",
"description": "External Consultant. Available only if instance uses Career Counseling module"
},
"accessibleMode": {
"type": "boolean",
"description": "Accessible Mode"
},
"groupMembership": {
"type": "array",
"description": "Group Membership. Available only if instance uses Granular User Rights"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Create StaffPOST/v1/staff
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema.
PUT https://example-csm.symplicity.com/api/public/v1/staff/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"externalConsultant": true
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"email": string,
"ssoUsername": string,
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": string,
"externalConsultant": true,
"accessibleMode": true,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"email": {
"type": "string",
"description": "Email"
},
"ssoUsername": {
"type": "string",
"description": "SSO Username. Available only if instance uses Shibboleth Single Sign-On system for Manager Users and the System Setting \"Enable SSO Username for manager users\" is ON"
},
"locations": {
"type": "array",
"description": "Locations"
},
"emailSignature": {
"type": "string",
"description": "Email Signature"
},
"externalConsultant": {
"type": "boolean",
"description": "External Consultant. Available only if instance uses Career Counseling module"
},
"accessibleMode": {
"type": "boolean",
"description": "Accessible Mode"
},
"groupMembership": {
"type": "array",
"description": "Group Membership. Available only if instance uses Granular User Rights"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Update StaffPUT/v1/staff/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/staff?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"firstName": "Rachel",
"middleName": "Boven",
"lastName": "New",
"email": "rbnew@test.com"
},
{
"firstName": "Staff with missing fields"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create StaffPOST/v1/staff?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"fullName": "",
"firstName": "",
"middleName": "",
"lastName": "",
"email": "",
"ssoUsername": "",
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": "",
"externalConsultant": false,
"accessibleMode": false,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/staff?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"fullName": "John Charles Young"
},
{
"id": "def456",
"fullName": "Bob Simmons"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update StaffPUT/v1/staff?batch=1
POST https://example-csm.symplicity.com/api/public/v1/staff/abc123/rights
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
"announce_create"
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"email": string,
"ssoUsername": string,
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": string,
"externalConsultant": true,
"accessibleMode": true,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"email": {
"type": "string",
"description": "Email"
},
"ssoUsername": {
"type": "string",
"description": "SSO Username. Available only if instance uses Shibboleth Single Sign-On system for Manager Users and the System Setting \"Enable SSO Username for manager users\" is ON"
},
"locations": {
"type": "array",
"description": "Locations"
},
"emailSignature": {
"type": "string",
"description": "Email Signature"
},
"externalConsultant": {
"type": "boolean",
"description": "External Consultant. Available only if instance uses Career Counseling module"
},
"accessibleMode": {
"type": "boolean",
"description": "Accessible Mode"
},
"groupMembership": {
"type": "array",
"description": "Group Membership. Available only if instance uses Granular User Rights"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Add Staff RightsPOST/v1/staff/{id}/rights
Additional rights can be added using this route.
URI Parameters
- id
string(required) Example: abc123id of the requested record
DELETE https://example-csm.symplicity.com/api/public/v1/staff/abc123/rights
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
"announce_create"
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"fullName": string,
"firstName": string,
"middleName": string,
"lastName": string,
"email": string,
"ssoUsername": string,
"locations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"emailSignature": string,
"externalConsultant": true,
"accessibleMode": true,
"groupMembership": [
{
"id": "abc123",
"label": "Display Label"
}
],
"rights": [
{
"id": "abc123",
"label": "Display Label"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"fullName": {
"type": "string",
"description": "Full Name"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"email": {
"type": "string",
"description": "Email"
},
"ssoUsername": {
"type": "string",
"description": "SSO Username. Available only if instance uses Shibboleth Single Sign-On system for Manager Users and the System Setting \"Enable SSO Username for manager users\" is ON"
},
"locations": {
"type": "array",
"description": "Locations"
},
"emailSignature": {
"type": "string",
"description": "Email Signature"
},
"externalConsultant": {
"type": "boolean",
"description": "External Consultant. Available only if instance uses Career Counseling module"
},
"accessibleMode": {
"type": "boolean",
"description": "Accessible Mode"
},
"groupMembership": {
"type": "array",
"description": "Group Membership. Available only if instance uses Granular User Rights"
},
"rights": {
"type": "array",
"description": "Rights"
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"email"
]
}Remove Staff RightsDELETE/v1/staff/{id}/rights
Rights can be removed using this route.
URI Parameters
- id
string(required) Example: abc123id of the requested record
Address ¶
An address is a field object that captures the specific street, city, state, zip, country data for a location. If non-US, data records will reflect non-US locations. Addresses are affiliated with employers, contacts, students, and alumni records. While you can pull addresses through the GET address route, address creation/updates are done through the affiliated object (e.g., post/put student). Multiple addresses can be affiliated with a single object (e.g., students might have both a “permanent” and a “school” address).
Address ¶
GET https://example-csm.symplicity.com/api/public/v1/addresses/a123456789abcdef0123456789abcdef
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"street": string,
"city": string,
"locality": string,
"zip": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"street": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"locality": {
"type": "string",
"description": "Locality. Available only on a Language Pack instance"
},
"zip": {
"type": "string",
"description": "Zip+4"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
}
}Get AddressGET/v1/addresses/{id}
URI Parameters
- id
string(required) Example: a123456789abcdef0123456789abcdefid of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/addresses/state?country=US
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "US-CA",
"value": "California"
},
{
"id": "US-NY",
"value": "New York"
}
]Get Picklist keys and valuesGET/v1/picklists/addresses/{field}{?country}
Picklist represents all possible pick values for a given field.
URI Parameters
- field
string(required) Example: statename of a pick field
Choices:
countrystate- country
string(optional) Example: USInternational instances can pull states/provinces for a specific country by using a two-character country parameter.
File ¶
Document records that can be extracted from the system.
File ¶
These routes are special since they deal with actual files, so the response is not a json structure, but rather the actual file data.
GET https://example-csm.symplicity.com/api/public/v1/files/0123456789abcdef0123456789abcdef
Responses
Headers
Content-Description: File Transfer
Content-Disposition: attachment; filename="sample.txt"
Content-Length: 32
Content-Type: plain/textBody
Sample text file for API tests.Get FileGET/v1/files/{id}
URI Parameters
- id
string(required) Example: 0123456789abcdef0123456789abcdefid of the requested record
Job ¶
Employer job opportunities are posted to the job board within the CSM system. This is where the employer articulates the specifics of the job and what is needed from the student to apply for the position. Some jobs will limit student applications based on specific student screening criteria (e.g., only students from a particular major can apply). Jobs can also be tied to specific interview schedules on campus. Use parameter includeOcrData=true to pull interview schedule dates/deadlines for On Campus Recruiting (OCR) jobs. Sites not using OCR module will not present data for this parameter.
Click here to learn more about our Recruit API - the best solution to import jobs into CSM.
Job ¶
GET https://example-csm.symplicity.com/api/public/v1/jobs?keywords=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=approved&stats=true&includeOcrData=true
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "job",
"models": [
{
"id": "abc123",
"label": "",
"visualId": 49,
"importedId": "",
"title": "",
"description": "",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"contact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"remoteJob": false,
"workplaceType": {
"id": "abc123",
"label": "Display Label"
},
"locations": [
{
"city": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
}
],
"showContactInformation": false,
"contactInformation": "",
"postingDate": "2017-01-09",
"expirationDate": "2017-01-09",
"applicationDeadline": "2017-01-09",
"resumeSubmissionMethod": [
{
"id": "abc123",
"label": "Display Label"
}
],
"resumeSubmissionEmail": "",
"howToApply": "",
"skills": [
{
"id": "abc123",
"label": ""
}
],
"additionalDocuments": [
{
"id": "abc123",
"label": "Display Label"
}
],
"additionalDocumentsNotes": "",
"documentsRequired": [
{
"id": "abc123",
"label": "Display Label"
}
],
"blindPosting": false,
"restrictApplicants": false,
"openings": 49,
"salary": "",
"compensation": {
"from": "1.23",
"to": "1.23",
"frequency": {
"id": "abc123",
"label": "Display Label"
}
},
"annuallyRecurring": false,
"policyAffirmation": false,
"isOCR": false,
"shadowFlag": false,
"shadowPeriod": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"approved": false,
"approvalDate": "2017-01-09T14:40:30Z",
"careerFair": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"attachments": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"functions": [
{
"id": "abc123",
"label": "Display Label"
}
],
"classLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"graduationDateStart": "2017-01-09",
"graduationDateEnd": "2017-01-09",
"workAuthorization": [
{
"id": "abc123",
"label": "Display Label"
}
],
"gpa": "1.23",
"source": {
"id": "abc123",
"label": "Display Label"
},
"geographicPreference": {
"id": "abc123",
"label": "Display Label"
},
"screenMajors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenMinors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenCertificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenSchools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenGraduationDateStart": "2017-01-09",
"screenGraduationDateEnd": "2017-01-09",
"screenDegreeLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenGpa": "1.23",
"screenWorkAuthorization": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenClassLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenApplicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"stats": {
"studentViews": {
"total": 49,
"unique": 49
},
"linkTracking": [
{
"link": "",
"totalClicks": 49,
"uniqueClicks": 49
}
]
},
"ocrSchedules": [
{
"id": "abc123",
"label": "",
"ocrScheduleId": "",
"interviewDate": "2017-01-09",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {},
"approved": false,
"scheduleDeadlines": {
"resumeSubmissionStartDate": "2017-01-09T14:40:30Z",
"resumeSubmissionEndDate": "2017-01-09T14:40:30Z",
"preselectSignupsStartDate": "2017-01-09T14:40:30Z",
"signupStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsEndDate": "2017-01-09T14:40:30Z",
"biddingStartDate": "2017-01-09T14:40:30Z",
"biddingEndDate": "2017-01-09T14:40:30Z",
"biddingSignupsStartDate": "2017-01-09T14:40:30Z",
"biddingSignupsEndDate": "2017-01-09T14:40:30Z",
"openSignupsStartDate": "2017-01-09T14:40:30Z",
"cancelationStartDate": "2017-01-09T14:40:30Z",
"cancelationEndDate": "2017-01-09T14:40:30Z",
"signupsEndDate": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"externalLink": "",
"contractHours": {
"id": "abc123",
"label": "Display Label"
},
"contractType": {
"id": "abc123",
"label": "Display Label"
},
"compensationType": {
"id": "abc123",
"label": "Display Label"
},
"compensationDetails": "",
"messageSendOptOuts": [
{
"id": "abc123",
"label": "Display Label"
}
],
"created": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List JobsGET/v1/jobs{?keywords,lastModified,customFields,page,perPage,sort,stats,includeOcrData}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: approvedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
- stats
boolean(optional) Example: trueSet to true to add an element of student views and link tracking statistics
- includeOcrData
boolean(optional) Example: trueSet to true to add OCR schedules related to the job
GET https://example-csm.symplicity.com/api/public/v1/jobs/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": "",
"visualId": 49,
"importedId": "",
"title": "",
"description": "",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"contact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"types": [
{
"id": "abc123",
"label": "Display Label"
}
],
"remoteJob": false,
"workplaceType": {
"id": "abc123",
"label": "Display Label"
},
"locations": [
{
"city": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
}
],
"showContactInformation": false,
"contactInformation": "",
"postingDate": "2017-01-09",
"expirationDate": "2017-01-09",
"applicationDeadline": "2017-01-09",
"resumeSubmissionMethod": [
{
"id": "abc123",
"label": "Display Label"
}
],
"resumeSubmissionEmail": "",
"howToApply": "",
"skills": [
{
"id": "abc123",
"label": ""
}
],
"additionalDocuments": [
{
"id": "abc123",
"label": "Display Label"
}
],
"additionalDocumentsNotes": "",
"documentsRequired": [
{
"id": "abc123",
"label": "Display Label"
}
],
"blindPosting": false,
"restrictApplicants": false,
"openings": 49,
"salary": "",
"compensation": {
"from": "1.23",
"to": "1.23",
"frequency": {
"id": "abc123",
"label": "Display Label"
}
},
"annuallyRecurring": false,
"policyAffirmation": false,
"isOCR": false,
"shadowFlag": false,
"shadowPeriod": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"approved": false,
"approvalDate": "2017-01-09T14:40:30Z",
"careerFair": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"attachments": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"majors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"minors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"certificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"schools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"functions": [
{
"id": "abc123",
"label": "Display Label"
}
],
"classLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"degreeLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"graduationDateStart": "2017-01-09",
"graduationDateEnd": "2017-01-09",
"workAuthorization": [
{
"id": "abc123",
"label": "Display Label"
}
],
"gpa": "1.23",
"source": {
"id": "abc123",
"label": "Display Label"
},
"geographicPreference": {
"id": "abc123",
"label": "Display Label"
},
"screenMajors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenMinors": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenCertificates": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenSchools": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenGraduationDateStart": "2017-01-09",
"screenGraduationDateEnd": "2017-01-09",
"screenDegreeLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenGpa": "1.23",
"screenWorkAuthorization": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenClassLevel": [
{
"id": "abc123",
"label": "Display Label"
}
],
"screenApplicantType": [
{
"id": "abc123",
"label": "Display Label"
}
],
"stats": {
"studentViews": {
"total": 49,
"unique": 49
},
"linkTracking": [
{
"link": "",
"totalClicks": 49,
"uniqueClicks": 49
}
]
},
"ocrSchedules": [
{
"id": "abc123",
"label": "",
"ocrScheduleId": "",
"interviewDate": "2017-01-09",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {},
"approved": false,
"scheduleDeadlines": {
"resumeSubmissionStartDate": "2017-01-09T14:40:30Z",
"resumeSubmissionEndDate": "2017-01-09T14:40:30Z",
"preselectSignupsStartDate": "2017-01-09T14:40:30Z",
"signupStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsEndDate": "2017-01-09T14:40:30Z",
"biddingStartDate": "2017-01-09T14:40:30Z",
"biddingEndDate": "2017-01-09T14:40:30Z",
"biddingSignupsStartDate": "2017-01-09T14:40:30Z",
"biddingSignupsEndDate": "2017-01-09T14:40:30Z",
"openSignupsStartDate": "2017-01-09T14:40:30Z",
"cancelationStartDate": "2017-01-09T14:40:30Z",
"cancelationEndDate": "2017-01-09T14:40:30Z",
"signupsEndDate": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
}
],
"affiliations": [
{
"id": "abc123",
"label": "Display Label"
}
],
"externalLink": "",
"contractHours": {
"id": "abc123",
"label": "Display Label"
},
"contractType": {
"id": "abc123",
"label": "Display Label"
},
"compensationType": {
"id": "abc123",
"label": "Display Label"
},
"compensationDetails": "",
"messageSendOptOuts": [
{
"id": "abc123",
"label": "Display Label"
}
],
"created": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"visualId": {
"type": "number",
"description": "ID"
},
"importedId": {
"type": "string",
"description": "Imported ID"
},
"title": {
"type": "string",
"description": "Job Title"
},
"description": {
"type": "string",
"description": "Description"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"contact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Contact"
},
"types": {
"type": "array",
"description": "Position Type"
},
"remoteJob": {
"type": "boolean",
"description": "Remote Job (* This field is deprecated, and will be removed in V2. Please use workplaceType)"
},
"workplaceType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Work Place Type"
},
"locations": {
"type": "array",
"description": "Locations"
},
"showContactInformation": {
"type": "boolean",
"description": "Show Contact Information To Students"
},
"contactInformation": {
"type": "string",
"description": "Contact Information"
},
"postingDate": {
"type": "string",
"description": "Posting Date"
},
"expirationDate": {
"type": "string",
"description": "Expiration Date"
},
"applicationDeadline": {
"type": "string",
"description": "Application Deadline"
},
"resumeSubmissionMethod": {
"type": "array",
"description": "Resume Submission Method"
},
"resumeSubmissionEmail": {
"type": "string",
"description": "Email for resumes"
},
"howToApply": {
"type": "string",
"description": "How to apply for \"other\" submission method"
},
"skills": {
"type": "array",
"description": "Skills"
},
"additionalDocuments": {
"type": "array",
"description": "Additional Documents"
},
"additionalDocumentsNotes": {
"type": "string",
"description": "Additional Documents Notes"
},
"documentsRequired": {
"type": "array",
"description": "Documents Required"
},
"blindPosting": {
"type": "boolean",
"description": "Blind Posting"
},
"restrictApplicants": {
"type": "boolean",
"description": "Restrict Applicants"
},
"openings": {
"type": "number",
"description": "Number of Openings"
},
"salary": {
"type": "string",
"description": "Salary"
},
"compensation": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "From (only accepts numbers, a period as the decimal separator, and up to two decimal places)"
},
"to": {
"type": "string",
"description": "To (only accepts numbers, a period as the decimal separator, and up to two decimal places)"
},
"frequency": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Frequency (must be specified if from/to is set)"
}
},
"description": "Compensation"
},
"annuallyRecurring": {
"type": "boolean",
"description": "Annually Recurring Job"
},
"policyAffirmation": {
"type": "boolean",
"description": "Policy Affirmation"
},
"isOCR": {
"type": "boolean",
"description": "OCR Status"
},
"shadowFlag": {
"type": "boolean",
"description": "Job Shadow Flag. Available only if instance uses Job Shadow module and the System Setting \"Activate Job Shadow\" is ON"
},
"shadowPeriod": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Job Shadow Period. Available only if instance uses Job Shadow module and the System Setting \"Activate Job Shadow\" is ON"
},
"approved": {
"type": "boolean",
"description": "Job Approval"
},
"approvalDate": {
"type": "string",
"description": "Job Approval Date"
},
"careerFair": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Career Fair"
},
"attachments": {
"type": "array",
"description": "Attachments"
},
"majors": {
"type": "array",
"description": "Majors (known as Practice Areas for Law Schools)"
},
"minors": {
"type": "array",
"description": "Minors"
},
"certificates": {
"type": "array",
"description": "Certificates"
},
"schools": {
"type": "array",
"description": "Schools"
},
"functions": {
"type": "array",
"description": "Functions"
},
"classLevel": {
"type": "array",
"description": "Class Level"
},
"degreeLevel": {
"type": "array",
"description": "Degree Level"
},
"graduationDateStart": {
"type": "string",
"description": "Graduation Date (Start)"
},
"graduationDateEnd": {
"type": "string",
"description": "Graduation Date (End)"
},
"workAuthorization": {
"type": "array",
"description": "Work Authorization"
},
"gpa": {
"type": "string",
"description": "Minimum Cumulative GPA"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Source"
},
"geographicPreference": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Geographic Preference. Available only on a Law instance"
},
"screenMajors": {
"type": "array",
"description": "Screening Majors. Not available on Law instance"
},
"screenMinors": {
"type": "array",
"description": "Screening Minors. Not available on Law instance"
},
"screenCertificates": {
"type": "array",
"description": "Screening Certificates. Not available on Law instance"
},
"screenSchools": {
"type": "array",
"description": "Screening Schools. Not available on Law instance"
},
"screenGraduationDateStart": {
"type": "string",
"description": "Screening Graduation Date (Start). Not available on Law instance"
},
"screenGraduationDateEnd": {
"type": "string",
"description": "Screening Graduation Date (End). Not available on Law instance"
},
"screenDegreeLevel": {
"type": "array",
"description": "Screening Degree Levels. Not available on Law instance"
},
"screenGpa": {
"type": "string",
"description": "Screening Minimum GPA. Not available on Law instance"
},
"screenWorkAuthorization": {
"type": "array",
"description": "Screening Work Authorization. Not available on Law instance"
},
"screenClassLevel": {
"type": "array",
"description": "Screening Class Level. Not available on Law instance"
},
"screenApplicantType": {
"type": "array",
"description": "Screening Applicant Type. Not available on Law instance"
},
"stats": {
"type": "object",
"properties": {
"studentViews": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total view clicks"
},
"unique": {
"type": "number",
"description": "Unique view clicks"
}
},
"description": "Student Views"
},
"linkTracking": {
"type": "array",
"description": "Link Tracking"
}
},
"description": "Student Statistics. Available only if ?stats=true, which adds an element of student views and link tracking statistics"
},
"ocrSchedules": {
"type": "array",
"description": "OCR Schedules. Requires parameter ?includeOcrData=true, which adds related OCR Schedule data. Not available on Law instance."
},
"affiliations": {
"type": "array",
"description": "Affiliations. Available only on an Multi School Environment (MSE) instance"
},
"externalLink": {
"type": "string",
"description": "CSM student interface direct link to approved job posting"
},
"contractHours": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Contract Hours. Available only on a CHC Aus Network instance"
},
"contractType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Contract Type. Available only on a CHC Aus Network instance"
},
"compensationType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Compensation Type. Available only on a Law instance"
},
"compensationDetails": {
"type": "string",
"description": "Compensation Details. Available only on a Law instance"
},
"messageSendOptOuts": {
"type": "array",
"description": "Message Sending Opt-Outs. Available only on a Law instance"
},
"created": {
"type": "string",
"description": "Created"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"title",
"description",
"employer",
"contact",
"types",
"locations",
"postingDate",
"expirationDate",
"restrictApplicants",
"annuallyRecurring"
]
}GET https://example-csm.symplicity.com/api/public/v1/jobs/abc123/notes
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "note",
"models": [
{
"id": "abc123",
"label": "",
"subject": "",
"body": "",
"category": {
"id": "abc123",
"label": "Display Label"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}Get NotesGET/v1/jobs/{id}/notes
Notes are free-form text entries associated with jobs in the system. Use this route to retrieve notes associated with the specified job.
URI Parameters
- id
string(required) Example: abc123id of the requested record
POST https://example-csm.symplicity.com/api/public/v1/jobs/abc123/addNote
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"subject": "Case Update",
"body": "Added missing information",
"category": "4"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"subject": string,
"body": string,
"category": {
"id": "abc123",
"label": "Display Label"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"subject": {
"type": "string",
"description": "Subject"
},
"body": {
"type": "string",
"description": "Body"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Category"
}
}
}Add NotePOST/v1/jobs/{id}/addNote
Use this route to add a note to the specified job.
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/jobs/types
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Full Time"
},
{
"id": "2",
"value": "Part Time"
},
{
"id": "3",
"value": "Internship"
},
{
"id": "4",
"value": "Temporary/Seasonal"
},
{
"id": "5",
"value": "Student Employment"
},
{
"id": "6",
"value": "Co-Op"
}
]Get Picklist keys and valuesGET/v1/picklists/jobs/{field}
Picklist represents all possible pick values for a given field.
URI Parameters
- field
string(required) Example: typesname of a pick field
Choices:
typessourceclassLeveldegreeLevelworkAuthorizationaffiliationscertificatesdocumentsRequiredadditionalDocumentsgeographicPreferencemessageSendOptOutsschoolsfunctionsmajorsminorscompensationFrequencyscreenApplicantTypescreenClassLevelscreenDegreeLevelscreenCertificatesscreenMajorsscreenMinorsscreenWorkAuthorizationscreenSchoolsnotesCategory
GET https://example-csm.symplicity.com/api/public/v1/jobs/abc123/student-views
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "tracking_users_hits",
"models": [
{
"id": "abc123",
"label": "",
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"views": 49,
"lastViewed": "2017-01-09T14:40:30Z",
"applied": 49
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Student ViewsGET/v1/jobs/{id}/student-views
Lists Job Views per student, how many times viewed, last viewed, and if student applied for the job
URI Parameters
- id
string(required) Example: abc123id of the requested Job
GET https://example-csm.symplicity.com/api/public/v1/jobs/abc123/url-track
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "url_tracking",
"models": [
{
"totalClicks": 49,
"uniqueClicks": 49,
"breakdown": [
{
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"clickedOn": "2017-01-09T14:40:30Z"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Student URL TrackingGET/v1/jobs/{id}/url-track
Lists Job links with total and unique clicks, as well as per student breakdown, timestamped
URI Parameters
- id
string(required) Example: abc123id of the requested Job
Experiential Learning ¶
Experiential Learning is a work placement opportunity that is fulfilled by a student for a specific job with an employer. This is where the student will provide specific information regarding the timing of their placement, what learning objectives they may wish to accomplish, and supervisory information for their work experience. The work placements are defined by a set period of time for when they are completed called a Work Term. Students may hold more than one placement at the same time.
Experiential Learning ¶
GET https://example-csm.symplicity.com/api/public/v1/experiential-learning?type=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=name
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "exp_learning",
"models": [
{
"id": "abc123",
"label": "",
"visualId": 49,
"startDate": "2017-01-09",
"endDate": "2017-01-09",
"enrollDate": "2017-01-09",
"type": {
"id": "abc123",
"label": "Display Label"
},
"workTerm": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerRegistration": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newEmployer": "",
"assignedContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"job": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newJobTitle": "",
"workEmail": "",
"classNumber": "",
"placedBy": {
"id": "abc123",
"label": "Display Label"
},
"credits": {
"id": "abc123",
"label": "Display Label"
},
"grade": {
"id": "abc123",
"label": "Display Label"
},
"compensationType": {
"id": "abc123",
"label": "Display Label"
},
"compensation": "",
"hoursPerWeek": 49,
"totalHoursSummary": {
"submitted": "",
"approved": "",
"rejected": "",
"pending": ""
},
"supervisor": {
"name": "",
"email": "",
"phone": "",
"department": ""
},
"draft": false,
"completed": false,
"approvalStatus": {
"id": "abc123",
"label": "Display Label"
},
"created": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Experiential Learning DataGET/v1/experiential-learning{?type,lastModified,customFields,page,perPage,sort}
URI Parameters
- type
PickValue(optional)Filter Types.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: nameName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/experiential-learning/772c21111e8865b1ecc83b999caa4d2a
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"visualId": 1,
"startDate": string,
"endDate": string,
"enrollDate": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"workTerm": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerRegistration": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newEmployer": string,
"assignedContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"job": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newJobTitle": string,
"workEmail": string,
"classNumber": string,
"placedBy": {
"id": "abc123",
"label": "Display Label"
},
"credits": {
"id": "abc123",
"label": "Display Label"
},
"grade": {
"id": "abc123",
"label": "Display Label"
},
"compensationType": {
"id": "abc123",
"label": "Display Label"
},
"compensation": string,
"hoursPerWeek": 1,
"totalHoursSummary": {
"submitted": string,
"approved": string,
"rejected": string,
"pending": string
},
"supervisor": {
"name": string,
"email": string,
"phone": string,
"department": string
},
"draft": true,
"completed": true,
"approvalStatus": {
"id": "abc123",
"label": "Display Label"
},
"created": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"visualId": {
"type": "number",
"description": "Visual ID"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"enrollDate": {
"type": "string",
"description": "Enroll Date"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"workTerm": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Work Term"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"employerRegistration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer Registration"
},
"newEmployer": {
"type": "string",
"description": "New Employer"
},
"assignedContact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Contact"
},
"job": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Job"
},
"newJobTitle": {
"type": "string",
"description": "New Job Title"
},
"workEmail": {
"type": "string",
"description": "Work Email"
},
"classNumber": {
"type": "string",
"description": "Class Number"
},
"placedBy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Placed By"
},
"credits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Credits"
},
"grade": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Grade"
},
"compensationType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Compensation Type"
},
"compensation": {
"type": "string",
"description": "Compensation"
},
"hoursPerWeek": {
"type": "number",
"description": "Hours Per Week"
},
"totalHoursSummary": {
"type": "object",
"properties": {
"submitted": {
"type": "string",
"description": "Total Submitted Hours"
},
"approved": {
"type": "string",
"description": "Total Approved Hours"
},
"rejected": {
"type": "string",
"description": "Total Rejected Hours"
},
"pending": {
"type": "string",
"description": "Total Pending Hours"
}
},
"description": "Total Hours Summary"
},
"supervisor": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"department": {
"type": "string",
"description": "Department"
}
},
"description": "Supervisor"
},
"draft": {
"type": "boolean",
"description": "Draft"
},
"completed": {
"type": "boolean",
"description": "Completed. Available only if the System Setting \"Experiential Learning Placement Completed Field\" is ON"
},
"approvalStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Approval Status"
},
"created": {
"type": "string",
"description": "Created"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get Experiential LearningGET/v1/experiential-learning/{id}
URI Parameters
- id
string(required) Example: 772c21111e8865b1ecc83b999caa4d2aid of the requested record
PUT https://example-csm.symplicity.com/api/public/v1/experiential-learning/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"startDate": "2025-09-21",
"endDate": "2026-01-18",
"assignedContact": "4669947417456f3ecb8707a13f6325c9"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"visualId": 1,
"startDate": string,
"endDate": string,
"enrollDate": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"workTerm": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employerRegistration": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newEmployer": string,
"assignedContact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"job": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"newJobTitle": string,
"workEmail": string,
"classNumber": string,
"placedBy": {
"id": "abc123",
"label": "Display Label"
},
"credits": {
"id": "abc123",
"label": "Display Label"
},
"grade": {
"id": "abc123",
"label": "Display Label"
},
"compensationType": {
"id": "abc123",
"label": "Display Label"
},
"compensation": string,
"hoursPerWeek": 1,
"totalHoursSummary": {
"submitted": string,
"approved": string,
"rejected": string,
"pending": string
},
"supervisor": {
"name": string,
"email": string,
"phone": string,
"department": string
},
"draft": true,
"completed": true,
"approvalStatus": {
"id": "abc123",
"label": "Display Label"
},
"created": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"visualId": {
"type": "number",
"description": "Visual ID"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"enrollDate": {
"type": "string",
"description": "Enroll Date"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"workTerm": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Work Term"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"employerRegistration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer Registration"
},
"newEmployer": {
"type": "string",
"description": "New Employer"
},
"assignedContact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Contact"
},
"job": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Job"
},
"newJobTitle": {
"type": "string",
"description": "New Job Title"
},
"workEmail": {
"type": "string",
"description": "Work Email"
},
"classNumber": {
"type": "string",
"description": "Class Number"
},
"placedBy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Placed By"
},
"credits": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Credits"
},
"grade": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Grade"
},
"compensationType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Compensation Type"
},
"compensation": {
"type": "string",
"description": "Compensation"
},
"hoursPerWeek": {
"type": "number",
"description": "Hours Per Week"
},
"totalHoursSummary": {
"type": "object",
"properties": {
"submitted": {
"type": "string",
"description": "Total Submitted Hours"
},
"approved": {
"type": "string",
"description": "Total Approved Hours"
},
"rejected": {
"type": "string",
"description": "Total Rejected Hours"
},
"pending": {
"type": "string",
"description": "Total Pending Hours"
}
},
"description": "Total Hours Summary"
},
"supervisor": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"email": {
"type": "string",
"description": "Email"
},
"phone": {
"type": "string",
"description": "Phone"
},
"department": {
"type": "string",
"description": "Department"
}
},
"description": "Supervisor"
},
"draft": {
"type": "boolean",
"description": "Draft"
},
"completed": {
"type": "boolean",
"description": "Completed. Available only if the System Setting \"Experiential Learning Placement Completed Field\" is ON"
},
"approvalStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Approval Status"
},
"created": {
"type": "string",
"description": "Created"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Update Experiential LearningPUT/v1/experiential-learning/{id}
Update is available for startDate, endDate, assignedContact and all custom fields. assignedContact must be an active contact related to the employer on the placement record, or (for Law instances) a contact from the related employers
URI Parameters
- id
string(required) Example: abc123id of the updated record
GET https://example-csm.symplicity.com/api/public/v1/picklists/experiential-learning/type
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Internship"
},
{
"id": "2",
"value": "Co-op"
},
{
"id": "3",
"value": "Externship"
}
]Get Picklist keys and valuesGET/v1/picklists/experiential-learning/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typename of a pick field
Choices:
typeplacedBycreditsgradecompensationTypeapprovalStatusnotesCategory
GET https://example-csm.symplicity.com/api/public/v1/experiential-learning/abc123/notes
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "note",
"models": [
{
"id": "abc123",
"label": "",
"subject": "",
"body": "",
"category": {
"id": "abc123",
"label": "Display Label"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}Get NotesGET/v1/experiential-learning/{id}/notes
Notes are free-form text entries associated with experiential learning records in the system. Use this route to retrieve notes associated with the specified experiential learning record.
URI Parameters
- id
string(required) Example: abc123id of the requested record
POST https://example-csm.symplicity.com/api/public/v1/experiential-learning/abc123/addNote
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"subject": "Case Update",
"body": "Added missing information",
"category": "4"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"subject": string,
"body": string,
"category": {
"id": "abc123",
"label": "Display Label"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"subject": {
"type": "string",
"description": "Subject"
},
"body": {
"type": "string",
"description": "Body"
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Category"
}
}
}Add NotePOST/v1/experiential-learning/{id}/addNote
Use this route to add a note to the specified experiential learning record.
URI Parameters
- id
string(required) Example: abc123id of the requested record
Experiential Learning Work Term ¶
Experiential Learning Work Term is a defined period during which a student may complete an Experiential Learning placement. This is where the system administrator can provide a label and description for the work period, the dates between which a placement occurs, and can make it visible to employers to select when submitting their job opportunities. It is tied to the placement record for students and the employers with whom they are working.
Experiential Learning Work Term ¶
GET https://example-csm.symplicity.com/api/public/v1/experiential-learning-work-term?title=&lastModified=["2020-11-22","2021-11-21"]&page=1&perPage=10&sort=title
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "exp_learning_work_term",
"models": [
{
"id": "abc123",
"title": "",
"description": "",
"startDate": "2017-01-09",
"endDate": "2017-01-09",
"published": false,
"archived": false,
"archivedOn": "2017-01-09T14:40:30Z",
"created": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Experiential Learning Work Term DataGET/v1/experiential-learning-work-term{?title,lastModified,page,perPage,sort}
URI Parameters
- title
string(optional)Filter by Title.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: titleName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/experiential-learning-work-term/772c21111e8865b1ecc83b999caa4d2a
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"title": string,
"description": string,
"startDate": string,
"endDate": string,
"published": true,
"archived": true,
"archivedOn": string,
"created": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"title": {
"type": "string",
"description": "Label"
},
"description": {
"type": "string",
"description": "Description"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"published": {
"type": "boolean",
"description": "Published"
},
"archived": {
"type": "boolean",
"description": "Archived"
},
"archivedOn": {
"type": "string",
"description": "Archived On"
},
"created": {
"type": "string",
"description": "Created"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get Experiential Learning Work TermGET/v1/experiential-learning-work-term/{id}
URI Parameters
- id
string(required) Example: 772c21111e8865b1ecc83b999caa4d2aid of the requested record
Professional Network Mentor Profile ¶
Current and former students, contacts, and faculty staff who are members of the Professional Network (ProNet) mentoring program within the CSM.
ProNet Profile ¶
GET https://example-csm.symplicity.com/api/public/v1/pronet/ca23456789abcdef0123456789abcdef
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"careerField": {
"id": "abc123",
"label": "Display Label"
},
"additionalInfo": true,
"workExperience": [
{
"id": "abc123",
"label": string,
"jobTitle": string,
"employer": string,
"employerSite": string,
"address": {
"id": "abc123",
"label": "Display Label",
"link": "href"
}
}
],
"education": [
{
"school": string,
"major": {
"id": "abc123",
"label": "Display Label"
},
"degree": {
"id": "abc123",
"label": "Display Label"
},
"graduationYear": 1
}
],
"employment": [
{
"employer": string,
"jobTitle": string,
"jobDescription": string,
"status": {
"id": "abc123",
"label": "Display Label"
}
}
],
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"careerField": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Career Field"
},
"additionalInfo": {
"type": "boolean",
"description": "Additional Info"
},
"workExperience": {
"type": "array",
"description": "Work Experience"
},
"education": {
"type": "array",
"description": "Education"
},
"employment": {
"type": "array",
"description": "Employment"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get ProNet ProfileGET/v1/pronet/{id}
Description
URI Parameters
- id
string(required) Example: ca23456789abcdef0123456789abcdefid of the requested record
Counseling ¶
Counseling appointment records which reflect historical, future, cancelled and pending career counseling appointment information.
Counseling ¶
GET https://example-csm.symplicity.com/api/public/v1/counsel?keywords=&dateRange=["2017-01-10","2018-09-12"]&perPage=10&page=1&sort=lastModified
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "career_counseling",
"models": [
{
"id": "abc123",
"label": "",
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"type": {
"id": "abc123",
"label": "Display Label"
},
"date": "2017-01-09",
"time": "14:40:30",
"appointmentStart": "2017-01-09T14:40:30Z",
"appointmentLength": {
"id": "abc123",
"label": "Display Label"
},
"isJoint": false,
"status": "",
"notes": "",
"studentNotes": "",
"kioskCheckInTime": "2017-01-09T14:40:30Z",
"meetingStart": "2017-01-09T14:40:30Z",
"meetingEnd": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List CounselingsGET/v1/counsel{?keywords,dateRange,perPage,page,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2017-01-10","2018-09-12"]Filter collection by a date range.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: lastModifiedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/counsel/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"type": {
"id": "abc123",
"label": "Display Label"
},
"date": string,
"time": string,
"appointmentStart": string,
"appointmentLength": {
"id": "abc123",
"label": "Display Label"
},
"isJoint": true,
"status": string,
"notes": string,
"studentNotes": string,
"kioskCheckInTime": string,
"meetingStart": string,
"meetingEnd": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"counselors": {
"type": "array",
"description": "Counselors"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"date": {
"type": "string",
"description": "Counseling Date (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"time": {
"type": "string",
"description": "Counseling Time (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"appointmentStart": {
"type": "string",
"description": "Appointment Start (* Should be specified in UTC/Z format, e.g., 2019-01-09T14:40:30Z)"
},
"appointmentLength": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Appointment Length"
},
"isJoint": {
"type": "boolean",
"description": "Joint Appointment"
},
"status": {
"type": "string",
"description": "Status"
},
"notes": {
"type": "string",
"description": "Counselor Notes"
},
"studentNotes": {
"type": "string",
"description": "Student Notes"
},
"kioskCheckInTime": {
"type": "string",
"description": "Kiosk Check-In Time. Available only if instance uses Kiosks module"
},
"meetingStart": {
"type": "string",
"description": "Meeting Start Time"
},
"meetingEnd": {
"type": "string",
"description": "Meeting End Time"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"counselors",
"type",
"appointmentStart",
"appointmentLength"
]
}Get CounselingGET/v1/counsel/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/counsel/type
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": 12,
"value": "Guidance & Career (30 mins)",
"length": "6"
},
{
"id": 3,
"value": "Internship Opportunity (60 mins)",
"length": "3"
},
{
"id": 2,
"value": "Resume Review (30 mins)",
"length": "6"
}
]Get Picklist keys and valuesGET/v1/picklists/counsel/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typename of a pick field
Choices:
typestatuscounselorsappointmentLength
POST https://example-csm.symplicity.com/api/public/v1/counsel
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"student": "9681b36dfe74f4f0d6411d585c043825",
"appointmentStart": "2020-01-11T17:57:03Z",
"type": "12",
"appointmentLength": "6",
"notes": "Student appeared anxious",
"studentNotes": "Overwhelmed by work deadlines",
"counselors": [
"7c6a3c645334181d95f20920b7345f78",
"05d3d53e4c06f658bf26f8bb042fec37"
]
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"type": {
"id": "abc123",
"label": "Display Label"
},
"date": string,
"time": string,
"appointmentStart": string,
"appointmentLength": {
"id": "abc123",
"label": "Display Label"
},
"isJoint": true,
"status": string,
"notes": string,
"studentNotes": string,
"kioskCheckInTime": string,
"meetingStart": string,
"meetingEnd": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"counselors": {
"type": "array",
"description": "Counselors"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"date": {
"type": "string",
"description": "Counseling Date (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"time": {
"type": "string",
"description": "Counseling Time (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"appointmentStart": {
"type": "string",
"description": "Appointment Start (* Should be specified in UTC/Z format, e.g., 2019-01-09T14:40:30Z)"
},
"appointmentLength": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Appointment Length"
},
"isJoint": {
"type": "boolean",
"description": "Joint Appointment"
},
"status": {
"type": "string",
"description": "Status"
},
"notes": {
"type": "string",
"description": "Counselor Notes"
},
"studentNotes": {
"type": "string",
"description": "Student Notes"
},
"kioskCheckInTime": {
"type": "string",
"description": "Kiosk Check-In Time. Available only if instance uses Kiosks module"
},
"meetingStart": {
"type": "string",
"description": "Meeting Start Time"
},
"meetingEnd": {
"type": "string",
"description": "Meeting End Time"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"counselors",
"type",
"appointmentStart",
"appointmentLength"
]
}Create CounselingPOST/v1/counsel
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema. appointmentStart should be a valid UTC datetime string. counselors: Staff Users with Counseling Advising rights
PUT https://example-csm.symplicity.com/api/public/v1/counsel/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"appointmentStart": "2019-12-31T17:57:03Z",
"type": "40"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"type": {
"id": "abc123",
"label": "Display Label"
},
"date": string,
"time": string,
"appointmentStart": string,
"appointmentLength": {
"id": "abc123",
"label": "Display Label"
},
"isJoint": true,
"status": string,
"notes": string,
"studentNotes": string,
"kioskCheckInTime": string,
"meetingStart": string,
"meetingEnd": string,
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"counselors": {
"type": "array",
"description": "Counselors"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"date": {
"type": "string",
"description": "Counseling Date (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"time": {
"type": "string",
"description": "Counseling Time (* This field will be deprecated in V2. The full datetime is available under appointmentStart)"
},
"appointmentStart": {
"type": "string",
"description": "Appointment Start (* Should be specified in UTC/Z format, e.g., 2019-01-09T14:40:30Z)"
},
"appointmentLength": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Appointment Length"
},
"isJoint": {
"type": "boolean",
"description": "Joint Appointment"
},
"status": {
"type": "string",
"description": "Status"
},
"notes": {
"type": "string",
"description": "Counselor Notes"
},
"studentNotes": {
"type": "string",
"description": "Student Notes"
},
"kioskCheckInTime": {
"type": "string",
"description": "Kiosk Check-In Time. Available only if instance uses Kiosks module"
},
"meetingStart": {
"type": "string",
"description": "Meeting Start Time"
},
"meetingEnd": {
"type": "string",
"description": "Meeting End Time"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"counselors",
"type",
"appointmentStart",
"appointmentLength"
]
}Update CounselingPUT/v1/counsel/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/counsel?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"student": "9681b36dfe74f4f0d6411d585c043825",
"appointmentStart": "2020-01-11T17:57:03Z",
"type": "12",
"appointmentLength": "6",
"notes": "Dredd Notes",
"counselors": [
"05d3d53e4c06f658bf26f8bb042fec37",
"3d0f64e116434a8c6b308078a040da34"
]
},
{
"counselors": "05d3d53e4c06f658bf26f8bb042fec37"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create CounselingPOST/v1/counsel?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"counselors": [
{
"id": "abc123",
"label": "Display Label",
"link": "href"
}
],
"type": {
"id": "abc123",
"label": "Display Label"
},
"date": "2017-01-09",
"time": "14:40:30",
"appointmentStart": "2017-01-09T14:40:30Z",
"appointmentLength": {
"id": "abc123",
"label": "Display Label"
},
"isJoint": false,
"status": "",
"notes": "",
"studentNotes": "",
"kioskCheckInTime": "2017-01-09T14:40:30Z",
"meetingStart": "2017-01-09T14:40:30Z",
"meetingEnd": "2017-01-09T14:40:30Z",
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/counsel?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"type": "40",
"notes": "Update A"
},
{
"type": "40",
"notes": "Update B"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update Counseling RecordsPUT/v1/counsel?batch=1
Career Outcome ¶
The Career Outcomes CSM module tracks student employment placement activity. Schools determine the types of outcomes tracked in their system via a Career Outcomes placement Type picklist, but often these include Co-op Placements, Internship Placements, and post graduation Career Employment records. The outcome “semester” field applies to Co-Op and Internship Placements, but not “Career” outcomes.
Career Outcome ¶
GET https://example-csm.symplicity.com/api/public/v1/career-outcomes?keywords=&lastModified=["2020-11-22","2021-11-21"]&customFields=&page=1&perPage=10&sort=lastModified
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "student_coop",
"models": [
{
"id": "abc123",
"label": "",
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"externalEmployer": "",
"supervisor": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobTitle": "",
"workEmail": "",
"workPhone": "",
"placementType": {
"id": "abc123",
"label": "Display Label"
},
"positionType": {
"id": "abc123",
"label": "Display Label"
},
"semester": {
"id": "abc123",
"label": "Display Label"
},
"startDate": "2017-01-09",
"endDate": "2017-01-09",
"evaluationProcessed": false,
"comments": "",
"location": {
"city": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Career OutcomesGET/v1/career-outcomes{?keywords,lastModified,customFields,page,perPage,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: lastModifiedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
number(optional)Set to 1 to add an array of custom fields/values to output
GET https://example-csm.symplicity.com/api/public/v1/career-outcomes/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"externalEmployer": string,
"supervisor": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobTitle": string,
"workEmail": string,
"workPhone": string,
"placementType": {
"id": "abc123",
"label": "Display Label"
},
"positionType": {
"id": "abc123",
"label": "Display Label"
},
"semester": {
"id": "abc123",
"label": "Display Label"
},
"startDate": string,
"endDate": string,
"evaluationProcessed": true,
"comments": string,
"location": {
"city": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"externalEmployer": {
"type": "string",
"description": "External Employer"
},
"supervisor": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Supervisor"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"workEmail": {
"type": "string",
"description": "Work Email"
},
"workPhone": {
"type": "string",
"description": "Work Phone"
},
"placementType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Placement Type"
},
"positionType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Position Type"
},
"semester": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Semester"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"evaluationProcessed": {
"type": "boolean",
"description": "Evaluation Processed"
},
"comments": {
"type": "string",
"description": "Comments"
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
},
"description": "Location"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"placementType",
"startDate"
]
}Get Career OutcomeGET/v1/career-outcomes/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/career-outcomes/placementType
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": 1,
"value": "Co-op"
},
{
"id": 2,
"value": "Further Education"
},
{
"id": 3,
"value": "Job Shadow"
},
{
"id": 4,
"value": "Internship Abroad"
},
{
"id": 5,
"value": "Summer Work"
}
]Get Picklist keys and valuesGET/v1/picklists/career-outcomes/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: placementTypename of a pick field
Choices:
placementTypepositionTypesemesterstatecountry
POST https://example-csm.symplicity.com/api/public/v1/career-outcomes
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"student": "9681b36dfe74f4f0d6411d585c043825",
"employer": "c9e9defc9cd42e2613a5b08c35546613",
"supervisor": "4669947417456f3ecb8707a13f6325c9",
"externalEmployer": "Symplicity Corp.",
"jobTitle": "Mathador",
"startDate": "2016-01-07",
"endDate": "2017-05-11",
"placementType": 5,
"positionType": 3,
"semester": 16,
"evaluationProcessed": false,
"workEmail": "mathador@test.com",
"workPhone": "778 456 9807",
"location": {
"city": "Springfield",
"zip": "36784",
"state": "US-AL",
"country": "US"
},
"comments": "it was very good to work with the people at this fascility"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"externalEmployer": string,
"supervisor": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobTitle": string,
"workEmail": string,
"workPhone": string,
"placementType": {
"id": "abc123",
"label": "Display Label"
},
"positionType": {
"id": "abc123",
"label": "Display Label"
},
"semester": {
"id": "abc123",
"label": "Display Label"
},
"startDate": string,
"endDate": string,
"evaluationProcessed": true,
"comments": string,
"location": {
"city": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"externalEmployer": {
"type": "string",
"description": "External Employer"
},
"supervisor": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Supervisor"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"workEmail": {
"type": "string",
"description": "Work Email"
},
"workPhone": {
"type": "string",
"description": "Work Phone"
},
"placementType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Placement Type"
},
"positionType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Position Type"
},
"semester": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Semester"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"evaluationProcessed": {
"type": "boolean",
"description": "Evaluation Processed"
},
"comments": {
"type": "string",
"description": "Comments"
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
},
"description": "Location"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"placementType",
"startDate"
]
}Create Career OutcomePOST/v1/career-outcomes
Not all fields returned in GET responses are writable with POST/PUT. The writable fields are indicated in the request body schema. A newly created Career Outcome requires either “employer” (ID of the employer in the system) or “externalEmployer” (name of firm not in the system). Only one or the other can be specified. If “employer” is set, it is also necessary to specify the supervisor (Contact ID), who must be a contact associated to the specified existing employer.
PUT https://example-csm.symplicity.com/api/public/v1/career-outcomes/abc123
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
{
"jobTitle": "Director"
}Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"externalEmployer": string,
"supervisor": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobTitle": string,
"workEmail": string,
"workPhone": string,
"placementType": {
"id": "abc123",
"label": "Display Label"
},
"positionType": {
"id": "abc123",
"label": "Display Label"
},
"semester": {
"id": "abc123",
"label": "Display Label"
},
"startDate": string,
"endDate": string,
"evaluationProcessed": true,
"comments": string,
"location": {
"city": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"student": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Student"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"externalEmployer": {
"type": "string",
"description": "External Employer"
},
"supervisor": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Supervisor"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"workEmail": {
"type": "string",
"description": "Work Email"
},
"workPhone": {
"type": "string",
"description": "Work Phone"
},
"placementType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Placement Type"
},
"positionType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Position Type"
},
"semester": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Semester"
},
"startDate": {
"type": "string",
"description": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date"
},
"evaluationProcessed": {
"type": "boolean",
"description": "Evaluation Processed"
},
"comments": {
"type": "string",
"description": "Comments"
},
"location": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
},
"description": "Location"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
},
"required": [
"student",
"placementType",
"startDate"
]
}Update Career OutcomePUT/v1/career-outcomes/{id}
URI Parameters
- id
string(required) Example: abc123id of the record to update
POST https://example-csm.symplicity.com/api/public/v1/career-outcomes?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"student": "9681b36dfe74f4f0d6411d585c043825",
"externalEmployer": "Symplicity Corp.",
"jobTitle": "Mathador",
"placementType": 6,
"startDate": "2016-01-07",
"endDate": "2017-05-11",
"comments": "We made excellent use of weekly staff support groups for the whole team"
},
{
"jobTitle": "Mathador",
"placementType": 5
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Create Career OutcomePOST/v1/career-outcomes?batch=1
GET https://example-csm.symplicity.com/api/public/v1/batch/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": "",
"total": 0,
"className": "",
"responses": [
{
"id": "abc123",
"label": "",
"student": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"externalEmployer": "",
"supervisor": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"jobTitle": "",
"workEmail": "",
"workPhone": "",
"placementType": {
"id": "abc123",
"label": "Display Label"
},
"positionType": {
"id": "abc123",
"label": "Display Label"
},
"semester": {
"id": "abc123",
"label": "Display Label"
},
"startDate": "2017-01-09",
"endDate": "2017-01-09",
"evaluationProcessed": false,
"comments": "",
"location": {
"city": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"lastModified": "2017-01-09T14:40:30Z"
},
{
"errors": {
"field_errors": {}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, completed, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"responses": {
"type": "array"
}
}
}Batch Create ResultsGET/v1/batch/{id}
URI Parameters
- id
string(required) Example: abc123id of the batch request
PUT https://example-csm.symplicity.com/api/public/v1/career-outcomes?batch=1
Requests
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "abc123",
"jobTitle": "Nurse"
},
{
"id": "def456",
"jobTitle": "Carpenter"
}
]Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"status": string,
"total": 1,
"className": string,
"results_url": "/api/v1/batch/abc123"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the batch"
},
"status": {
"type": "string",
"description": "pending, processing, or error"
},
"total": {
"type": "number",
"description": "number of records in the batch"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"results_url": {
"type": "string",
"description": "api route with status and results of the batch"
}
}
}Batch Update Career OutcomePUT/v1/career-outcomes?batch=1
OCR Schedule ¶
When employers conduct interviews with students on campus, these meetings are coordinated in the OCR (On Campus Recruiting) module. There are various ways these interview schedules can be configured in the system. Interview Schedules are set up within an Interview Sessions (e.g., “Fall Recruiting” or “Accounting Spring Interviews”). Both system settings and session settings establish what types of schedules can be managed during a session. The following types of schedules can be allowed within a CSM: Preselect - P, Alternate - A, Open - O, Room Reservation Only - R, Bidding - B, Resume Collection - C. Note, a single schedule can have multiple models to fill slots - for instance a “preselect to alternate to open” schedule creates phases of time where students apply, the employer reviews applicants, and then invites preselected, then alternates, and then finally anyone to fill slots on their schedule. Once a session is opened up to employers for schedule requests, the employer normally indicates the type of schedule they need (e.g., 2 room full-day preselect schedule of 30 minute interviews), the date they need to interview (e.g., on Oct. 26, 2018) and for what position(s) they are recruiting (e.g,. “Entry Level Marketing Analyst”). Students apply to the positions during specific windows of time, and in the case where the schedule is “open”, can actually sign up for a timeslot on the interview schedule. Alternatively, preselect schedules allow a timeframe where the employer can review applicants and invite preselected students to signup for interviews. Employers can also request “room only schedules” where they essentially book space in the recruiting center. There is also the notion of “employer managed” schedules where an employer books a room and uses the system to manage a schedule of interviews that they put together outside the normal OCR model (e.g., employers may meet candidates at a Career Fair and want to invite them to meet for interviews the next day). So in working with OCR records, there are many possible types of schedules to consider. Also note, Law instances use a different module (On Campus Interviews) to manage campus recruiting activities. This summary overview for OCR does not apply to OCI records.
OCR Schedule ¶
GET https://example-csm.symplicity.com/api/public/v1/ocr-schedules?keywords=&approved=&interviewDate=["2020-11-22","2021-11-21"]&lastModified=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=lastModified
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "ocr_schedule_data",
"models": [
{
"id": "abc123",
"label": "",
"ocrScheduleId": "",
"interviewDate": "2017-01-09",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {},
"approved": false,
"scheduleDeadlines": {
"resumeSubmissionStartDate": "2017-01-09T14:40:30Z",
"resumeSubmissionEndDate": "2017-01-09T14:40:30Z",
"preselectSignupsStartDate": "2017-01-09T14:40:30Z",
"signupStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsEndDate": "2017-01-09T14:40:30Z",
"biddingStartDate": "2017-01-09T14:40:30Z",
"biddingEndDate": "2017-01-09T14:40:30Z",
"biddingSignupsStartDate": "2017-01-09T14:40:30Z",
"biddingSignupsEndDate": "2017-01-09T14:40:30Z",
"openSignupsStartDate": "2017-01-09T14:40:30Z",
"cancelationStartDate": "2017-01-09T14:40:30Z",
"cancelationEndDate": "2017-01-09T14:40:30Z",
"signupsEndDate": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List OCR SchedulesGET/v1/ocr-schedules{?keywords,approved,interviewDate,lastModified,perPage,page,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- approved
boolean(optional)Filter collection by approval status.
- interviewDate
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Interview Date.
- lastModified
array(optional) Example: ["2020-11-22","2021-11-21"]Filter collection by Last Modified.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: lastModifiedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/ocr-schedules/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": "",
"ocrScheduleId": "",
"interviewDate": "2017-01-09",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {},
"approved": false,
"scheduleDeadlines": {
"resumeSubmissionStartDate": "2017-01-09T14:40:30Z",
"resumeSubmissionEndDate": "2017-01-09T14:40:30Z",
"preselectSignupsStartDate": "2017-01-09T14:40:30Z",
"signupStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsStartDate": "2017-01-09T14:40:30Z",
"alternateSignupsEndDate": "2017-01-09T14:40:30Z",
"biddingStartDate": "2017-01-09T14:40:30Z",
"biddingEndDate": "2017-01-09T14:40:30Z",
"biddingSignupsStartDate": "2017-01-09T14:40:30Z",
"biddingSignupsEndDate": "2017-01-09T14:40:30Z",
"openSignupsStartDate": "2017-01-09T14:40:30Z",
"cancelationStartDate": "2017-01-09T14:40:30Z",
"cancelationEndDate": "2017-01-09T14:40:30Z",
"signupsEndDate": "2017-01-09T14:40:30Z"
},
"lastModified": "2017-01-09T14:40:30Z"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"ocrScheduleId": {
"type": "string",
"description": "ID"
},
"interviewDate": {
"type": "string",
"description": "Interview Date"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"location": {
"type": "object",
"properties": {},
"description": "Location"
},
"approved": {
"type": "boolean",
"description": "Approved"
},
"scheduleDeadlines": {
"type": "object",
"properties": {
"resumeSubmissionStartDate": {
"type": "string",
"description": "Resume Submission Start"
},
"resumeSubmissionEndDate": {
"type": "string",
"description": "Resume Submission End"
},
"preselectSignupsStartDate": {
"type": "string",
"description": "Preselect Signups Start"
},
"signupStartDate": {
"type": "string",
"description": "Open-Only Signups Start"
},
"alternateSignupsStartDate": {
"type": "string",
"description": "Alternate Signups Start"
},
"alternateSignupsEndDate": {
"type": "string",
"description": "Alternate Signups End"
},
"biddingStartDate": {
"type": "string",
"description": "Bidding Period Start"
},
"biddingEndDate": {
"type": "string",
"description": "Bidding Period End"
},
"biddingSignupsStartDate": {
"type": "string",
"description": "Bidding Signup Start"
},
"biddingSignupsEndDate": {
"type": "string",
"description": "Bidding Signup End"
},
"openSignupsStartDate": {
"type": "string",
"description": "Open Signups Start"
},
"cancelationStartDate": {
"type": "string",
"description": "Cancel Period Start"
},
"cancelationEndDate": {
"type": "string",
"description": "Cancel Period End"
},
"signupsEndDate": {
"type": "string",
"description": "Schedule Close"
}
},
"description": "Schedule Deadlines"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get OCR ScheduleGET/v1/ocr-schedules/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
Calendar Event ¶
Calendar records that represent system holidays, calendar events for specific user types (employer, faculty, staff, student) and these specific types of CSM events:
-
Career Fair: many employers and many students come together to meet at a specified location (can be a physical or virtual location), and during a specific timeframe which can span multiple days.
-
Interview: On Campus Recruiting (OCR) event type where an employer’s representatives and a student meet for a specific job interview. Employer contacts coordinate the employer’s schedule in the system. Interviews are scheduled for a specific location on a specific date and for a time span. “Room Only” schedules are not included in the list because they are not shown to students in the system’s calendar.
-
Information Session / Presentation: a single employer meets with many students at a specified location and single date timeframe. Information Sessions that are restricted by class level visibility will not be included in the list. Also only approved Information Sessions will be included in the list. For Multi-School Environment (MSE) systems, if the system setting “Allow Students to View/RSVP to Info Sessions From Any System” is OFF, only Information Sessions affiliated to your specific instance are included.
-
Workshop: school’s own staff meets with many students at a specified location and timeframe. There are two types of workshop models supported, one where the time is shared for all student attendees, and one where student attendees have specific time slots within the time bounds of a longer session. Workshops that are restricted by class level visibility will not be included in the list. For Multi-School Environment (MSE) systems, if the system setting “Allow Students to View/RSVP to Workshops From Any System” is OFF, only workhops affiliated to your specific instance are inlcuded.
-
Staff Event: Only public events targeted to students will be included in the list.
-
Holidays: Days designated in the system as being holidays (no event days)
Note: Workshops and presentations can be filtered by custom fields: ?customFields=1&custom_field_name="{{office}}" where custom_field_name is a custom field defined for both event types. If a custom field does not exist on workshops or presentations, filter is ignored for that type. category filter may be used so that only desired event types are included.
Calendar Event ¶
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?category=workshop&keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=category&customFields=1
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Calendar EventsGET/v1/calendar-events{?category,keywords,dateRange,perPage,page,sort,customFields}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- category
string(optional) Example: workshopFilter collection by category.
Choices:
staffemployerstudentfacultycareer-fairholidayocrpresentationworkshop- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: categoryName of field to sort by in ascending order. Prepend ! to field name for descending sort.
- customFields
boolean(optional) Example: 1Include custom fields or not.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=startTime&category=career-fair
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Career Fair EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=career-fair
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: startTimeName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=endTime&category=employer
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Employer EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=employer
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: endTimeName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=date&category=faculty
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Faculty EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=faculty
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: dateName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=!date&category=holiday
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Holiday EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=holiday
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: !dateName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=!startTime&category=ocr
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List OCR Interview EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=ocr
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: !startTimeName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=!endTime&category=presentation
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Information Session EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=presentation
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: !endTimeName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=date&category=staff
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Staff EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=staff
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: dateName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events?keywords=&dateRange=["2020-11-22","2021-11-21"]&perPage=10&page=1&sort=startTime&category=student
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"category": "",
"date": "2017-01-09",
"startTime": "14:40:30",
"endTime": "14:40:30",
"location": "",
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Student EventsGET/v1/calendar-events{?keywords,dateRange,perPage,page,sort}&category=student
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- dateRange
array(optional) Example: ["2020-11-22","2021-11-21"]Date Range, defaults to from today to one week from today.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: startTimeName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/calendar-events/workshop/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"title": string,
"description": string,
"category": string,
"date": string,
"startTime": string,
"endTime": string,
"location": string,
"externalLink": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"title": {
"type": "string",
"description": "Title"
},
"description": {
"type": "string",
"description": "Description"
},
"category": {
"type": "string",
"description": "Category"
},
"date": {
"type": "string",
"description": "Date"
},
"startTime": {
"type": "string",
"description": "Start Time"
},
"endTime": {
"type": "string",
"description": "End Time"
},
"location": {
"type": "string",
"description": "Location"
},
"externalLink": {
"type": "string",
"description": "CSM interface direct link"
}
}
}Get Calendar EventGET/v1/calendar-events/{category}/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
- category
string(required) Example: workshop
Career Fair ¶
Career Fairs are CSM events where employers and students come together at a “place and time” indicated by the CSM fair’s settings. There are “Career Fair” and “Virtual” types of fairs. Virtual fairs occur online and do not include specification of a physical location. Career Fairs will have and present physical location(s) in the API and if applicable to the fair, booth map table designation for specific event registrants. Career fairs occur during specific event time-frame(s) that can happen on one day, span a range of days, or occur with multiple dates that can have differing time-frames by day. All times are presented in UTC format. Date filters applied to the list of Career Fairs limits the list of fairs to those with any date/timeframe falling within the specified filter criteria. Attendee types can be either “employers” or “students.” The “List Employer Registrations” route presents employer attendee type registrants for an employer attendee type fair. To ensure date range filtering works effectively where events can have multiple days, pagination is not used for this list response.
CareerFair ¶
GET https://example-csm.symplicity.com/api/public/v1/careerfairs?keywords=&attendeeType=&dateRange=["2017-01-10","2018-09-12"]&sort=created
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"attendeeType": {
"id": "abc123",
"label": "Display Label"
},
"videoFair": false,
"days": [
{
"id": "abc123",
"label": "",
"title": "",
"start": "2017-01-09T14:40:30Z",
"end": "2017-01-09T14:40:30Z",
"location": ""
}
],
"acceptRegistrations": false,
"registrantsVisible": false,
"publicDisplay": false,
"externalLink": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Career FairsGET/v1/careerfairs{?keywords,attendeeType,dateRange,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- attendeeType
string(optional)Filter collection by Attendee Type.
- dateRange
array(optional) Example: ["2017-01-10","2018-09-12"]Filter collection by a date range. Date Range defaults to from today to one week from today.
- sort
string(optional) Example: createdName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/careerfairs/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"title": string,
"description": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"attendeeType": {
"id": "abc123",
"label": "Display Label"
},
"videoFair": true,
"days": [
{
"id": "abc123",
"label": string,
"title": string,
"start": string,
"end": string,
"location": string
}
],
"acceptRegistrations": true,
"registrantsVisible": true,
"publicDisplay": true,
"externalLink": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"title": {
"type": "string",
"description": "Title"
},
"description": {
"type": "string",
"description": "Description"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"attendeeType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Attendee Type"
},
"videoFair": {
"type": "boolean",
"description": "Video Fair"
},
"days": {
"type": "array",
"description": "Days"
},
"acceptRegistrations": {
"type": "boolean",
"description": "Accept Registrations"
},
"registrantsVisible": {
"type": "boolean",
"description": "Visible to Registrants"
},
"publicDisplay": {
"type": "boolean",
"description": "Display in Public"
},
"externalLink": {
"type": "string",
"description": "External URL"
}
}
}Get CareerFairGET/v1/careerfairs/{id}
URI Parameters
- id
string(required) Example: abc123ID of the requested record
GET https://example-csm.symplicity.com/api/public/v1/careerfairs/abc123/employer-registrations
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "event_abc123",
"models": [
{
"id": "abc123",
"label": "",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"description": "",
"status": "",
"website": "",
"majorsDesired": [
{
"id": "abc123",
"label": "Display Label"
}
],
"workAuthorizationsDesired": [
{
"id": "abc123",
"label": "Display Label"
}
],
"days": [
{
"title": "",
"start": "2017-01-09T14:40:30Z",
"end": "2017-01-09T14:40:30Z",
"location": "",
"table": ""
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Employer RegistrationsGET/v1/careerfairs/{id}/employer-registrations
Lists all employer career fair registrations for a specified employer-attendee type career fair. “Status” designates the status of the employer’s registration for the event. Pending, cancelled and approved registrant status is indicated for each registrant.
URI Parameters
- id
string(required) Example: abc123id of the requested record
Information Sessions ¶
Information Session / Presentation: a single employer meets with many students at a specified location and single date timeframe. There are two types of RSVP Modes for Information Sessions. One where the session time-span is a common shared time-span for all student attendees, and one where student attendees have specific time slots within the time bounds of a longer session.
Information Session ¶
GET https://example-csm.symplicity.com/api/public/v1/info-sessions?keywords=&perPage=10&page=1&sort=lastModified
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "presentation",
"models": [
{
"id": "abc123",
"label": "",
"description": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"topic": "",
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"contact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {
"id": "abc123",
"label": "",
"information": "",
"parkingInformation": "",
"cost": "",
"address": {
"id": "abc123",
"label": "",
"street": "",
"city": "",
"locality": "",
"zip": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"latitude": "",
"longitude": ""
},
"start": "2017-01-09T14:40:30Z",
"end": "2017-01-09T14:40:30Z",
"dateViewable": "2017-01-09T14:40:30Z",
"recruitingDate": "2017-01-09T14:40:30Z",
"approved": false,
"allowRsvp": false,
"rsvpMode": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List Information SessionsGET/v1/info-sessions{?keywords,perPage,page,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: lastModifiedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/info-sessions/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"description": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"topic": string,
"employer": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"contact": {
"id": "abc123",
"label": "Display Label",
"link": "href"
},
"location": {
"id": "abc123",
"label": string,
"information": string,
"parkingInformation": string,
"cost": string,
"address": {
"id": "abc123",
"label": string,
"street": string,
"city": string,
"locality": string,
"zip": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"latitude": string,
"longitude": string
},
"start": string,
"end": string,
"dateViewable": string,
"recruitingDate": string,
"approved": true,
"allowRsvp": true,
"rsvpMode": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"description": {
"type": "string",
"description": "Description"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"topic": {
"type": "string",
"description": "Topic"
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Employer"
},
"contact": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the related record"
},
"label": {
"type": "string",
"description": "label of the related record"
},
"link": {
"type": "string",
"description": "link to the related record"
}
},
"description": "Contact"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"information": {
"type": "string",
"description": "Information"
},
"parkingInformation": {
"type": "string",
"description": "Parking Information"
},
"cost": {
"type": "string",
"description": "Cost"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"street": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"locality": {
"type": "string",
"description": "Locality. Available only on a Language Pack instance"
},
"zip": {
"type": "string",
"description": "Zip+4"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
},
"description": "Address"
},
"latitude": {
"type": "string",
"description": "Latitude"
},
"longitude": {
"type": "string",
"description": "Longitude"
}
},
"description": "Location"
},
"start": {
"type": "string",
"description": "Start"
},
"end": {
"type": "string",
"description": "End"
},
"dateViewable": {
"type": "string",
"description": "Viewable Date"
},
"recruitingDate": {
"type": "string",
"description": "Recruiting Date"
},
"approved": {
"type": "boolean",
"description": "Approved"
},
"allowRsvp": {
"type": "boolean",
"description": "Allow RSVP"
},
"rsvpMode": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "RSVP Mode"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get Information SessionGET/v1/info-sessions/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/info-sessions/type
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "1",
"value": "Q & A"
},
{
"id": "2",
"value": "Open House"
},
{
"id": "3",
"value": "Evening Social"
}
]Get Picklist keys and valuesGET/v1/picklists/info-sessions/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typename of a pick field
Choices:
type
Workshop ¶
Workshops are where a school’s own staff sets up meetings with students at a specified location and timeframe. There are two types of RSVP Modes for workshops. One where the workshop time-span is a common shared time-span for all student attendees, and one where student attendees have specific time slots within the time bounds of a longer session.
Workshop ¶
GET https://example-csm.symplicity.com/api/public/v1/workshops?keywords=&perPage=10&page=1&sort=lastModified
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "workshop",
"models": [
{
"id": "abc123",
"label": "",
"title": "",
"description": "",
"type": {
"id": "abc123",
"label": "Display Label"
},
"location": {
"id": "abc123",
"label": "",
"information": "",
"parkingInformation": "",
"cost": "",
"address": {
"id": "abc123",
"label": "",
"street": "",
"city": "",
"locality": "",
"zip": "",
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"latitude": "",
"longitude": ""
},
"start": "2017-01-09T14:40:30Z",
"end": "2017-01-09T14:40:30Z",
"dateViewable": "2017-01-09T14:40:30Z",
"allowRsvp": false,
"rsvpMode": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List WorkshopsGET/v1/workshops{?keywords,perPage,page,sort}
URI Parameters
- keywords
string(optional)Filter collection by keywords.
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
- sort
string(optional) Example: lastModifiedName of field to sort by in ascending order. Prepend ! to field name for descending sort.
GET https://example-csm.symplicity.com/api/public/v1/workshops/abc123
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"title": string,
"description": string,
"type": {
"id": "abc123",
"label": "Display Label"
},
"location": {
"id": "abc123",
"label": string,
"information": string,
"parkingInformation": string,
"cost": string,
"address": {
"id": "abc123",
"label": string,
"street": string,
"city": string,
"locality": string,
"zip": string,
"state": {
"id": "abc123",
"label": "Display Label"
},
"country": {
"id": "abc123",
"label": "Display Label"
}
},
"latitude": string,
"longitude": string
},
"start": string,
"end": string,
"dateViewable": string,
"allowRsvp": true,
"rsvpMode": {
"id": "abc123",
"label": "Display Label"
},
"lastModified": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"title": {
"type": "string",
"description": "Title"
},
"description": {
"type": "string",
"description": "Description"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Type"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"information": {
"type": "string",
"description": "Information"
},
"parkingInformation": {
"type": "string",
"description": "Parking Information"
},
"cost": {
"type": "string",
"description": "Cost"
},
"address": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Label"
},
"street": {
"type": "string",
"description": "Street Address"
},
"city": {
"type": "string",
"description": "City"
},
"locality": {
"type": "string",
"description": "Locality. Available only on a Language Pack instance"
},
"zip": {
"type": "string",
"description": "Zip+4"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "State"
},
"country": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "Country"
}
},
"description": "Address"
},
"latitude": {
"type": "string",
"description": "Latitude"
},
"longitude": {
"type": "string",
"description": "Longitude"
}
},
"description": "Location"
},
"start": {
"type": "string",
"description": "Start"
},
"end": {
"type": "string",
"description": "End"
},
"dateViewable": {
"type": "string",
"description": "Viewable Date"
},
"allowRsvp": {
"type": "boolean",
"description": "Allow RSVP"
},
"rsvpMode": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the pick value"
},
"label": {
"type": "string",
"description": "label of the pick value"
}
},
"description": "RSVP Mode"
},
"lastModified": {
"type": "string",
"description": "Last Modified"
}
}
}Get WorkshopGET/v1/workshops/{id}
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/picklists/workshops/type
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "job",
"value": "Job & Internship Search"
},
{
"id": "int_prep",
"value": "Interviewing Prep"
},
{
"id": "cf_prep",
"value": "Career Fairs Prep"
},
{
"id": "network",
"value": "Networking"
},
{
"id": "planning",
"value": "Career Planning"
}
]Get Picklist keys and valuesGET/v1/picklists/workshops/{field}
Picklist represents all possible pick values for a given field. Some picklists are only available on specific types of CSM instances.
URI Parameters
- field
string(required) Example: typename of a pick field
Choices:
type
Report ¶
Data outputs generated using CSM reporting engine. A single report query can be saved as a “report job”. Each execution of that report job generates a “report run”. The REST API allows for extraction of reports. The “className” of a report indicates the base class object type for the report.
Report ¶
GET https://example-csm.symplicity.com/api/public/v1/reports?perPage=10&page=1
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "csm_report",
"models": [
{
"id": "abc123",
"label": "",
"description": "",
"lastRun": "2017-01-09T14:40:30Z",
"className": "",
"version": ""
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}List ReportsGET/v1/reports{?perPage,page}
List existing report jobs.
URI Parameters
- page
number(optional) Example: 1Page number of the collection.
- perPage
number(optional) Default: 20 Example: 10Maximum number of records to return, up to 500.
GET https://example-csm.symplicity.com/api/public/v1/picklists/reports/status
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "pending",
"value": "pending"
},
{
"id": "processing",
"value": "processing"
},
{
"id": "complete",
"value": "complete"
},
{
"id": "error",
"value": "error"
}
]Get Picklist keys and valuesGET/v1/picklists/reports/{field}
Picklist represents all possible pick values for a given field.
URI Parameters
- field
string(required) Example: statusname of a pick field
Choices:
status
GET https://example-csm.symplicity.com/api/public/v1/reports/abc123/status?run=
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"status": string,
"created": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Name of the report"
},
"status": {
"type": "string",
"description": "Status of this report run"
},
"created": {
"type": "string",
"description": "The date and time report run was created"
}
}
}Get Report Run StatusGET/v1/reports/{id}/status{?run}
Get the status and other basic information for a given report job run. If run is not specified, returns the last run.
URI Parameters
- id
string(required) Example: abc123id of the requested record
- run
string(optional)id of a Report Run
GET https://example-csm.symplicity.com/api/public/v1/reports/abc123/details?run=
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"description": string,
"status": string,
"created": string,
"startTime": string,
"elapsedTime": string,
"headers": [
string
],
"data": [
string
],
"count": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Md5 ID"
},
"label": {
"type": "string",
"description": "Name of the report"
},
"description": {
"type": "string",
"description": "Description of the report"
},
"status": {
"type": "string",
"description": "Status of this report run"
},
"created": {
"type": "string",
"description": "The date and time this report run was created"
},
"startTime": {
"type": "string",
"description": "The date and time this run started"
},
"elapsedTime": {
"type": "string",
"description": "Length of execution"
},
"headers": {
"type": "array",
"description": "Data column names"
},
"data": {
"type": "array",
"description": "Report results"
},
"count": {
"type": "number",
"description": "Number of data rows"
}
}
}Get Report Run DetailsGET/v1/reports/{id}/details{?run}
Get details of a given report job run. If run is not specified, returns the last run.
URI Parameters
- id
string(required) Example: abc123id of the requested record
- run
string(optional)id of a Report Run
GET https://example-csm.symplicity.com/api/public/v1/reports/abc123/data?run=&format=
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
[
string
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Get Report Run DataGET/v1/reports/{id}/data{?run,format}
Get results of a given report job. If run is not specified, returns the last run.
URI Parameters
- id
string(required) Example: abc123id of the requested Report
- run
string(optional)id of a Report Run
- format
string(optional)data format to return
Choices:
arraycsvexcel
PUT https://example-csm.symplicity.com/api/public/v1/reports/abc123/run
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "abc123",
"label": string,
"status": string,
"created": string
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "MD5 ID"
},
"label": {
"type": "string",
"description": "Name of the report"
},
"status": {
"type": "string",
"description": "Status of this report run"
},
"created": {
"type": "string",
"description": "The date and time report run was created"
}
}
}Run ReportPUT/v1/reports/{id}/run
Start a new run of a given report job.
URI Parameters
- id
string(required) Example: abc123id of the requested record
GET https://example-csm.symplicity.com/api/public/v1/reports/abc123/runs?perPage=&page=
Responses
Headers
Content-Type: application/json;charset=UTF-8Body
{
"page": 1,
"perPage": 20,
"total": 100,
"className": "report_result",
"models": [
{
"id": "abc123",
"label": "",
"status": "",
"created": "2017-01-09T14:40:30Z"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Page returned"
},
"perPage": {
"type": "number",
"description": "Number of responses to returned per Page"
},
"total": {
"type": "number",
"description": "Total responses"
},
"className": {
"type": "string",
"description": "name of the backend data record type"
},
"models": {
"type": "array"
}
}
}Get Report RunsGET/v1/reports/{id}/runs{?perPage,page}
Get a collection of previous runs of a given report job.
URI Parameters
- id
string(required) Example: abc123id of the requested record
- page
number(optional)Page number of the collection.
- perPage
number(optional) Default: 20Maximum number of records to return, up to 500.
Generated by aglio on 03 Mar 2026