{ "opencollection": "1.0.0", "info": { "name": "Unified.to account lms API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "lms", "type": "folder" }, "items": [ { "info": { "name": "List All Activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/activity", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "content_id", "value": "", "type": "query", "description": "The content ID to filter by" }, { "name": "student_id", "value": "", "type": "query", "description": "The student ID to filter by (reference to LmsStudent)" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Activities" }, { "info": { "name": "Create an Activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/activity", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create an Activity" }, { "info": { "name": "Retrieve an Activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/activity/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Activity" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve an Activity" }, { "info": { "name": "Update an Activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/activity/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Activity" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Activity" }, { "info": { "name": "Update an Activity", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/activity/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Activity" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Activity" }, { "info": { "name": "Remove an Activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/activity/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Activity" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove an Activity" }, { "info": { "name": "List All Classes", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/class", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Classes" }, { "info": { "name": "Create a Class", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/class", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Class" }, { "info": { "name": "Retrieve a Class", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/class/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Class" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Class" }, { "info": { "name": "Update a Class", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/class/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Class" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Class" }, { "info": { "name": "Update a Class", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/class/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Class" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Class" }, { "info": { "name": "Remove a Class", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/class/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Class" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Class" }, { "info": { "name": "List All Collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/collection", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "parent_id", "value": "", "type": "query", "description": "The parent ID to filter by" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Collections" }, { "info": { "name": "Create a Collection", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/collection", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Collection" }, { "info": { "name": "Retrieve a Collection", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/collection/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Collection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Collection" }, { "info": { "name": "Update a Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/collection/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Collection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Collection" }, { "info": { "name": "Update a Collection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/collection/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Collection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Collection" }, { "info": { "name": "Remove a Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/collection/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Collection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Collection" }, { "info": { "name": "List All Contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/content", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "collection_id", "value": "", "type": "query", "description": "The collection ID to filter by (reference to CommerceCollection)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Contents" }, { "info": { "name": "Create a Content", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/content", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Content" }, { "info": { "name": "Retrieve a Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/content/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Content" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Content" }, { "info": { "name": "Update a Content", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/content/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Content" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Content" }, { "info": { "name": "Update a Content", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/content/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Content" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Content" }, { "info": { "name": "Remove a Content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/content/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Content" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Content" }, { "info": { "name": "List All Courses", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/course", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "class_id", "value": "", "type": "query", "description": "The class ID to filter by (reference to LmsClass)" }, { "name": "company_id", "value": "", "type": "query", "description": "The company ID to filter by (reference to HrisCompany)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Courses" }, { "info": { "name": "Create a Course", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/course", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Course" }, { "info": { "name": "Retrieve a Course", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/course/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Course" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Course" }, { "info": { "name": "Update a Course", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/course/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Course" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Course" }, { "info": { "name": "Update a Course", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/course/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Course" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Course" }, { "info": { "name": "Remove a Course", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/course/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Course" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Course" }, { "info": { "name": "List All Instructors", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/instructor", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "class_id", "value": "", "type": "query", "description": "The class ID to filter by (reference to LmsClass)" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "company_id", "value": "", "type": "query", "description": "The company ID to filter by (reference to HrisCompany)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Instructors" }, { "info": { "name": "Create an Instructor", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/instructor", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create an Instructor" }, { "info": { "name": "Retrieve an Instructor", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/instructor/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Instructor" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve an Instructor" }, { "info": { "name": "Update an Instructor", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/instructor/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Instructor" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Instructor" }, { "info": { "name": "Update an Instructor", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/instructor/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Instructor" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Instructor" }, { "info": { "name": "Remove an Instructor", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/instructor/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Instructor" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove an Instructor" }, { "info": { "name": "List All Students", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/student", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "class_id", "value": "", "type": "query", "description": "The class ID to filter by (reference to LmsClass)" }, { "name": "course_id", "value": "", "type": "query", "description": "The course ID to filter by (reference to Course)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Students" }, { "info": { "name": "Create a Student", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/lms/:connection_id/student", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Student" }, { "info": { "name": "Retrieve a Student", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/lms/:connection_id/student/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Student" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Student" }, { "info": { "name": "Update a Student", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/lms/:connection_id/student/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Student" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Student" }, { "info": { "name": "Update a Student", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/lms/:connection_id/student/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Student" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Student" }, { "info": { "name": "Remove a Student", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/lms/:connection_id/student/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Student" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Student" } ] } ], "bundled": true }