CE Manager, the market leader in continuing education compliance tracking software, is used in over 400 jurisdictions worldwide. For nearly 20 years, firms have relied on CE Manager for its CLE, CPE, and CPD tracking and professional development capabilities.
\nCE Manager's APIs belong to the Representational State Transfer (REST) category. They allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data from your CE MAnager. The APIs also support Cross-Origin Resource Sharing (CORS).
\nYou can also:
\n\n\nNote:\nThis documentation is for the v1.0 of the APIs.
\n
Deprecation Policy\nThe current version of production level APIs is v1. When a new version of APIs is made generally available, the older version will be deprecated and will cease to function after one year. Once an API is removed, any request to it will result in a 404 error.
\n\n\nNote:\nWe will not remove any API until similar functionality is present in the new version
\n
Breaking Change Policy\nChanges that do not break an API, such as adding a new attribute can be made at any time. Changes that break a production level API such as removing attributes or making major changes to the API’s behavior will only be done with an advance notice of 60 days. However, there may be rare occasions where due to legal, performance, or security reasons, we are forced to make breaking changes without advance notice.
\nThe firm who wish to use the CE Manager API will be given a client_id and client_secret. These will be provided upon request.
\nCE Manager APIs are plain JSON over HTTPS and use the following HTTPS methods:
\nWeb API returns all response data as a JSON object. See the Web API Endpoint for a description of all the retrievable objects.
\nWeb API uses the following response status codes, as defined in the RFC 2616 and RFC 6585:
\nWeb API uses two different formats to describe an error:
\nAuthentication Error Object\nWhenever the application makes requests related to authentication or authorization to Web API, such as retrieving an access token or refreshing an access token, the error response follows RFC 6749 on the OAuth 2.0 Authorization Framework.
\nHere is an example of a request that has an invalid access token.
\n{\n \"error\": \"invalid_client\",\n \"error_description\": \"Invalid client secret\"\n}\nRegular Error Object\nApart from the response code, unsuccessful responses return a JSON object containing the following information:
\nHere, for example is the error that occurs when trying to fetch information for a non-existent record:
\n[\n {\n \"IsValid\": false,\n \"Errors\": [\n {\n \"Field\": \"field name\",\n \"Message\": \"error message\"\n },\n {\n \"Field\": \"field name\",\n \"Message\": \"error message\"\n }\n ]\n },\n {\n \"IsValid\": false,\n \"Errors\": [\n {\n \"Field\": \"field name\",\n \"Message\": \"error message\"\n },\n {\n \"Field\": \"field name\",\n \"Message\": \"error message\"\n }\n ]\n }\n]\nTimestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
\nSome endpoints support a way of paging the dataset, taking an offset and limit as query parameters:
\n$ curl https://api.micronsystems.com/v1/courses?offset=20&limit=10\nIn this example, in a list of 50 [total] courses under the firm: From the twentieth (offset) course, retrieve the next 10 (limit) courses.
\n\n\nNote: The offset numbering is zero-based. Omitting the offset parameter returns the first 30 records. Check the documentation for the specific endpoint and verify the default limit value. Requests that return an array of items are automatically paginated if the number of items exceeds 30. For example, attendance in a schedule. In such case, the results are returned within a paging object.
\n
Rate Limiting enables Web API to share access bandwidth to its resources equally across all clients.
\nRate limiting is applied as per application based on Client ID, and regardless of the number of users who authenticate using the Client ID.
\nTo reduce the amount of requests, use endpoints that fetch multiple entities in one request. For example: If you often request single course, schedule or attendees use endpoints such as List All Courses, List All Schedules or Get All Schedule Attendees, instead. For POST request, maximize the request limit by sending bulk request. The bulk request limit is 100 records per minute.
\nNote: If Web API returns status code 429, it means that you have sent too many requests. When this happens, check the X-Rate-Limit-Reset header, where you will see a number displayed. This is the number of seconds that you need to wait, before you try your request again.
\nThe returned HTTP headers of any API request show your current rate limit status:
\nTo use the CE Manager API, your app must send an OAuth2 access token in an Authorization header with each request.
\nclient_id and client_secret\n\n","urlObject":{"protocol":"https","path":["connect","token"],"host":["devauth","microncloud","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"033bc27c-1f27-4bd5-858e-ca2ba1d21b56"}],"id":"4e6266d0-71b9-432e-ab4f-151c3da436b9","_postman_id":"4e6266d0-71b9-432e-ab4f-151c3da436b9","description":""},{"name":"Affiliation","item":[{"name":"View an Affiliation","id":"a4b26c0c-4e0f-43ce-b8d8-6757f60732ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Note: Access Token will expire after 60 minutes.
\n
View a specific details of a client affiliation based on the supplied id.
\nList all client affiliations within the firm.
\nUpdate information of an existing client affiliation. The request allows multiple updating of client affiliations.
\nCreate a new client affiliation. The request allows multiple adding of client affiliations.
\nDelete a specific affiliation based on the provided Affiliation Id.
\nAffiliation refers to a specific company that a firm's client list is assocaited with.
\n","_postman_id":"ec11f581-276d-444f-a9b3-25d4416891a4"},{"name":"Attendance","item":[{"name":"List credit records of an attendance id","id":"72411588-2784-4398-9bfe-e11e49acf446","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List the credits earned by an attendee or instructor.
\nUpdate credits of an Attendee or Instructor registered under a schedule.
\nDelete attendee or instructor from a course or schedule.
\nAttendance is the list of those who attended and completed a program.
\n","_postman_id":"b0f0d23f-9d36-45e0-9276-562b2375f779"},{"name":"ClassYear","item":[{"name":"View a Class Year","id":"91c831e7-31a5-4f82-a85f-ef096a37ea7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of class year based on the supplied id.
\nList all availabe class years within the firm.
\nUpdate information of an existing class year. The request allows multiple updating of class years.
\nCreate a new class year. The request allows multiple adding of class years.
\nDelete a specific class year based on the provided Class Year Id.
\nClass year is the year an end user graduated from educational institution.
\n","_postman_id":"e56f88dc-5567-4b7d-9047-75515e882956"},{"name":"Compliance","item":[{"name":"Get Compliance Reports of Users","id":"32652815-bb25-4dc2-b5fc-f90fcdd896e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all compliance reports of user's licenses based on the supplied id.
\nList down compliance report links based on the supplied id of user and license.
\nView a compliance report of a specific license of user based on the supplied id.
\nIn CEM, credits gain from different courses are tabulated to identify the status of every licenses associated to a user wherein this report is called compliance chart.
\n","_postman_id":"8e147e18-a289-4e68-8a0e-746f202ad615"},{"name":"Country","item":[{"name":"List all Countries","id":"f5f04d88-389b-48e9-942d-0c02a654d6b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all available countries within the firm.
\nView a specific details of a country based on the supplied id.
\nCountry is used to determine what region a provider or firm resides in.
\n","_postman_id":"ce4cb535-a2e1-4962-a3e6-8da0c835c4b1"},{"name":"Course","item":[{"name":"View a Course","id":"b479fb67-7d2c-4443-a573-9750665c2cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of course based on the supplied id.
\nView the licenses associated to a specific course.
\nView a Course by Vendor Course Id
\nView a specific license associated to a course.
\nList all attendees and instructors included in a course.
\nList all availabe courses within the firm.
\nUpdate information of an existing course. The request allows multiple updating of courses.
\n\n\nTo retrieve the list of course formats, use method: GET List all Course formats
\n
\nTo retrieve the list of providers, use method: GET List all Providers
\nTo retrieve the list of locations, use method: GET List all Locations
Update credits of license associated to a course.
\n\n\nTo retrieve the list of licenses associated to a course, use method: GET List all Licenses associated to a Course\n
\n
To retrieve a license with its corresponding credit types and properties, use the method: GET List all the credit types and properties associated to a license
Create a new course. The request allows multiple adding of courses.
\n\n\nTo retrieve the list of course formats, use method: GET List all Course formats
\n
\nTo retrieve the list of providers, use method: GET List all Providers
\nTo retrieve the list of locations, use method: GET List all Locations
Associate new license(s) and applied necessary credits to a course.
\n\n\nTo retrieve a license with its corresponding credit types and properties, use the method: GET List all the credit types and properties associated to a license
\n
\nIf the provided license properties are complete, it will bypass the verification of licenses to be associated to the course.
Update a Vendor Course Id
\nDelete a Course
\nDelete a License associated to a Course
\nIn CEM, a course is created to let attendees or instructors acquire credits by attending schedules under a course.
\n","_postman_id":"26d41304-b008-4331-a43b-546fede34996"},{"name":"Department","item":[{"name":"View a Department","id":"b241b261-5245-4300-95a4-baf94ebb9f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a depatrtment based on supplied id.
\nList all available departments within the firm.
\nUpdate information of an existing department. The request allows multiple updating of departments.
\nCreate a new department. The request allows multiple adding of departments.
\nDelete a specific department based on the provided Department Id.
\nDepartment is a specialized functional area within an organization or a division. Department is use as an additional information for courses and users.
\n","_postman_id":"0692a193-821d-4e20-a5f6-5f8efb296e43"},{"name":"Ethnicity","item":[{"name":"View an Ethnicity","id":"12a97f40-2a2c-41df-898c-586ab66d88d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of an ethnicity based on supplied id.
\nList all available ethnicities within the firm.
\nUpdate information of an existing ethnicity. The request allows multiple updating of ethnicities.
\nCreate a new ethnicity. The request allows multiple adding of ethnicities.
\nDelete a specific ethnicity based on the provided Ethnicity Id.
\nEthnicity is a category of people who identify with each other based on similarities such as common ancestry, language, history, society, culture or nation.
\n","_postman_id":"dac46bf9-6be4-40e8-bad0-d54d2e562711"},{"name":"Format","item":[{"name":"View a Course Format","id":"f35437cb-1efb-4792-81ee-f1189291591e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a course format based on supplied id.
\nList all available course formats within the firm.
\nA course format refers to the layout of a course.
\n \n \n","_postman_id":"27ae7ee8-5f67-4c9f-b576-a944ff54e40c"},{"name":"LearningTrack","item":[{"name":"List all courses associated to a learning track","id":"751db292-931d-4b71-a88b-a8ecf75d5a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all courses associated to a learning track.
\nList all available learning tracks within the firm.
\nA Learning Track is a customized course catalog designed by an institution. There are two types of learning tracks which are free choice and arranged.
\n","_postman_id":"dfe89e3a-312a-4691-8c8f-0d91fe72365e"},{"name":"Level","item":[{"name":"View a Level","id":"9b36a537-06a9-4c24-90b4-b26ffbc3b531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a level based on supplied id.
\nList all levels available within the firm.
\nUpdate information of an existing level. The request allows multiple updating of levels.
\nCreate a new level. The request allows multiple adding of levels.
\nDelete a specific level based on the provided Level Id.
\nA level is a relative position or degree of value in a graded group.
\n","_postman_id":"ec9b03a1-fd77-412c-99e2-6a19eda87285"},{"name":"License","item":[{"name":"View a License","id":"77cc402d-b87f-4494-bd94-117230474348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a license based on supplied id.
\nList all the credit types and properties associated to a license.
\nList all enabled licenses within the firm.
\nLicense is a form of government regulation requiring a license to pursue a particular profession or vocation for compensation.
\n","_postman_id":"fa099d49-8e62-49d2-8cfc-d6d85e1870f8"},{"name":"Location","item":[{"name":"View a Location","id":"627dea9f-bc38-40c1-86b8-3e594006d100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a location based on supplied id.
\nList all available locations within the firm.
\nUpdate information of an existing location. The request allows multiple updating of locations.
\nCreate a new location. The request allows multiple adding of locations.
\nDelete a specific location based on the provided Location Id.
\nLocation is the physical space where providers and firm offices exists
\n ","_postman_id":"51038cbf-64b6-4f24-948e-577b92798bee"},{"name":"Material","item":[{"name":"Get list of available Materials","id":"be548a06-4b74-45a6-ad14-dd103dab04b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all available materials within the firm.
\nMaterials are the resources instructors use to deliver instruction. In CEM, materials are uploaded and associated to courses.
\n","_postman_id":"e02ccc34-684a-4d96-86b1-546d8143c73a"},{"name":"PracticeArea","item":[{"name":"View a Practice Area","id":"04e4ec59-5d87-4dcb-9e45-d8b4ea0e2e34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a practice area based on the supplied Id.
\nList all available practice areas within the firm.
\nUpdate information of an existing practice area. The request allows multiple updating of practice areas.
\nCreate a new practice area. The request allows multiple adding of practice areas.
\nDelete a specific practice area based on the provided Practice Area Id.
\nPractice Areas are the different areas of CPE/CPD to be specialized by a lawyer or accountant.
\n","_postman_id":"b97666ab-1fef-4ad0-a485-2be129111b6d"},{"name":"Provider","item":[{"name":"View a Provider","id":"b38b12a0-d530-48ea-8118-9f0bf2063af3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a provider based on supplied id.
\nList all in-house and third party providers.
\nUpdate information of an existing provider. The request allows multiple updating of providers.
\nCreate a new provider. The request allows multiple adding of providers.
\nDelete a specific provider based on the provided Provider Id.
\nProviders are Legal / Accounting orgarnizations and associations that offers opportunities/courses for CLE/CPE.
\n \n \n","_postman_id":"278289ad-2683-42a7-97f9-1b55df92baea"},{"name":"Recommendations","item":[{"name":"Get associated Recommendations associated to a user filterable by RequestType or RequestStatus","id":"55106cd0-dedb-4cad-b285-53b008f01098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all associated recommendations to a user using Request type and Request status as filters.
\nAdd new recommended courses to be taken by the user.
\nIn CEM, recommendations are used to recommend courses to be taken by users and used by the Top Performance application.
\n","_postman_id":"e7f044a8-9a05-47d0-a6a7-06cc4b301563"},{"name":"Schedule","item":[{"name":"View a Schedule","id":"ba6e83cc-7880-4fca-8712-812295d54588","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a schedule details based on provided Schedule Id.
\nList all schedules associated to a course.
\nList all licenses associated to a schedule of a course.
\nList all attendees or instructors enrolled in all schedules under a course.
\nView details of a specific schedule associated to a course.
\nList all attendees or instructors enrolled in a schedule of a course.
\nUpdate information of an existing schedule of a course. The request allows multiple updating of schedules.
\n\n\nTo retrieve the list of course formats, use method: GET List all Course formats
\n
\nTo retrieve the list of locations, use method: GET List all Locations
Update a license credits associated to a schedule of a course.
\n\n\nTo retrieve the list of licenses associated to a schedule, use the method: GET List all Licenses associated to a Schedule\n
\n
To retrieve a license with its corresponding credit types and properties, use the method: GET List all the credit types and properties associated to a license
Update the attendees or instructors enrolled in a schedule of a course.
\n\n\nTo retrieve the list of attendance ids of attendees and instructors of a schedule, use the method: GET List all Attendees and Instructors of a Schedule
\n
Create a new schedule under a course.
\n\n\nTo retrieve the list of course formats, use method: GET List all Course formats
\n
\nTo retrieve the list of locations, use method: GET List all Locations
Add new attendees or instructor to a schedule of a course.
\nUpdate a Vendor Schedule Id
\nDelete a Schedule
\nIn CEM, a course is comprised of one or many schedules (or instances) wherein attendees or instructors are enrolled to gain license credits.
\n","_postman_id":"270511d8-c785-44ee-a65e-eb6e38ffdb1a"},{"name":"State","item":[{"name":"View a State","id":"a412a517-3634-403f-8ad5-85c5b7c522c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a state based on supplied id.
\nList all available states within the firm.
\nState is a nation or territory wherein a provider or firm office resides.
\n","_postman_id":"c69b1814-8f49-4688-9ae7-f139c4e15e4b"},{"name":"Timezone","item":[{"name":"View a Time zone","id":"c979cde2-2464-4b7a-9a58-ebbf06a10e7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a time zone based on supplied id.
\nList all available time zones within the firm.
\nA time zone is a region of the globe that observes a uniform standard time for legal, commercial, and social purposes.
\n","_postman_id":"6ea7db78-6598-4d6c-b36b-67245898193d"},{"name":"Title","item":[{"name":"View a Title","id":"bb3d8b9e-6967-4be8-92b3-4be145e40043","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"View a specific details of a title based on supplied id.
\nList all available titles within the firm.
\nUpdate information of an existing title. The request allows multiple updating of titles.
\nCreate a new title. The request allows multiple adding of titles.
\nDelete a specific title based on the provided Title Id.
\nA title can be a named to show their status or profession or describes their job or status in an organiztaion.
\n","_postman_id":"fb446605-cf13-4765-9454-ffad01e7292d"},{"name":"User","item":[{"name":"Get User Information of user by Email Address","id":"15bf296e-a8ac-4f57-be06-1e2bc0557238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"List all courses attended and instructed by user.
\nThe Admin has the capability to feed input data and get output data of all users in a firm.
\n","_postman_id":"a9e23a4c-1968-4eff-8f23-1917df618301"},{"name":"Reference","item":[],"id":"df73ac0f-e43f-4dfb-9aa6-4985432e86b1","description":"Collection of CE Manager specific values
\n