Mince ! Il s'agit visiblement d'un lien où il est nécessaire d'être connecté à Readme.
Voici ; V1 ``` {"openapi":"3.0.0","info":{"title":"EDUSIGN API","version":"1.0.0","description":"Cette API permet aux centres de formation, mais aussi aux fournisseurs de services de se connecter à Edusign via une API REST."},"paths":{"/v1/justified-absence/absence-reason":{"delete":{"tags":["Absences"],"summary":"Archive an absence reason","description":"Archive an absence reason (soft delete).","operationId":"DeleteAbsenceReasons","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Reason successfully hidden"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request-Example:","type":"object","properties":{"ID":{"type":"number","description":"The id of the absence reason"}},"required":["ID"]},"example":{"ID":6}}}}},"get":{"tags":["Absences"],"summary":"Get all absence reasons","description":"Retrieve all the absences reasons of your school (both archived or not).","operationId":"GetAbsenceReasons","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"}},"required":["ID","NAME"]}}}},"example":{"status":"success","result":[{"ID":1,"NAME":"Sick leave"},{"ID":2,"NAME":"Death of a close relative"}]}}}}}},"post":{"tags":["Absences"],"summary":"Create an absence reason","description":"Create a new absence reason. Must define an absence reason ID to create it.","operationId":"PostAbsenceReasons","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":101,"NAME":"My absence reason"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"NAME":{"type":"string","description":"Absence reason name"},"ID":{"type":"number","description":"Absence reason ID"}},"required":["NAME","ID"]},"example":{"NAME":"Sick leave","ID":101}}}}}},"/v1/justified-absence/{absenceId}":{"delete":{"tags":["Absences"],"summary":"Delete a justified absence","description":"Delete a single justified absence (hard delete).","operationId":"DeleteV1JustifiedAbsenceAbsenceid","parameters":[{"in":"path","name":"absenceId","description":"Justified absence ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Your absence has been deleted"}}}}}},"get":{"tags":["Absences"],"summary":"Get a justified absence by ID","description":"Retrieve a single justified absence using its ID.","operationId":"GetJustifiedAbsence","parameters":[{"in":"path","name":"absenceId","description":"Justified absence ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"TYPE":{"type":"number"},"COMMENT":{"type":"string"},"COURSE_ID":{"type":"string"},"STUDENT_ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"FILE_URL":{"type":"string"},"DATE_CREATION":{"type":"string"},"REQUEST_DATE":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"7kqbzf6zhpi13g7l","TYPE":6,"COMMENT":"Panne de réveil","COURSE_ID":"92g9m0j4tjv1of","STUDENT_ID":"rmv3xi6mrwm136p5","SCHOOL_ID":"vn82hoj9","FILE_URL":"https://...","DATE_CREATION":"2020-10-23T17:40:59.000Z","REQUEST_DATE":"2020-10-23T17:40:59.000Z","START":"2020-10-23T17:40:59.000Z","END":"2020-10-23T17:40:59.000Z","API_ID":"498","API_TYPE":"test"}}}}}}},"patch":{"tags":["Absences"],"summary":"Update a justified absence","description":"Update a single student justified absence.","operationId":"PatchV1JustifiedAbsenceAbsenceid","parameters":[{"in":"path","name":"absenceId","description":"The justified absence id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Absence successfully edited"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"TYPE":{"type":"number","description":"The type of the justified absence"},"COMMENT":{"type":"string","description":"The comment of the justified absence"},"FILE":{"type":"object","properties":{"DATA":{"type":"string","description":"The base64 file of the justified absence"},"NAME":{"type":"string","description":"The name of the justified absence"}},"required":["DATA","NAME"]},"DATE_START":{"type":"string","description":"The start date of the justified absence"},"DATE_END":{"type":"string","description":"The end date of the justified absence"},"API_ID":{"type":"string","description":"The id of the API"},"API_TYPE":{"type":"string","description":"The type of the API"}},"required":["TYPE","COMMENT","FILE","DATE_START","DATE_END"]},"example":{"TYPE":1,"COMMENT":"The student sent us a medical certificate","FILE":{"DATA":"data:application/pdf;base64,JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwog","NAME":"medical_certificate.pdf"},"DATE_START":"2021-01-01T10:00:00.000Z","DATE_END":"2021-01-30T10:00:00.000Z","API_ID":"","API_TYPE":""}}}}}},"/v1/justified-absence":{"get":{"tags":["Absences"],"summary":"Get all justified absences","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the justified absences of your school.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1JustifiedAbsence","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\" and displays 100 absences per page","required":true,"schema":{"type":"string"}},{"in":"query","name":"start","description":"Filter absences in a range (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"end","description":"Filter absences in a range (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"creationDate","description":"Filter absences by creation date (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"absenceReason","description":"Filter absences by reason ID or reason name","required":false,"schema":{"type":"string"}},{"in":"query","name":"courseId","description":"Filter absences for a specific course by ID","required":false,"schema":{"type":"string"}},{"in":"query","name":"studentId","description":"Filter absences for a specific student by ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"TYPE":{"type":"number"},"START":{"type":"string"},"END":{"type":"string"},"COMMENT":{"type":"string"},"COURSE_ID":{"type":"string"},"STUDENT_ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"FILE_URL":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATION":{"type":"string"},"REQUEST_DATE":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"jkhgfghbjnk","TYPE":1,"START":"2020-01-20T15:00:00","END":"2020-01-20T18:00:00","COMMENT":"The student sent us a medical certificate","COURSE_ID":"juhygutf","STUDENT_ID":"nvfxdswswsxfg","SCHOOL_ID":"mkijhfdswqfsfvb","FILE_URL":"https://...","API_ID":"654","API_TYPE":"test","DATE_CREATION":"2020-01-20T08:00:00","REQUEST_DATE":"2024-03-26T09:32:56"}]}}}}}},"post":{"tags":["Absences"],"summary":"Create a justified absence","description":"Create a new justified absence for a student. You can upload a base64 PDF file (max 4mb) as an attachment.\n

\nImportant: The absence dates (START/END) are automatically set from the course dates. If you need to create absences with custom date ranges, use POST /v1/justified-absence/multiple instead.","operationId":"PostV1JustifiedAbsence","parameters":[],"responses":{"200":{"description":"Body","content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"nfscw1lejaa93j"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"COURSE_ID":{"type":"string","description":"Course ID (required) - The absence dates will be automatically set to the course start and end dates"},"STUDENT_ID":{"type":"string","description":"Student ID"},"TYPE":{"type":"number","description":"Type of justified absence"},"COMMENT":{"type":"string","description":"A comment for the justified absence"},"FILE":{"type":"object","properties":{"DATA":{"type":"string","description":"The base64 file of the justified absence"},"NAME":{"type":"string","description":"The name of the justified absence"}}},"API_ID":{"type":"string","description":"API ID"},"API_TYPE":{"type":"string","description":"Type of API"}},"required":["COURSE_ID","STUDENT_ID","TYPE"]},"example":{"COURSE_ID":"juhygutf","STUDENT_ID":"advhfjsaa77zc","TYPE":1,"COMMENT":"The student sent us a medical certificate","FILE":{"DATA":"data:application/pdf;base64,JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwog","NAME":"medical_certificate.pdf"},"API_ID":"","API_TYPE":""}}}}}},"/v1/justified-absence/multiple":{"post":{"tags":["Absences"],"summary":"Create a justified absence between two dates","description":"Create a new justified absence for a student for all the courses between two dates provided. You can upload a base64 PDF file (max 4mb) as an attachment.","operationId":"PostV1JustifiedAbsenceMultiple","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"result":{"type":"string"},"ID":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"}}}}}},"example":{"status":"success","result":[{"result":"Successfully created","ID":"4rdy7bp3oyk1uj6m","START":"2024-03-25T10:00:00.000Z","END":"2024-03-30T10:00:00.000Z"}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"STUDENT_ID":{"type":"string","description":"Student ID"},"TYPE":{"type":"number","description":"Type of justified absence"},"COMMENT":{"type":"string","description":"A comment for the justified absence"},"FILE":{"type":"object","properties":{"DATA":{"type":"string","description":"Base64 file of the justified absence"},"NAME":{"type":"string","description":"Name of the justified absence"}}},"DATE_START":{"type":"string","description":"Start date of the justified absence (format YYYY-MM-DD, ISO 8601)"},"DATE_END":{"type":"string","description":"End date of the justified absence (format YYYY-MM-DD, ISO 8601)"},"API_ID":{"type":"string","description":"API ID"},"API_TYPE":{"type":"string","description":"Type of API"}},"required":["STUDENT_ID","TYPE","DATE_START","DATE_END"]},"example":{"STUDENT_ID":"advhfjsaa77zc","TYPE":1,"COMMENT":"The student sent us a medical certificate","FILE":{"DATA":"data:application/pdf;base64,JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwog","NAME":"medical_certificate.pdf"},"DATE_START":"2021-01-01T10:00:00.000Z","DATE_END":"2021-01-30T10:00:00.000Z","API_ID":"492","API_TYPE":"test"}}}}}},"/v1/apps/parameters":{"get":{"tags":["Apps"],"summary":"Get an app parameters","description":"Used to get the parameters of an App' installed in the school. The parameters are user-defined. Only the API Key linked to the app can retrieve the parameters.","operationId":"GetV1AppsParameters","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"MY_NEW_PARAMETER":{"type":"string"},"DATE_VALUE":{"type":"string"}}}}},"example":{"status":"success","result":{"MY_NEW_PARAMETER":"My new value","DATE_VALUE":"date value"}}}}}}}},"/v1/apps/project":{"get":{"tags":["Apps"],"summary":"Get a school application details","description":"Used to get an App' installed in the school","operationId":"GetV1AppsProject","parameters":[{"in":"query","name":"appProjectId","description":"Application ID in string","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"},"SHORT_DESCRIPTION":{"type":"string"},"TECHNICAL_CONTACT":{"type":"string"},"DESCRIPTION":{"type":"string"},"LOGO_URL":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"GRANT_TYPES":{"type":"string"},"REDIRECT_URIS":{"type":"array","items":{"type":"string"}},"CLIENT_ID":{"type":"string"},"CLIENT_SECRET":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"1lrwOxW6xJsV35howIoR","SCHOOL_ID":"wnvglwc7j0q4uz38","NAME":"Simon SA","SHORT_DESCRIPTION":"Culpa qui explicabo voluptatem debitis nihil quisquam.","TECHNICAL_CONTACT":"Jules.Fleury@yahoo.fr","DESCRIPTION":"Occaecati sed tenetur voluptatem beatae. Quisquam et repellat. Omnis perferendis commodi voluptates voluptatem illo minima neque distinctio voluptas.","LOGO_URL":"https://picsum.photos/seed/Tq4v4n/640/480","DATE_CREATED":"2024-02-25T17:42:30.635Z","DATE_UPDATED":"2024-08-07T00:18:32.822Z","GRANT_TYPES":"authorization_code","REDIRECT_URIS":["https://www.edusign.fr"],"CLIENT_ID":"34d8p4ora9n4uzpa","CLIENT_SECRET":"d4a45a71-704a-4870-b702-520c567a716c"}}}}}}}},"/v1/apps/public":{"get":{"tags":["Apps"],"summary":"Get public marketplace applications","description":"Used to get public marketplace applications list","operationId":"GetV1AppsPublic","parameters":[{"in":"query","name":"limit","description":"Number of items per page","required":false,"schema":{"type":"string","default":"25"}},{"in":"query","name":"p","description":"Page number","required":false,"schema":{"type":"string","default":"1"}},{"in":"query","name":"q","description":"Search query","required":false,"schema":{"type":"string"}},{"in":"query","name":"category","description":"Filter by category","required":false,"schema":{"type":"string"}},{"in":"query","name":"platform","description":"Filter by platform","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"APP_PROJECT_ID":{"type":"string"},"OWNER_SCHOOL_ID":{"type":"string"},"CATEGORY":{"type":"string"},"CREATOR_NAME":{"type":"string"},"CREATOR_URL":{"type":"string"},"CREATOR_EMAIL":{"type":"string"},"DOCUMENTATION_URL":{"type":"string"},"TERM_OF_USE_URL":{"type":"string"},"PAID_PLAN":{"type":"number"},"FEATURED":{"type":"number"},"PRIVACY_POLICY_URL":{"type":"string"},"SUPPORT_URL":{"type":"string"},"NAME":{"type":"string"},"SHORT_DESCRIPTION":{"type":"string"},"DESCRIPTION":{"type":"string"},"LOGO_URL":{"type":"string"},"PAGE_COUNT":{"type":"number"},"DISABLED":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}},"pagination":{"type":"object","properties":{"total_records":{"type":"number"},"current_page":{"type":"number"},"total_pages":{"type":"number"}}}}}}},"example":{"status":"success","result":{"data":[{"ID":"l3jhZazg3IXIithoAUIj","APP_PROJECT_ID":"s-4RJ6hzGW1FDSEE5Y8J","OWNER_SCHOOL_ID":"lonxowpp5he4uqqs","CATEGORY":"autem","CREATOR_NAME":"Adalric","CREATOR_URL":"https://vivace-conseil-municipal.net/","CREATOR_EMAIL":"Adrehilde_Nicolas@yahoo.fr","DOCUMENTATION_URL":"https://affable-lectorat.com/","TERM_OF_USE_URL":"https://rapide-personnel.com/","PAID_PLAN":1,"FEATURED":0,"PRIVACY_POLICY_URL":"https://sympathique-gestionnaire.eu/","SUPPORT_URL":"https://brusque-police.org","NAME":"cumque quis sit","SHORT_DESCRIPTION":"Excepturi eveniet minus officia suscipit.","DESCRIPTION":"Aperiam quod fugit blanditiis harum repellat sequi. Consequatur distinctio et dolores deserunt accusamus minima unde. Doloribus vitae aperiam et sit nihil soluta repellendus nobis.","LOGO_URL":"https://picsum.photos/seed/ymT9GK/640/480","PAGE_COUNT":0,"DISABLED":0,"DATE_CREATED":"2024-02-08T04:41:09.979Z","DATE_UPDATED":"2024-08-08T03:42:05.952Z"}],"pagination":{"total_records":1,"current_page":1,"total_pages":1}}}}}}}}},"/v1/apps/public/{appId}":{"get":{"tags":["Apps"],"summary":"Get a public marketplace application details","description":"Used to get an marketplace application details","operationId":"GetV1AppsPublicAppid","parameters":[{"in":"path","name":"appId","description":"Application ID in string","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"APP_PROJECT_ID":{"type":"string"},"OWNER_SCHOOL_ID":{"type":"string"},"CATEGORY":{"type":"string"},"CREATOR_NAME":{"type":"string"},"CREATOR_URL":{"type":"string"},"CREATOR_EMAIL":{"type":"string"},"DOCUMENTATION_URL":{"type":"string"},"TERM_OF_USE_URL":{"type":"string"},"PAID_PLAN":{"type":"number"},"FEATURED":{"type":"number"},"PRIVACY_POLICY_URL":{"type":"string"},"SUPPORT_URL":{"type":"string"},"NAME":{"type":"string"},"SHORT_DESCRIPTION":{"type":"string"},"DESCRIPTION":{"type":"string"},"LOGO_URL":{"type":"string"},"PAGE_COUNT":{"type":"number"},"DISABLED":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"ACTIONS":{"type":"array","items":{}},"APP_PARAMETERS_TYPES":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"defaultValue":{"type":"string"}}}},"INSTALL_URL":{"type":"string"},"UNINSTALL_URL":{"type":"string"},"PREVIEWS":{"type":"array","items":{}},"HAS_CUSTOMIZATION":{"type":"boolean"},"IS_PRIVATE_APP":{"type":"boolean"}}}}},"example":{"status":"success","result":{"ID":"UkX3w7LC120UFvYLKAVA","APP_PROJECT_ID":"yzf3ZIOLtLNjzNZy25mU","OWNER_SCHOOL_ID":"fsq6wms5yqn4upub","CATEGORY":"marketing","CREATOR_NAME":"Lucienne","CREATOR_URL":"https://edusign.fr","CREATOR_EMAIL":"a.user@yahoo.fr","DOCUMENTATION_URL":"https://edusign.fr","TERM_OF_USE_URL":"https://edusign.fr","PAID_PLAN":1,"FEATURED":0,"PRIVACY_POLICY_URL":"https://edusign.fr","SUPPORT_URL":"https://edusign.fr","NAME":"reiciendis facilis recusandae","SHORT_DESCRIPTION":"Corporis voluptate delectus saepe accusamus porro nihil.","DESCRIPTION":"Possimus eaque facilis molestias. Natus eum incidunt incidunt ratione sunt nihil exercitationem dolor. Ea dicta at dolorem vitae maiores doloremque fuga.","LOGO_URL":"https://picsum.photos/seed/Vl2TeA/640/480","PAGE_COUNT":0,"DISABLED":0,"DATE_CREATED":"2024-02-14T01:34:34.094Z","DATE_UPDATED":"2024-08-08T09:59:52.744Z","ACTIONS":[],"APP_PARAMETERS_TYPES":[{"id":1,"name":"PARAM1","label":"Paramètre 1","type":"text","description":"","defaultValue":"azerty"}],"INSTALL_URL":"https://edusign.fr","UNINSTALL_URL":"https://edusign.fr","PREVIEWS":[],"HAS_CUSTOMIZATION":false,"IS_PRIVATE_APP":false}}}}}}}},"/v1/attachments/{attachmentId}":{"delete":{"tags":["Attachments"],"summary":"Delete an attachment","description":"Delete a single attachment (hard delete).","operationId":"DeleteV1AttachmentsAttachmentid","parameters":[{"in":"path","name":"attachmentId","description":"Attachment ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"success"}}}}}},"get":{"tags":["Attachments"],"summary":"Get attachment by ID","description":"Retrieve a single attachment using its attachment ID.","operationId":"GetV1AttachmentsAttachmentid","parameters":[{"in":"path","name":"attachmentId","description":"Attachment ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"FILE_TYPE":{"type":"string"},"LINK":{"type":"string"},"TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"SCHOOL_ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":1,"NAME":"Example Attachment","FILE_TYPE":"pdf","LINK":"https://example.com/attachment.pdf","TYPE":"link","RESSOURCE_ID":"w8y63cmsk4j8unj","RESSOURCE_TYPE":"student","DATE_CREATED":"2024-01-20T12:00:00.000Z","SCHOOL_ID":"w8y63cmsk4j5lm"}}}}}}},"put":{"tags":["Attachments"],"summary":"Update an Attachment","description":"Updates the properties of a single attachment linked to a resource.","operationId":"PutV1AttachmentsAttachmentid","parameters":[{"in":"path","name":"attachmentId","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success Response:","content":{"application/json":{"schema":{"title":"Success Response:","type":"object","properties":{"status":{"type":"string"},"attachment":{"type":"object","properties":{"attachmentId":{"type":"number"},"resourceId":{"type":"string"},"fileName":{"type":"string"},"fileType":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}}}}},"example":{"status":"success","attachment":{"attachmentId":5882,"resourceId":"vwrlzqdxryr2fxqw","fileName":"example.pdf","fileType":"pdf","type":"file","url":"https://example.com/document.pdf"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request Example:","type":"object","properties":{"attachmentId":{"type":"number"},"attachment":{"type":"object","properties":{"resourceId":{"type":"string","description":"The ID of the resource linked to the attachment."},"fileName":{"type":"string","description":"The name of the attachment."},"fileType":{"type":"string","description":"The type of the attachment. Allowed values: \"csv\", \"pdf\", \"docx\", \"xls\", \"xlsx\", \"ppt\", \"pptx\", \"odt\", \"ods\", \"odp\", \"jpeg\"."},"type":{"type":"string","description":"The type of the attachment. Possible values are \"file\" or \"link\".","default":"file"},"url":{"type":"string","description":"The URL of the attachment."}},"required":["resourceId","fileName","fileType","url"]}},"required":["attachment"]},"example":{"attachmentId":5882,"attachment":{"resourceId":"vwrlzqdxryr2fxqw","fileName":"example.pdf","fileType":"pdf","type":"file","url":"https://example.com/document.pdf"}}}}}}},"/v1/attachments/{ressourceType}/{ressourceId}":{"get":{"tags":["Attachments"],"summary":"Get all attachments for a resource","description":"Retrieve all the attachments linked to a given resource ID (course, student, professor, external).","operationId":"GetV1AttachmentsRessourcetypeRessourceid","parameters":[{"in":"path","name":"ressourceId","description":"The ID of your resource","required":true,"schema":{"type":"string"}},{"in":"path","name":"ressourceType","description":"The type of your resource : \"course\", \"student\", \"professor\" or \"external\".","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"FILE_TYPE":{"type":"string"},"LINK":{"type":"string"},"TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"SCHOOL_ID":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":1,"NAME":"Example Attachment","FILE_TYPE":"pdf","LINK":"https://example.com/attachment.pdf","TYPE":"link","RESSOURCE_ID":"w8y63cmsk4j8unj","RESSOURCE_TYPE":"student","DATE_CREATED":"2024-01-20T12:00:00.000Z","SCHOOL_ID":"w8y63cmsk4j5lm"}]}}}}}},"post":{"tags":["Attachments"],"summary":"Add an attachment to a resource","description":"Add a new file or a link attachment for a given resource ID (course, student, professor, external).","operationId":"PostV1AttachmentsRessourcetypeRessourceid","parameters":[{"in":"path","name":"ressourceId","description":"The ID of your resource","required":true,"schema":{"type":"string"}},{"in":"path","name":"ressourceType","description":"The type of your resource : \"course\", \"student\", \"professor\" or \"external\"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"success"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request-Example:","type":"object","properties":{"attachment":{"type":"object","properties":{"resourceId":{"type":"string","description":"The ID of your resource"},"fileName":{"type":"string","description":"Name of your attachment (255 characters maximum)"},"fileType":{"type":"string","description":"MIME type of the file."},"fileData":{"type":"string","description":"Base64 string of your attachment."},"type":{"type":"string","description":"Type of your attachment : \"file\" or \"link\"."},"url":{"type":"string","description":"URL of the attachment."}},"required":["resourceId","fileName","fileType","fileData","type","url"]}},"required":["attachment"]},"example":{"attachment":{"resourceId":"vwrlzqdxryr2fxqw","fileName":"example.pdf","fileType":"application/pdf","fileData":"pdf;base64,base64-encoded-data","type":"file","url":"https://example.com/document.pdf"}}}}}}},"/v1/classrooms/{classroomId}":{"delete":{"tags":["Classrooms"],"summary":"Delete a classroom by ID.","description":"Delete a single classroom (hard delete) using its classroom ID.","operationId":"DeleteV1ClassroomsClassroomid","parameters":[{"in":"path","name":"classroomId","description":"Classroom ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}}},"put":{"tags":["Classrooms"],"summary":"Update a classroom.","description":"Update the name of a single classroom.","operationId":"PutV1ClassroomsClassroomid","parameters":[{"in":"path","name":"classroomId","description":"Classroom ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"number"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":7643,"SCHOOL_ID":"e2dytuiplq2fxqv","NAME":"Classroom Name"}}}}},"409":{"description":"Error-Response (409):","content":{"application/json":{"schema":{"title":"Error-Response (409):","type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}},"example":{"status":"error","message":"ERR_CLASSROOMS_ALREADY_EXIST"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"name":{"type":"string","description":"Classroom name."}},"required":["name"]},"example":{"name":"Classroom Name"}}}}}},"/v1/classrooms/delete-by-name/{classroomName}":{"delete":{"tags":["Classrooms"],"summary":"Delete a classroom by name.","description":"Delete a single classroom (hard delete) using its classroom name.","operationId":"DeleteV1ClassroomsDeleteByNameClassroomname","parameters":[{"in":"path","name":"classroomName","description":"Classroom name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}},"example":{"status":"success","message":"OK"}}}}}}},"/v1/classrooms":{"get":{"tags":["Classrooms"],"summary":"Get all classrooms","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) This is an heavy request, please use this endpoint only when needed. Retrieve all the classrooms of your school.","operationId":"GetV1Classrooms","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":7643,"SCHOOL_ID":"e2dytuiplq2fxqv","NAME":"Classroom"}]}}}}}},"post":{"tags":["Classrooms"],"summary":"Create a classroom","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Create a new classroom for your school.","operationId":"PostV1Classrooms","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"number"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":7643,"SCHOOL_ID":"e2dytuiplq2fxqv","NAME":"Classroom"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"name":{"type":"string","description":"Classroom name."}},"required":["name"]},"example":{"name":"New Classroom"}}}}}},"/v1/classrooms/get-by-name/{classroomName}":{"get":{"tags":["Classrooms"],"summary":"Get a classroom by name","description":"Retrieve a single classroom by its name (case insensitive).","operationId":"GetV1ClassroomsGetByNameClassroomname","parameters":[{"in":"path","name":"classroomName","description":"Classroom name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"number"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":7643,"SCHOOL_ID":"e2dytuiplq2fxqv","NAME":"B303"}}}}}}}},"/v1/connectors/logs":{"get":{"tags":["Connectors"],"summary":"Get all connectors logs","description":"Retrieve all the logs from the connectors of your school. Logs are sorted by creation date in ascending order by default (oldest first). Use `orderBy` to change the sort direction.","operationId":"GetV1ConnectorsLogs","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"1\"","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Set a limit to the number of retrieved logs (max 100 -- set to 40 by default)","required":false,"schema":{"type":"string"}},{"in":"query","name":"apiId","description":"Filter logs with a specific API ID","required":false,"schema":{"type":"string"}},{"in":"query","name":"orderBy","description":"Sort logs by `DATE_CREATED`: `asc` (oldest first) or `desc` (newest first). Defaults to `asc` if omitted.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"SCHOOL_ID":{"type":"string"},"STRING":{"type":"string"},"API_ID":{"type":"string"},"TYPE":{"type":"string"},"CODE":{"type":"string"},"DATE_CREATED":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":4775313,"SCHOOL_ID":"w8y63cmsk4j5lm","STRING":"INFO_START_CONN - ERR_MISSING_DATA COURSE_NOT_IMPORTED - NO_STUDENTS_IN_RUBRIQUE","API_ID":"64335","TYPE":"COURSE","CODE":"ERR_MISSING_DATA","DATE_CREATED":"2020-01-20T15:22:20.000Z"}]}}}}}}},"/v1/course/attendance/{id}":{"delete":{"tags":["Courses"],"summary":"Remove a student from a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Remove a single student from an existing course using both the student and the course ID. Other students linked to the course won't be impacted.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"DeleteV1CourseAttendanceId","parameters":[{"in":"path","name":"id","description":"Course ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"success"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"studentId":{"type":"string","description":"Student ID"},"course":{"type":"object","properties":{},"description":"Course object"}},"required":["course","studentId"]},"example":{"studentId":"sjdjf91j1082bx"}}}}}},"/v1/course/{id}":{"delete":{"tags":["Courses"],"summary":"Delete a course","description":"Delete a single course (hard delete).","operationId":"DeleteV1CourseId","parameters":[{"in":"path","name":"id","description":"Course ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Courses"],"summary":"Get a course by ID","description":"Retrieve a single course using its course ID. If the course is locked (\"LOCKED\" : 1) the attendance sheet PDF URL (\"ATTENDANCE_LIST_GENERATED\") is available.","operationId":"GetV1CourseId","parameters":[{"in":"path","name":"id","description":"Course id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"PROFESSOR":{"type":"string"},"PROFESSOR_SIGNATURE":{"type":"string"},"PROFESSOR_2":{"type":"string"},"PROFESSOR_SIGNATURE_2":{"type":"string"},"PROFESSOR_3":{"type":"string"},"PROFESSOR_SIGNATURE_3":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"object","properties":{"state":{"type":"boolean"},"comment":{"type":"string"},"studentId":{"type":"string"},"timestamp":{"type":"string"},"absenceId":{"type":"string"},"delay":{"type":"number"},"excluded":{"type":"string"}}}},"CLASSROOM":{"type":"string"},"READER_ID":{"type":"string"},"CREATOR_ID":{"type":"string"},"ANNOTATION":{"type":"string"},"ADMIN_ANNOTATION":{"type":"string"},"SCHOOL_GROUP":{"type":"array","items":{"type":"string"}},"ATTENDANCE_LIST_GENERATED":{"type":"string"},"ATTENDANCE_LIST_GENERATED_NOLOGO":{"type":"string"},"DATE_CREATED":{"type":"string"},"LOCKED":{"type":"boolean"},"DATE_UPDATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"MESSAGES":{"type":"array","items":{}},"METADATA":{"type":"array","items":{}},"SIMPLE_SIGNATURE":{"type":"number"},"SIMPLE_SIGNATURE_PIN":{"type":"string"},"EMAIL_SIGNATURE_STUDENTS":{"type":"string"},"ARCHIVING_ID":{"type":"string"},"METADATA_ARCHIVING_ID":{"type":"string"},"ARCHIVING_CERTIFICATE_URL":{"type":"string"},"SCANNED_ATTENDANCE_LIST":{"type":"string"},"ATTENDANCE_ENDED":{"type":"number"},"SURVEY_ID":{"type":"string"},"SURVEY_ID_2":{"type":"string"},"TEACHER_SURVEY":{"type":"string"},"STUDENT_INSCRIPTION_HASH":{"type":"string"},"STUDENT_INSCRIPTION_SIGN":{"type":"number"},"ZOOM":{"type":"number"},"ABSENCE_SENT":{"type":"number"},"TEAMS":{"type":"number"},"TEAMS_JSON":{"type":"string"},"EMAILS_ADDED":{"type":"number"},"STATE_UPDATE":{"type":"number"},"MAX_STUDENTS":{"type":"number"},"INSCRIPTION_FORMS":{"type":"array","items":{}},"STUDENT_EMAIL_REMINDER":{"type":"array","items":{}},"NEED_STUDENTS_SIGNATURE":{"type":"number"},"TRAINING_ID":{"type":"string"},"id":{"type":"string"},"PROFESSOR_EMAIL_HISTORY":{"type":"string"},"PROFESSOR_EMAIL_HISTORY_2":{"type":"string"},"PROFESSOR_EMAIL_HISTORY_3":{"type":"string"},"idx":{"type":"number"},"PROFESSOR_SIGNATURE_TIMESTAMP":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"sdfgh567hn","NAME":"Growth hacking","DESCRIPTION":"Course about growth hacking","START":"2020-01-20T15:00:00.000Z","END":"2020-01-20T18:00:00.000Z","PROFESSOR":"dfgh6789Uhghj","PROFESSOR_SIGNATURE":"","PROFESSOR_2":"","PROFESSOR_SIGNATURE_2":"","PROFESSOR_3":"","PROFESSOR_SIGNATURE_3":"","STUDENTS":[{"state":true,"comment":"","studentId":"123456","timestamp":"2020-04-08 12:50:51.000000","absenceId":"cthsibqa1vsqa54","delay":15,"excluded":"2021/01/06 12:24:22"}],"CLASSROOM":"B102","READER_ID":"","CREATOR_ID":"API","ANNOTATION":"","ADMIN_ANNOTATION":"","SCHOOL_GROUP":["ghj865fgh897Tgh"],"ATTENDANCE_LIST_GENERATED":"https://edusign.app/uploads/sdfgh567hn.pdf","ATTENDANCE_LIST_GENERATED_NOLOGO":"https://edusign.app/uploads/sdfgh567hn.pdf","DATE_CREATED":"2020-01-20T15:22:20.000Z","LOCKED":true,"DATE_UPDATED":"2020-01-20T15:22:20.000Z","API_ID":"","API_TYPE":"","MESSAGES":[],"METADATA":[],"SIMPLE_SIGNATURE":0,"SIMPLE_SIGNATURE_PIN":"","EMAIL_SIGNATURE_STUDENTS":"","ARCHIVING_ID":"","METADATA_ARCHIVING_ID":"","ARCHIVING_CERTIFICATE_URL":"","SCANNED_ATTENDANCE_LIST":"","ATTENDANCE_ENDED":0,"SURVEY_ID":"","SURVEY_ID_2":"","TEACHER_SURVEY":"","STUDENT_INSCRIPTION_HASH":"sdfgh567hn","STUDENT_INSCRIPTION_SIGN":0,"ZOOM":0,"ABSENCE_SENT":0,"TEAMS":0,"TEAMS_JSON":"","EMAILS_ADDED":0,"STATE_UPDATE":0,"MAX_STUDENTS":23,"INSCRIPTION_FORMS":[],"STUDENT_EMAIL_REMINDER":[],"NEED_STUDENTS_SIGNATURE":0,"TRAINING_ID":"jhbjgfckjnhbjgv","id":"sdfgh567hn","PROFESSOR_EMAIL_HISTORY":"","PROFESSOR_EMAIL_HISTORY_2":"","PROFESSOR_EMAIL_HISTORY_3":"","idx":0,"PROFESSOR_SIGNATURE_TIMESTAMP":"2022-03-25T08:08:57.000Z"}}}}}}}},"/v1/course":{"get":{"tags":["Courses"],"summary":"Get all courses","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the courses of your school (both locked and unlocked courses).
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Course","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\" and displays 40 courses per page","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"Filter courses based on the course start date (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"end","description":"Filter courses based on the course end date (format YYYY-MM-DD, ISO 8601). The difference between the start and end date must be 90 days maximum","required":false,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filters must be separated by a comma \",\". List of available filters : \n
- locked : Retrieve all the locked courses\n
- unlocked : Retrieve all the unlocked courses\n
- absencessent : Retrieve all the absences send courses\n
- absencesnotsent : Retrieve all the absences not send courses","required":false,"schema":{"type":"string"}},{"in":"query","name":"groupId","description":"Filter courses based on an array of groupIds to retrieve courses for specific groups\nMultiple groupIds can be provided, separated by commas (e.g., ?groupId=123,456,789).","required":false,"schema":{"type":"string"}},{"in":"query","name":"studentId","description":"Filter courses based on an array of studentIds to retrieve courses for specific students.\nMultiple studentIds can be provided, separated by commas (e.g., ?studentId=123,456,789).","required":false,"schema":{"type":"string"}},{"in":"query","name":"professorId","description":"Filter courses based on an array of professorIds to retrieve courses for specific professors.\nMultiple professorIds can be provided, separated by commas (e.g., ?studentId=123,456,789).","required":false,"schema":{"type":"string"}},{"in":"query","name":"trainingId","description":"Filter courses based on an array of trainingIds.\nMultiple trainingIds can be provided, separated by commas (e.g., ?trainingId=training123,training456).","required":false,"schema":{"type":"string"}},{"in":"query","name":"classroom","description":"Filter courses based on the classroom.","required":false,"schema":{"type":"string"}},{"in":"query","name":"creatorId","description":"Filter courses based on creatorId to retrieve courses for specific creatorId","required":false,"schema":{"type":"string"}},{"in":"query","name":"courseName","description":"Filter courses based on courseName to retrieve courses for specific courseName","required":false,"schema":{"type":"string"}},{"in":"query","name":"dateCreated","description":"Filter courses based on an array of two dates (start and end)\n(e.g., ?dateCreated=2024-08-01, 2024-08-02).","required":false,"schema":{"type":"string"}},{"in":"query","name":"infoStudents","description":"Returns detailed student information for the first course only.\nValues: \"true\" or \"false\" (default)\nExample: ?infoStudents=true\nDescription: If \"true\", includes student details (first name, last name, email). If \"false\", only student states are returned.","required":false,"schema":{"type":"string"}},{"in":"query","name":"dateUpdated","description":"Filter courses based on an array of two dates (start and end)\n(e.g., ?dateUpdated=2024-08-01, 2024-08-02).","required":false,"schema":{"type":"string"}},{"in":"query","name":"professorSignature","description":"Filter courses based on professor's signature (true or false)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"PROFESSOR":{"type":"string"},"PROFESSOR_SIGNATURE":{"type":"string"},"PROFESSOR_2":{"type":"string"},"PROFESSOR_SIGNATURE_2":{"type":"string"},"PROFESSOR_3":{"type":"string"},"PROFESSOR_SIGNATURE_3":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"object","properties":{"state":{"type":"boolean"},"comment":{"type":"string"},"studentId":{"type":"string"},"timestamp":{"type":"string"},"absenceId":{"type":"string"},"delay":{"type":"number"},"excluded":{"type":"string"}}}},"CLASSROOM":{"type":"string"},"READER_ID":{"type":"string"},"CREATOR_ID":{"type":"string"},"ANNOTATION":{"type":"string"},"ADMIN_ANNOTATION":{"type":"string"},"SCHOOL_GROUP":{"type":"array","items":{"type":"string"}},"ATTENDANCE_LIST_GENERATED":{"type":"string"},"ATTENDANCE_LIST_GENERATED_NOLOGO":{"type":"string"},"DATE_CREATED":{"type":"string"},"LOCKED":{"type":"boolean"},"DATE_UPDATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"MESSAGES":{"type":"array","items":{}},"METADATA":{"type":"array","items":{}},"SIMPLE_SIGNATURE":{"type":"number"},"SIMPLE_SIGNATURE_PIN":{"type":"string"},"EMAIL_SIGNATURE_STUDENTS":{"type":"string"},"ARCHIVING_ID":{"type":"string"},"METADATA_ARCHIVING_ID":{"type":"string"},"ARCHIVING_CERTIFICATE_URL":{"type":"string"},"SCANNED_ATTENDANCE_LIST":{"type":"string"},"ATTENDANCE_ENDED":{"type":"number"},"SURVEY_ID":{"type":"string"},"SURVEY_ID_2":{"type":"string"},"TEACHER_SURVEY":{"type":"string"},"STUDENT_INSCRIPTION_HASH":{"type":"string"},"STUDENT_INSCRIPTION_SIGN":{"type":"number"},"ZOOM":{"type":"number"},"ABSENCE_SENT":{"type":"number"},"TEAMS":{"type":"number"},"TEAMS_JSON":{"type":"string"},"EMAILS_ADDED":{"type":"number"},"STATE_UPDATE":{"type":"number"},"MAX_STUDENTS":{"type":"number"},"INSCRIPTION_FORMS":{"type":"array","items":{}},"STUDENT_EMAIL_REMINDER":{"type":"array","items":{}},"NEED_STUDENTS_SIGNATURE":{"type":"number"},"TRAINING_ID":{"type":"string"},"TRAINING_INSCRIPTION_OPTIONS":{"type":"array","items":{}},"PROFESSORS_PRESENCES":{"type":"array","items":{"type":"object","properties":{"history":{"type":"array","items":{}},"priority":{"type":"number"},"signature":{"type":"string"},"professorId":{"type":"string"}}}},"id":{"type":"string"},"PROFESSOR_EMAIL_HISTORY":{"type":"string"},"PROFESSOR_EMAIL_HISTORY_2":{"type":"string"},"PROFESSOR_SIGNATURE_TIMESTAMP":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"45678jhg78","NAME":"Growth hacking","DESCRIPTION":"Course about growth hacking","START":"2020-01-20T15:00:00","END":"2020-01-20T18:00:00","PROFESSOR":"dfgh6789Uhghj","PROFESSOR_SIGNATURE":"","PROFESSOR_2":"","PROFESSOR_SIGNATURE_2":"","PROFESSOR_3":"","PROFESSOR_SIGNATURE_3":"","STUDENTS":[{"state":true,"comment":"","studentId":"123456","timestamp":"2020-04-08 12:50:51.000000","absenceId":"cthsibqa1vsqa54","delay":15,"excluded":"2021/01/06 12:24:22"}],"CLASSROOM":"B102","READER_ID":"","CREATOR_ID":"API","ANNOTATION":"","ADMIN_ANNOTATION":"","SCHOOL_GROUP":["ghj865fgh897Tgh"],"ATTENDANCE_LIST_GENERATED":"https://edusign.app/uploads/sdfgh567hn.pdf","ATTENDANCE_LIST_GENERATED_NOLOGO":"https://edusign.app/uploads/sdfgh567hn.pdf","DATE_CREATED":"2020-01-20T15:22:20.000Z","LOCKED":true,"DATE_UPDATED":"2020-01-20T15:22:20.000Z","API_ID":"","API_TYPE":"","MESSAGES":[],"METADATA":[],"SIMPLE_SIGNATURE":0,"SIMPLE_SIGNATURE_PIN":"","EMAIL_SIGNATURE_STUDENTS":"","ARCHIVING_ID":"","METADATA_ARCHIVING_ID":"","ARCHIVING_CERTIFICATE_URL":"","SCANNED_ATTENDANCE_LIST":"","ATTENDANCE_ENDED":0,"SURVEY_ID":"","SURVEY_ID_2":"","TEACHER_SURVEY":"","STUDENT_INSCRIPTION_HASH":"sdfgh567hn","STUDENT_INSCRIPTION_SIGN":0,"ZOOM":0,"ABSENCE_SENT":0,"TEAMS":0,"TEAMS_JSON":"","EMAILS_ADDED":0,"STATE_UPDATE":0,"MAX_STUDENTS":23,"INSCRIPTION_FORMS":[],"STUDENT_EMAIL_REMINDER":[],"NEED_STUDENTS_SIGNATURE":0,"TRAINING_ID":"uhytgtfrd","TRAINING_INSCRIPTION_OPTIONS":[],"PROFESSORS_PRESENCES":[{"history":[],"priority":1,"signature":"juytrdtyguhijhuygftdthyjhkjloijhugyftdresxfdcgvhbjnkhuy","professorId":"dfgh6789Uhghj"}],"id":"sdfgh567hn","PROFESSOR_EMAIL_HISTORY":"","PROFESSOR_EMAIL_HISTORY_2":"","PROFESSOR_SIGNATURE_TIMESTAMP":"2022-03-25T08:08:57.000Z"}]}}}}}},"post":{"tags":["Courses"],"summary":"Create a course","description":"Create a new course. Students listed in the \"SCHOOL_GROUP\" array will be listed in the created course.
NOTE: You can link more teachers by adding fields PROFESSOR_X (where X is 4, 5, etc.)","operationId":"PostV1Course","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"uytfyghuhuygtf"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"course":{"type":"object","properties":{"NAME":{"type":"string","description":"Name of the course"},"DESCRIPTION":{"type":"string","description":"Description of the course"},"START":{"type":"string","description":"Start date of the course (ISO 8601 datetime)"},"END":{"type":"string","description":"End date of the course (ISO 8601 datetime)"},"PROFESSOR":{"type":"string","description":"Professor ID"},"PROFESSOR_2":{"type":"string","description":"Professor 2 ID"},"PROFESSOR_3":{"type":"string","description":"Professor 3 ID"},"CLASSROOM":{"type":"string","description":"Classroom"},"SCHOOL_GROUP":{"type":"array","items":{"type":"string"}},"MAX_STUDENTS":{"type":"number","description":"Maximum number of students"},"ZOOM":{"type":"boolean","description":"Zoom course"},"API_ID":{"type":"string","description":"API ID"},"SURVEY_ID":{"type":"string","description":"Survey Template ID"},"SURVEY_ID_2":{"type":"string","description":"Survey Template ID 2.
It's possible to send several surveys to students"},"SURVEY_1_AUTOMATIC_SEND_DATE":{"type":"string","description":"Survey 1 automatic send date (ISO 8601 datetime)"},"SURVEY_2_AUTOMATIC_SEND_DATE":{"type":"string","description":"Survey 2 automatic send date (ISO 8601 datetime)"},"TEACHER_SURVEY":{"type":"string","description":"Teacher survey ID"},"TRAINING_ID":{"type":"string","description":"Training ID"},"NEED_STUDENTS_SIGNATURE":{"type":"boolean","description":"Need students signature"}},"required":["NAME","START","END","PROFESSOR","NEED_STUDENTS_SIGNATURE"]}},"required":["course"]},"example":{"course":{"NAME":"Growth hacking","DESCRIPTION":"Course about growth hacking","START":"2020-01-20T15:00:00","END":"2020-01-20T18:00:00","PROFESSOR":"dfgh6789Uhghj","PROFESSOR_2":"dfgh6789Uhghj","PROFESSOR_3":"dfgh678hgfdcv","CLASSROOM":"B102","SCHOOL_GROUP":["ghj865fgh897Tgh"],"MAX_STUDENTS":23,"ZOOM":false,"API_ID":"7942","SURVEY_ID":"amsk22ovssga19f","SURVEY_ID_2":"amsk22ovshgvcds","SURVEY_1_AUTOMATIC_SEND_DATE":"2022-02-23T09:20:00","SURVEY_2_AUTOMATIC_SEND_DATE":"2022-02-23T09:20:00","TEACHER_SURVEY":"amsk22ovssga19f","TRAINING_ID":"amsk22ovssga19f","NEED_STUDENTS_SIGNATURE":true}}}}}}},"/v1/course/get-id/{apiId}":{"get":{"tags":["Courses"],"summary":"Get course ID by API ID","description":"Retrieve a single course ID using its API ID.","operationId":"GetV1CourseGetIdApiid","parameters":[{"in":"path","name":"apiId","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"dzeh832Hjs9kka9"}}}}}}}},"/v1/course/get-professors-signature-links/{courseId}":{"get":{"tags":["Courses"],"summary":"Get a professor signature link on a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of a professor(s) linked to a course.This endpoint is useful for Edusign integrations, you can add the retrieved signature links as a button or an iFrame.
WARNING Heavy request, a special delay is applied to this request.","operationId":"GetV1CourseGetProfessorsSignatureLinksCourseid","parameters":[{"in":"path","name":"courseId","description":"Id of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"API_ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"SIGNATURE_LINK":{"type":"string"},"state":{"type":"boolean"},"emailHistory":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"2301eh49g93919","API_ID":"","FIRSTNAME":"Kurt","LASTNAME":"Cobain","EMAIL":"kurt@cobain.fr","SIGNATURE_LINK":"https://edusign.app/user/professor/email-signature/index.html#/?professorId=2301eh49g93919&courseId=hri4rnrnq7syu1i&verificationToken=NBZGSNDSNZZG44JXON4XKMLJGIZTAMLFNA2DSZZZGM4TCOI=","state":false,"emailHistory":""}]}}}}}}},"/v1/course/get-qr-code/{courseId}/{professorId}":{"get":{"tags":["Courses"],"summary":"Get a student signature QR Code on a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature QR Code of a student linked to a course. Both the course and the professor ID (professor linked to that course) are required to retrive the signature QR Code. This endpoint is useful for Edusign integrations, you can add the retrieved signature QR Code as an iFrame (recommended size 550 width and 820 height).","operationId":"GetV1CourseGetQrCodeCourseidProfessorid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"professorId","description":"Professor ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"url":{"type":"string"}}}}},"example":{"status":"success","result":{"url":"https://static.edusign.com/course/get-qr-code/..."}}}}}}}},"/v1/course/get-signature-links-by-range/{start}/{end}":{"get":{"tags":["Courses"],"summary":"Get the students signatures links on a date range","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of all your students between a time range. This endpoint is useful for Edusign integrations, you can add the retrieved signature links as a button or an iFrame.
WARNING This is an heavy request, a special delay is applied to it.
WARNING Be careful, using this endpoint will send a signature email and authorize all enrolled students within the time range provided to sign the attendance sheets.","operationId":"GetV1CourseGetSignatureLinksByRangeStartEnd","parameters":[{"in":"path","name":"start","description":"Start date at the format YYYY-MM-DD (ISO 8601)","required":true,"schema":{"type":"string"}},{"in":"path","name":"end","description":"End date at the format YYYY-MM-DD (ISO 8601)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"API_ID":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"object","properties":{"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"ID":{"type":"string"},"SIGNATURE_LINK":{"type":"string"},"state":{"type":"boolean"},"comment":{"type":"string"}},"required":["FIRSTNAME","LASTNAME","EMAIL","ID","SIGNATURE_LINK","state","comment"]}},"PROFESSORS":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"API_ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"SIGNATURE_LINK":{"type":"string"},"state":{"type":"boolean"}}}}}}}}},"example":{"status":"success","result":[{"ID":"2c305facab3e4","NAME":"Zoom 4","START":"2020-07-07T12:00:00.000Z","END":"2020-07-07T14:00:00.000Z","API_ID":"","STUDENTS":[{"FIRSTNAME":"Teixeira","LASTNAME":"Dylan","EMAIL":"dylantxa+a4@gmail.com","ID":"abbfa55061a42","SIGNATURE_LINK":"https://edusign.app/email-signature/2c305facab3e4/abbfa55061a42?token=bc4c50ceh5cgd","state":false,"comment":""},{"FIRSTNAME":"BJohn (mandatory)","LASTNAME":"BDoe (mandatory)","EMAIL":"dylantxa+api5@gmail.com","ID":"hh1bh81ce0e6d","SIGNATURE_LINK":"https://edusign.app/email-signature/2c305facab3e4/hh1bh81ce0e6d?token=be8407h8e6e3a","state":false,"comment":""}],"PROFESSORS":[{"ID":"3dbf509aeg45g","API_ID":"","FIRSTNAME":"Dylan","LASTNAME":"TEIXEIRA prof 2","EMAIL":"hello@edusign.fr","SIGNATURE_LINK":"https://edusign.app/user/professor/email-signature/index.html/#/?professorId=3dbf509aeg45g&courseId=rxzhdywcm29zdzw&verificationToken=GCA0972","state":false}]}]}}}}}}},"/v1/course/get-signature-links/{courseId}":{"get":{"tags":["Courses"],"summary":"Get a student signature link on a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of a student(s) linked to a course. This endpoint is useful for Edusign integrations, you can add the retrieved signature links as a button or an iFrame.
WARNING This is an heavy request, a special delay is applied to it.
WARNING Be careful, using this endpoint will send a signature email and authorize all enrolled students within the course provided to sign the attendance sheet.","operationId":"GetV1CourseGetSignatureLinksCourseid","parameters":[{"in":"path","name":"courseId","description":"Id of the course","required":true,"schema":{"type":"string"}},{"in":"query","name":"studentids","description":"Query Param with student IDs (separated by comma). If no student ID is provided, this endpoint will return all the signature links of the course and authorize enrolled students within the course to sign the attendance sheet.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"ID":{"type":"string"},"SIGNATURE_LINK":{"type":"string"},"state":{"type":"boolean"},"comment":{"type":"string"}},"required":["FIRSTNAME","LASTNAME","EMAIL","ID","SIGNATURE_LINK","state","comment"]}}}},"example":{"status":"success","result":[{"FIRSTNAME":"Test cr s","LASTNAME":"test","EMAIL":"dylantxa+dg@gmail.com","ID":"b7b212g7f0c63","SIGNATURE_LINK":"https://edusign.app/email-signature/2c305facab3e4/b7b212g7f0c63?token=7gb76028eh756","state":false,"comment":""},{"FIRSTNAME":"Teixeira","LASTNAME":"Dylan","EMAIL":"dylantxa+a4@gmail.com","ID":"abbfa55061a42","SIGNATURE_LINK":"https://edusign.app/email-signature/2c305facab3e4/abbfa55061a42?token=b530fa7eb73e3","state":false,"comment":""}]}}}}}}},"/v1/course/getGroupAttendanceSheet/{groupId}":{"get":{"tags":["Courses"],"summary":"Generate a presential sheet for a group on a date range","description":"Generate and retrieve a presential sheet PDF for a group between a date range.","operationId":"GetV1CourseGetgroupattendancesheetGroupid","parameters":[{"in":"path","name":"groupId","description":"Group ID","required":true,"schema":{"type":"string"}},{"in":"query","name":"start","description":"Start date at the format YYYY-MM-DD (ISO 8601)","required":true,"schema":{"type":"string"}},{"in":"query","name":"end","description":"End date at the format YYYY-MM-DD (ISO 8601)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"filename":{"type":"string"}}}}},"example":{"status":"success","result":{"filename":"https://edusign.fr/my-sheet-url.pdf"}}}}}}}},"/v1/course/lock/{courseId}":{"get":{"tags":["Courses"],"summary":"Lock a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Lock a single course (prevent students signatures and allow to generate presential sheets).
WARNING This is an heavy request, a special delay is applied to it.","operationId":"GetV1CourseLockCourseid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"locked":{"type":"boolean"},"link":{"type":"string"}}}}},"example":{"status":"success","result":{"locked":true,"link":"https://..."}}}}}}}},"/v1/course/pin/{courseId}":{"get":{"tags":["Courses"],"summary":"Generate a PIN code for a course","description":"Generate and retrieve a PIN code used for student attendance (see our Help Center article).","operationId":"GetV1CoursePinCourseid","parameters":[{"in":"path","name":"courseId","description":"Id of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"1CK6FXKN"}}}}}}},"/v1/course/reload/{courseId}":{"get":{"tags":["Courses"],"summary":"Reset student signature for a course","description":"Reset the student signatures of a course, existing signature(s) will be removed.","operationId":"GetV1CourseReloadCourseid","parameters":[{"in":"path","name":"courseId","description":"ID of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"edited":{"type":"boolean"}}}}},"example":{"status":"success","result":{"edited":true}}}}}}}},"/v1/course/timestamps/{courseId}":{"get":{"tags":["Courses"],"summary":"Get a course timestamps","description":"Retrieve a course timestamps (horodatage) including the following elements : \n- DEVICE_MODEL : Device used by the student to sign\n- SIGNATURE : The image signature link for a student","operationId":"GetV1CourseTimestampsCourseid","parameters":[{"in":"path","name":"courseId","description":"Id of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"COURSE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_SIGNATURE":{"type":"string"},"IP":{"type":"string"},"GEOLOCATION":{"type":"string"},"STUDENT_ID":{"type":"string"},"TYPE":{"type":"number"},"SIGNATURE":{"type":"string"},"PERSON_TYPE":{"type":"string"},"DEVICE_UUID":{"type":"string"},"DEVICE_MODEL":{"type":"string"},"FULLNAME":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":27775218,"COURSE":"Akgdsozl24dkd","SCHOOL_ID":"vn82hoj9","DATE_SIGNATURE":"2023-03-14T13:26:31.000Z","IP":"1.1.1.1","GEOLOCATION":"","STUDENT_ID":"lbkq0tor8od1azec","TYPE":4,"SIGNATURE":"https://edusign-sign.s3.eu-west-3.amazonaws.com/present.png","PERSON_TYPE":"student","DEVICE_UUID":"","DEVICE_MODEL":"","FULLNAME":"Dylan Txa"}]}}}}}}},"/v1/course/verify-qr-code/{courseId}/{qrCode}":{"get":{"tags":["Courses"],"summary":"Verify a course QR Code","description":"Verify the validity of a QR Code linked to a course.
WARNING The QR Code regenerates every 5 seconds with a rest time of 5 seconds, so this API call should be made as soon as possible after a student scans the QR Code.","operationId":"GetV1CourseVerifyQrCodeCourseidQrcode","parameters":[{"in":"path","name":"courseId","description":"The course id","required":true,"schema":{"type":"string"}},{"in":"path","name":"qrCode","description":"The QR code pin code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/course/":{"patch":{"tags":["Courses"],"summary":"Update a course","description":"Update a single course informations.
WARNING When updating a course, every field will be updated, even if you don't provide a value for them. For instance if you are updating a course name and you have already provided an array of SCHOOL_GROUP for your course, if you don't provide them again when updating the course, they will be deleted.","operationId":"PatchV1Course","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"course":{"type":"object","properties":{"ID":{"type":"string","description":"ID of the course"},"NAME":{"type":"string","description":"Name of the course"},"DESCRIPTION":{"type":"string","description":"Description of the course"},"START":{"type":"string","description":"Start date of the course (ISO 8601 datetime)"},"END":{"type":"string","description":"End date of the course (ISO 8601 datetime)"},"PROFESSOR":{"type":"string","description":"Professor ID at least one professor is required"},"PROFESSOR_2":{"type":"string","description":"Professor 2 ID"},"PROFESSOR_3":{"type":"string","description":"Professor 3 ID"},"CLASSROOM":{"type":"string","description":"Classroom"},"SCHOOL_GROUP":{"type":"array","items":{"type":"string"}},"SURVEY_ID":{"type":"string","description":"Survey Template ID"},"SURVEY_ID_2":{"type":"string","description":"Survey Template ID 2.
It's possible to send several surveys to students"},"TEACHER_SURVEY":{"type":"string"},"SURVEY_1_AUTOMATIC_SEND_DATE":{"type":"string","description":"Survey 1 automatic send date (ISO 8601 datetime)"},"SURVEY_2_AUTOMATIC_SEND_DATE":{"type":"string","description":"Survey 2 automatic send date (ISO 8601 datetime)"},"TEACHER_SURVEY_AUTOMATIC_SEND_DATE":{"type":"string"},"ZOOM":{"type":"boolean","description":"Zoom course"},"API_ID":{"type":"string","description":"API ID"},"NEED_STUDENTS_SIGNATURE":{"type":"boolean","description":"Need students signature"},"TRAINING_ID":{"type":"string","description":"Training ID. Warning: if a course is already linked to a training and this field is set to null/empty, the course will be unlinked from that training"}},"required":["ID","NEED_STUDENTS_SIGNATURE"]},"editSurveys":{"type":"boolean","description":"Boolean query param (true/false), If true and a SURVEY_ID is provided, the survey will be erased and a new will be created."}},"required":["course","editSurveys"]},"example":{"course":{"ID":"45678jhg78","NAME":"Growth hacking","DESCRIPTION":"Course about growth hacking","START":"2020-01-20T15:00:00","END":"2020-01-20T18:00:00","PROFESSOR":"dfgh6789Uhghj","PROFESSOR_2":"dfgh6789Uhghj","PROFESSOR_3":"dfgh678lkhbvx","CLASSROOM":"B102","SCHOOL_GROUP":["ghj865fgh897Tgh"],"SURVEY_ID":"amsk22ovssga19f","SURVEY_ID_2":"amsk22ovshgvcds","TEACHER_SURVEY":"amsk22ovssga19f","SURVEY_1_AUTOMATIC_SEND_DATE":"2022-02-23T09:20:00","SURVEY_2_AUTOMATIC_SEND_DATE":"2022-02-23T09:20:00","TEACHER_SURVEY_AUTOMATIC_SEND_DATE":"2022-02-23T09:20:00","ZOOM":true,"API_ID":"7942","NEED_STUDENTS_SIGNATURE":true}}}}}}},"/v1/course/set-absences-sent/{courseId}":{"patch":{"tags":["Courses"],"summary":"Set absences between Edusign and an ERP","description":"Set absences between Edusign and a homemade ERP.","operationId":"PatchV1CourseSetAbsencesSentCourseid","parameters":[{"in":"path","name":"courseId","description":"ID of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"success"}}}}}}},"/v1/course/unlock/{courseId}":{"patch":{"tags":["Courses"],"summary":"Unlock a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Unlock a single locked course.
WARNING This is an heavy request, a special delay is applied to it.","operationId":"PatchV1CourseUnlockCourseid","parameters":[{"in":"path","name":"courseId","description":"ID of the course","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"unlocked":{"type":"boolean"}}}}},"example":{"status":"success","result":{"unlocked":true}}}}}}}},"/v1/course/send-sign-emails":{"post":{"tags":["Courses"],"summary":"Send signature emails","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Send signature emails to student(s) and/or professor(s) of a course. At least one of the two parameters (student or professor ID) must be provided.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"PostV1CourseSendSignEmails","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"The emails will be sent"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"course":{"type":"string"},"students":{"type":"array","items":{"type":"string"}},"professors":{"type":"array","items":{"type":"string"}}},"required":["course","students","professors"]},"example":{"course":"sjdjf91j1082bx","students":["aksodf01dfq92","mskao110dxxjkq"],"professors":["a65nf01dfnfen","nb7t1108hgfy"]}}}}}},"/v1/course/attendance/{courseId}":{"put":{"tags":["Courses"],"summary":"Add a student to a course","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Add a single student to an existing course using both the student and the course ID. Other students linked to the course won't be impacted. If a survey is linked to the course, the student will also be added to it.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"PutV1CourseAttendanceCourseid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"success"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"studentId":{"type":"string","description":"Student ID"}},"required":["studentId"]},"example":{"studentId":"sjdjf91j1082bx"}}}}}},"/v1/document/v2/delete-document/{documentId}":{"delete":{"tags":["Deprecated"],"summary":"Archive a document","description":"Archive a single document (soft delete for 30 days, then hard delete).","operationId":"DeleteV1DocumentV2DeleteDocumentDocumentid","parameters":[{"in":"path","name":"documentId","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Document xxx successfully deleted"}}}}}}},"/v1/course/absence/{absenceId}":{"get":{"tags":["Deprecated"],"summary":"Get a justified absence by ID","description":"Retrieve a single justified absence using its ID.","operationId":"GetV1CourseAbsenceAbsenceid","parameters":[{"in":"path","name":"absenceId","description":"Justified absence ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Not Defined","content":{"application/json":{"schema":{"title":"Not Defined","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Not Defined"}}}}}}},"/v1/document/custom":{"get":{"tags":["Deprecated"],"summary":"Get all documents","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the documents of your school (with and without signature). This endpoint will retrieve only the metadata of your documents,, the \"DOCUMENT_URL\" will be generated when everyone has signed the document.
WARNING : This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1DocumentCustom","parameters":[{"in":"query","name":"STUDENT_ID","description":"Filter documents sent to a specific student (optional filter)","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"Retrieve documents created after the provided date (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"end","description":"Retrieve documents created before the provided date (format YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"total":{"type":"number"},"documents":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"step":{"type":"number"},"emails":{"type":"object","properties":{"documentSent":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"documentCompleted":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"signatureReminder":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"},"emailsAlreadySent":{"type":"array","items":{}}}}}},"version":{"type":"number"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"index":{"type":"number"},"order":{"type":"number"},"phone":{"type":"string"},"token":{"type":"string"},"category":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"signatureDate":{"type":"string"},"signatureState":{"type":"string"},"signatureUrl":{"type":"boolean"}}}},"validationMethod":{"type":"string"},"sendEmailWhenCompleted":{"type":"boolean"}}},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"personId":{"type":"string"},"required":{"type":"boolean"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"page":{"type":"number"}}}}}},"METADATAS":{"type":"object","properties":{"SIGNATORY_IP":{"type":"string"},"SIGNATORY_URL":{"type":"string"},"SIGNATORY_DATE":{"type":"string"},"SIGNATORY_TYPE":{"type":"string"},"SIGNATORY_EMAIL":{"type":"string"},"SIGNATORY_SIGN":{"type":"string"},"SIGNATORY_TOKEN":{"type":"string"},"SIGNATORY_FULLNAME":{"type":"string"},"VALIDATION_CODE":{"type":"string"}}},"STUDENT_ID":{"type":"string"},"PROFESSOR_ID":{"type":"string"},"ADMIN_ID":{"type":"string"},"USER_ID":{"type":"string"},"DIRECTORY_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"STUDENT_DOWNLOAD_DOCUMENT":{"type":"boolean"},"DOCUMENT_SECURED":{"type":"boolean"},"DOCUMENT_URL":{"type":"string"},"DOCUMENT_PROOF_URL":{"type":"string"},"DOCUMENT_SIGNATURE_CODES":{"type":"array","items":{"type":"string"}},"YOUSIGN_PROCEDURE":{"type":"string"},"AUTOMATIC_EMAIL_SEND":{"type":"boolean"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DATE_EXPIRED":{"type":"string"},"TO_DELETE":{"type":"boolean"},"DELETED_BY":{"type":"string"},"TRAINING_ID":{"type":"string"},"TYPE":{"type":"number"},"STATE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"total":1,"documents":[{"ID":"rxyyciia12fq213","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","SCHOOL_ID":"efa4cdm3ayaa713","VARIABLES":{"step":1,"emails":{"documentSent":{"body":"Your document is ready to be signed","subject":"Document to sign"},"documentCompleted":{"body":"Your document has been signed","subject":"Document signed"},"signatureReminder":{"body":"Please sign the document","subject":"Document signature reminder","amount":3,"interval":2,"emailsAlreadySent":[]}},"version":1,"recipients":[{"id":"rxyyciia12fq213","name":"John Doe","email":"john.doe@edusign.fr","index":0,"order":1,"phone":"0601020304","token":"rxyyciia12fq213","category":"student","firstname":"John","lastname":"Doe","signatureDate":"2020-08-29T10:22:16.000Z","signatureState":"pending","signatureUrl":true}],"validationMethod":"email","sendEmailWhenCompleted":true},"INPUTS":[{"id":"rxyyciia12fq213","type":"input","label":"input_startdate","category":"student","personId":"rxyyciia12fq213","required":true,"position":{"x":0,"y":0,"width":100,"height":100,"page":1}}],"METADATAS":{"SIGNATORY_IP":"::1","SIGNATORY_URL":"https://edusign.fr","SIGNATORY_DATE":"2020-08-29T10:22:16.000Z","SIGNATORY_TYPE":"student","SIGNATORY_EMAIL":"john.doe@edusign.fr","SIGNATORY_SIGN":"https://edusign.fr","SIGNATORY_TOKEN":"rxyyciia12fq213","SIGNATORY_FULLNAME":"John Doe","VALIDATION_CODE":"rxyyciia12fq213"},"STUDENT_ID":"rxyyciia12fq213","PROFESSOR_ID":"rxyyciia12fq213","ADMIN_ID":"rxyyciia12fq213","USER_ID":"rxyyciia12fq213","DIRECTORY_ID":"rxyyciia12fq213","TEMPLATE_ID":"rxyyciia12fq213","STUDENT_DOWNLOAD_DOCUMENT":true,"DOCUMENT_SECURED":true,"DOCUMENT_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_PROOF_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_SIGNATURE_CODES":["rxyyciia12fq213"],"YOUSIGN_PROCEDURE":"rxyyciia12fq213","AUTOMATIC_EMAIL_SEND":true,"DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","DATE_EXPIRED":"2020-08-29T10:22:16.000Z","TO_DELETE":false,"DELETED_BY":"rxyyciia12fq213","TRAINING_ID":"rxyyciia12fq213","TYPE":0,"STATE":"pending"}]}}}}}}}},"/v1/document/custom/templates":{"get":{"tags":["Deprecated"],"summary":"Get all document templates","description":"Retrieve all the document templates of your school. The template \"TYPE\" field defines if it's a document with or without signature :\n- \"1\" : Template of a document without signature\n- \"2\" : Template of a document with signature","operationId":"GetV1DocumentCustomTemplates","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"THUMBNAIL_URL":{"type":"string"},"CREATOR_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"TYPE":{"type":"number"}}}}}},"example":{"status":"success","result":[{"ID":"rxyyciia12fq213","SCHOOL_ID":"efa4cdm3ayaa713","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","VARIABLES":[{"name":"input_startdate","value":"07/10/2020"}],"THUMBNAIL_URL":"https://s3-edusign.s3.eu-west-3.amazonaws.com/checkbox.png","CREATOR_ID":"efa4cdm3ayaa713","DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","TYPE":0}]}}}}}}},"/v1/document/custom/templates/{id}":{"get":{"tags":["Deprecated"],"summary":"Get a document template by ID","description":"Retrieve a single document template using its template ID. The template \"TYPE\" field defines if it's a document with or without signature :\n- \"1\" : Template of a document without signature\n- \"2\" : Template of a document with signature","operationId":"GetV1DocumentCustomTemplatesId","parameters":[{"in":"path","name":"id","description":"Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"THUMBNAIL_URL":{"type":"string"},"CREATOR_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"TYPE":{"type":"number"}}}}},"example":{"status":"success","result":{"ID":"rxyyciia12fq213","SCHOOL_ID":"efa4cdm3ayaa713","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","VARIABLES":[{"name":"input_startdate","value":"07/10/2020"}],"THUMBNAIL_URL":"https://s3-edusign.s3.eu-west-3.amazonaws.com/checkbox.png","CREATOR_ID":"efa4cdm3ayaa713","DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","TYPE":0}}}}}}}},"/v1/document/v2/{documentId}":{"get":{"tags":["Deprecated"],"summary":"Get a document by ID","description":"Retrieve a single document using its document ID.","operationId":"GetV1DocumentV2Documentid","parameters":[{"in":"path","name":"documentId","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"studentId":{"type":"string"},"professorId":{"type":"string"},"fillVariables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"match":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["name","match","value","type"]}},"signatures":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"token":{"type":"string"},"signature":{"type":"string"},"timestamp":{"type":"string"}}}}}},"ADMIN_ID":{"type":"string"},"STUDENT_DOWNLOAD_DOCUMENT":{"type":"number"},"DOCUMENT_SECURED":{"type":"number"},"DOCUMENT_URL":{"type":"string"},"DOCUMENT_PROOF_URL":{"type":"string"},"DATE_CREATED":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"bbb9i322ana3sb9","NAME":"Certificat de réalisation","TEMPLATE":"

CERTIFICAT DE REALISATION

Je soussigné(e) (prénom et nom) Kelly Millois
pour le représentant légal du dispensateur de formation Edusign atteste que :

Mme/M. Dylan Teixeira
salarié(e) de l’entreprise Edusign
a suivi l’action de formation 2A BACHELOR

Nature de l’action de formation :

action de formation

bilan de compétences

action de VAE

action de formation par apprentissage

qui s’est déroulée du 07/10/2020 au 23/12/2020 pour une durée totale de 199 heures(s) et 00 minute(s).

Sans préjudice des délais imposés par les règles fiscales, comptables ou commerciales, je m’engage à conserver l’ensemble des pièces justificatives qui ont permis d’établir le présent certificat pendant une durée de 3 ans à compter de la fin de l’année du dernier paiement. En cas de cofinancement des fonds européens la durée de conservation est étendue conformément aux obligations conventionnelles spécifiques.

Fait à : Paris
Le : 13/01/2021

Cachet et signature
du responsable du dispensateur de formation
Dylan Txa
Responsable de la scolarité
[SIGNATURE_ADMIN]

Dans le cadre des formations à distance prendre en compte la réalisation des activités pédagogiques et le temps estimé pour les réaliser.","SCHOOL_ID":"bfa4hdmacy5q713","VARIABLES":{"studentId":"9dgsd7zaqilqcqz","professorId":"","fillVariables":[{"name":"input_startdate","match":"[INPUT_TO_FILL:'startdate']","value":"07/10/2020","type":"input"},{"name":"input_enddate","match":"[INPUT_TO_FILL:'enddate']","value":"23/12/2020","type":"input"},{"name":"input_duration","match":"[INPUT_TO_FILL:'duration']","value":"199 heures(s) et 00 minute(s)","type":"input"},{"name":"input_Qualité du signataire (Administrateur)","match":"[INPUT_TO_FILL:'Qualité du signataire (Administrateur)']","value":"Responsable de la scolarité","type":"input"},{"name":"checkbox_Action de formation","match":"[CHECKBOX_TO_FILL:'Action de formation']","value":"","type":"checkbox"},{"name":"checkbox_Bilan de compétences","match":"[CHECKBOX_TO_FILL:'Bilan de compétences']","value":"","type":"checkbox"},{"name":"checkbox_Action de VAE","match":"[CHECKBOX_TO_FILL:'Action de VAE']","value":"","type":"checkbox"},{"name":"checkbox_Action de formation par apprentissage","match":"[CHECKBOX_TO_FILL:'Action de formation par apprentissage']","value":"true","type":"checkbox"}],"signatures":[{"type":"student","name":"Kurt Cobain","email":"kurt@cobain.fr","token":"dd16a120-150c-11eb-982c-6dla2141amep9","signature":"https://edusign-sign.s3.eu-west-3.amazonaws.com/f4489d9f303d4ecd7c916b3da4579c84667bde8af10b8bb8cf3876f49ca2f10a.jpg","timestamp":"2021/01/13 15:37:08"}]},"ADMIN_ID":"acrcdw1sdca91v1a","STUDENT_DOWNLOAD_DOCUMENT":0,"DOCUMENT_SECURED":1,"DOCUMENT_URL":"https://edusign-test.s3.eu-west-3.amazonaws.com/p6fpsqkz293jom.pdf","DOCUMENT_PROOF_URL":"https://edusign-test.s3.eu-west-3.amazonaws.com/vcf37fubjz3joz.pdf","DATE_CREATED":"2021-01-13T14:37:08.000Z"}}}}}}}},"/v1/document/custom/send/{templateId}":{"post":{"tags":["Deprecated"],"summary":"Send a document for signature","description":"Send a document for signature to student(s). In order to add an admin signature in the document, provide an admin_signature image URL. Provide the templateId, students ID array, user_id of the school administration, and custom fields filled. If fields are missing, send a request without them; the response will be the array of fields. For admin signature in the document, provide an admin_signature image URL.","operationId":"PostV1DocumentCustomSendTemplateid","parameters":[{"in":"path","name":"templateId","description":"Unique id of the template","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"documentsSuccess":{"type":"number"},"documents":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"documentsSuccess":2,"documents":["xxxxxxxxx"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"students":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string","description":"ID of the school administration"},"admin_signature":{"type":"string","description":"URL of the admin signature"},"sendDocumentToStudent":{"type":"boolean","description":"Send the document to the student"},"validateSignatureBy":{"type":"string","description":"Validation method of the signature (email, sms, none)"}},"required":["students","user_id","admin_signature","sendDocumentToStudent","validateSignatureBy"]},"example":{"students":["a72344hzzaa","2983I902ksdf"],"user_id":"2gb2fc6a99edb","admin_signature":"https://upload.wikimedia.org/wikipedia/commons/6/68/Justin_Timberlake_signature.jpg","sendDocumentToStudent":true,"validateSignatureBy":"email"}}}}}},"/v1/document/v2/send-base64":{"post":{"tags":["Deprecated"],"summary":"Send a document without template","description":"This endpoint permit to send a document to student(s) and external signatories. You must provide the ID of the template, the user_id of the school administration who send the documents, and the custom fields filled. If you haven't the fields, you can send a request without the fields, the response will be the array of the fields. If there is an admin signature in the document, you must provide an admin_signature image URL.

Currently two modes are supported :

By document base64 (beta !)
By template ID (you need to create the template in the Edusign school interface)

If you use the document base64 method, you need to put the signatories variables inside the document. Please contact the support if you want to use this method.","operationId":"PostV1DocumentV2SendBase64","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"documentsSuccess":{"type":"number"},"documents":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"documentsSuccess":2,"documents":["xxxxxxxxx"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"user_id":{"type":"string","description":"User ID"},"document":{"type":"object","properties":{"name":{"type":"string"},"base64":{"type":"string"}}},"sendDocumentToRecipients":{"type":"boolean","description":"Send document to recipients"},"signatories":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"position":{"type":"object","properties":{"page":{"type":"string"},"x":{"type":"string"},"y":{"type":"string"}}}}}}}}},"redirectionLinkOnceSigned":{"type":"string","description":"Redirection link once signed"},"validateSignatureBy":{"type":"string","description":"Validate signature by"},"emailReminder":{"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"}}},"directoryId":{"type":"string","description":"Directory ID"},"trainingId":{"type":"string"},"document[name]":{"type":"string","description":"Document name"},"document[base64]":{"type":"string","description":"Document base64"},"signatories[type]":{"type":"string","description":"Signatory type"},"signatories[id]":{"type":"string","description":"Signatory ID"},"signatories[elements]":{"type":"string","description":"[type] Element type"},"emailReminder[subject]":{"type":"string","description":"Email reminder subject"},"emailReminder[message]":{"type":"string","description":"Email reminder message"},"emailReminder[amount]":{"type":"number","description":"[interval] Email reminder amount interval"},"emailReminder[interval]":{"type":"number","description":"Email reminder interval"}},"required":["user_id","document","document[name]","document[base64]","sendDocumentToRecipients","signatories[type]","signatories[id]","signatories[elements]","validateSignatureBy","emailReminder[subject]","emailReminder[message]","emailReminder[amount]","emailReminder[interval]"]},"example":{"user_id":"2gb2fc6a11edb","document":{"name":"","base64":""},"sendDocumentToRecipients":true,"signatories":[{"type":"student","id":"fhdehj8H4sq2","elements":[{"type":"","position":{"page":"","x":"","y":""}}]}],"redirectionLinkOnceSigned":"","validateSignatureBy":"email","emailReminder":{"subject":"","message":"","amount":3,"interval":1},"directoryId":"","trainingId":"adwbdjaw64ha"}}}}}},"/v1/document/v2/send-template":{"post":{"tags":["Deprecated"],"summary":"Send a document template to sign","description":"BETA - Will change in the next updates - This endpoint permit to send a document to student(s) and external signatories. You must provide the ID of the template, the user_id of the school administration who send the documents, and the custom fields filled. If you haven't the fields, you can send a request without the fields, the response will be the array of the fields. If there is an admin signature in the document, you must provide an admin_signature image URL.

Currently two modes are supported :

By document base64 (beta !)
By template ID (you need to create the template in the Edusign school interface)

If you use the document base64 method, you need to put the signatories variables inside the document. Please contact the support if you want to use this method.","operationId":"PostV1DocumentV2SendTemplate","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"documentsSuccess":{"type":"number"},"documents":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"documentsSuccess":2,"documents":["xxxxxxxxx"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"user_id":{"type":"string","description":"User ID"},"sendDocumentToRecipients":{"type":"boolean","description":"Send document to recipients"},"templateId":{"type":"string","description":"Template ID"},"adminSignature":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"signature":{"type":"string"}}},"signatory":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"externalsId":{"type":"array","items":{}}}},"redirectionLinkOnceSigned":{"type":"string","description":"Redirection link once signed"},"validateSignatureBy":{"type":"string","description":"Validate signature by"},"emailReminder":{"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"}}},"fields":{"type":"object","properties":{"debut coaching":{"type":"string"},"fin coaching":{"type":"string"}}},"directoryId":{"type":"string","description":"Directory ID"},"trainingId":{"type":"string"},"adminSignature[name]":{"type":"string","description":"Admin name"},"adminSignature[email]":{"type":"string","description":"Admin email"},"adminSignature[signature]":{"type":"string","description":"Admin signature URL"},"signatory[type]":{"type":"string","description":"Signatory type"},"signatory[id]":{"type":"string","description":"Signatory ID"},"signatory[externalsId]":{"items":{"type":"string","description":"Signatory externals ID"},"type":"array"},"emailReminder[subject]":{"type":"string","description":"Email reminder subject"},"emailReminder[message]":{"type":"string","description":"Email reminder message"},"emailReminder[amount]":{"type":"number","description":"Email reminder amount"},"emailReminder[interval]":{"type":"number","description":"Email reminder interval"},"fields[debut_coaching]":{"type":"string","description":"Field debut coaching"},"fields[fin_coaching]":{"type":"string","description":"Field fin coaching"}},"required":["user_id","sendDocumentToRecipients","templateId","adminSignature[name]","adminSignature[email]","adminSignature[signature]","signatory[type]","signatory[id]","redirectionLinkOnceSigned","validateSignatureBy","emailReminder[subject]","emailReminder[message]","emailReminder[amount]","emailReminder[interval]"]},"example":{"user_id":"2gb2fc6a11edb","sendDocumentToRecipients":true,"templateId":"","adminSignature":{"name":"John Doe","email":"john.doe@edusign.fr","signature":"https://edusign-sign.s3.eu-west-3.amazonaws.com/ac81505d3ecb669e8aa1a7f43e8055b25d3d029c00e58ea514cf28f02f40f8d4.jpg"},"signatory":{"type":"students","id":"fhdehj8H4sq2","externalsId":[]},"redirectionLinkOnceSigned":"","validateSignatureBy":"email","emailReminder":{"subject":"","message":"","amount":3,"interval":1},"fields":{"debut coaching":"12/12/2021","fin coaching":"23/12/2021"},"directoryId":"","trainingId":"adwbdjaw64ha"}}}}}},"/v2/documents/pdf-to-images":{"post":{"tags":["Documents"],"summary":"Convert PDF to images","description":"Convert a PDF document to images for the document editor","operationId":"ConvertPdfToImages","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"images":{"type":"array","items":{"type":"string"}},"pageWidth":{"type":"number"},"pageHeight":{"type":"number"}}}}},"example":{"status":"success","result":{"images":["

Page content

","

Page content

"],"pageWidth":595.28,"pageHeight":841.89}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request-Example:","type":"object","properties":{"url":{"type":"string","description":"URL of the PDF to convert"}},"required":["url"]},"example":{"url":"https://edusign.s3.amazonaws.com/document.pdf"}}}}}},"/v2/documents":{"post":{"tags":["Documents"],"summary":"Create a document using base64","description":"Allows the creation of a document from A to Z. Convert your PDF to base64, add signatories, fields at the position of your choice, and attach documents if necessary.

\nINFO : This sending mode only allows sending documents with a signature field. You can use it to send any type of document as long as at least one input of type \"SIGNATURE\" is present.
\nThis sending mode does not create a template. It creates the document on the fly and sends it to the listed signatories.","operationId":"CreateDocumentByBase64","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"documentsSuccess":{"type":"number"},"directoryId":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signatureLinks":{"type":"array","items":{"type":"object","properties":{"signatoryId":{"type":"string"},"signatoryEmail":{"type":"string"},"signatureLink":{"type":"string"}},"required":["signatoryId","signatoryEmail","signatureLink"]}}},"required":["id","signatureLinks"]}}}}}},"example":{"status":"success","result":{"documentsSuccess":2,"directoryId":"ghefkergbergkethgz","documents":[{"id":"hgegregethgnegehjge","signatureLinks":[{"signatoryId":"rhtekfgehgekr","signatoryEmail":"john.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=hgegregethgnegehjge&token=854x1b3b-a112-3158-8f92-bc9bf9545e5a"},{"signatoryId":"r5oppiecwxd13paj","signatoryEmail":"jane.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=hgegregethgnegehjge&token=4377eaf2-5366-4ae2-b87x-69ddcbe6g428"}]},{"id":"ghefekgerhgerhge","signatureLinks":[{"signatoryId":"rhtekfgehgekr","signatoryEmail":"john.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=ghefekgerhgerhge&token=df4f1b9d-afa5-4d5a-bf5a-5f43cf542dd8"},{"signatoryId":"cr8apy17yl82675","signatoryEmail":"luke.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=ghefekgerhgerhge&token=54e1c522-deb9-4c75-bfd4-b32ea66694cf"}]}]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"directoryId":{"type":"string","description":"Sélectionnez le dossier existant dans lequel vous souhaitez enregistrer les documents que vous créez"},"trainingId":{"type":"string","description":"This field is used to select the existing training in which you want to link the documents you are creating"},"sendDocumentToSignByEmail":{"type":"string","description":"This field is used to choose if the document should be sent by email to all recipients to allow them to sign it. Default: true"},"sendDocumentByEmailWhenCompleted":{"type":"string","description":"This field is used to choose if the document should be sent by email to all recipients once it is fully signed. Default: true"},"redirectionLinkOnceSigned":{"type":"string","description":"Redirigez l'utilisateur vers une URL spécifique une fois qu'il a signé"},"signatureValidationMethod":{"type":"string","description":"Allowed values: \"email\", \"sms\", \"none\" (none make the signature validation optional). Default: \"email\""},"signWithOrder":{"type":"boolean","description":"This field allows to send the document to the recipients one after the other only when the previous recipient has signed"},"expirationDate":{"type":"string","description":"This field allows you to define a date from which it will no longer be possible to sign the document"},"attachedDocuments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attached document (required when attachedDocuments is sent)"},"url":{"type":"string","description":"URL of the attached document (required when attachedDocuments is sent)"}},"required":["name","url"]}},"sendCustomDocumentEmail":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"}},"required":["subject","body"]},"sendCustomSignatureReminderEmail":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"},"amount":{"type":"number","description":"The number of reminder emails you want to send"},"interval":{"type":"number","description":"The interval in hours between each reminder email (in hours)"}},"required":["subject","body","amount","interval"]},"sendCustomEmailWhenDocumentCompleted":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"}},"required":["subject","body"]},"admin_id":{"type":"string","description":"The ID of the admin who sends the document"},"recipients":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Category of the recipient","enum":["student","external","professor"]},"id":{"type":"string","description":"Id of the recipient"}},"required":["category","id"]}},"description":"recipients Who receives the document. Each sub-array is one group — all members of a group must share the same category; each member has its own id.
\n NOTE: Only interactive signers go here (student, professor, external). Why isn't admin in this list? admin is not a valid recipient — to add an admin stamp, use inputs[] with category: \"admin\" and index: 0 instead."},"inputs":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Category of the input (same as recipients)"},"required":{"type":"boolean","description":"If the input is required (only for INPUT_TO_FILL). default: true"},"type":{"type":"string","description":"Type of input Allowed values: \"INPUT_TO_FILL\", \"CHECKBOX_TO_FILL\", \"PARAPHE\", \"SIGNATURE\", \"FIRSTNAME\", \"LASTNAME\", \"FULLNAME\", \"EMAIL\", \"COMPANY\", \"TRAINING_NAME\""},"index":{"type":"number","description":"Used to distinguish multiple recipients with the same category
example: the first professor on the recipient array is index 0, the second professor is index 1 etc\nEXAMPLE: If the recipient array contains 2 recipients of category `\"professor\"`, the first with index 0 and the second with index 1"},"label":{"type":"string","description":"Text used as the name of the input and displayed as a placeholder on the document
Text used as the name of the input and who is displayed as a placeholder on the document. This field is required only for input of type \"INPUT_TO_FILL\"\nWARNING: This field is optional but required for inputs where the category is `\"admin\"` and type is `\"INPUT_TO_FILL\"`, `\"CHECKBOX_TO_FILL\"`, `\"SIGNATURE\"`"},"value":{"type":"string","description":"Link to the admin's signature image if the input type is `\"SIGNATURE\"`, true or false if the input type is `\"CHECKBOX_TO_FILL\"`, or a custom string if the input type is `\"INPUT_TO_FILL\"`.
\nWARNING: This field is optional but required for inputs where the category is `\"admin\"` and type is `\"INPUT_TO_FILL\"`, `\"CHECKBOX_TO_FILL\"`, `\"SIGNATURE\"`"},"position":{"type":"object","properties":{"page":{"type":"number","description":"Page number where to place the input (starts from 1)"},"x":{"type":"number","description":"x-axis of the input
\nINFO: You can activate a hidden feature on the template builder page by typing \"api\" on your keyboard. This feature gives the x/y position of the place where you click"},"y":{"type":"number","description":"y-axis of the input
\nINFO: You can activate a hidden feature on the template builder page by typing \"api\" on your keyboard. This feature gives the x/y position of the place where you click"},"width":{"type":"number","description":"width of the input (Used for signature inputs!)
\nINFO: If you want to change the size of a signature (To use in CERFA for example), you can set the width of the input"},"height":{"type":"number","description":"height of the input (Used for signature inputs!)
\nINFO: If you want to change the size of a signature (To use in CERFA for example), you can set the width of the input"}},"description":"Data used to place the input on the document","required":["page","x","y"]}},"description":"List of inputs for the document","required":["category","type","index","position"]}},"document":{"type":"object","properties":{"name":{"type":"string","description":"The name of the document"},"base64":{"type":"string","description":"The base64 string of the document"}},"description":"The document you want to send","required":["name","base64"]},"attachedDocuments[name]":{"type":"string","description":"Nom du document joint (requis si attachedDocuments est envoyé)"},"attachedDocuments[url]":{"type":"string","description":"URL du document joint (requis si attachedDocuments est envoyé)"}},"required":["admin_id","recipients","inputs","sendDocumentToSignByEmail","sendDocumentByEmailWhenCompleted","signatureValidationMethod","signWithOrder","document"]},"example":{"directoryId":"rxyyciia12fq213","trainingId":"rxyyciia12fqyup","sendDocumentToSignByEmail":true,"sendDocumentByEmailWhenCompleted":true,"redirectionLinkOnceSigned":"https://your-redirect-url.com","signatureValidationMethod":"email","signWithOrder":false,"expirationDate":"2021-01-01T00:00:00","attachedDocuments":[{"name":"Document1","url":"https://document1-url.com"},{"name":"Document2","url":"https://document2-url.com"}],"sendCustomDocumentEmail":{"subject":"Custom Subject","body":"Custom Body"},"sendCustomSignatureReminderEmail":{"subject":"Reminder Subject","body":"Reminder Body","amount":3,"interval":24},"sendCustomEmailWhenDocumentCompleted":{"subject":"Completion Subject","body":"Completion Body"}}}}}},"get":{"tags":["Documents"],"summary":"Get all documents","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the documents of your school (with and without signature). The \"TYPE\" field define if the retrieved document is without signature (\"TYPE\" = 1) or with signature (\"TYPE\" = 2).
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetDocuments","parameters":[{"in":"query","name":"getHTML","description":"Retrieve or not the HTML version of the document. \nWARNING : The weight of the HTML template can have an impact on the payload size and request speed, depending on the quantity of documents to retrieve.","required":false,"schema":{"type":"string","default":"false"}},{"in":"query","name":"offset","description":"Query param for pagination, starts at page \"0\" and displays \"limit\" documents per page, with a maximum of 500.","required":false,"schema":{"type":"string","default":"0"}},{"in":"query","name":"limit","description":"Query param for pagination, maximum of 500 documents per page.","required":false,"schema":{"type":"string","default":"500"}},{"in":"query","name":"recipientId","description":"Retrieve documents based on a recipient resource ID : \n- Student ID\n- Professor ID\n- External ID\n- Admin ID (a user with the 'admin' rights in Edusign)","required":false,"schema":{"type":"string"}},{"in":"query","name":"state","description":"Retrieve documents based on its signature state : \n- \"completed\" : All recipients have signed the document\n- \"pending\" : At least one signature is still pending\n- \"expired\" : The signature link is no longer available\n- \"refused\" : The recipient(s) have refused to sign","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdAfter","description":"Retrieve documents created after the provided date (format YYYY-MM-DDThh:mm:ss, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdBefore","description":"Retrieve documents created before the provided date (format YYYY-MM-DDThh:mm:ss, ISO 8601)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"total":{"type":"number"},"documents":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"step":{"type":"number"},"emails":{"type":"object","properties":{"documentSent":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"documentCompleted":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"signatureReminder":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"},"emailsAlreadySent":{"type":"array","items":{}}}}}},"version":{"type":"number"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"index":{"type":"number"},"order":{"type":"number"},"phone":{"type":"string"},"token":{"type":"string"},"category":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"signatureDate":{"type":"string"},"signatureState":{"type":"string"},"signatureUrl":{"type":"boolean"}}}},"validationMethod":{"type":"string"},"sendEmailWhenCompleted":{"type":"boolean"}}},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"personId":{"type":"string"},"required":{"type":"boolean"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"page":{"type":"number"}}}}}},"METADATAS":{"type":"object","properties":{"SIGNATORY_IP":{"type":"string"},"SIGNATORY_URL":{"type":"string"},"SIGNATORY_DATE":{"type":"string"},"SIGNATORY_TYPE":{"type":"string"},"SIGNATORY_EMAIL":{"type":"string"},"SIGNATORY_SIGN":{"type":"string"},"SIGNATORY_TOKEN":{"type":"string"},"SIGNATORY_FULLNAME":{"type":"string"},"VALIDATION_CODE":{"type":"string"}}},"STUDENT_ID":{"type":"string"},"PROFESSOR_ID":{"type":"string"},"ADMIN_ID":{"type":"string"},"USER_ID":{"type":"string"},"DIRECTORY_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"STUDENT_DOWNLOAD_DOCUMENT":{"type":"boolean"},"DOCUMENT_SECURED":{"type":"boolean"},"DOCUMENT_URL":{"type":"string"},"DOCUMENT_PROOF_URL":{"type":"string"},"DOCUMENT_SIGNATURE_CODES":{"type":"array","items":{"type":"string"}},"YOUSIGN_PROCEDURE":{"type":"string"},"AUTOMATIC_EMAIL_SEND":{"type":"boolean"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DATE_EXPIRED":{"type":"string"},"TO_DELETE":{"type":"boolean"},"DELETED_BY":{"type":"string"},"TRAINING_ID":{"type":"string"},"TYPE":{"type":"number"},"STATE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"total":1,"documents":[{"ID":"rxyyciia12fq213","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","SCHOOL_ID":"efa4cdm3ayaa713","VARIABLES":{"step":1,"emails":{"documentSent":{"body":"Your document is ready to be signed","subject":"Document to sign"},"documentCompleted":{"body":"Your document has been signed","subject":"Document signed"},"signatureReminder":{"body":"Please sign the document","subject":"Document signature reminder","amount":3,"interval":2,"emailsAlreadySent":[]}},"version":1,"recipients":[{"id":"rxyyciia12fq213","name":"John Doe","email":"john.doe@edusign.fr","index":0,"order":1,"phone":"0601020304","token":"rxyyciia12fq213","category":"student","firstname":"John","lastname":"Doe","signatureDate":"2020-08-29T10:22:16.000Z","signatureState":"pending","signatureUrl":true}],"validationMethod":"email","sendEmailWhenCompleted":true},"INPUTS":[{"id":"rxyyciia12fq213","type":"input","label":"input_startdate","category":"student","personId":"rxyyciia12fq213","required":true,"position":{"x":0,"y":0,"width":100,"height":100,"page":1}}],"METADATAS":{"SIGNATORY_IP":"::1","SIGNATORY_URL":"https://edusign.fr","SIGNATORY_DATE":"2020-08-29T10:22:16.000Z","SIGNATORY_TYPE":"student","SIGNATORY_EMAIL":"john.doe@edusign.fr","SIGNATORY_SIGN":"https://edusign.fr","SIGNATORY_TOKEN":"rxyyciia12fq213","SIGNATORY_FULLNAME":"John Doe","VALIDATION_CODE":"rxyyciia12fq213"},"STUDENT_ID":"rxyyciia12fq213","PROFESSOR_ID":"rxyyciia12fq213","ADMIN_ID":"rxyyciia12fq213","USER_ID":"rxyyciia12fq213","DIRECTORY_ID":"rxyyciia12fq213","TEMPLATE_ID":"rxyyciia12fq213","STUDENT_DOWNLOAD_DOCUMENT":true,"DOCUMENT_SECURED":true,"DOCUMENT_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_PROOF_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_SIGNATURE_CODES":["rxyyciia12fq213"],"YOUSIGN_PROCEDURE":"rxyyciia12fq213","AUTOMATIC_EMAIL_SEND":true,"DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","DATE_EXPIRED":"2020-08-29T10:22:16.000Z","TO_DELETE":false,"DELETED_BY":"rxyyciia12fq213","TRAINING_ID":"rxyyciia12fq213","TYPE":0,"STATE":"pending"}]}}}}}}}},"/v2/documents/{templateId}":{"post":{"tags":["Documents"],"summary":"Create a Document Using an Existing Template","description":"Allows the creation of a document using an existing template by providing the template ID in the request parameters.

\nINFO This method only allows sending documents with a signature field. If you try to use the ID of a template without a signature field, an error will be returned.

\nINFO: You can [get the list of entries by querying the template by its ID](https://ext.edusign.fr/doc/#api-Documents-GetTemplateById), allowing you to access the ID and the label of all entries, like admin inputs label or id.","operationId":"CreateDocumentByTemplateId","parameters":[{"in":"path","name":"templateId","description":"Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"documentsSuccess":{"type":"number"},"directoryId":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signatureLinks":{"type":"array","items":{"type":"object","properties":{"signatoryId":{"type":"string"},"signatoryEmail":{"type":"string"},"signatureLink":{"type":"string"}},"required":["signatoryId","signatoryEmail","signatureLink"]}}},"required":["id","signatureLinks"]}}}}}},"example":{"status":"success","result":{"documentsSuccess":2,"directoryId":"ghefkergbergkethgz","documents":[{"id":"hgegregethgnegehjge","signatureLinks":[{"signatoryId":"rhtekfgehgekr","signatoryEmail":"john.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=hgegregethgnegehjge&token=854x1b3b-a112-3158-8f92-bc9bf9545e5a"},{"signatoryId":"r5oppiecwxd13paj","signatoryEmail":"jane.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=hgegregethgnegehjge&token=4377eaf2-5366-4ae2-b87x-69ddcbe6g428"}]},{"id":"ghefekgerhgerhge","signatureLinks":[{"signatoryId":"rhtekfgehgekr","signatoryEmail":"john.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=ghefekgerhgerhge&token=df4f1b9d-afa5-4d5a-bf5a-5f43cf542dd8"},{"signatoryId":"cr8apy17yl82675","signatoryEmail":"luke.doe@ecole.fr","signatureLink":"https://static.edusign.com/documents/?documentId=ghefekgerhgerhge&token=54e1c522-deb9-4c75-bfd4-b32ea66694cf"}]}]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"directoryId":{"type":"string","description":"Sélectionnez le dossier existant dans lequel vous souhaitez enregistrer les documents que vous créez"},"trainingId":{"type":"string","description":"ID of the training to which you want to link the documents you're creating"},"sendDocumentToSignByEmail":{"type":"string","description":"This field is used to choose whether the document should be sent by email to all recipients to allow them to sign it. Default: true","default":"true"},"sendDocumentByEmailWhenCompleted":{"type":"string","description":"This field is used to choose whether the document should be sent by email to all recipients once fully signed. Default: true","default":"true"},"redirectionLinkOnceSigned":{"type":"string","description":"Redirigez l'utilisateur vers une URL spécifique une fois qu'il a signé"},"signatureValidationMethod":{"type":"string","description":"Allowed values: \"email\", \"sms\", \"none\" (none makes signature validation optional). Default: \"email\"","default":"email"},"signWithOrder":{"type":"boolean","description":"This field allows sending the document to the recipients one after another only when the previous recipient has signed.","default":"false"},"expirationDate":{"type":"string","description":"This field allows you to set a date after which it will no longer be possible to sign the document."},"attachedDocuments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attached document (required when attachedDocuments is sent)"},"url":{"type":"string","description":"URL of the attached document (required when attachedDocuments is sent)"}},"required":["name","url"]}},"sendCustomDocumentEmail":{"type":"object","properties":{"subject":{"type":"string","description":"Subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"}},"required":["subject","body"]},"sendCustomSignatureReminderEmail":{"type":"object","properties":{"subject":{"type":"string","description":"Subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"},"amount":{"type":"number","description":"The number of reminder emails you'd like to send"},"interval":{"type":"number","description":"Interval in hours between each reminder email (in hours)"}},"required":["subject","body","amount","interval"]},"sendCustomEmailWhenDocumentCompleted":{"type":"object","properties":{"subject":{"type":"string","description":"Subject of the email"},"body":{"type":"string","description":"Additional message injected where [CUSTOM_MESSAGE] appears in the default email template (the signature link is already included)"}},"required":["subject","body"]},"admin":{"type":"object","properties":{"id":{"type":"string","description":"Administrator's ID"},"inputs":{"type":"object","properties":{"263917":{"type":"string","description":"here the input entry corresponds to the date of signature, assigned by its ID (263917)"},"741293":{"type":"string","description":"here the input entry corresponds to the privilege status of the administrator, assigned by its ID (741293)"},"signature":{"type":"string","description":"here the input entry corresponds to the signature URL of the administrator, assigned by its label (signature)"},"adminName":{"type":"string","description":"here the input entry corresponds to the name of the administrator, assigned by its label (adminName)"}},"description":"You can use either the label (name) or the ID (id) of the corresponding entry, previously retrieved by your call to the route (https://ext.edusign.fr/doc/#api-Documents-GetTemplateById). Here some examples of what inputs would look like:
"}},"description":"Administrator's data"},"recipients":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Category of the recipient","enum":["student","external","professor"]},"id":{"type":"string","description":"Id of the recipient"}},"required":["category","id"]}},"description":"recipients Who receives the document. Each sub-array is one group — all members of a group must share the same category; each member has its own id.
\n NOTE: Only interactive signers go here (student, professor, external). Why isn't admin in this list? admin is not a valid recipient — to add an admin stamp, use inputs[] with category: \"admin\" and index: 0 instead."},"attachedDocuments[name]":{"type":"string","description":"Nom du document joint (requis si attachedDocuments est envoyé)"},"attachedDocuments[url]":{"type":"string","description":"URL du document joint (requis si attachedDocuments est envoyé)"}},"required":["recipients"]},"example":{"directoryId":"rxyyciia12fq213","trainingId":"rxyyciia12fqyup","sendDocumentToSignByEmail":true,"sendDocumentByEmailWhenCompleted":true,"redirectionLinkOnceSigned":"https://your-redirect-url.com","signatureValidationMethod":"email","signWithOrder":false,"expirationDate":"2021-01-01T00:00:00","attachedDocuments":[{"name":"Document1","url":"https://document1-url.com"},{"name":"Document2","url":"https://document2-url.com"}],"sendCustomDocumentEmail":{"subject":"Custom Subject","body":"Custom Body"},"sendCustomSignatureReminderEmail":{"subject":"Reminder Subject","body":"Reminder Body","amount":3,"interval":24},"sendCustomEmailWhenDocumentCompleted":{"subject":"Completion Subject","body":"Completion Body"}}}}}}},"/v2/documents/{documentId}":{"delete":{"tags":["Documents"],"summary":"Archive a document","description":"Archive a single document (soft delete for 30 days, then hard delete).","operationId":"DeleteDocument","parameters":[{"in":"path","name":"documentId","description":"ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Document xxx successfully deleted"}}}}}},"get":{"tags":["Documents"],"summary":"Get a document by ID","description":"Retrieve a single document using its document ID.","operationId":"GetDocumentById","parameters":[{"in":"path","name":"documentId","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"step":{"type":"number"},"emails":{"type":"object","properties":{"documentSent":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"documentCompleted":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"signatureReminder":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"},"emailsAlreadySent":{"type":"array","items":{}}}}}},"version":{"type":"number"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"index":{"type":"number"},"order":{"type":"number"},"phone":{"type":"string"},"token":{"type":"string"},"category":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"signatureDate":{"type":"string"},"signatureState":{"type":"string"},"signatureUrl":{"type":"boolean"}}}},"validationMethod":{"type":"string"},"sendEmailWhenCompleted":{"type":"boolean"}}},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"personId":{"type":"string"},"required":{"type":"boolean"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"page":{"type":"number"}}}}}},"METADATAS":{"type":"object","properties":{"SIGNATORY_IP":{"type":"string"},"SIGNATORY_URL":{"type":"string"},"SIGNATORY_DATE":{"type":"string"},"SIGNATORY_TYPE":{"type":"string"},"SIGNATORY_EMAIL":{"type":"string"},"SIGNATORY_SIGN":{"type":"string"},"SIGNATORY_TOKEN":{"type":"string"},"SIGNATORY_FULLNAME":{"type":"string"},"VALIDATION_CODE":{"type":"string"}}},"STUDENT_ID":{"type":"string"},"PROFESSOR_ID":{"type":"string"},"ADMIN_ID":{"type":"string"},"USER_ID":{"type":"string"},"DIRECTORY_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"STUDENT_DOWNLOAD_DOCUMENT":{"type":"boolean"},"DOCUMENT_SECURED":{"type":"boolean"},"DOCUMENT_URL":{"type":"string"},"DOCUMENT_PROOF_URL":{"type":"string"},"DOCUMENT_SIGNATURE_CODES":{"type":"array","items":{"type":"string"}},"YOUSIGN_PROCEDURE":{"type":"string"},"AUTOMATIC_EMAIL_SEND":{"type":"boolean"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DATE_EXPIRED":{"type":"string"},"TO_DELETE":{"type":"boolean"},"DELETED_BY":{"type":"string"},"TRAINING_ID":{"type":"string"},"TYPE":{"type":"number"},"STATE":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"rxyyciia12fq213","NAME":"Certificate of Completion","TEMPLATE":"My HTML template document","SCHOOL_ID":"efa4cdm3ayaa713","VARIABLES":{"step":1,"emails":{"documentSent":{"body":"Your document is ready to be signed","subject":"Document to sign"},"documentCompleted":{"body":"Your document has been signed","subject":"Document signed"},"signatureReminder":{"body":"Please sign the document","subject":"Document signature reminder","amount":3,"interval":2,"emailsAlreadySent":[]}},"version":1,"recipients":[{"id":"rxyyciia12fq213","name":"John Doe","email":"john.doe@edusign.fr","index":0,"order":1,"phone":"0601020304","token":"rxyyciia12fq213","category":"student","firstname":"John","lastname":"Doe","signatureDate":"2020-08-29T10:22:16.000Z","signatureState":"pending","signatureUrl":true}],"validationMethod":"email","sendEmailWhenCompleted":true},"INPUTS":[{"id":"rxyyciia12fq213","type":"input","label":"input_startdate","category":"student","personId":"rxyyciia12fq213","required":true,"position":{"x":0,"y":0,"width":100,"height":100,"page":1}}],"METADATAS":{"SIGNATORY_IP":"::1","SIGNATORY_URL":"https://edusign.fr","SIGNATORY_DATE":"2020-08-29T10:22:16.000Z","SIGNATORY_TYPE":"student","SIGNATORY_EMAIL":"john.doe@edusign.fr","SIGNATORY_SIGN":"https://edusign.fr","SIGNATORY_TOKEN":"rxyyciia12fq213","SIGNATORY_FULLNAME":"John Doe","VALIDATION_CODE":"rxyyciia12fq213"},"STUDENT_ID":"rxyyciia12fq213","PROFESSOR_ID":"rxyyciia12fq213","ADMIN_ID":"rxyyciia12fq213","USER_ID":"rxyyciia12fq213","DIRECTORY_ID":"rxyyciia12fq213","TEMPLATE_ID":"rxyyciia12fq213","STUDENT_DOWNLOAD_DOCUMENT":true,"DOCUMENT_SECURED":true,"DOCUMENT_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_PROOF_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_SIGNATURE_CODES":["rxyyciia12fq213"],"YOUSIGN_PROCEDURE":"rxyyciia12fq213","AUTOMATIC_EMAIL_SEND":true,"DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","DATE_EXPIRED":"2020-08-29T10:22:16.000Z","TO_DELETE":false,"DELETED_BY":"rxyyciia12fq213","TRAINING_ID":"rxyyciia12fq213","TYPE":0,"STATE":"pending"}}}}}}}},"/v2/documents/templates/{templateId}":{"delete":{"tags":["Documents"],"summary":"Delete a document template","description":"Delete a single document template (hard delete).","operationId":"DeleteTemplate","parameters":[{"in":"path","name":"templateId","description":"Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Document xxx successfully deleted"}}}}}},"get":{"tags":["Documents"],"summary":"Get a template by Document ID","description":"Retrieve a document template using a document ID. The template \"TYPE\" field defines if it's a document with or without signature : \n- \"1\" : Template of a document without signature\n- \"2\" : Template of a document with signature","operationId":"GetTemplateById","parameters":[{"in":"path","name":"templateId","description":"Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"type":{"type":"string"},"index":{"type":"number"},"label":{"type":"string"},"category":{"type":"string"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"page":{"type":"string"},"required":{"type":"boolean"}}}},"IMAGE_URL":{"type":"string"},"THUMBNAIL_URL":{"type":"string"},"ATTACHED_DOCUMENTS":{"type":"array","items":{}},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"TYPE":{"type":"number"}}}}},"example":{"status":"success","result":{"ID":"t1mcy3qc931vc9s","SCHOOL_ID":"1z6t74qzq6c5glkt","NAME":"Template name","TEMPLATE":"...","INPUTS":[{"id":1,"type":"text","index":1,"label":"First name","category":"Personal information","position":{"x":0,"y":0,"width":100,"height":100},"page":"1","required":true}],"IMAGE_URL":"https://...","THUMBNAIL_URL":"https://...","ATTACHED_DOCUMENTS":[],"DATE_CREATED":"2020-10-05T14:00:00.000Z","DATE_UPDATED":"2020-10-05T14:00:00.000Z","TYPE":1}}}}}}}},"/v2/documents/directories":{"get":{"tags":["Documents"],"summary":"Get all directories","description":"Rerieve all the document directories of your school.","operationId":"GetDirectories","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"response":{"type":"object","properties":{"total":{"type":"number"},"directories":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DOCUMENTS":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"step":{"type":"number"},"emails":{"type":"object","properties":{"documentSent":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"documentCompleted":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"signatureReminder":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"},"emailsAlreadySent":{"type":"array","items":{}}}}}},"version":{"type":"number"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"index":{"type":"number"},"order":{"type":"number"},"phone":{"type":"string"},"token":{"type":"string"},"category":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"signatureDate":{"type":"string"},"signatureState":{"type":"string"},"signatureUrl":{"type":"boolean"}}}},"validationMethod":{"type":"string"},"sendEmailWhenCompleted":{"type":"boolean"}}},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"personId":{"type":"string"},"required":{"type":"boolean"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"page":{"type":"number"}}}}}},"METADATAS":{"type":"object","properties":{"SIGNATORY_IP":{"type":"string"},"SIGNATORY_URL":{"type":"string"},"SIGNATORY_DATE":{"type":"string"},"SIGNATORY_TYPE":{"type":"string"},"SIGNATORY_EMAIL":{"type":"string"},"SIGNATORY_SIGN":{"type":"string"},"SIGNATORY_TOKEN":{"type":"string"},"SIGNATORY_FULLNAME":{"type":"string"},"VALIDATION_CODE":{"type":"string"}}},"STUDENT_ID":{"type":"string"},"PROFESSOR_ID":{"type":"string"},"ADMIN_ID":{"type":"string"},"USER_ID":{"type":"string"},"DIRECTORY_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"STUDENT_DOWNLOAD_DOCUMENT":{"type":"boolean"},"DOCUMENT_SECURED":{"type":"boolean"},"DOCUMENT_URL":{"type":"string"},"DOCUMENT_PROOF_URL":{"type":"string"},"DOCUMENT_SIGNATURE_CODES":{"type":"array","items":{"type":"string"}},"YOUSIGN_PROCEDURE":{"type":"string"},"AUTOMATIC_EMAIL_SEND":{"type":"boolean"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DATE_EXPIRED":{"type":"string"},"TO_DELETE":{"type":"boolean"},"DELETED_BY":{"type":"string"},"TRAINING_ID":{"type":"string"},"TYPE":{"type":"number"},"STATE":{"type":"string"}}}}}}}}}}},"example":{"status":"success","response":{"total":1,"directories":[{"ID":"uhytftgyhuji","NAME":"directoryName","SCHOOL_ID":"hjggfgyhuhj","DATE_CREATED":"2021-01-01T00:00:00.000Z","DATE_UPDATED":"2021-01-01T00:00:00.000Z","DOCUMENTS":[{"ID":"rxyyciia12fq213","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","SCHOOL_ID":"efa4cdm3ayaa713","VARIABLES":{"step":1,"emails":{"documentSent":{"body":"Your document is ready to be signed","subject":"Document to sign"},"documentCompleted":{"body":"Your document has been signed","subject":"Document signed"},"signatureReminder":{"body":"Please sign the document","subject":"Document signature reminder","amount":3,"interval":2,"emailsAlreadySent":[]}},"version":1,"recipients":[{"id":"rxyyciia12fq213","name":"John Doe","email":"john.doe@edusign.fr","index":0,"order":1,"phone":"0601020304","token":"rxyyciia12fq213","category":"student","firstname":"John","lastname":"Doe","signatureDate":"2020-08-29T10:22:16.000Z","signatureState":"pending","signatureUrl":true}],"validationMethod":"email","sendEmailWhenCompleted":true},"INPUTS":[{"id":"rxyyciia12fq213","type":"input","label":"input_startdate","category":"student","personId":"rxyyciia12fq213","required":true,"position":{"x":0,"y":0,"width":100,"height":100,"page":1}}],"METADATAS":{"SIGNATORY_IP":"::1","SIGNATORY_URL":"https://edusign.fr","SIGNATORY_DATE":"2020-08-29T10:22:16.000Z","SIGNATORY_TYPE":"student","SIGNATORY_EMAIL":"john.doe@edusign.fr","SIGNATORY_SIGN":"https://edusign.fr","SIGNATORY_TOKEN":"rxyyciia12fq213","SIGNATORY_FULLNAME":"John Doe","VALIDATION_CODE":"rxyyciia12fq213"},"STUDENT_ID":"rxyyciia12fq213","PROFESSOR_ID":"rxyyciia12fq213","ADMIN_ID":"rxyyciia12fq213","USER_ID":"rxyyciia12fq213","DIRECTORY_ID":"rxyyciia12fq213","TEMPLATE_ID":"rxyyciia12fq213","STUDENT_DOWNLOAD_DOCUMENT":true,"DOCUMENT_SECURED":true,"DOCUMENT_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_PROOF_URL":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf","DOCUMENT_SIGNATURE_CODES":["rxyyciia12fq213"],"YOUSIGN_PROCEDURE":"rxyyciia12fq213","AUTOMATIC_EMAIL_SEND":true,"DATE_CREATED":"2020-08-29T10:22:16.000Z","DATE_UPDATED":"2020-08-29T10:22:16.000Z","DATE_EXPIRED":"2020-08-29T10:22:16.000Z","TO_DELETE":false,"DELETED_BY":"rxyyciia12fq213","TRAINING_ID":"rxyyciia12fq213","TYPE":0,"STATE":"pending"}]}]}}}}}}}},"/v2/documents/directories/{directoryId}":{"get":{"tags":["Documents"],"summary":"Get a directory by ID","description":"Retrieve a single document directory using its directory ID.","operationId":"GetDirectoryById","parameters":[{"in":"path","name":"directoryId","description":"Directory ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"response":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"DOCUMENTS":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"VARIABLES":{"type":"object","properties":{"step":{"type":"number"},"emails":{"type":"object","properties":{"documentSent":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"documentCompleted":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"}}},"signatureReminder":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"amount":{"type":"number"},"interval":{"type":"number"},"emailsAlreadySent":{"type":"array","items":{}}}}}}}},"version":{"type":"number"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"signatureState":{"type":"string"},"signatureUrl":{"type":"boolean"}}}},"validationMethod":{"type":"string"},"sendEmailWhenCompleted":{"type":"boolean"}}}}}}}},"example":{"status":"success","response":{"ID":"hugytftyuhugy","NAME":"directoryName","SCHOOL_ID":"schoolId","DATE_CREATED":"2021-01-01T00:00:00.000Z","DATE_UPDATED":"2021-01-01T00:00:00.000Z","DOCUMENTS":[{"ID":"rxyyciia12fq213","NAME":"Certificat de réalisation","TEMPLATE":"My HTML template document","SCHOOL_ID":"efa4cdm3ayaa713","VARIABLES":{"step":1,"emails":{"documentSent":{"body":"Your document is ready to be signed","subject":"Document to sign"},"documentCompleted":{"body":"Your document has been signed","subject":"Document signed"},"signatureReminder":{"body":"Please sign the document","subject":"Document signature reminder","amount":3,"interval":2,"emailsAlreadySent":[]}}},"version":1,"recipients":[{"id":"rxyyciia12fq213","name":"John Doe","email":"john.doe@edusign.fr","signatureState":"pending","signatureUrl":true}],"validationMethod":"email","sendEmailWhenCompleted":true}]}}}}}}}},"/v2/documents/{documentId}/template":{"get":{"tags":["Documents"],"summary":"Get template by document ID","operationId":"GetDocumentTemplateById","parameters":[{"in":"path","name":"documentId","description":"ID of the document","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Not Defined","content":{"application/json":{"schema":{"title":"Not Defined","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Not Defined"}}}}}}},"/v2/documents/to-sign/{id}":{"get":{"tags":["Documents"],"summary":"Get document to sign by ID for editing","description":"Retrieve a document to sign by ID with inputs for editing. Document must be generated (DOCUMENT_URL must exist).","operationId":"GetDocumentToSignForEditing","parameters":[{"in":"path","name":"id","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DOCUMENT_URL":{"type":"string"},"INPUTS":{"type":"array","items":{}},"TEMPLATE_ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"rxyyciia12fq213","SCHOOL_ID":"school123","DOCUMENT_URL":"https://edusign.s3.amazonaws.com/doc.pdf","INPUTS":[],"TEMPLATE_ID":"template123"}}}}}}}},"/v2/documents/templates":{"get":{"tags":["Documents"],"summary":"Get all templates","description":"Retrieve all the document templates of your school. The template \"TYPE\" field defines if it's a document with or without signature : \n- \"1\" : Template of a document without signature\n- \"2\" : Template of a document with signature","operationId":"GetTemplates","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"total":{"type":"number"},"templates":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"INPUTS":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"type":{"type":"string"},"index":{"type":"number"},"label":{"type":"string"},"category":{"type":"string"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"page":{"type":"string"},"required":{"type":"boolean"}}}},"IMAGE_URL":{"type":"string"},"THUMBNAIL_URL":{"type":"string"},"ATTACHED_DOCUMENTS":{"type":"array","items":{}},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"TYPE":{"type":"number"}}}}}}}},"example":{"status":"success","result":{"total":1,"templates":[{"ID":"t1mcy3qc931vc9s","SCHOOL_ID":"1z6t74qzq6c5glkt","NAME":"Template name","TEMPLATE":"...","INPUTS":[{"id":1,"type":"text","index":1,"label":"First name","category":"Personal information","position":{"x":0,"y":0,"width":100,"height":100},"page":"1","required":true}],"IMAGE_URL":"https://...","THUMBNAIL_URL":"https://...","ATTACHED_DOCUMENTS":[],"DATE_CREATED":"2020-10-05T14:00:00.000Z","DATE_UPDATED":"2020-10-05T14:00:00.000Z","TYPE":1}]}}}}}}}},"/v1/document/professor/courses-between-dates":{"post":{"tags":["Documents"],"summary":"Generate a professor course summary between two dates","description":"Generate a PDF document course summary for a given professor between two dates.","operationId":"PostV1DocumentProfessorCoursesBetweenDates","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"filename":{"type":"string"}}}}},"example":{"status":"success","result":{"filename":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"PROFESSOR_ID":{"type":"string","description":"Professor ID"},"DATE_START":{"type":"string","description":"Start date of your professor course summary (format YYYY-MM-DD, ISO 8601)"},"DATE_END":{"type":"string","description":"End date of your professor course summary (format YYYY-MM-DD, ISO 8601)"}},"required":["PROFESSOR_ID","DATE_START","DATE_END"]},"example":{"PROFESSOR_ID":"zrtyfjz922jn","DATE_START":"2021-01-01T00:00:00","DATE_END":"2021-01-20T20:00:00"}}}}}},"/v1/document/student/courses-between-dates":{"post":{"tags":["Documents"],"summary":"Generate a student course summary between two dates","description":"Generate a PDF document course summary for a given student between two dates.","operationId":"PostV1DocumentStudentCoursesBetweenDates","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"filename":{"type":"string"}}}}},"example":{"status":"success","result":{"filename":"https://edusign.s3.eu-west-3.amazonaws.com/Elliot_Boucher_hfihfdd.pdf"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"STUDENT_ID":{"type":"string","description":"Student ID"},"DATE_START":{"type":"string","description":"Start date of your student course summary (format YYYY-MM-DD, ISO 8601)"},"DATE_END":{"type":"string","description":"End date of your student course summary (format YYYY-MM-DD, ISO 8601)"},"GROUP_ID":{"type":"string","description":"ID of the group attached to your student (will be displayed on the generated summary)"}},"required":["STUDENT_ID","DATE_START","DATE_END"]},"example":{"STUDENT_ID":"zrtyfjz922jn","DATE_START":"2021-01-01T00:00:00","DATE_END":"2021-01-20T20:00:00","GROUP_ID":"d9e2ld91dma12"}}}}}},"/v2/documents/to-sign/{id}/regenerate":{"post":{"tags":["Documents"],"summary":"Regenerate document with new inputs","description":"Regenerate a document PDF with updated inputs","operationId":"RegenerateDocument","parameters":[{"in":"path","name":"id","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"url":{"type":"string"},"hash":{"type":"string"}}}}},"example":{"status":"success","result":{"url":"https://edusign.s3.amazonaws.com/regenerated.pdf","hash":"abc123def456"}}}}}}}},"/v2/documents/to-sign/{id}/inputs":{"put":{"tags":["Documents"],"summary":"Update document inputs","description":"Update the inputs field for a document to sign","operationId":"UpdateDocumentInputs","parameters":[{"in":"path","name":"id","description":"Document ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Inputs updated successfully"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request-Example:","type":"object","properties":{"inputs":{"type":"array","description":"Array of input objects"}},"required":["inputs"]},"example":{"inputs":[{"id":1,"type":"SIGNATURE","label":"Signature de l'étudiant","category":"student","personId":"student123","required":true,"position":{"x":100,"y":200,"width":150,"height":50,"page":1},"index":0}]}}}}}},"/v1/events/{id}":{"delete":{"tags":["Events"],"summary":"Delete a single event","description":"

Permanently deletes a single event from your school's system.

What this endpoint does:

Permanently removes the event from the database
Automatically removes all student and professor associations
Sends deletion notifications to affected students
Cannot be undone once completed

Automatic behaviors:

Cascade deletion: All relationships (students, professors) are automatically removed
Smart notifications: Students receive push notifications only for events happening within 14 days
Notification content: Students get notified with event name, date, and time
Error handling: If the event doesn't exist, the operation fails gracefully

Use cases:

Removing cancelled events
Cleaning up duplicate or incorrect events
Bulk cleanup operations (though consider using mass delete for better performance)

⚠️ Warning: This operation cannot be undone. The event and all its data will be permanently lost.

","operationId":"DeleteV1EventsId","parameters":[{"in":"path","name":"id","description":"Event identifier (use internal Edusign event ID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"sjdjf91j1082bx"}}}}}}},"get":{"tags":["Events"],"summary":"Get a single event by ID","description":"

Retrieves detailed information about a specific event.

What this endpoint does:

Fetches a single event with all its details
Includes complete information about assigned students and professors
Returns both internal IDs and external API IDs where available

Use cases:

Displaying detailed event information in your side
Editing event details (get current values first)
Checking event participants before making changes
Verifying event information after creation or updates

Error handling: Returns a 404 error if the event doesn't exist or doesn't belong to your school.

","operationId":"GetV1EventsId","parameters":[{"in":"path","name":"id","description":"Event identifier (use internal Edusign event ID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"professors":{"type":"array","items":{"type":"object","properties":{"professorId":{"type":"string"},"apiId":{"type":"string"}}}},"students":{"type":"array","items":{"type":"object","properties":{"studentId":{"type":"string"},"apiId":{"type":"string"}}}},"classroom":{"type":"string"},"apiId":{"type":"string"},"apiType":{"type":"string"},"color":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"sdfgh567hn","name":"Growth hacking","description":"Event about growth hacking techniques and strategies","start":"2020-01-20T15:00:00.000Z","end":"2020-01-20T18:00:00.000Z","professors":[{"professorId":"dfgh6789Uhghj","apiId":"hjnafs89w3nmf"}],"students":[{"studentId":"1jawdhbj90adw","apiId":"ajhbdawlk934fj"}],"classroom":"B102","apiId":"bhwa89nmdaw","apiType":"calendar_system","color":"#3a7810"}}}}}}},"patch":{"tags":["Events"],"summary":"Update an existing event","description":"

Updates an existing event with new information.

What this endpoint does:

Updates only the fields you specify (partial update)
Creates new classrooms if they don't exist
Intelligently manages student and professor associations
Sends notifications to students for upcoming events (within 14 days)
Handles errors gracefully if some student/professor IDs are invalid

Smart participant management:

Replacement logic: When you provide a students or professors array, it completely replaces the existing list
Adding participants: The system automatically determines who to add
Removing participants: The system automatically determines who to remove
Empty arrays: Send [] to remove all students or professors from the event

Automatic notifications: Students receive push notifications when dates, times, or locations change for upcoming events.

Partial updates: Only include the fields you want to change. Omitted fields remain unchanged.

","operationId":"PatchV1EventsId","parameters":[{"in":"path","name":"id","description":"Event identifier in the URL (use internal Edusign event ID)","required":true,"schema":{"type":"string"}},{"in":"query","name":"apiIdMode","description":"Switch between internal IDs and external API IDs for students/professors\n
Important: When enabled, use external API IDs in the students and professors arrays instead of internal Edusign IDs.","required":false,"schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Success-Response (Perfect):","content":{"application/json":{"schema":{"title":"Success-Response (Perfect):","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"sdfgh567hn"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Partial Update (Name and Time):","type":"object","properties":{"name":{"type":"string","description":"New event title (optional - only include if changing)"},"start":{"type":"string","description":"New start date and time (optional, format: ISO 8601)"},"end":{"type":"string","description":"New end date and time (optional, format: ISO 8601)"},"description":{"type":"string","description":"New event description (optional - set to null to remove)"},"professors":{"items":{"type":"string","description":"Complete list of professor identifiers for this event\n
Important: This replaces ALL professors. Send an empty array to remove all professors."},"type":"array"},"students":{"items":{"type":"string","description":"Complete list of student identifiers for this event\n
Important: This replaces ALL students. Send an empty array to remove all students."},"type":"array"},"classroom":{"type":"string","description":"New classroom or location name (will be created if it doesn't exist)"},"apiId":{"type":"string","description":"New external API identifier"},"apiType":{"type":"string","description":"New source system or category for the external API"},"color":{"type":"string","description":"New display color in hex format (e.g., \"#4c00ff\")"}}},"example":{"name":"Advanced Growth Hacking","start":"2020-01-20T14:00:00.000Z","end":"2020-01-20T17:00:00.000Z"}}}}}},"/v1/events/mass":{"delete":{"tags":["Events"],"summary":"Delete multiple events in batch","description":"

Deletes multiple events efficiently in a single request.

What this endpoint does:

Deletes multiple events and all their associations (students, professors)
Automatically sends deletion notifications to previously associated students

Automatic behaviors:

Cascade deletion: Removes all student and professor associations automatically
Smart notifications: Students get notified only for events happening within 14 days
Error handling: Non-existent event IDs are silently ignored

Notification details: Students receive push notifications with event name, date, and time for upcoming deleted events.

Note: This operation cannot be undone. Make sure you really want to delete these events.

","operationId":"DeleteV1EventsMass","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"ids":["sdfgh567hn","ajndvfcd-0rf","kwj928nfj2k"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request Body:","type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}},"required":["ids"]},"example":{"ids":["sdfgh567hn","ajndvfcd-0rf","kwj928nfj2k"]}}}}},"post":{"tags":["Events"],"summary":"Add multiple events in batch","description":"

Creates multiple events in a single request for better performance.

What this endpoint does:

Creates multiple events efficiently with optimized database queries
Batch processes classroom creation (creates missing classrooms only once)
Associates students and professors with events in bulk
Sends notifications for updated events within 14 days in batches

Performance optimizations:

Classroom caching: Reuses classroom lookups across multiple events
Smart notifications: Groups notifications efficiently for updated events
Rate limiting: This endpoint has enhanced rate limiting due to its resource intensity

Best practices:

Use this endpoint when creating 5+ events to get better performance
Group events with similar classrooms together for better caching
Consider splitting very large batches (>1000 events) into smaller chunks

","operationId":"PostV1EventsMass","parameters":[{"in":"query","name":"apiIdMode","description":"Switch between internal IDs and external API IDs for students/professors\n
Important: When enabled, use external API IDs in the students and professors arrays instead of internal Edusign IDs.","required":false,"schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"ids":["sdfgh567hn","ajndvfcd-0rf"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Standard Request:","type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"professors":{"type":"array","items":{"type":"string"}},"students":{"type":"array","items":{"type":"string"}},"classroom":{"type":"string"},"apiId":{"type":"string"},"apiType":{"type":"string"},"color":{"type":"string"}},"required":["name","start","end","professors","students","classroom","apiId","apiType"]}},"events[name]":{"type":"string","description":"Event title (required)"},"events[description]":{"type":"string","description":"Detailed description of the event (optional)"},"events[start]":{"type":"string","description":"Event start date and time (required, format: ISO 8601)"},"events[end]":{"type":"string","description":"Event end date and time (required, format: ISO 8601)"},"events[professors]":{"items":{"type":"string","description":"List of professor identifiers to assign to this event"},"type":"array"},"events[students]":{"items":{"type":"string","description":"List of student identifiers to assign to this event"},"type":"array"},"events[classroom]":{"type":"string","description":"Classroom or location name (will be automatically created if it doesn't exist)"},"events[apiId]":{"type":"string","description":"External API identifier for this event (required for tracking and updates)"},"events[apiType]":{"type":"string","description":"Source system or category for the external API"},"events[color]":{"type":"string","description":"Display color for the event in hex format (e.g., \"#4c00ff\")"}},"required":["events","events[name]","events[start]","events[end]","events[apiId]"]},"example":{"events":[{"name":"Growth hacking","description":"Event about growth hacking techniques","start":"2020-01-20T15:00:00.000Z","end":"2020-01-20T18:00:00.000Z","professors":["dfgh6789Uhghj"],"students":["1jawdhbj90adw"],"classroom":"B102","apiId":"bhwa89nmdaw","apiType":"calendar_system","color":"#3a7810"},{"name":"Digital Marketing","start":"2020-01-21T14:00:00.000Z","end":"2020-01-21T16:00:00.000Z","professors":["dfgh6789Uhghj"],"students":["1jawdhbj90adw","2kawdhjb90adx"],"classroom":"B102","apiId":"bhwa89nmdaw2","apiType":"calendar_system"}]}}}}}},"/v1/events":{"get":{"tags":["Events"],"summary":"Get all events","description":"

This endpoint retrieves a paginated list of all events for your school.

What this endpoint does:

Supports various filtering options to find specific events
Returns paginated results to handle large datasets efficiently
Can return either full event details or lightweight data for performance

Date filtering behavior: The start/end filters work based on the event's start date.

Filtering options:

If both start and end are provided: returns events that start between these two dates (inclusive)
If only start is provided: returns events that start on or after this date
If only end is provided: returns events that start on or before this date

⚠️ Important: The school's timezone is automatically used when applying date filters to ensure accurate date comparisons.

Light mode: Use the 'light' parameter when you only need basic event information for lists or dropdowns, which improves loading speed.

","operationId":"GetV1Events","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"1\" and displays events per page (default: 1)","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Maximum number of events to return per page (default and max: 1000)","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"Filter events starting from this date (format: YYYY-MM-DD, ISO 8601)","required":false,"schema":{"type":"string"}},{"in":"query","name":"end","description":"Filter events ending before this date (format: YYYY-MM-DD, ISO 8601)\n
Note: When both start and end dates are provided, events will be filtered to include only those occurring within this date range.","required":false,"schema":{"type":"string"}},{"in":"query","name":"studentId","description":"Show only events assigned to this specific student (use internal Edusign student ID)","required":false,"schema":{"type":"string"}},{"in":"query","name":"professorId","description":"Show only events assigned to this specific professor (use internal Edusign professor ID)","required":false,"schema":{"type":"string"}},{"in":"query","name":"apiIds","description":"Filter events by external API IDs (JSON array as string, e.g., '[\"api1\",\"api2\"]')","required":false,"schema":{"type":"string"}},{"in":"query","name":"light","description":"When set to true, returns simplified event data with only id, name, apiId, and apiType fields for faster loading","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response (Full Mode):","content":{"application/json":{"schema":{"title":"Success-Response (Full Mode):","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"professors":{"type":"array","items":{"type":"object","properties":{"professorId":{"type":"string"},"apiId":{"type":"string"}}}},"students":{"type":"array","items":{"type":"object","properties":{"studentId":{"type":"string"},"apiId":{"type":"string"}}}},"classroom":{"type":"string"},"apiId":{"type":"string"},"apiType":{"type":"string"},"color":{"type":"string"}}}},"total":{"type":"number"},"page":{"type":"number"},"limit":{"type":"number"}}}}},"example":{"status":"success","result":{"data":[{"id":"sdfgh567hn","name":"Growth hacking","description":"Event about growth hacking","start":"2020-01-20T15:00:00.000Z","end":"2020-01-20T18:00:00.000Z","professors":[{"professorId":"dfgh6789Uhghj","apiId":"hjnafs89w3nmf"}],"students":[{"studentId":"1jawdhbj90adw","apiId":"ajhbdawlk934fj"}],"classroom":"B102","apiId":"bhwa89nmdaw","apiType":"calendar_system","color":"#000000"}],"total":150,"page":1,"limit":1000}}}}}}},"post":{"tags":["Events"],"summary":"Add a new event","description":"

Creates a new event in your school's system.

What this endpoint does:

Creates a new event with the provided information
Creates classrooms if they don't exist in the system
Associates students and professors with the event
Sends push notifications to students if the event already exists, is updated and is within 14 days
Handles errors gracefully if some students or professors aren't found

Automatic features:

Classroom creation: If you specify a classroom name that doesn't exist, it will be automatically created
Smart notifications: Students receive push notifications for updated events happening within the next 14 days
Error resilience: The event is still created even if some student/professor IDs are invalid

API ID Mode: Use this when your external system has its own user IDs that differ from Edusign's internal IDs.

","operationId":"PostV1Events","parameters":[{"in":"query","name":"apiIdMode","description":"Switch between internal IDs and external API IDs for students/professors\n
Important: When enabled, use external API IDs in the students and professors arrays instead of internal Edusign IDs.","required":false,"schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"sdfgh567hn"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Standard Request:","type":"object","properties":{"name":{"type":"string","description":"Event title (required)"},"description":{"type":"string","description":"Detailed description of the event (optional)"},"start":{"type":"string","description":"Event start date and time (required, format: ISO 8601, e.g., \"2020-01-20T15:00:00.000Z\")"},"end":{"type":"string","description":"Event end date and time (required, format: ISO 8601, e.g., \"2020-01-20T18:00:00.000Z\")"},"professors":{"type":"array","items":{"type":"string"}},"students":{"type":"array","items":{"type":"string"}},"classroom":{"type":"string","description":"Classroom or location name (will be automatically created if it doesn't exist)"},"apiId":{"type":"string","description":"External API identifier for this event (required for tracking and updates)"},"apiType":{"type":"string","description":"Source system or category for the external API (e.g., \"calendar_system\")"},"color":{"type":"string","description":"Display color for the event in hex format (e.g., \"#4c00ff\")"}},"required":["name","start","end","apiId"]},"example":{"name":"Growth hacking","description":"Event about growth hacking techniques","start":"2020-01-20T15:00:00.000Z","end":"2020-01-20T18:00:00.000Z","professors":["dfgh6789Uhghj"],"students":["1jawdhbj90adw","2kawdhjb90adx"],"classroom":"B102","apiId":"bhwa89nmdaw","apiType":"calendar_system","color":"#3a7810"}}}}}},"/v1/externals/{externalId}":{"delete":{"tags":["Externals"],"summary":"Archive an external","description":"Archive a single external (soft delete).","operationId":"DeleteV1ExternalsExternalid","parameters":[{"in":"path","name":"externalId","description":"External ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Externals"],"summary":"Get an external by id","description":"Retrieve a single external using its external ID.","operationId":"GetV1ExternalsExternalid","parameters":[{"in":"path","name":"externalId","description":"External ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"COMPANY":{"type":"string"},"PHONE":{"type":"string"},"DATE_EDITED":{"type":"string"},"DATE_CREATED":{"type":"string"},"TYPE":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"HIDDEN":{"type":"number"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"TYPE":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"array","items":{"type":"string"}},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"}," VALUE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"akff92zsaafi","SCHOOL_ID":"9e2b25c79sa5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","COMPANY":"edusign","PHONE":"","DATE_EDITED":"2020-01-12T09:28:09.000Z","DATE_CREATED":"2020-01-12T09:28:09.000Z","TYPE":0,"API_ID":"uytffgyt","API_TYPE":"aimaira","HIDDEN":0,"VARIABLES":[{"ID":1044,"NAME":"test name","RESSOURCE_TYPE":"external","TYPE":"text","SELECT_TYPE_VALUES":["option 1","option 2"],"SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2020-01-12T09:28:09.000Z","DATE_UPDATED":"2020-01-12T09:28:09.000Z","RESSOURCE_ID":"ricdgdvx44e1ui55","VALUE_ID":79377,"SCHOOL_VARIABLE_ID":1044," VALUE":"test"}]}}}}}}}},"/v1/externals/variables/{variableId}":{"delete":{"tags":["Externals"],"summary":"Delete an external variable","description":"Delete a single variable (or custom field) and the values it contains for each external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a group or an external).","operationId":"DeleteV1ExternalsVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"Variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/externals":{"get":{"tags":["Externals"],"summary":"Get all external contacts","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active externals of your school (without the archived externals).
WARNING : This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Externals","parameters":[{"in":"query","name":"keyword","description":"search keyword (search in the FIRSTNAME, LASTNAME, and EMAIL)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"COMPANY":{"type":"string"},"PHONE":{"type":"string"},"TYPE":{"type":"number"},"DATE_EDITED":{"type":"string"},"DATE_CREATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"HIDDEN":{"type":"number"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"TYPE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"array","items":{"type":"string"}},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"VALUE":{"type":"string"}}}}}}}}},"example":{"status":"success","result":[{"ID":"akff92zsaafi","SCHOOL_ID":"9e2b25c79sa5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","COMPANY":"Edusign","PHONE":"0637625172","TYPE":0,"DATE_EDITED":"2024-03-12T14:09:29.000Z","DATE_CREATED":"2024-03-12T14:09:29.000Z","API_ID":"32895Y","API_TYPE":"test","HIDDEN":0,"VARIABLES":[{"ID":1044,"NAME":"test name","RESSOURCE_TYPE":"external","TYPE":"text","SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2024-03-25T10:26:32.000Z","DATE_UPDATED":"2024-03-25T10:26:32.000Z","RESSOURCE_ID":"ricdgdvx44e1ui55","SELECT_TYPE_VALUES":["option 1","option 2"],"VALUE_ID":79377,"SCHOOL_VARIABLE_ID":1044,"VALUE":"test"}]}]}}}}}},"patch":{"tags":["Externals"],"summary":"Update an external","description":"Un contact externe est par exemple un maitre d'apprentissage, un signataire externe de document...","operationId":"PatchV1Externals","parameters":[{"in":"query","name":"editCourses","description":"If true, upcoming courses are updated with the new list of students in the group (default: true)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"external":{"type":"object","properties":{"ID":{"type":"string","description":"External ID"},"FIRSTNAME":{"type":"string","description":"Firstname of the external contact"},"LASTNAME":{"type":"string","description":"Lastname of the external contact"},"EMAIL":{"type":"string","description":"Email of the external contact"},"COMPANY":{"type":"string","description":"Company of the external contact"},"TYPE":{"type":"number","description":"Type of the external contact"},"PHONE":{"type":"string","description":"Phone of the external contact"},"API_ID":{"type":"string","description":"API ID of the external contact"},"API_TYPE":{"type":"string","description":"API type of the external contact"},"HIDDEN":{"type":"number","description":"Hidden of the external contact"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"NAME":{"type":"string","description":"The name of the variable"},"TYPE":{"type":"string","description":"The type of the variable"},"RESSOURCE_TYPE":{"type":"string","description":"The type of the ressource"},"RESSOURCE_ID":{"type":"number","description":"The ID of the ressource"},"VALUE_ID":{"type":"number","description":"It's the ID of the external variable value, to not be confused with the school variable id (see above)"},"SCHOOL_VARIABLE_ID":{"type":"number","description":"The school variable ID"},"VALUE":{"type":"string","description":"The value of the variable, can be a string of a boolean depending on the type"},"SCHOOL_ID":{"type":"string","description":"The school ID"},"DATE_CREATED":{"type":"string","description":"The date created"},"DATE_UPDATED":{"type":"string","description":"The date updated"}},"required":["NAME","TYPE","RESSOURCE_TYPE","RESSOURCE_ID","VALUE","VALUE_ID","SCHOOL_ID","DATE_CREATED","DATE_UPDATED","SCHOOL_VARIABLE_ID"]}}},"required":["ID","FIRSTNAME","LASTNAME","EMAIL"]}},"required":["external"]},"example":{"external":{"ID":"adj82jdflb01k","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","COMPANY":"Edusign","TYPE":0,"PHONE":"0637625172","API_ID":"32895Y","API_TYPE":"test","HIDDEN":0,"VARIABLES":[{"NAME":"test name","TYPE":"text","RESSOURCE_TYPE":"external","RESSOURCE_ID":"ricdgdvx44e1ui55","VALUE_ID":79377,"SCHOOL_VARIABLE_ID":1044,"VALUE":"test"}]}}}}}},"post":{"tags":["Externals"],"summary":"Create an external","description":"Un contact externe est par exemple un maitre d'apprentissage, un signataire externe de document...","operationId":"PostV1Externals","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"aa972jjdz221"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"FIRSTNAME":{"type":"string","description":"Firstname of the external contact"},"LASTNAME":{"type":"string","description":"Lastname of the external contact"},"EMAIL":{"type":"string","description":"Email of the external contact"},"COMPANY":{"type":"string","description":"Company of the external contact"},"TYPE":{"type":"number","description":"Type of the external contact"},"PHONE":{"type":"string","description":"Phone of the external contact"},"HIDDEN":{"type":"number","description":"Hidden of the external contact"},"API_ID":{"type":"string","description":"API ID of the external contact"},"API_TYPE":{"type":"string","description":"API type of the external contact"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"NAME":{"type":"string","description":"The name of the variable"},"TYPE":{"type":"string","description":"The type of the variable"},"RESSOURCE_TYPE":{"type":"string","description":"The type of the ressource"},"RESSOURCE_ID":{"type":"number","description":"The ID of the ressource"},"VALUE_ID":{"type":"number","description":"It's the ID of the external variable value, to not be confused with the school variable id (see above)"},"SCHOOL_VARIABLE_ID":{"type":"number","description":"The school variable ID"},"VALUE":{"type":"string","description":"The value of the variable, can be a string of a boolean depending on the type"},"SCHOOL_ID":{"type":"string","description":"The school ID"},"DATE_CREATED":{"type":"string","description":"The date created"},"DATE_UPDATED":{"type":"string","description":"The date updated"}},"required":["NAME","TYPE","RESSOURCE_TYPE","RESSOURCE_ID","VALUE","VALUE_ID","SCHOOL_ID","DATE_CREATED","DATE_UPDATED","SCHOOL_VARIABLE_ID"]}}},"required":["FIRSTNAME","LASTNAME","EMAIL"]},"example":{"FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","COMPANY":"Edusign","TYPE":0,"PHONE":"0637625172","HIDDEN":0,"API_ID":"32895Y","API_TYPE":"test","VARIABLES":[{"NAME":"test name","TYPE":"text","RESSOURCE_TYPE":"external","RESSOURCE_ID":"ricdgdvx44e1ui55","VALUE_ID":79377,"SCHOOL_VARIABLE_ID":1044,"VALUE":"test"}]}}}}}},"/v1/externals/by-email/{email}":{"get":{"tags":["Externals"],"summary":"Get an external by email","description":"Retrieve a single external using its email address.","operationId":"GetV1ExternalsByEmailEmail","parameters":[{"in":"path","name":"email","description":"External email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"SCHOOL_ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"COMPANY":{"type":"string"},"PHONE":{"type":"string"},"DATE_EDITED":{"type":"string"},"DATE_CREATED":{"type":"string"},"TYPE":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"HIDDEN":{"type":"number"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"TYPE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"VALUE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"q9vgsuqmrhg6rrt","SCHOOL_ID":"9e2b25c79sa5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","COMPANY":"Edusign","PHONE":"0637625172","DATE_EDITED":"2024-03-12T14:09:29.000Z","DATE_CREATED":"2024-03-12T14:09:29.000Z","TYPE":0,"API_ID":"32895Y","API_TYPE":"test","HIDDEN":0,"VARIABLES":[{"ID":1044,"NAME":"test name","RESSOURCE_TYPE":"external","TYPE":"text","SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2024-03-25T10:26:32.000Z","DATE_UPDATED":"2024-03-25T10:26:32.000Z","RESSOURCE_ID":"ricdgdvx44e1ui55","VALUE_ID":79377,"SCHOOL_VARIABLE_ID":1044,"VALUE":"test"}]}}}}}}}},"/v1/externals/{externalId}/variables":{"get":{"tags":["Externals"],"summary":"Get an external's variables","description":"Retrieve an array of variables (or custom fields) for an external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a group or an external).","operationId":"GetV1ExternalsExternalidVariables","parameters":[{"in":"path","name":"externalId","description":"External ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"valueId":{"type":"number"}}}}}}}},"example":{"status":"success","result":{"ID":"mw26lt3s1bf622bj","VARIABLES":[{"id":1,"name":"test name","type":"select","value":"option 1","valueId":1}]}}}}}}},"post":{"tags":["Externals"],"summary":"Create an external variable","description":"Create a new variable and assign a value for it for each external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a group or an external).","operationId":"PostV1ExternalsExternalidVariables","parameters":[{"in":"path","name":"externalId","description":"External ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1047}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body:","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"type":{"type":"string","description":"Type of the variable","default":"text"},"value":{"type":"string","description":"Value of the variable for the external, can be either a string or a boolean.
WARNING : The value must be of the same type as the variable type."},"selectOptions":{"items":{"type":"string","description":"The values options for the \"select\" type.
WARNING : This field is required if the variable type is \"select\""},"type":"array"}},"required":["name","type","value"]},"example":{"name":"test name","type":"boolean","value":true}}}}}},"/v1/externals/{externalId}/variables/{variableId}":{"patch":{"tags":["Externals"],"summary":"Update an external variable","description":"Update an external variable using its variable ID.","operationId":"PatchV1ExternalsExternalidVariablesVariableid","parameters":[{"in":"path","name":"externalId","description":"External ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"variableId","description":"Variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1047}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body:","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"type":{"type":"string","description":"Type of the variable","default":"text"},"value":{"type":"string","description":"Value of the variable for the external.
WARNING : The value must be of the same type as the existing variable type."}},"required":["name","type","value"]},"example":{"name":"test name edited","type":"boolean","value":true}}}}}},"/v1/group/{groupId}":{"delete":{"tags":["Groups"],"summary":"Archive a group","description":"Archive a single group (soft delete).","operationId":"DeleteV1GroupGroupid","parameters":[{"in":"path","name":"groupId","description":"Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"bbnhc5knnn1vtlw archived"}}}}}},"get":{"tags":["Groups"],"summary":"Get a group by id","description":"Retrieve a single group using its group ID.","operationId":"GetV1GroupGroupid","parameters":[{"in":"path","name":"groupId","description":"Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"SCHOOL_ID":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string"},"LOGO":{"type":"string"},"HIDDEN":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"TYPE":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"string"},"VALUE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}},"id":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"bbnhc5knnn1vtlw","NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","SCHOOL_ID":"9e2b25c79sa5fzsu","STUDENTS":["w027oq2mtq5fzsu"],"PARENT":"","LOGO":"","HIDDEN":0,"API_ID":"jfgjihgfsc97s","API_TYPE":"test","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z","VARIABLES":[{"ID":1,"VALUE_ID":1,"SCHOOL_VARIABLE_ID":1,"NAME":"test name","SCHOOL_ID":"9e2b25c79sa5fzsu","RESSOURCE_TYPE":"group","RESSOURCE_ID":"bbnhc5knnn1vtlw","TYPE":"select","SELECT_TYPE_VALUES":"option 1","VALUE":"option 1","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z"}],"id":"bbnhc5knnn1vtlw"}}}}}}}},"/v1/group/variables/{variableId}":{"delete":{"tags":["Groups"],"summary":"Delete a group variable","description":"Delete a single variable (or custom field) and the values it contains for each group linked to it. When a group is linked to a variable, the variable ID can be retrieved through the group with the \"VARIABLES\" array.","operationId":"DeleteV1GroupVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"variable id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/group":{"get":{"tags":["Groups"],"summary":"Get all groups","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active groups of your school (without the archived groups).
WARNING : This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Group","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\" and displays 100 groups per page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"SCHOOL_ID":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string"},"LOGO":{"type":"string"},"HIDDEN":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"TYPE":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"string"},"VALUE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}}}}}}},"example":{"status":"success","result":[{"ID":"bbnhc5knnn1vtlw","NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","SCHOOL_ID":"9e2b25c79sa5fzsu","STUDENTS":["w027oq2mtq5fzsu"],"PARENT":"","LOGO":"https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg","HIDDEN":0,"API_ID":"jfgjihgfsc97s","API_TYPE":"test","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z","VARIABLES":[{"ID":1,"VALUE_ID":1,"SCHOOL_VARIABLE_ID":1,"NAME":"test name","SCHOOL_ID":"9e2b25c79sa5fzsu","RESSOURCE_TYPE":"group","RESSOURCE_ID":"bbnhc5knnn1vtlw","TYPE":"select","SELECT_TYPE_VALUES":"option 1","VALUE":"option 1","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z"}]}]}}}}}},"post":{"tags":["Groups"],"summary":"Create a group","description":"Create a new group.","operationId":"PostV1Group","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"vf5k2u0f2xe1vth5"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"group":{"type":"object","properties":{"NAME":{"type":"string","description":"Group name"},"DESCRIPTION":{"type":"string","description":"Group description"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string","description":"Group parent"},"LOGO":{"type":"string","description":"Group logo"},"API_ID":{"type":"string","description":"Group API ID"},"API_TYPE":{"type":"string","description":"Group API type"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"NAME":{"type":"string","description":"The variable name"},"RESSOURCE_TYPE":{"type":"string","description":"The variable ressource type"},"RESSOURCE_ID":{"type":"string","description":"The variable ressource ID"},"TYPE":{"type":"string","description":"The variable type"},"SELECT_TYPE_VALUES":{"type":"string","description":"The variable select type values"},"VALUE":{"type":"string","description":"The variable value"}},"required":["NAME","RESSOURCE_TYPE","RESSOURCE_ID","TYPE","SELECT_TYPE_VALUES","VALUE"]}}},"required":["NAME","STUDENTS"]}},"required":["group"]},"example":{"group":{"NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","STUDENTS":["ad876fgh7","gh76th76FG","n876GBnvPPM"],"PARENT":"bbnhc5knnn1vglk","LOGO":"https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg","API_ID":"jfgjihgfsc97s","API_TYPE":"test","VARIABLES":[{"NAME":"test name","RESSOURCE_TYPE":"group","RESSOURCE_ID":"bbnhc5knnn1vtlw","TYPE":"select","SELECT_TYPE_VALUES":"option 1","VALUE":"option 1"}]}}}}}}},"/v1/group/get-by-name/{groupName}":{"get":{"tags":["Groups"],"summary":"Get a group by name","description":"Retrieve a single group using its group name.","operationId":"GetV1GroupGetByNameGroupname","parameters":[{"in":"path","name":"groupName","description":"Group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"SCHOOL_ID":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string"},"LOGO":{"type":"string"},"HIDDEN":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"TYPE":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"string"},"VALUE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}},"id":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"bbnhc5knnn1vtlw","NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","SCHOOL_ID":"9e2b25c79sa5fzsu","STUDENTS":["w027oq2mtq5fzsu"],"PARENT":"","LOGO":"https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg","HIDDEN":0,"API_ID":"jfgjihgfsc97s","API_TYPE":"","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z","VARIABLES":[{"ID":1,"VALUE_ID":1,"SCHOOL_VARIABLE_ID":1,"NAME":"test name","SCHOOL_ID":"9e2b25c79sa5fzsu","RESSOURCE_TYPE":"group","RESSOURCE_ID":"bbnhc5knnn1vtlw","TYPE":"select","SELECT_TYPE_VALUES":"option 1","VALUE":"option 1","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z"}],"id":"bbnhc5knnn1vtlw"}}}}}}}},"/v1/group/get-id/{apiId}":{"get":{"tags":["Groups"],"summary":"Get group ID by API ID","description":"Retrieve a single group ID using its API ID.","operationId":"GetV1GroupGetIdApiid","parameters":[{"in":"path","name":"apiId","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"DESCRIPTION":{"type":"string"},"SCHOOL_ID":{"type":"string"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string"},"LOGO":{"type":"string"},"HIDDEN":{"type":"number"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"NAME":{"type":"string"},"SCHOOL_ID":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"TYPE":{"type":"string"},"SELECT_TYPE_VALUES":{"type":"string"},"VALUE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}},"id":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"bbnhc5knnn1vtlw","NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","SCHOOL_ID":"9e2b25c79sa5fzsu","STUDENTS":["w027oq2mtq5fzsu"],"PARENT":"","LOGO":"https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg","HIDDEN":0,"API_ID":"jfgjihgfsc97s","API_TYPE":"","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z","VARIABLES":[{"ID":1,"VALUE_ID":1,"SCHOOL_VARIABLE_ID":1,"NAME":"test name","SCHOOL_ID":"9e2b25c79sa5fzsu","RESSOURCE_TYPE":"group","RESSOURCE_ID":"bbnhc5knnn1vtlw","TYPE":"select","SELECT_TYPE_VALUES":"option 1","VALUE":"option 1","DATE_CREATED":"2024-03-12T15:43:24.000Z","DATE_UPDATED":"2024-03-12T15:43:24.000Z"}],"id":"bbnhc5knnn1vtlw"}}}}}}}},"/v1/group/{groupId}/variables":{"get":{"tags":["Groups"],"summary":"Get a group's variables","description":"Retrieve an array of variables (or custom fields) linked to a group.","operationId":"GetV1GroupGroupidVariables","parameters":[{"in":"path","name":"groupId","description":"group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"valueId":{"type":"number"}}}}}}}},"example":{"status":"success","result":{"ID":"mw26lt3s1bf622bj","VARIABLES":[{"id":1,"name":"test name","type":"select","value":"option 1","valueId":1}]}}}}}}},"post":{"tags":["Groups"],"summary":"Create a group variable","description":"Create a new variable and assign a value for it for a group.","operationId":"PostV1GroupGroupidVariables","parameters":[{"in":"path","name":"groupId","description":"group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1043}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"body:","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value of the variable for the group, can be either a string or a boolean.
WARNING : The value must be of the same type as the variable type."},"type":{"type":"string","description":"Type of the variable","default":"text"},"selectOptions":{"items":{"type":"string","description":"The values options for the \"select\" type.
WARNING : This field is required if the variable type is \"select\""},"type":"array"}},"required":["name","type","value"]},"example":{"name":"test name","value":"true","type":"boolean"}}}}}},"/v1/group/":{"patch":{"tags":["Groups"],"summary":"Update a group","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Update a single group informations.
WARNING : This is an heavy request, please use this endpoint only when needed.
WARNING : When updating a group, every field will be updated, even if you don't provide a value for them. For instance if you are updating a group name and your group has an array of students in it, if you don't provide again that array of students when updating the group, the value will be deleted.","operationId":"PatchV1Group","parameters":[{"in":"query","name":"editCourses","description":"If true, upcoming courses are updated with the new list of students in the group (default: true)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"},"studentsHasBeenUpdated":{"type":"boolean"},"result":{"type":"boolean"}}},"example":{"status":"success","id":"bbnhc5knnn1vtlw","studentsHasBeenUpdated":false,"result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"group":{"type":"object","properties":{"ID":{"type":"string","description":"Group ID"},"NAME":{"type":"string","description":"Group name"},"DESCRIPTION":{"type":"string","description":"Group description"},"STUDENTS":{"type":"array","items":{"type":"string"}},"PARENT":{"type":"string","description":"Group parent"},"LOGO":{"type":"string","description":"Group logo"},"HIDDEN":{"type":"number","description":"Group hidden"},"API_ID":{"type":"string"}},"required":["ID","NAME"]}},"required":["group"]},"example":{"group":{"ID":"sdfgh67dg67","NAME":"Master Digital 2020-2022","DESCRIPTION":"Whatever you want","STUDENTS":["gh876fgh7","gh76th76FG","n876GBnvPPM"],"PARENT":"gh76thhgytfrt","LOGO":"https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg","HIDDEN":"0","API_ID":""}}}}}}},"/v1/group/{groupId}/variables/{variableId}":{"patch":{"tags":["Groups"],"summary":"Update a group variable","description":"Update a group variable using its variable ID.","operationId":"PatchV1GroupGroupidVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"Variable ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"groupId","description":"Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1043}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body:","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value of the variable for the group, can be either a string or a boolean.
WARNING : The value must be of the same type as the variable type."}},"required":["name","value"]},"example":{"name":"test name edited","value":"test edited"}}}}}},"/v1/presential-states/set-absent/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Set an absence for a student","description":"Set a single absence for a student in a given course (course must be unlocked).","operationId":"PatchV1PresentialStatesSetAbsentCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Example Request Body with optional comment:","type":"object","properties":{"comment":{"type":"string","description":"An optional comment when the student is absent"}}},"example":{"comment":"Student absent comment"}}}}}},"/v1/presential-states/set-comment/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Create a comment for a student.","description":"Create a single comment for a student in a given course (course must be unlocked). Comments can be displayed or hidden on the courses PDF generated within Edusign.","operationId":"PatchV1PresentialStatesSetCommentCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Example Request Body with comment to erase existing one:","type":"object","properties":{"comment":{"type":"string","description":"A comment to add for a Student in a Course"}},"required":["comment"]},"example":{"comment":""}}}}}},"/v1/presential-states/set-delay/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Set a delay for a student","description":"Set a single delay for a student in a given course (course must be unlocked).","operationId":"PatchV1PresentialStatesSetDelayCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"delay":{"type":"number","description":"Student's delay value, in minutes"},"comment":{"type":"string","description":"An optional comment for the student's delay"}},"required":["delay"]},"example":{"delay":"10","comment":"delay comment"}}}}}},"/v1/presential-states/set-early-departure/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Set an early departure for a student","description":"Set an early departure for a student in a given course (course must be unlocked).","operationId":"PatchV1PresentialStatesSetEarlyDepartureCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Example Request Body with optional comment:","type":"object","properties":{"earlyDate":{"type":"string","description":"The date of the student's early departure (format YYYY-MM-DD, ISO 8601)"},"comment":{"type":"string","description":"An optional comment for the student's early departure"}},"required":["earlyDate"]},"example":{"earlyDate":"2023-09-25T07:06:55Z","comment":"early departure comment"}}}}}},"/v1/presential-states/set-exclusion/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Set an exclusion for a student","description":"Set an exclusion for a student in a given course (course must be unlocked).","operationId":"PatchV1PresentialStatesSetExclusionCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Example Request Body with optional comment:","type":"object","properties":{"excludeDate":{"type":"string","description":"The date of the student's exclusion (format YYYY-MM-DD, ISO 8601)"},"comment":{"type":"string","description":"An optional comment for the student's exclusion"}},"required":["excludeDate"]},"example":{"excludeDate":"2023-09-25T07:06:55","comment":"student excluded comment"}}}}}},"/v1/presential-states/set-present/{courseId}/{studentId}":{"patch":{"tags":["Presential_States"],"summary":"Set a presence for a student - Only for courses without signature.","description":"Set a presence for a student in a given course (course must be unlocked). This endpoint can be used only if the option \"Students signature required\" have been disabled from Edusign's school platform.","operationId":"PatchV1PresentialStatesSetPresentCourseidStudentid","parameters":[{"in":"path","name":"courseId","description":"Course ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"OK"}}}}}}},"/v1/professor/{professorId}":{"delete":{"tags":["Professors"],"summary":"Archive a professor","description":"Archive a single professor (soft delete).
WARNING : Never delete a professor linked to a group or a course.","operationId":"DeleteV1ProfessorProfessorid","parameters":[{"in":"path","name":"professorId","description":"Professor ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"8jyj5wg71yp5fzsu deleted"}}}}}},"get":{"tags":["Professors"],"summary":"Get a professor by id","description":"Retrieve a single professor using its professor ID.","operationId":"GetV1ProfessorProfessorid","parameters":[{"in":"path","name":"professorId","description":"Professor ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"SPECIALITY":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"EMAIL":{"type":"string"},"PASSWORD":{"type":"string"},"PHONE":{"type":"string"},"PIN":{"type":"string"},"OLD_HIDDEN":{"type":"string"},"MAGIC_LINK_TOKEN":{"type":"string"},"LOGIN_CODE":{"type":"array","items":{}},"NEW_PASSWORD_TOKEN":{"type":"string"},"OLD_API_ID":{"type":"string"},"OLD_API_TYPE":{"type":"string"},"ZOOM_ID":{"type":"array","items":{}},"TEAMS_ID":{"type":"array","items":{}},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"string"},"INDEX":{"type":"number"},"PROFESSOR_ID":{"type":"string"},"SCHOOL_ID":{"type":"array","items":{"type":"string"}},"HIDDEN":{"type":"array","items":{}},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"SCHOOL_DATE_CREATED":{"type":"string"},"SCHOOL_DATE_UPDATED":{"type":"string"},"id":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"TYPE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"VALUE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"8jyj5wg71yp5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","SPECIALITY":"Marketing","TAGS":["Finance","Physiologie"],"DATE_CREATED":"2023-09-05T12:43:18.000Z","DATE_UPDATED":"2024-03-12T14:33:31.000Z","EMAIL":"johndoe@edusign.com","PASSWORD":"jhgtyftyuhihgy","PHONE":"0612345678","PIN":"","OLD_HIDDEN":"null","MAGIC_LINK_TOKEN":"","LOGIN_CODE":[],"NEW_PASSWORD_TOKEN":"","OLD_API_ID":"","OLD_API_TYPE":"","ZOOM_ID":[],"TEAMS_ID":[],"MULTI_ACCOUNT_LOGIN_CODE":"","INDEX":180771,"PROFESSOR_ID":"8jyj5wg71yp5fzsu","SCHOOL_ID":["9e2b25c79sa5fzsu"],"HIDDEN":[],"API_ID":"f0js9Uj","API_TYPE":"hyperplanning","SCHOOL_DATE_CREATED":"2023-09-05T12:43:18.000Z","SCHOOL_DATE_UPDATED":"2024-03-12T14:33:31.000Z","id":"8jyj5wg71yp5fzsu","VARIABLES":[{"ID":1045,"NAME":"test name","RESSOURCE_TYPE":"professor","TYPE":"text","SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2024-03-25T10:52:18.000Z","DATE_UPDATED":"2024-03-25T10:52:18.000Z","RESSOURCE_ID":"16j37p2t38b5fzsu","VALUE_ID":79378,"SCHOOL_VARIABLE_ID":1045,"VALUE":"test"}]}}}}}}}},"/v1/professor/variables/{variableId}":{"delete":{"tags":["Professors"],"summary":"Delete a professor variable","description":"Delete a single variable (or custom field) and the values it contains for each professor linked to it. When a professor is linked to a variable, the variable ID can be retrieved through the professor with the \"VARIABLES\" array.","operationId":"DeleteV1ProfessorVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"Variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/professor":{"get":{"tags":["Professors"],"summary":"Get all professors","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active professors of your school (without the archived professors).
WARNING : This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Professor","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\" and displays 100 professors per page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"EMAIL":{"type":"string"},"SPECIALITY":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"PHONE":{"type":"string"},"PIN":{"type":"string"},"PASSWORD":{"type":"string"},"OLD_HIDDEN":{"type":"string"},"MAGIC_LINK_TOKEN":{"type":"string"},"LOGIN_CODE":{"type":"array","items":{}},"NEW_PASSWORD_TOKEN":{"type":"string"},"OLD_API_ID":{"type":"string"},"OLD_API_TYPE":{"type":"string"},"ZOOM_ID":{"type":"array","items":{}},"TEAMS_ID":{"type":"array","items":{}},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"string"},"INDEX":{"type":"number"},"PROFESSOR_ID":{"type":"string"},"SCHOOL_ID":{"type":"array","items":{"type":"string"}},"HIDDEN":{"type":"array","items":{}},"SCHOOL_DATE_CREATED":{"type":"string"},"SCHOOL_DATE_UPDATED":{"type":"string"},"id":{"type":"string"},"ZOOM_FOR_THIS_SCHOOL":{"type":"boolean"},"TEAMS_FOR_THIS_SCHOOL":{"type":"boolean"}}}}}},"example":{"status":"success","result":[{"ID":"16j37p2t38b5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","SPECIALITY":"Marketing","TAGS":["Finance","Marketing","Physiologie"],"DATE_CREATED":"2020-01-20T15:22:20.000Z","DATE_UPDATED":"2020-01-20T15:22:20.000Z","API_ID":"","API_TYPE":"","PHONE":"0612345678","PIN":"","PASSWORD":"hgtftyguhiygtf","OLD_HIDDEN":"null","MAGIC_LINK_TOKEN":"","LOGIN_CODE":[],"NEW_PASSWORD_TOKEN":"","OLD_API_ID":"6712","OLD_API_TYPE":"ammon","ZOOM_ID":[],"TEAMS_ID":[],"MULTI_ACCOUNT_LOGIN_CODE":"","INDEX":180770,"PROFESSOR_ID":"16j37p2t38b5fzsu","SCHOOL_ID":["9e2b25c79sa5fzsu"],"HIDDEN":[],"SCHOOL_DATE_CREATED":"2023-09-05T12:43:18.000Z","SCHOOL_DATE_UPDATED":"2023-09-05T12:43:18.000Z","id":"16j37p2t38b5fzsu","ZOOM_FOR_THIS_SCHOOL":false,"TEAMS_FOR_THIS_SCHOOL":false}]}}}}}},"post":{"tags":["Professors"],"summary":"Create a professor","description":"Create a new professor.","operationId":"PostV1Professor","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"type":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"iu38rnfs7smdxi","type":"creation"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"professor":{"type":"object","properties":{"FIRSTNAME":{"type":"string","description":"Firstname of the professor"},"LASTNAME":{"type":"string","description":"Lastname of the professor"},"EMAIL":{"type":"string","description":"Email of the professor"},"SPECIALITY":{"type":"string","description":"Speciality of the professor"},"API_ID":{"type":"string","description":"API ID of the professor"},"API_TYPE":{"type":"string","description":"API type of the professor"},"TAGS":{"type":"array","items":{"type":"string"}},"PHONE":{"type":"string","description":"Phone of the professor"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"NAME":{"type":"string","description":"Name of the variable"},"VALUE":{"type":"string","description":"Value of the variable"},"RESSOURCE_TYPE":{"type":"string","description":"Ressource type of the variable"},"SCHOOL_VARIABLE_ID":{"type":"number","description":"School variable ID"}},"required":["NAME","VALUE","RESSOURCE_TYPE","SCHOOL_VARIABLE_ID"]}}},"required":["FIRSTNAME","LASTNAME","EMAIL"]},"dontSendCredentials":{"type":"boolean","description":"If true, the credentials won't be sent to the professor"}},"required":["professor","dontSendCredentials"]},"example":{"professor":{"FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"john@edusign.com","SPECIALITY":"Marketing","API_ID":"f0js9Uj","API_TYPE":"hyperplanning","TAGS":["tag1","tag2","..."],"PHONE":"0123456789","VARIABLES":[{"NAME":"Identifiant","VALUE":"ar82U1kk","RESSOURCE_TYPE":"professor","SCHOOL_VARIABLE_ID":1038}]},"dontSendCredentials":false}}}}}},"/v1/professor/by-email/{email}":{"get":{"tags":["Professors"],"summary":"Get a professor by email","description":"Retrieve a single professor using its email address.","operationId":"GetV1ProfessorByEmailEmail","parameters":[{"in":"path","name":"email","description":"Professor email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"SPECIALITY":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"EMAIL":{"type":"string"},"PASSWORD":{"type":"string"},"PHONE":{"type":"string"},"PIN":{"type":"string"},"OLD_HIDDEN":{"type":"string"},"MAGIC_LINK_TOKEN":{"type":"string"},"LOGIN_CODE":{"type":"array","items":{}},"NEW_PASSWORD_TOKEN":{"type":"string"},"OLD_API_ID":{"type":"string"},"OLD_API_TYPE":{"type":"string"},"ZOOM_ID":{"type":"array","items":{}},"TEAMS_ID":{"type":"array","items":{}},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"string"},"INDEX":{"type":"number"},"PROFESSOR_ID":{"type":"string"},"SCHOOL_ID":{"type":"array","items":{"type":"string"}},"OLD_SCHOOL_ID":{"type":"array","items":{"type":"string"}},"HIDDEN":{"type":"array","items":{}},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"SCHOOL_DATE_CREATED":{"type":"string"},"SCHOOL_DATE_UPDATED":{"type":"string"},"id":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"},"RESSOURCE_TYPE":{"type":"string"},"TYPE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"RESSOURCE_ID":{"type":"string"},"VALUE_ID":{"type":"number"},"SCHOOL_VARIABLE_ID":{"type":"number"},"VALUE":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"8jyj5wg71yp5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","SPECIALITY":"Marketing","TAGS":["Finance","Physiologie"],"DATE_CREATED":"2023-09-05T12:43:18.000Z","DATE_UPDATED":"2024-03-12T14:33:31.000Z","EMAIL":"johndoe@edusign.com","PASSWORD":"","PHONE":"0612345678","PIN":"","OLD_HIDDEN":"null","MAGIC_LINK_TOKEN":"","LOGIN_CODE":[],"NEW_PASSWORD_TOKEN":"","OLD_API_ID":"6123","OLD_API_TYPE":"ammon","ZOOM_ID":[],"TEAMS_ID":[],"MULTI_ACCOUNT_LOGIN_CODE":"","INDEX":180771,"PROFESSOR_ID":"8jyj5wg71yp5fzsu","SCHOOL_ID":["9e2b25c79sa5fzsu"],"OLD_SCHOOL_ID":["9e2b25c79sa5fzsu"],"HIDDEN":[],"API_ID":"f0js9Uj","API_TYPE":"hyperplanning","SCHOOL_DATE_CREATED":"2023-09-05T12:43:18.000Z","SCHOOL_DATE_UPDATED":"2024-03-12T14:33:31.000Z","id":"8jyj5wg71yp5fzsu","VARIABLES":[{"ID":1045,"NAME":"test name","RESSOURCE_TYPE":"professor","TYPE":"text","SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2024-03-25T10:52:18.000Z","DATE_UPDATED":"2024-03-25T10:52:18.000Z","RESSOURCE_ID":"16j37p2t38b5fzsu","VALUE_ID":79378,"SCHOOL_VARIABLE_ID":1045,"VALUE":"test"}]}}}}}}}},"/v1/professor/get-id/{apiId}":{"get":{"tags":["Professors"],"summary":"Get professor ID by API ID","description":"Retrieve a single professor ID using its API ID.","operationId":"GetV1ProfessorGetIdApiid","parameters":[{"in":"path","name":"apiId","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"dzeh832Hjs9kka9"}}}}}}}},"/v1/professor/{professorId}/variables":{"get":{"tags":["Professors"],"summary":"Get a professor's variables","description":"Retrieve an array of variables (or custom fields) linked to a professor.","operationId":"GetV1ProfessorProfessoridVariables","parameters":[{"in":"path","name":"professorId","description":"Professor ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"valueId":{"type":"number"}}}}}}}},"example":{"status":"success","result":{"ID":"mw26lt3s1bf622bj","VARIABLES":[{"id":1,"name":"test name","type":"select","value":"option 1","valueId":1}]}}}}}}},"post":{"tags":["Professors"],"summary":"Create a professor variable","description":"Create a new variable and assign a value for it for a professor.","operationId":"PostV1ProfessorProfessoridVariables","parameters":[{"in":"path","name":"professorId","description":"Professor ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1042}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"name":{"type":"string","description":"name of the variable"},"type":{"type":"string","description":"type of the variable"},"value":{"type":"string","description":"value of the variable for the professor, can be a string of a boolean.
WARNING : the value must be of the same type as the variable type !"},"selectOptions":{"items":{"type":"string","description":"The type \"select\" options.
WARNING : this field is required if the type is \"select\" !"},"type":"array"}},"required":["name","value"]},"example":{"name":"test name","type":"boolean","value":true}}}}}},"/v1/professor/":{"patch":{"tags":["Professors"],"summary":"Update a professor","description":"Update a single professor informations.
WARNING : When updating a professor, every field will be updated, even if you don't provide a value for them.\nFor instance if you are updating a professor email address and your professor has a phone number, if you don't provide again the value of \"phone number\" when updating the professor, the value will be deleted.","operationId":"PatchV1Professor","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"string"}}}}},"example":{"status":"success","result":{"result":"8jyj5wg71yp5fzsu"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"professor":{"type":"object","properties":{"ID":{"type":"string","description":"ID of the professor"},"FIRSTNAME":{"type":"string","description":"Firstname of the professor"},"LASTNAME":{"type":"string","description":"Lastname of the professor"},"EMAIL":{"type":"string","description":"Email of the professor"},"SPECIALITY":{"type":"string","description":"Speciality of the professor"},"API_ID":{"type":"string","description":"API ID of the professor"},"API_TYPE":{"type":"string","description":"API type of the professor"},"TAGS":{"type":"array","items":{"type":"string"}},"PHONE":{"type":"string","description":"Phone of the professor"},"PIN":{"type":"string","description":"Pin of the professor"},"HIDDEN":{"type":"string","description":"Hidden of the professor"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"NAME":{"type":"string","description":"Name of the variable"},"VALUE":{"type":"string","description":"Value of the variable"},"RESSOURCE_TYPE":{"type":"string","description":"Ressource type of the variable"},"SCHOOL_VARIABLE_ID":{"type":"string","description":"ID of the variable"}},"required":["NAME","VALUE","RESSOURCE_TYPE","SCHOOL_VARIABLE_ID"]}}},"required":["ID","FIRSTNAME","LASTNAME","EMAIL"]}},"required":["professor"]},"example":{"professor":{"ID":"567yhgf567","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"johndoe@edusign.com","SPECIALITY":"Marketing","API_ID":"f0js9Uj","API_TYPE":"hyperplanning","TAGS":["Finance","Marketing","Physiologie"],"PHONE":"0123456789","PIN":"1234","HIDDEN":"0","VARIABLES":[{"NAME":"Identifiant","VALUE":"ar82U1kk","RESSOURCE_TYPE":"professor"}]}}}}}}},"/v1/professor/{professorId}/variables/{variableId}":{"patch":{"tags":["Professors"],"summary":"Update a professor variable","description":"Update a professor variable using its variable ID.","operationId":"PatchV1ProfessorProfessoridVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"Variable Id","required":true,"schema":{"type":"string"}},{"in":"path","name":"professorId","description":"Professor Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1042}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value of the variable for the professor, can be either a string or a boolean.
WARNING : The value must be of the same type as the existing variable type."}},"required":["name","value"]},"example":{"name":"test name edited","value":"test edited"}}}}}},"/v1/school":{"get":{"tags":["School"],"summary":"Get a school","description":"Retrieve a list of informations (name, adress, logo, number of signatures, absences types, etc.) regarding a school account on Edusign.","operationId":"GetV1School","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"LOGO":{"type":"string"},"LOGOS":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"filename":{"type":"string"}}}},"STREET_ADDRESS":{"type":"string"},"CITY":{"type":"string"},"POSTALCODE":{"type":"string"},"COUNTRY":{"type":"string"},"PHONE":{"type":"string"},"SIGNATURE_NB":{"type":"number"},"WEBHOOKS":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}}}},"CONNECTOR":{"type":"string"},"ABSENCES_TYPE":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"}}}},"NB_CREDITS_DOCUMENT_LEFT":{"type":"number"},"TIMEZONE":{"type":"string"},"LANGUAGE":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"school.ID","NAME":"My super school","LOGO":"https://","LOGOS":[{"url":"https://","filename":"my_logo.png"}],"STREET_ADDRESS":"1 avenue des champs élysées","CITY":"Paris","POSTALCODE":"75008","COUNTRY":"France","PHONE":"01 00 00 00 00 00","SIGNATURE_NB":1634,"WEBHOOKS":[{"type":"on_student_sign","url":"https://webhook.site/abc"}],"CONNECTOR":"","ABSENCES_TYPE":[{"ID":106,"NAME":"Super motif"}],"NB_CREDITS_DOCUMENT_LEFT":0,"TIMEZONE":"Europe/Paris","LANGUAGE":"fr"}}}}}}},"patch":{"tags":["School"],"summary":"Update a school","description":"Update a single school informations.","operationId":"PatchV1School","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"school":{"type":"object","properties":{"NAME":{"type":"string","description":"School name"},"LOGO":{"type":"string","description":"School logo"},"LOGOS":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"School logo URL"},"filename":{"type":"string","description":"School logo filename"}}}},"STREET_ADDRESS":{"type":"string","description":"School street address"},"CITY":{"type":"string","description":"School city"},"POSTALCODE":{"type":"string","description":"School postal code"},"COUNTRY":{"type":"string","description":"School country"},"PHONE":{"type":"string","description":"School phone"},"WEBHOOKS":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Webhook type"},"url":{"type":"string","description":"Webhook URL"}}}}},"required":["NAME","LOGO","STREET_ADDRESS","CITY","POSTALCODE","COUNTRY","PHONE"]}},"required":["school"]},"example":{"school":{"NAME":"My super school","LOGO":"https://","LOGOS":[{"url":"https://","filename":"my_logo.png"}],"STREET_ADDRESS":"1 avenue des champs élysées","CITY":"Paris","POSTALCODE":"75008","COUNTRY":"France","PHONE":"01 00 00 00 00 00","WEBHOOKS":[{"type":"on_student_sign","url":"https://webhook.site/abc"}]}}}}}}},"/v1/school/daily-courses/{schoolId}":{"get":{"tags":["School"],"summary":"Get a school's daily courses","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all of the courses of a school for the actual day. This endpoint is mainly used to display data on school's screens.
WARNING : This endpoint does not need a token.","operationId":"GetV1SchoolDailyCoursesSchoolid","parameters":[{"in":"path","name":"schoolId","description":"School ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"LOGO":{"type":"string"},"SIGNATURE_NB":{"type":"number"},"ATTENDANCE_SHEET_PAPER_SAVED":{"type":"number"},"DOCUMENT_SHEET_PAPER_SAVED":{"type":"number"},"COURSES":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"PROFESSOR":{"type":"string"},"PROFESSOR_2":{"type":"string"},"CLASSROOM":{"type":"string"},"PROFESSOR_NAME":{"type":"object","properties":{"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"}}}}}}}}}},"example":{"status":"success","result":{"ID":"e84bdh1fae45f","NAME":"EDUSIGN","LOGO":"https://s3-edusign.s3.eu-west-3.amazonaws.com/jmmr8mevk.png","SIGNATURE_NB":593,"ATTENDANCE_SHEET_PAPER_SAVED":0,"DOCUMENT_SHEET_PAPER_SAVED":0,"COURSES":[{"ID":"38iy06v52zi5gde2","NAME":"Course name","START":"2021-09-26T16:00:00.000Z","END":"2021-09-26T18:00:00.000Z","PROFESSOR":"4aae5c7072493","PROFESSOR_2":"","CLASSROOM":"","PROFESSOR_NAME":{"FIRSTNAME":"Elliot","LASTNAME":"Boucher"}}]}}}}}}}},"/v1/student/external-relation/{studentId}/{externalId}":{"delete":{"tags":["Students"],"summary":"Unlink an external contact to a student","description":"Unlink an external contact (such as a tutor) linked to a student. When a student is linked to an external contact, the external contact ID can be retrieved through the student with the \"STUDENT_FOLLOWER_ID\" array.","operationId":"DeleteV1StudentExternalRelationStudentidExternalid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"externalId","description":"External contact ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/student/{studentId}":{"delete":{"tags":["Students"],"summary":"Archive a student","description":"Archive a single student (soft delete).","operationId":"DeleteV1StudentStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Students"],"summary":"Get a student by ID","description":"Retrieve a single student using its student ID.","operationId":"GetV1StudentStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"id":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"USERNAME":{"type":"string"},"EMAIL":{"type":"string"},"FILE_NUMBER":{"type":"string"},"PHOTO":{"type":"string"},"PHONE":{"type":"string"},"GROUPS":{"type":"array","items":{"type":"string"}},"TRAINING_NAME":{"type":"string"},"COMPANY":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"SIGNATURE_ID":{"type":"string"},"HIDDEN":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"BADGE_ID":{"type":"string"},"NEW_PASSWORD_NEEDED":{"type":"boolean"},"LANGUAGE":{"type":"string"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{"type":"string"}},"TRAINING_IDS":{"type":"array","items":{"type":"string"}}}}}},"example":{"status":"success","result":{"ID":"87g1fa3cbsb5fzsu","id":"87g1fa3cbsb5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","USERNAME":"johndoe1","EMAIL":"johndoe@edusign.com","FILE_NUMBER":"4567098547","PHOTO":"https://randomuser.me/api/portraits/men/64.jpg","PHONE":"+33782576803","GROUPS":["fitbhw3hft1vdkc"],"TRAINING_NAME":"Master 1 Digital","COMPANY":"Edusign","TAGS":["Tag 1","Tag 2"],"SIGNATURE_ID":"jiuhygtfgy8765.jpg","HIDDEN":0,"DATE_CREATED":"2020-01-20T15:22:20.000Z","DATE_UPDATED":"2020-01-20T15:22:20.000Z","API_ID":"f0js9Uj","API_TYPE":"hyperplanning","VARIABLES":[{"name":"Identifiant","value":"ar82U1kk"}],"MULTI_ACCOUNT_LOGIN_CODE":0,"SCHOOL_ID":"9e2b25c79sa5fzsu","BADGE_ID":"123456","NEW_PASSWORD_NEEDED":false,"LANGUAGE":"fr","STUDENT_FOLLOWER_ID":["fhygftg27ghju","fjujhu973hgfyhu"],"TRAINING_IDS":["umhy9nz3s11utuy"]}}}}}}}},"/v1/student/variables/{variableId}":{"delete":{"tags":["Students"],"summary":"Delete a student variable","description":"Delete a single variable (or custom field) and the values it contains for each student linked to it. When a student is linked to a variable, the variable ID can be retrieved through the student with the \"VARIABLES\" array.","operationId":"DeleteV1StudentVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"Variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/student":{"get":{"tags":["Students"],"summary":"Get all students","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active students of your school (without the archived students).
WARNING : This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Student","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\"","required":false,"schema":{"type":"string","default":"0"}},{"in":"query","name":"limit","description":"Number of students per page","required":false,"schema":{"type":"string","default":"100"}},{"in":"query","name":"updatedAfter","description":"Filter students updated after this date (ISO format)","required":false,"schema":{"type":"string"}},{"in":"query","name":"search","description":"Search in student's firstname, lastname and email","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"USERNAME":{"type":"string"},"EMAIL":{"type":"string"},"FILE_NUMBER":{"type":"string"},"PASSWORD":{"type":"string"},"COMPANY":{"type":"string"},"PHOTO":{"type":"string"},"PHONE":{"type":"string"},"TRAINING_NAME":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"SIGNATURE_ID":{"type":"string"},"HIDDEN":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"NEW_PASSWORD_TOKEN":{"type":"string"},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"BADGE_ID":{"type":"string"},"PUSH_TOKEN":{"type":"string"},"LANGUAGE":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"NEW_PASSWORD_NEEDED":{"type":"number"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{"type":"string"}},"id":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"8j1c43ww7y3r3is7","FIRSTNAME":"John","LASTNAME":"Doe","USERNAME":"johndoe1","EMAIL":"john.doe@edusign.com","FILE_NUMBER":"4567098547","PASSWORD":"","COMPANY":"edusign","PHOTO":"https://randomuser.me/api/portraits/men/64.jpg","PHONE":"+33782576803","TRAINING_NAME":"Master 1 Digital","TAGS":["Tag 1","Tag 2"],"SIGNATURE_ID":"kiojuhygutfydrfgh7654345678.jpg","HIDDEN":0,"DATE_CREATED":"2020-01-20T15:22:20.000Z","DATE_UPDATED":"2020-01-20T15:22:20.000Z","API_ID":"plwx75oyxl8o1jj","API_TYPE":"hyperplanning","NEW_PASSWORD_TOKEN":"","MULTI_ACCOUNT_LOGIN_CODE":0,"SCHOOL_ID":"9e2b25c79sa5fzsu","BADGE_ID":"","PUSH_TOKEN":"","LANGUAGE":"fr","VARIABLES":[{"name":"Identifiant","value":"ar82U1kk"}],"NEW_PASSWORD_NEEDED":1,"STUDENT_FOLLOWER_ID":["qxjs5qazx4jbm3h","rp32zcyg2mk7boj"],"id":"8j1c43ww7y3r3is7"}]}}}}}},"post":{"tags":["Students"],"summary":"Create a student","description":"Create a new student.","operationId":"PostV1Student","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"type":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"8j1c43ww7y3r3is7","type":"creation"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"student":{"type":"object","properties":{"FIRSTNAME":{"type":"string","description":"Student's first name"},"LASTNAME":{"type":"string","description":"Student's last name"},"EMAIL":{"type":"string","description":"Student's email"},"FILE_NUMBER":{"type":"string"},"PHOTO":{"type":"string","description":"Student's photo"},"PHONE":{"type":"string","description":"Student's phone"},"GROUPS":{"type":"array","items":{"type":"string"}},"TRAINING_NAME":{"type":"string","description":"Student training's name"},"COMPANY":{"type":"string","description":"Student's company"},"TAGS":{"type":"array","items":{"type":"string"}},"SEND_EMAIL_CREDENTIALS":{"type":"boolean","description":"boolean to know if the API sends the credentials to the mail of the student"},"API_ID":{"type":"string","description":"Student's External Id"},"API_TYPE":{"type":"string","description":"name of the connector the student if part of (if he is)"},"BADGE_ID":{"type":"string"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{"type":"string"}},"ISIC_ID":{"type":"string","description":"Student's ISIC ID"},"STUDENT_CARD":{"type":"object","properties":{"BIRTH_DATE":{"type":"string","description":"Student's birth date"},"DIPLOMA":{"type":"string","description":"Student's diploma"},"STUDENT_NATIONAL_ID":{"type":"string","description":"Student's national ID"},"CARD_EXPIRATION_DATE":{"type":"string","description":"Student's card expiration date"},"SCHOOL_YEAR":{"type":"string","description":"Student's school year"}}},"NEW_PASSWORD_NEEDED":{"type":"boolean","description":"Ask the student to change the password on first login (default: true)"},"HIDDEN":{"type":"number","description":"Student's hidden status"}},"required":["FIRSTNAME","LASTNAME","EMAIL"]}},"required":["student"]},"example":{"student":{"FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"john.doe@edusign.com","FILE_NUMBER":"4567098547","PHOTO":"https://randomuser.me/api/portraits/men/64.jpg","PHONE":"+33782576803","GROUPS":["92cwzhknqki49ia5","utcaetznqbi7oi89"],"TRAINING_NAME":"Master 1 Digital","COMPANY":"Edusign","TAGS":["tag 1","tag 2"],"SEND_EMAIL_CREDENTIALS":true,"API_ID":"f0js9Uj","API_TYPE":"hyperplanning","BADGE_ID":"1234567","STUDENT_FOLLOWER_ID":["qxjs5qazx4jbm3h","rp32zcyg2mk7boj"],"ISIC_ID":"S1234567890","STUDENT_CARD":{"BIRTH_DATE":"2000-01-01","DIPLOMA":"Bachelor of Science","STUDENT_NATIONAL_ID":"1234567890","CARD_EXPIRATION_DATE":"2025-01-01","SCHOOL_YEAR":"2024-2025"},"NEW_PASSWORD_NEEDED":true,"HIDDEN":0}}}}}}},"/v1/student/by-email/{email}":{"get":{"tags":["Students"],"summary":"Get a student by email","description":"Retrieve a single student using its email address.","operationId":"GetV1StudentByEmailEmail","parameters":[{"in":"path","name":"email","description":"Student email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"id":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"USERNAME":{"type":"string"},"EMAIL":{"type":"string"},"FILE_NUMBER":{"type":"string"},"PHOTO":{"type":"string"},"PHONE":{"type":"string"},"HIDDEN":{"type":"number"},"GROUPS":{"type":"array","items":{"type":"string"}},"TRAINING_NAME":{"type":"string"},"COMPANY":{"type":"string"},"SIGNATURE_ID":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"BADGE_ID":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"LANGUAGE":{"type":"string"},"NEW_PASSWORD_NEEDED":{"type":"number"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{"type":"string"}},"TRAINING_IDS":{"type":"array","items":{"type":"string"}},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"w027oq2mtq5fzsu","id":"w027oq2mtq5fzsu","FIRSTNAME":"John","LASTNAME":"Doe","USERNAME":"johndoe1","EMAIL":"john.doe@edusign.com","FILE_NUMBER":"4567098547","PHOTO":"https://randomuser.me/api/portraits/men/64.jpg","PHONE":"+33782576803","HIDDEN":0,"GROUPS":["92cwzhknqki49ia5","utcaetznqbi7oi89"],"TRAINING_NAME":"Master 1 Digital","COMPANY":"Edusign","SIGNATURE_ID":"jhgfdxcgvhbjnk9765.jpg","TAGS":["Finance","Physiologie"],"MULTI_ACCOUNT_LOGIN_CODE":0,"SCHOOL_ID":"9e2b25c79sa5fzsu","DATE_CREATED":"2020-01-20T15:22:20.000Z","DATE_UPDATED":"2020-01-20T15:22:20.000Z","BADGE_ID":"","API_ID":"qafettdlpfdjrct","API_TYPE":"hyperplanning","LANGUAGE":"fr","NEW_PASSWORD_NEEDED":1,"STUDENT_FOLLOWER_ID":["fhygftg27ghju","fjujhu973hgfyhu"],"TRAINING_IDS":["umhy9nz3s11utuy"],"VARIABLES":[{"name":"Identifiant","value":"ar82U1kk"}]}}}}}}}},"/v1/student/external-relation/{studentId}":{"get":{"tags":["Students"],"summary":"Get external contacts of a student","description":"Retrieve an array of external contacts (such as a tutor) linked to a student.","operationId":"GetV1StudentExternalRelationStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"STUDENT_ID":{"type":"string"},"EXTERNAL_ID":{"type":"string"},"TYPE":{"type":"number"}}}}}},"example":{"status":"success","result":[{"STUDENT_ID":"8j1c43ww7y3r3is7","EXTERNAL_ID":"dwalri8Dwa","TYPE":0}]}}}}}},"post":{"tags":["Students"],"summary":"Link an external contact to a student","description":"Link a single external contact (such as a tutor) to a student.","operationId":"PostV1StudentExternalRelationStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"EXTERNAL_ID":{"type":"string","description":"External ID of the external (see external section)"},"TYPE":{"type":"number","description":"Type of the relation (0 = Apprenticeship Supervisor, 1 = Tutor, 2 and above = Other)"}},"required":["EXTERNAL_ID","TYPE"]},"example":{"EXTERNAL_ID":"dwalri8Dwa","TYPE":0}}}}}},"/v1/student/get-id/{apiId}":{"get":{"tags":["Students"],"summary":"Get student ID by API ID","description":"Retrieve a single student ID using its API ID.","operationId":"GetV1StudentGetIdApiid","parameters":[{"in":"path","name":"apiId","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"ach981ffk90lsa1"}}}}}}}},"/v1/student/restore/{studentId}":{"get":{"tags":["Students"],"summary":"Restore a student","description":"Restore a single archived student.","operationId":"GetV1StudentRestoreStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/student/{studentId}/variables":{"get":{"tags":["Students"],"summary":"Get a student's variables","description":"Retrieve an array of variables (or custom fields) linked to a student.","operationId":"GetV1StudentStudentidVariables","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"valueId":{"type":"number"}}}}}}}},"example":{"status":"success","result":{"ID":"mw26lt3s1bf622bj","VARIABLES":[{"id":1,"name":"test name","type":"select","value":"option 1","valueId":1}]}}}}}}},"post":{"tags":["Students"],"summary":"Create a student variable","description":"Create a new variable and assign a value for it for a student.","operationId":"PostV1StudentStudentidVariables","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1039}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"Type of the variable","default":"text"},"value":{"type":"string","description":"Value of the variable for the student, can be either a string or a boolean.
WARNING : The value must be of the same type as the variable type."},"Name":{"type":"string","description":"name of the variable"},"selectOptions":{"items":{"type":"string","description":"The values options for the \"select\" type.
WARNING : This field is required if the variable type is \"select\" (max length: 70 characters)"},"type":"array"}},"required":["Name","type","value"]},"example":{"name":"test name","type":"boolean","value":true}}}}}},"/v1/student/":{"patch":{"tags":["Students"],"summary":"Update a student","description":"Update a single student informations.
WARNING : When updating a student, every field will be updated, even if you don't provide a value for them. For instance if you are updating a student email address and your student is registered in several groups, if you don't provide again those \"GROUPS\" when updating the student, they will be deleted.","operationId":"PatchV1Student","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"student":{"type":"object","properties":{"ID":{"type":"string","description":"Student's ID"},"FIRSTNAME":{"type":"string","description":"Student's first name"},"LASTNAME":{"type":"string","description":"Student's last name"},"EMAIL":{"type":"string","description":"Student's email"},"FILE_NUMBER":{"type":"string","description":"Student's file number"},"PHOTO":{"type":"string","description":"Student's photo"},"HIDDEN":{"type":"boolean","description":"Student's hidden status"},"GROUPS":{"type":"array","items":{"type":"string"}},"PHONE":{"type":"string","description":"Student's phone"},"TRAINING_NAME":{"type":"string","description":"Student training's name"},"COMPANY":{"type":"string","description":"Student's company"},"TAGS":{"type":"array","items":{"type":"string"}},"API_ID":{"type":"string","description":"Student's External Id"},"API_TYPE":{"type":"string","description":"name of the connector the student if part of (if he is)"},"BADGE_ID":{"type":"string","description":"Student's Badge Id"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{"type":"string"}},"VARIABLES":{"type":"array","items":{"type":"object","properties":{"OPCO":{"type":"string"}}}}},"required":["ID","FIRSTNAME","LASTNAME"]}},"required":["student"]},"example":{"student":{"ID":"45ygb678h6G6","FIRSTNAME":"John","LASTNAME":"Doe","EMAIL":"john.doe@edusign.com","FILE_NUMBER":"4567098547","PHOTO":"https://randomuser.me/api/portraits/men/64.jpg","HIDDEN":false,"GROUPS":["szfasv3fdboqlz1","unatpyuibhflwjm"],"PHONE":"+33782576803","TRAINING_NAME":"Master 1 Digital","COMPANY":"Edusign","TAGS":["Finance","Physiologie"],"API_ID":"f0js9Uj","API_TYPE":"hyperplanning","BADGE_ID":"123456","STUDENT_FOLLOWER_ID":["qxjs5qazx4jbm3h","rp32zcyg2mk7boj"],"VARIABLES":[{"OPCO":"Central office"}]}}}}}}},"/v1/student/{studentId}/variables/{variableId}":{"patch":{"tags":["Students"],"summary":"Update a student variable","description":"Update a student variable using its variable ID.","operationId":"PatchV1StudentStudentidVariablesVariableid","parameters":[{"in":"path","name":"variableId","description":"variable ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"studentId","description":"student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"boolean"},"variableId":{"type":"number"}}}}},"example":{"status":"success","result":{"result":true,"variableId":1039}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value of the variable for the student, can be either a string or a boolean.
WARNING : The value must be of the same type as the existing variable type (max length: 70 characters)."}},"required":["name","value"]},"example":{"name":"test name edited","value":"test edited"}}}}}},"/v1/student/attendance-report/send":{"post":{"tags":["Students"],"summary":"Send an attendance report","description":"Send the attendance report of an array of students.\n- Need UPDATE right for doing this request\n- The array of students is limited to 10 maximum per call.\n- If the request is too long, the server will send a zip file to the provided email address, therefore the field \"emailForZip\" is required.\n- The student array is limited to 10 students at once","operationId":"PostV1StudentAttendanceReportSend","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"zipUrl":{"type":"string"}}}}},"example":{"status":"success","result":{"zipUrl":"https://edusign-temp-files.s3.eu-west-3.amazonaws.com/archive_1abcdefge12e.zip"}}}}},"202":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"pending"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body:","type":"object","properties":{"dateStart":{"type":"string","description":"Start date of the attendance report at the format YYYY-MM-DD"},"dateEnd":{"type":"string","description":"End date of the attendance report at the format YYYY-MM-DD"},"externalIdToCC":{"type":"string","description":"External ID of the person to send a copy of the attendance report"},"sendToStudent":{"type":"boolean","description":"Send the attendance report to the student"},"studentsIds":{"type":"array","items":{"type":"string"}},"emailForZip":{"type":"string","description":"Email to send the zip file if the request is too long"}},"required":["studentsIds","dateStart","dateEnd","emailForZip"]},"example":{"dateStart":"2024-01-01","dateEnd":"2024-01-30","externalIdToCC":"dwalri8Dwa","sendToStudent":true,"studentsIds":["8j1c43ww7y3r3is7","8j1c43ww7y3r3is7"],"emailForZip":"emailToContact@example.com"}}}}}},"/v1/student/by-ids":{"post":{"tags":["Students"],"summary":"Retrieve students by identifiers","description":"Retrieves a list of students using their Edusign identifiers.","operationId":"PostV1StudentByIds","parameters":[],"responses":{"200":{"description":"Example response:","content":{"application/json":{"schema":{"title":"Example response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"id":{"type":"string"},"EMAIL":{"type":"string"},"FIRSTNAME":{"type":"string"},"LASTNAME":{"type":"string"},"USERNAME":{"type":"string"},"PHOTO":{"type":"string"},"PHONE":{"type":"string"},"TRAINING_NAME":{"type":"string"},"FILE_NUMBER":{"type":"string"},"COMPANY":{"type":"string"},"TAGS":{"type":"array","items":{}},"SIGNATURE_ID":{"type":"string"},"HIDDEN":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"MULTI_ACCOUNT_LOGIN_CODE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"BADGE_ID":{"type":"string"},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"LANGUAGE":{"type":"string"},"NEW_PASSWORD_NEEDED":{"type":"number"},"STUDENT_FOLLOWER_ID":{"type":"array","items":{}},"TRAINING_IDS":{"type":"array","items":{}},"GROUPS":{"type":"array","items":{}},"VARIABLES":{"type":"array","items":{}}}}}}},"example":{"status":"success","result":[{"ID":"abc123def456ghi","id":"abc123def456ghi","EMAIL":"firstname.lastname1@example.com","FIRSTNAME":"Firstname1","LASTNAME":"Lastname1","USERNAME":"flastname1","PHOTO":"","PHONE":"","TRAINING_NAME":"","FILE_NUMBER":"","COMPANY":"","TAGS":[],"SIGNATURE_ID":"","HIDDEN":0,"DATE_CREATED":"2023-01-15T10:30:00.000Z","DATE_UPDATED":"2023-06-20T14:25:30.000Z","MULTI_ACCOUNT_LOGIN_CODE":0,"SCHOOL_ID":"school123456789","BADGE_ID":"","API_ID":"","API_TYPE":"","LANGUAGE":"fr","NEW_PASSWORD_NEEDED":1,"STUDENT_FOLLOWER_ID":[],"TRAINING_IDS":[],"GROUPS":[],"VARIABLES":[]}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Request-Example:","type":"object","properties":{"studentIds":{"type":"array","items":{"type":"string"}}},"required":["studentIds"]},"example":{"studentIds":["abc123def456ghi","jkl789mno012pqr"]}}}}}},"/v1/student/hours-of-presence/{studentId}":{"post":{"tags":["Students"],"summary":"Get a student attendance summary","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Permit to get the number of hours of presence, justified absence and unjustified absences of a student between two dates","operationId":"PostV1StudentHoursOfPresenceStudentid","parameters":[{"in":"path","name":"studentId","description":"Student ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"studentId":{"type":"string"},"justified":{"type":"number"},"present":{"type":"number"},"missing":{"type":"number"},"numberOfCourses":{"type":"number"}}}}},"example":{"status":"success","result":{"studentId":"8j1c43ww7y3r3is7","justified":12.8,"present":110.72,"missing":0,"numberOfCourses":41}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"start":{"type":"string","description":"Start date at the format YYYY-MM-DD HH:mm:ss"},"end":{"type":"string","description":"End date at the format YYYY-MM-DD HH:mm:ss"}},"required":["start","end"]},"example":{"start":"2025-10-24 08:00:000","end":"2025-10-24 20:00:00"}}}}}},"/v1/surveys/{surveyId}":{"delete":{"tags":["Surveys"],"summary":"Delete a survey","description":"Delete a single survey (hard delete).","operationId":"DeleteV1SurveysSurveyid","parameters":[{"in":"path","name":"surveyId","description":"Survey ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Surveys"],"summary":"Get a survey by ID","description":"Retrieve a single survey using its survey ID.","operationId":"GetV1SurveysSurveyid","parameters":[{"in":"path","name":"surveyId","description":"Survey ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"OLD_STUDENT_ANSWERS":{"type":"string"},"RECIPIENT_IDS":{"type":"array","items":{"type":"string"}},"REMINDER_EMAILS_NB_SENT":{"type":"number"},"ANONYMOUS":{"type":"number"},"TYPE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"COURSE_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"AUTOMATIC_SEND_DATE":{"type":"string"},"SURVEY_SENT":{"type":"number"},"RECIPIENT_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"STUDENT_INSCRIPTION_HASH":{"type":"string"},"HIDDEN":{"type":"number"},"MESSAGE":{"type":"string"},"SEND_TO_ABSENTS":{"type":"number"},"TRAINING_ID":{"type":"string"},"TRAINING_SCHEDULE":{"type":"string"},"STUDENT_ANSWERS":{"type":"array","items":{"type":"object","properties":{"answers":{"type":"object","properties":{}},"studentId":{"type":"string"},"recipientType":{"type":"string"},"completionDate":{"type":"string"}}}}}}}},"example":{"status":"success","result":{"ID":"pfgcxl1nkux6sn","NAME":"Mon QCM","TEMPLATE":"","OLD_STUDENT_ANSWERS":"","RECIPIENT_IDS":["5qe9rs5jzfm2tg3","8hlv0k4che8nv5n","023mv17lkj9m3o7b"],"REMINDER_EMAILS_NB_SENT":0,"ANONYMOUS":0,"TYPE":1,"SCHOOL_ID":"vn82hoj9","COURSE_ID":"","TEMPLATE_ID":"dkjaja181Iddk1","AUTOMATIC_SEND_DATE":"2021-02-17T15:19:37.000Z","SURVEY_SENT":1,"RECIPIENT_TYPE":"student","DATE_CREATED":"2021-02-17T14:48:45.000Z","DATE_UPDATED":"2021-02-17T14:48:45.000Z","STUDENT_INSCRIPTION_HASH":"dkjaja181Iddk1","HIDDEN":0,"MESSAGE":"","SEND_TO_ABSENTS":0,"TRAINING_ID":"dkjaja181Iddk1","TRAINING_SCHEDULE":"","STUDENT_ANSWERS":[{"answers":{},"studentId":"5qe9rs5jzfm2tg3","recipientType":"student","completionDate":"2021-02-17T14:48:45.000Z"}]}}}}}}}},"/v1/surveys":{"get":{"tags":["Surveys"],"summary":"Get all surveys","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the surveys of your school.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Surveys","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"logoPosition":{"type":"string"},"pages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"elements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"choices":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"text":{"type":"string"}},"required":["value","text"]}}}}}}}}}},"OLD_STUDENT_ANSWERS":{"type":"string"},"RECIPIENT_IDS":{"type":"array","items":{"type":"string"}},"REMINDER_EMAILS_NB_SENT":{"type":"number"},"ANONYMOUS":{"type":"number"},"TYPE":{"type":"number"},"SCHOOL_ID":{"type":"string"},"COURSE_ID":{"type":"string"},"TEMPLATE_ID":{"type":"string"},"AUTOMATIC_SEND_DATE":{"type":"string"},"SURVEY_SENT":{"type":"number"},"RECIPIENT_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"STUDENT_INSCRIPTION_HASH":{"type":"string"},"HIDDEN":{"type":"number"},"MESSAGE":{"type":"string"},"SEND_TO_ABSENTS":{"type":"number"},"TRAINING_ID":{"type":"string"},"TRAINING_SCHEDULE":{"type":"string"},"STUDENT_ANSWERS":{"type":"array","items":{"type":"object","properties":{"studentId":{"type":"string"},"recipientType":{"type":"string"},"completionDate":{"type":"string"},"answers":{"type":"object","properties":{}}},"required":["studentId","recipientType","completionDate","answers"]}},"REMINDER_EMAILS":{"type":"array","items":{"type":"object","properties":{"nbSent":{"type":"number"},"dateSent":{"type":"string"}}}}}}}}},"example":{"status":"success","result":[{"ID":"prqo3482xqr8md1","NAME":"Sondage interne : Démo Vendredi ou Lundi","TEMPLATE":{"title":"Sondage interne : Démo Vendredi ou Lundi","description":"Sondage rapide pour connaître vos préférences","logoPosition":"right","pages":[{"name":"page1","elements":[{"type":"radiogroup","name":"question1","title":"Préférez vous une démo des nouvelles fonctionnalités Vendredi soir ou Lundi midi ?","choices":[{"value":"item1","text":"Lundi midi"},{"value":"item2","text":"Vendredi soir"}]}]}]},"OLD_STUDENT_ANSWERS":"","RECIPIENT_IDS":["fh34u0vo6oo61u59","aksj6djf911ed","901ml6ddj18","6djaie7jj822","aksj6djj39dja","ja8926ddj18","g8eer5er8grege","5vsf2zf6ze8e","54ze1fzef5e"],"REMINDER_EMAILS_NB_SENT":0,"ANONYMOUS":1,"TYPE":0,"SCHOOL_ID":"ocf6j13hownglt","COURSE_ID":"","TEMPLATE_ID":"00tbuc96rbjnf1us1n","AUTOMATIC_SEND_DATE":"2021-03-20T14:00:00.000Z","SURVEY_SENT":1,"RECIPIENT_TYPE":"external","DATE_CREATED":"2024-04-17T22:22:29.000Z","DATE_UPDATED":"2024-04-17T22:22:29.000Z","STUDENT_INSCRIPTION_HASH":"uzm9l7t7kt8md1","HIDDEN":0,"MESSAGE":"","SEND_TO_ABSENTS":1,"TRAINING_ID":"","TRAINING_SCHEDULE":"","STUDENT_ANSWERS":[{"studentId":"901ml6ddj18","recipientType":"student","completionDate":"","answers":{}},{"studentId":"aksj6djf911ed","recipientType":"student","completionDate":"","answers":{}},{"studentId":"6djaie7jj822","recipientType":"professor","completionDate":"","answers":{}}],"REMINDER_EMAILS":[{"nbSent":1,"dateSent":"2024-04-18 00:25:00.000000"}]}]}}}}}},"post":{"tags":["Surveys"],"summary":"Create a survey","description":"Create a new survey. A survey can be scheduled to be sent using the \"sending_date\" field.\nAt least one of the following arrays must be provided: students, professors, or externals. You don't need to send all three arrays - only include the ones you need. If none of these arrays are provided, the request will return an error.","operationId":"PostV1Surveys","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}},"example":{"status":"success","result":{"id":"aa972jjdz221"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"survey":{"type":"string","description":"Template ID of the survey"},"students":{"type":"array","items":{"type":"string"}},"professors":{"type":"array","items":{"type":"string"}},"externals":{"type":"array","items":{"type":"string"}},"sending_date":{"type":"string","description":"Sending date"},"trainingId":{"type":"string","description":"Training ID"}},"required":["survey","sending_date"]},"example":{"survey":"dkjaja181Iddk1","students":["6dkfds1jj822","aksj6djf911ed","901ml6ddj18"],"professors":["6djaie7jj822","aksj6djj39dja","ja8926ddj18"],"externals":["g8eer5er8grege","5vsf2zf6ze8e","54ze1fzef5e"],"sending_date":"2021-03-20T15:00:00","trainingId":"dkjaja181Iddk1"}}}}}},"/v1/surveys/templates":{"get":{"tags":["Surveys"],"summary":"Get all surveys templates","description":"Retrieve all the surveys templates of your school.","operationId":"GetV1SurveysTemplates","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"TEMPLATE":{"type":"string"},"ANONYMOUS":{"type":"number"},"TYPE":{"type":"number"},"HIDDEN":{"type":"number"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"SCHOOL_ID":{"type":"string"},"SHOW_CORRECT_ANSWERS_ON_PDF":{"type":"number"},"THUMBNAIL":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"pfgcxl1nkux6sn","NAME":"Mon QCM","TEMPLATE":"","ANONYMOUS":0,"TYPE":1,"HIDDEN":0,"DATE_CREATED":"2021-02-17T14:48:45.000Z","DATE_UPDATED":"2021-02-17T14:48:45.000Z","SCHOOL_ID":"vn82hoj9","SHOW_CORRECT_ANSWERS_ON_PDF":0,"THUMBNAIL":"https://edusign-test.s3.eu-west-3.amazonaws.com/Mon_questionnaire_Elliot-Boucher_q8di9lreif15kkv.pdf"}]}}}}}}},"/v1/surveys/generate":{"post":{"tags":["Surveys"],"summary":"Generate a PDF survey","description":"Generate a PDF survey based on the answers of the participants.","operationId":"PostV1SurveysGenerate","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"url":{"type":"string"}}}}},"example":{"status":"success","result":{"url":"https://edusign-test.s3.eu-west-3.amazonaws.com/Mon_questionnaire_Elliot-Boucher_q8di9lreif15kkv.pdf"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"survey":{"type":"string","description":"Survey ID"},"recipient":{"type":"string"},"student":{"type":"string","description":"Student ID"}},"required":["survey","student"]},"example":{"survey":"dkjaja181Iddk1","recipient":"6dkfds1jj822"}}}}}},"/v1/surveys/reminder/{surveyId}":{"post":{"tags":["Surveys"],"summary":"Send a survey completion reminder","description":"Send an email completion reminder to the participants who haven't answered yet.","operationId":"PostV1SurveysReminderSurveyid","parameters":[{"in":"path","name":"surveyId","description":"Survey id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"Successfully sent"}}}}}}},"/v1/trainings/{trainingId}":{"delete":{"tags":["Trainings"],"summary":"Archive a training","description":"Archive a single training (soft delete). It will also archive the courses linked to it.","operationId":"DeleteV1TrainingsTrainingid","parameters":[{"in":"path","name":"trainingId","description":"Training ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Trainings"],"summary":"Get a training","description":"Retrieve a single training using its training ID.","operationId":"GetV1TrainingsTrainingid","parameters":[{"in":"path","name":"trainingId","description":"Training ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"SCHOOL_ID":{"type":"string"},"CREATOR_ID":{"type":"string"},"ARCHIVED":{"type":"number"},"GOALS":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"},"STUDENT_IDS":{"type":"array","items":{"type":"string"}},"PROFESSOR_IDS":{"type":"array","items":{"type":"string"}},"STUDENT_INSCRIPTION_HASH":{"type":"string"},"HAS_UNCOMPLETE_DOCUMENTS":{"type":"boolean"},"REGISTRATION_OPTIONS":{"type":"object","properties":{"pastSheets":{"type":"boolean"},"pastDocuments":{"type":"boolean"},"pastSurveys":{"type":"boolean"},"futureSheets":{"type":"boolean"},"futureDocuments":{"type":"boolean"},"futureSurveys":{"type":"boolean"}}}}}}},"example":{"status":"success","result":{"ID":"awdahjw7wef","NAME":"Math","START":"2022-01-01 10:30","END":"2022-02-31 10:30","SCHOOL_ID":"8fvbgwdawd","CREATOR_ID":"0b8nlkptmn","ARCHIVED":0,"GOALS":"Learn math","TAGS":["math","learn"],"API_ID":"427862","API_TYPE":"mysoftware","DATE_CREATED":"2022-01-01 10:30","DATE_UPDATED":"2022-01-01 10:30","STUDENT_IDS":["mfd893njhksp"],"PROFESSOR_IDS":["nm190dbfdvg"],"STUDENT_INSCRIPTION_HASH":"njaw8adkawmd20kfks","HAS_UNCOMPLETE_DOCUMENTS":false,"REGISTRATION_OPTIONS":{"pastSheets":true,"pastDocuments":true,"pastSurveys":true,"futureSheets":true,"futureDocuments":true,"futureSurveys":true}}}}}}}},"put":{"tags":["Trainings"],"summary":"Update a training","description":"Update a single training informations.","operationId":"PutV1TrainingsTrainingid","parameters":[{"in":"path","name":"trainingId","description":"Training ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"NAME":{"type":"string","description":"Training name"},"START":{"type":"string","description":"Start date of the training (format YYYY-MM-DD, ISO 8601)"},"END":{"type":"string","description":"End date of the training (format YYYY-MM-DD, ISO 8601)"},"GOALS":{"type":"string","description":"Training goals"},"TAGS":{"type":"array","items":{"type":"string"}},"API_ID":{"type":"string","description":"The ID of your API resource representing the training"},"API_TYPE":{"type":"string","description":"The name of your API from where you created the training"},"REGISTRATION_OPTIONS":{"type":"object","properties":{"pastSheets":{"type":"boolean","description":"If you want to add the students to past attendance sheets"},"pastDocuments":{"type":"boolean","description":"If you want to add the students to past documents"},"pastSurveys":{"type":"boolean","description":"If you want to add the students to past surveys"},"futureSheets":{"type":"boolean","description":"If you want to add the students to future attendance sheets"},"futureDocuments":{"type":"boolean","description":"If you want to add the students to future documents"},"futureSurveys":{"type":"boolean","description":"If you want to add the students to future surveys"}}}}},"example":{"NAME":"Math","START":"2022-01-01 10:30","END":"2022-12-31 10:30","GOALS":"Learn math","TAGS":["math","learn"],"API_ID":"427862","API_TYPE":"mysoftware","REGISTRATION_OPTIONS":{"pastSheets":true,"pastDocuments":true,"pastSurveys":true,"futureSheets":true,"futureDocuments":true,"futureSurveys":true}}}}}}},"/v1/trainings/":{"get":{"tags":["Trainings"],"summary":"Get all trainings","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the trainings of your school (non-archived trainings only).
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Trainings","parameters":[{"in":"query","name":"page","description":"Query param for pagination, starts at page \"0\" and displays 50 trainings per page","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","description":"Filter trainings based on their name","required":false,"schema":{"type":"string"}},{"in":"query","name":"date","description":"An array of two dates (start and end) to filter the dates of the training","required":false,"schema":{"type":"string"}},{"in":"query","name":"students","description":"Filter trainings based on an array of students ids enrolled in that training","required":false,"schema":{"type":"string"}},{"in":"query","name":"professors","description":"An array of professors IDs to filter the professors ids of the training","required":false,"schema":{"type":"string"}},{"in":"query","name":"archived","description":"Filters the archived status of the training","required":false,"schema":{"type":"string"}},{"in":"query","name":"creatorId","description":"An array of creator IDs to filter the creator of the training","required":false,"schema":{"type":"string"}},{"in":"query","name":"dateCreated","description":"An array of two dates (start and end) to filter the date created of the training","required":false,"schema":{"type":"string"}},{"in":"query","name":"dateUpdated","description":"An array of two dates (start and end) to filter the date updated of the training","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"START":{"type":"string"},"END":{"type":"string"},"SCHOOL_ID":{"type":"string"},"CREATOR_ID":{"type":"string"},"ARCHIVED":{"type":"boolean"},"GOALS":{"type":"string"},"TAGS":{"type":"array","items":{"type":"string"}},"API_ID":{"type":"string"},"API_TYPE":{"type":"string"},"DATE_CREATED":{"type":"string"},"DATE_UPDATED":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"awdahjw7wef","NAME":"Math","START":"2022-01-01 10:30","END":"2022-02-31 10:30","SCHOOL_ID":"8fvbgwdawd","CREATOR_ID":"0b8nlkptmn","ARCHIVED":false,"GOALS":"Learn math","TAGS":["math","learn"],"API_ID":"427862","API_TYPE":"mysoftware","DATE_CREATED":"2022-01-01 10:30","DATE_UPDATED":"2022-01-01 10:30"}]}}}}}},"post":{"tags":["Trainings"],"summary":"Create a training","description":"Create a new training.","operationId":"PostV1Trainings","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"awdahjw7wef"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"NAME":{"type":"string","description":"Training name"},"START":{"type":"string","description":"Start date of the training"},"END":{"type":"string","description":"End date of the training (format YYYY-MM-DD HH:mm:ss, ISO 8601)"},"GOALS":{"type":"string","description":"Training goals"},"TAGS":{"type":"array","items":{"type":"string"}},"STUDENTS":{"type":"array","items":{"type":"string"}},"API_ID":{"type":"string","description":"The ID of your API resource representing the training"},"API_TYPE":{"type":"string","description":"The name of your API from where you created the training"}},"required":["NAME","START","END"]},"example":{"NAME":"Math","START":"2022-01-01 10:30","END":"2022-12-31 10:30","GOALS":"Learn math","TAGS":["math","learn"],"STUDENTS":["uawd89bawd"],"API_ID":"427862","API_TYPE":"mysoftware"}}}}}},"/v1/trainings/get-id/{apiId}":{"get":{"tags":["Trainings"],"summary":"Get training ID by API ID","description":"Retrieve a single training ID using its API ID.","operationId":"GetV1TrainingsGetIdApiid","parameters":[{"in":"path","name":"apiId","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"ach981ffd90lsa3"}}}}}}}},"/v1/trainings/resources/{trainingId}":{"patch":{"tags":["Trainings"],"summary":"Remove students or professors from a training","description":"Remove students or professors from an existing training. If students are removed from a training, they will be removed from the future resources of the training such as attendance sheets, documents or surveys.","operationId":"PatchV1TrainingsResourcesTrainingid","parameters":[{"in":"path","name":"trainingId","description":"The unique ID of the training","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"successfully removed students or professors from training"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"studentsIds":{"type":"array","items":{"type":"string"}},"professorsIds":{"type":"array","items":{"type":"string"}}}},"example":{"studentsIds":["uawd89bawd"],"professorsIds":["nadwj1mfdm"]}}}}},"post":{"tags":["Trainings"],"summary":"Add students or professors to a training","description":"Add students or professors to an existing training.","operationId":"PostV1TrainingsResourcesTrainingid","parameters":[{"in":"path","name":"trainingId","description":"The unique ID of the training","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"string"}}},"example":{"status":"success","result":"success"}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body-Example:","type":"object","properties":{"studentsIds":{"type":"array","items":{"type":"string"}},"professorsIds":{"type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"pastSheets":{"type":"boolean","description":"If you want to add the students to past attendance sheets"},"pastDocuments":{"type":"boolean","description":"If you want to add the students to past documents"},"pastSurveys":{"type":"boolean","description":"If you want to add the students to past surveys"},"futureSheets":{"type":"boolean","description":"If you want to add the students to future attendance sheets"},"futureDocuments":{"type":"boolean","description":"If you want to add the students to future documents"},"futureSurveys":{"type":"boolean","description":"If you want to add the students to future surveys"}}}}},"example":{"studentsIds":["uawd89bawd"],"professorsIds":["nadwj1mfdm"],"options":{"pastSheets":true,"pastDocuments":true,"pastSurveys":true,"futureSheets":true,"futureDocuments":true,"futureSurveys":true}}}}}}},"/v1/trainings/unarchive/{trainingId}":{"patch":{"tags":["Trainings"],"summary":"Restore a training","description":"Restore a single archived training.","operationId":"PatchV1TrainingsUnarchiveTrainingid","parameters":[{"in":"path","name":"trainingId","description":"Training ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}}},"/v1/users/{userId}":{"delete":{"tags":["Users"],"summary":"Delete a user","description":"Delete a user of Edusign's school platform (hard delete).","operationId":"DeleteV1UsersUserid","parameters":[{"in":"path","name":"userId","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}}},"get":{"tags":["Users"],"summary":"Get a user","description":"Get an admin user by its ID.","operationId":"GetV1UsersUserid","parameters":[{"in":"path","name":"userId","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"},"EMAIL":{"type":"string"},"NAME":{"type":"string"},"PHONE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"MULTI_ACCOUNTS":{"type":"string"},"PERMISSIONS":{"type":"number"},"DATE_CREATED":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"akff92zsaafi","EMAIL":"kurt@edusign.com","NAME":"Kurt Cobain","PHONE":"+33 6 01 01 01 01","SCHOOL_ID":"argvh221y","MULTI_ACCOUNTS":"[]","PERMISSIONS":4,"DATE_CREATED":"2020-12-15T14:23:57.000Z"}}}}}}}},"/v1/users":{"get":{"tags":["Users"],"summary":"Get all users","description":"![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the users of the Edusign's school platform.
WARNING This is an heavy request, please use this endpoint only when needed.","operationId":"GetV1Users","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string"},"EMAIL":{"type":"string"},"NAME":{"type":"string"},"PHONE":{"type":"string"},"SCHOOL_ID":{"type":"string"},"MULTI_ACCOUNTS":{"type":"string"},"PERMISSIONS":{"type":"number"},"DATE_CREATED":{"type":"string"}}}}}},"example":{"status":"success","result":[{"ID":"akff92zsaafi","EMAIL":"kurt@edusign.com","NAME":"Kurt Cobain","PHONE":"+33 6 01 01 01 01","SCHOOL_ID":"argvh221y","MULTI_ACCOUNTS":"[]","PERMISSIONS":4,"DATE_CREATED":"2020-12-15T14:23:57.000Z"}]}}}}}},"post":{"tags":["Users"],"summary":"Create a user","description":"Add a new admin user to Edusign. The user will receive an email to set-up its password. Various access levels can be given to a user with permissions.","operationId":"PostV1Users","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"object","properties":{"ID":{"type":"string"}}}}},"example":{"status":"success","result":{"ID":"aa972jjdz221"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"CREATOR_NAME":{"type":"string","description":"Name of the user who creates the account"},"NAME":{"type":"string","description":"Name of the user"},"EMAIL":{"type":"string","description":"Email of the user"},"PHONE":{"type":"string","description":"Phone number of the user"},"PERMISSIONS":{"type":"number","description":"Permissions level of the user (0: user, 1: admin, 4: collaborator)"}},"required":["CREATOR_NAME","NAME","EMAIL","PHONE","PERMISSIONS"]},"example":{"CREATOR_NAME":"John Doe","NAME":"Kurt Cobain","EMAIL":"kurt@edusign.com","PHONE":"+33 6 12 34 56 78","PERMISSIONS":2}}}}}},"/v1/users/change-permissions":{"post":{"tags":["Users"],"summary":"Update a user permission level","description":"Update a user permission level, available values are : \n
- \"0\" : Analyst\n
- \"1\" : User\n
- \"4\" : Admin\n
- \"5\" : Owner","operationId":"PostV1UsersChangePermissions","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"boolean"}}},"example":{"status":"success","result":true}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"USER_ID":{"type":"string","description":"User ID"},"PERMISSIONS":{"type":"number","description":"Permissions level of the user (0: user, 1: admin, 4: collaborator)"}},"required":["USER_ID","PERMISSIONS"]},"example":{"USER_ID":"azhfn822nddk","PERMISSIONS":2}}}}}},"/v2/utils/adobe-inputs":{"post":{"tags":["Utils"],"summary":"Get inputs from an Adobe document","description":"Retrieve the x/y position of a signature field in an Adobe document. Retrieving a signature position allows you to replace it easily in a document with signature generated within Edusign.","operationId":"GetAdobeInputs","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"object","properties":{"page":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}}},"required":["name","position"]}}}},"example":{"status":"success","result":[{"name":"STUDENT SIGNATURE","position":{"page":2,"x":46.97433248592353,"y":842.9312550843242,"width":150,"height":60}},{"name":"PROFESSOR SIGNATURE","position":{"page":2,"x":266.4184111998925,"y":842.9312550843242,"width":150,"height":60}}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"base64":{"type":"string","description":"The base64 string of the document excluding the prefix \"data:application/pdf;base64,\"","default":"Base64 format"}},"required":["base64"]},"example":{"base64":"JVBERi0xLjQKJe..."}}}}}},"/v2/utils/adobe-inputs-all":{"post":{"tags":["Utils"],"summary":"Get all input types from an Adobe document","description":"Retrieve the x/y position of all form fields in an Adobe document with optional filtering by field type. This endpoint supports all PDF form field types including text fields, checkboxes, signatures, radio groups, dropdowns, and option lists.","operationId":"GetAdobeInputsAll","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"object","properties":{"page":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"type":{"type":"string"},"label":{"type":"string"}},"required":["name","position","type"]}}}},"example":{"status":"success","result":[{"name":"RESP_SECTEUR*1","position":{"page":3,"x":57.5,"y":656.4007,"width":8,"height":8},"type":"CHECKBOX_TO_FILL","label":"Case à cocher"},{"name":"STUDENT_NAME","position":{"page":1,"x":100,"y":200,"width":200,"height":25},"type":"INPUT_TO_FILL"},{"name":"STUDENT SIGNATURE","position":{"page":2,"x":46.97433248592353,"y":842.9312550843242,"width":150,"height":60},"type":"SIGNATURE"}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"base64":{"type":"string","description":"The base64 string of the document excluding the prefix \"data:application/pdf;base64,\"","default":"Base64 format"},"includeTextField":{"type":"boolean","description":"Include text fields in the response","default":"true"},"includeCheckbox":{"type":"boolean","description":"Include checkboxes in the response","default":"true"},"includeSignature":{"type":"boolean","description":"Include signature fields in the response","default":"true"},"includeRadioGroup":{"type":"boolean","description":"Include radio groups in the response","default":"true"},"includeDropdown":{"type":"boolean","description":"Include dropdowns in the response","default":"true"},"includeOptionList":{"type":"boolean","description":"Include option lists in the response","default":"true"}},"required":["base64"]},"example":{"base64":"JVBERi0xLjQKJe...","includeTextField":true,"includeCheckbox":true,"includeSignature":false}}}}}},"/v2/utils/text-inputs":{"post":{"tags":["Utils"],"summary":"Get inputs from a text document","description":"Retrieve the x/y position of a field between brackets in a text document. For instance the [SIGNATURE_ADMIN] field. Retrieving a signature position allows you to replace it easily in a document with signature generated within Edusign.","operationId":"GetTextInputs","parameters":[],"responses":{"200":{"description":"Success-Response:","content":{"application/json":{"schema":{"title":"Success-Response:","type":"object","properties":{"status":{"type":"string"},"result":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"object","properties":{"page":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}}}}}}},"example":{"status":"success","result":[{"name":"[SIGNATURE]","position":{"page":1,"x":75.82783405388062,"y":204.93840754738238,"width":74.66015343916014,"height":11.9999995}}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"title":"Body","type":"object","properties":{"base64":{"type":"string","description":"The base64 string of the document excluding the prefix \"data:application/pdf;base64,\"","default":"Base64 format"}},"required":["base64"]},"example":{"base64":"JVBERi0xLjQKJe..."}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[{"bearerAuth":[]}],"servers":[{"url":"https://ext.edusign.fr"}]} ```
V3 ``` {"openapi":"3.1.0","info":{"title":"EduSign API","version":"3.1.0","description":"API for EduSign platform - Version 3","contact":{"name":"EduSign Support","email":"support@edusign.com","url":"https://edusign.com/support"},"termsOfService":"https://edusign.com/terms"},"tags":[{"name":"Courses","description":"Operations for managing courses (sessions, classes)"},{"name":"Trainings","description":"Operations for managing trainings (programs, curricula)"},{"name":"Students","description":"Operations for managing students"},{"name":"Assessments","description":"Operations for managing assessments (exams, quizzes)"},{"name":"Assessment Submissions","description":"Operations for managing assessment submissions and grades"},{"name":"Professors","description":"Operations for managing professors (teachers, instructors)"},{"name":"Surveys","description":"Operations for managing surveys and feedback"},{"name":"Absences","description":"Operations for managing absences and attendance records"},{"name":"Schools","description":"Operations for managing school information"},{"name":"Subjects","description":"Operations for managing subjects (disciplines, modules)"},{"name":"Groups","description":"Operations for managing student groups"}],"servers":[{"url":"api.edusign.com/v3"}],"security":[{"bearerAuth":[]}],"paths":{"/courses":{"post":{"summary":"Create a new course","description":"Create a single course session and add provided professors to it. At least one professor is required.","tags":["Courses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the course session. 255 characters maximum"},"startDateTime":{"type":"string","description":"Start date and time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)"},"endDateTime":{"type":"string","description":"End date and time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)"},"professorIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string","description":"A description of the course session. 2000 characters maximum"},"classroomId":{"type":"string","description":"ID of the classroom"},"classroomExternalReferenceId":{"type":"string","description":"External reference ID of the classroom (from partner ERP)"},"maxStudents":{"type":"number","description":"Maximum number of students allowed. Omit for no limit"},"needStudentsSignature":{"type":"boolean","description":"Require student signatures. Defaults to school setting"},"externalReferenceId":{"type":"string","description":"Your system unique identifier for this record"},"externalReferenceType":{"type":"string","description":"Name of the third-party system that owns this record ID"},"groupIds":{"type":"array","items":{"type":"string"},"description":"List of Group IDs to fetch students from"},"studentIds":{"type":"array","items":{"type":"string"},"description":"List of explicit Student IDs to enroll"}},"required":["name","startDateTime","endDateTime","professorIds"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"professorsEnrolledCount":{"type":"number"},"studentsEnrolledCount":{"type":"number"},"externalReferenceId":{"type":"string","description":"Present when the course was created with an external reference ID"}},"required":["id","professorsEnrolledCount","studentsEnrolledCount"],"additionalProperties":false},"meta":{"type":"object","properties":{"createdAt":{"type":"string"}},"required":["createdAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"get":{"summary":"Get all courses with filters","description":"Retrieve all the courses of your school (both archived and not archived courses).","tags":["Courses"],"parameters":[{"in":"query","name":"courseStartDateTime","required":false,"schema":{"type":"string","description":"Filter courses based on the course start date (format YYYY-MM-DDTHH:mm:ssZ, ISO 8601)\n\n\n If courseEndDateTime is provided, the results is searched in between the two dates\n\n\n If courseEndDateTime is not provided, the results is searched in between the courseStartDateTime and 6 months after\n\n\n Please note: the date is in UTC time"},"description":"Filter courses based on the course start date (format YYYY-MM-DDTHH:mm:ssZ, ISO 8601)\n\n\n If courseEndDateTime is provided, the results is searched in between the two dates\n\n\n If courseEndDateTime is not provided, the results is searched in between the courseStartDateTime and 6 months after\n\n\n Please note: the date is in UTC time"},{"in":"query","name":"courseEndDateTime","required":false,"schema":{"type":"string","description":"Filter courses based on the course end date (format YYYY-MM-DDTHH:mm:ssZ, ISO 8601)\n\n\n If courseStartDateTime is provided, the results is searched in between the two dates\n\n\n If courseStartDateTime is not provided, the results is searched in between the courseEndDateTime and 6 months before\n\n\n Please note: the date is in UTC time"},"description":"Filter courses based on the course end date (format YYYY-MM-DDTHH:mm:ssZ, ISO 8601)\n\n\n If courseStartDateTime is provided, the results is searched in between the two dates\n\n\n If courseStartDateTime is not provided, the results is searched in between the courseEndDateTime and 6 months before\n\n\n Please note: the date is in UTC time"},{"in":"query","name":"isArchived","required":false,"schema":{"type":"boolean","description":"Filter to retrieve all archived courses"},"description":"Filter to retrieve all archived courses"},{"in":"query","name":"absencesSent","required":false,"schema":{"type":"boolean","description":"Filter to retrieve all courses where absences have been sent"},"description":"Filter to retrieve all courses where absences have been sent"},{"in":"query","name":"absencesNotSent","required":false,"schema":{"type":"boolean","description":"Filter to retrieve all courses where absences have not been sent"},"description":"Filter to retrieve all courses where absences have not been sent"},{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"groupId","required":false,"schema":{"type":"string","description":"Filter courses based on an array of groupIds to retrieve courses for specific groups. Multiple groupIds can be provided, separated by commas (e.g., ?groupId=123,456,789)"},"description":"Filter courses based on an array of groupIds to retrieve courses for specific groups. Multiple groupIds can be provided, separated by commas (e.g., ?groupId=123,456,789)"},{"in":"query","name":"studentId","required":false,"schema":{"type":"string","description":"Filter courses based on an array of studentIds to retrieve courses for specific students. Multiple studentIds can be provided, separated by commas (e.g., ?studentId=123,456,789)"},"description":"Filter courses based on an array of studentIds to retrieve courses for specific students. Multiple studentIds can be provided, separated by commas (e.g., ?studentId=123,456,789)"},{"in":"query","name":"professorId","required":false,"schema":{"type":"string","description":"Filter courses based on an array of professorIds to retrieve courses for specific professors. Multiple professorIds can be provided, separated by commas (e.g., ?professorId=123,456,789)"},"description":"Filter courses based on an array of professorIds to retrieve courses for specific professors. Multiple professorIds can be provided, separated by commas (e.g., ?professorId=123,456,789)"},{"in":"query","name":"trainingId","required":false,"schema":{"type":"string","description":"Filter courses based on an array of trainingIds. Multiple trainingIds can be provided, separated by commas (e.g., ?trainingId=training123,training456)"},"description":"Filter courses based on an array of trainingIds. Multiple trainingIds can be provided, separated by commas (e.g., ?trainingId=training123,training456)"},{"in":"query","name":"classroom","required":false,"schema":{"type":"string","description":"Filter courses based on the classroom"},"description":"Filter courses based on the classroom"},{"in":"query","name":"creatorId","required":false,"schema":{"type":"string","description":"Filter courses based on creatorId to retrieve courses for specific creatorId"},"description":"Filter courses based on creatorId to retrieve courses for specific creatorId"},{"in":"query","name":"courseName","required":false,"schema":{"type":"string","description":"Filter courses based on courseName to retrieve courses for specific courseName"},"description":"Filter courses based on courseName to retrieve courses for specific courseName"},{"in":"query","name":"dateCreated","required":false,"schema":{"type":"string","description":"Filter courses based on an array of two dates (start and end) (e.g., ?dateCreated=2024-08-01,2024-08-02)"},"description":"Filter courses based on an array of two dates (start and end) (e.g., ?dateCreated=2024-08-01,2024-08-02)"},{"in":"query","name":"dateUpdated","required":false,"schema":{"type":"string","description":"Filter courses based on an array of two dates (start and end) (e.g., ?dateUpdated=2024-08-01,2024-08-02)"},"description":"Filter courses based on an array of two dates (start and end) (e.g., ?dateUpdated=2024-08-01,2024-08-02)"},{"in":"query","name":"professorSignature","required":false,"schema":{"type":"boolean","description":"Filter courses based on professor's signature (true or false)"},"description":"Filter courses based on professor's signature (true or false)"},{"in":"query","name":"includeStudents","required":false,"schema":{"type":"boolean","default":false},"description":"Include students in the response"},{"in":"query","name":"includeTeachers","required":false,"schema":{"type":"boolean","default":false},"description":"Include teachers in the response"},{"in":"query","name":"includeSurveyTemplates","required":false,"schema":{"type":"boolean","default":false},"description":"Include survey templates in the response"},{"in":"query","name":"includeTraining","required":false,"schema":{"type":"boolean","default":false},"description":"Include training data in the response"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the course"},"schoolId":{"type":"string"},"creatorId":{"type":"string"},"schoolGroupIds":{"type":"array","items":{"type":"string"},"nullable":true},"apiId":{"type":"string"},"apiType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"classroom":{"type":"string"},"teacherComment":{"type":"string"},"adminComment":{"type":"string","nullable":true},"maxStudents":{"type":"number"},"studentEmailReminderDate":{"type":"string"},"isSignatureRequired":{"type":"boolean"},"isArchived":{"type":"boolean"},"archivingId":{"type":"string"},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"isPresent":{"type":"boolean"},"comment":{"type":"string"},"signatureDateTime":{"type":"string","nullable":true},"justifiedAbsenceId":{"type":"string","nullable":true},"earlyDepartureDate":{"type":"string","nullable":true},"delayDuration":{"type":"number"},"exclusionDate":{"type":"string","nullable":true},"signatureImageUrl":{"type":"string","nullable":true},"signatureEmailSent":{"type":"object","properties":{"signUntilDateTime":{"type":"string"},"sendEmailDateTime":{"type":"string"},"isAutomaticReminderSent":{"type":"boolean"},"nbSent":{"type":"number"}},"required":["nbSent"],"additionalProperties":false,"nullable":true}},"required":["id","name","email","isPresent","delayDuration"],"additionalProperties":false}},"teachers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signatureImageUrl":{"type":"string","nullable":true},"signatureDateTime":{"type":"string","nullable":true},"order":{"type":"number"},"emailHistory":{"type":"object","properties":{"send":{"type":"number"},"date":{"type":"string"}},"required":["send","date"],"additionalProperties":false},"signatureType":{"type":"string","nullable":true}},"required":["id","order","signatureType"],"additionalProperties":false}},"surveyTemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"recipientType":{"type":"string"},"hidden":{"type":"boolean"}},"required":["id","name","recipientType","hidden"],"additionalProperties":false}},"training":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"trainingInscriptionOptions":{"type":"object","properties":{"past":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"future":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"pastRessources":{"type":"boolean"},"futureResources":{"type":"boolean"}},"required":["past","future","pastRessources","futureResources"],"additionalProperties":false,"nullable":true}},"required":["id","name"],"additionalProperties":false},"scannedAttendanceList":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","schoolId","name","startDateTime","endDateTime","isArchived","createdAt","updatedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/courses/{id}":{"get":{"summary":"Get a course by ID","description":"Retrieve a single course using its course ID.","tags":["Courses"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The Course ID"},"description":"The Course ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"schoolId":{"type":"string"},"schoolGroupIds":{"type":"array","items":{"type":"string"},"nullable":true},"name":{"type":"string"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"description":{"type":"string"},"classroom":{"type":"string"},"teachers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signatureImageUrl":{"type":"string","nullable":true},"signatureDateTime":{"type":"string","nullable":true},"order":{"type":"number"},"emailHistory":{"type":"object","properties":{"send":{"type":"number"},"date":{"type":"string"}},"required":["send","date"],"additionalProperties":false},"signatureType":{"type":"string","nullable":true}},"required":["id","order","signatureType"],"additionalProperties":false}},"creatorId":{"type":"string"},"maxStudents":{"type":"number"},"surveyTemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"recipientType":{"type":"string"},"hidden":{"type":"boolean"}},"required":["id","name","recipientType","hidden"],"additionalProperties":false}},"readerId":{"type":"string"},"teacherComment":{"type":"string"},"adminComment":{"type":"string","nullable":true},"attendanceListGenerated":{"type":"string"},"attendanceListGeneratedNoLogo":{"type":"string"},"professorSignature":{"type":"string"},"professorSignature2":{"type":"string"},"simpleSignature":{"type":"boolean"},"simpleSignaturePin":{"type":"string"},"emailSignatureStudents":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"},"archivingId":{"type":"string"},"metadataArchivingId":{"type":"string"},"archivingCertificateUrl":{"type":"string"},"scannedAttendanceList":{"type":"boolean"},"attendanceEnded":{"type":"boolean"},"apiId":{"type":"string"},"apiType":{"type":"string"},"teacherSurvey":{"type":"string","nullable":true},"studentInscriptionHash":{"type":"string","nullable":true},"studentInscriptionSign":{"type":"number"},"zoom":{"type":"string"},"zoomMeetingId":{"type":"string","nullable":true},"absencesSent":{"type":"boolean"},"teams":{"type":"number"},"teamsJson":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"order":{"type":"number"},"students":{"type":"array","items":{"type":"string"}}},"required":["id","name","color","order","students"],"additionalProperties":false},"emailsAdded":{"type":"number"},"stateUpdate":{"type":"boolean"},"inscriptionForms":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false},"studentEmailReminder":{"type":"string","nullable":true},"isSignatureRequired":{"type":"boolean","nullable":true},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"isPresent":{"type":"boolean"},"comment":{"type":"string"},"signatureDateTime":{"type":"string","nullable":true},"justifiedAbsenceId":{"type":"string","nullable":true},"earlyDepartureDate":{"type":"string","nullable":true},"delayDuration":{"type":"number"},"exclusionDate":{"type":"string","nullable":true},"signatureImageUrl":{"type":"string","nullable":true},"signatureEmailSent":{"type":"object","properties":{"signUntilDateTime":{"type":"string"},"sendEmailDateTime":{"type":"string"},"isAutomaticReminderSent":{"type":"boolean"},"nbSent":{"type":"number"}},"required":["nbSent"],"additionalProperties":false,"nullable":true}},"required":["id","name","email","isPresent","delayDuration"],"additionalProperties":false}},"training":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"trainingInscriptionOptions":{"type":"object","properties":{"past":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"future":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"pastRessources":{"type":"boolean"},"futureResources":{"type":"boolean"}},"required":["past","future","pastRessources","futureResources"],"additionalProperties":false,"nullable":true}},"required":["id","name"],"additionalProperties":false}},"required":["id","schoolId","name","startDateTime","endDateTime","createdAt","updatedAt"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/courses/batch-upsert":{"post":{"summary":"Batch create or update courses","description":"Upsert up to 1000 courses in a single request. Returns 200 when all items succeed, 207 for partial success with per-item failures.\n\n**Resolution logic:**\n- `courseId` provided → strict update by Edusign ID\n- `externalReferenceId` provided → create-or-update: lookup by external ID within school scope; create if not found\n- Neither provided → create (all mandatory fields required)\n\n**XOR rules (mutually exclusive):**\n- `courseId` / `externalReferenceId` — provide one or neither\n- `professorIds` / `professorExternalReferenceIds` — provide exactly one\n- `classroomId` / `classroomExternalReferenceId` — provide one or neither\n\n**Required fields for creation:** `name`, `startDateTime`, `endDateTime`, and one of `professorIds` or `professorExternalReferenceIds`.\n\n**Per-item error codes:** `VALIDATION_ERROR`, `AMBIGUOUS_COURSE_IDENTIFIER`, `DUPLICATE_IN_REQUEST`, `COURSE_NOT_FOUND`, `ARCHIVED_COURSE_EXISTS`, `REQUIRED_FIELD_MISSING`, `INVALID_DATE_RANGE`, `AMBIGUOUS_PROFESSOR_IDENTIFIER`, `PROFESSORS_NOT_FOUND`, `ARCHIVED_PROFESSOR_EXISTS`, `AMBIGUOUS_CLASSROOM_IDENTIFIER`, `CLASSROOM_NOT_FOUND`, `CREATE_FAILED`, `UPDATE_FAILED`.\n\n**Rate limit:** HEAVY. **Idempotency:** 5s deduplication window.","tags":["Courses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"courses":{"type":"array","items":{"type":"object","properties":{"courseId":{"type":"string","description":"Unique ID of the course generated by Edusign (strict update)"},"externalReferenceId":{"type":"string","description":"External system identifier — used for create-or-update matching"},"externalReferenceType":{"type":"string","description":"Name of the third-party system that owns this record ID"},"name":{"type":"string","description":"Name of the course"},"startDateTime":{"type":"string","description":"Start date and time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)"},"endDateTime":{"type":"string","description":"End date and time in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)"},"professorIds":{"type":"array","items":{"type":"string"},"description":"List of Edusign professor IDs assigned to the course"},"professorExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"List of external professor IDs assigned to the course"},"description":{"type":"string","nullable":true,"description":"A description of the course session — null to clear"},"trainingId":{"type":"string","nullable":true,"description":"Internal ID of the training — null to unlink"},"trainingExternalReferenceId":{"type":"string","nullable":true,"description":"External reference ID (API_ID) of the training — null to unlink"},"classroomId":{"type":"string","nullable":true,"description":"Internal ID of the classroom — null to unlink"},"classroomExternalReferenceId":{"type":"string","nullable":true,"description":"External ID of the classroom — null to unlink"},"maxStudents":{"type":"number","description":"Maximum number of students allowed"},"needStudentsSignature":{"type":"boolean","description":"Require student signatures"}},"additionalProperties":false}}},"required":["courses"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the course in the request courses array"},"id":{"type":"string","description":"Edusign internal course ID"},"type":{"type":"string","description":"Whether the course was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"updatedFields":{"type":"array","items":{"type":"string"},"description":"Fields that were updated (only for type \"updated\")"},"professorsEnrolledCount":{"type":"number","description":"Number of professors assigned (only for type \"created\")"},"studentsEnrolledCount":{"type":"number","description":"Number of students enrolled (only for type \"created\")"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request courses array"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total courses in the request"},"createdCount":{"type":"number","description":"Number of courses created"},"updatedCount":{"type":"number","description":"Number of courses updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"207":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the course in the request courses array"},"id":{"type":"string","description":"Edusign internal course ID"},"type":{"type":"string","description":"Whether the course was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"updatedFields":{"type":"array","items":{"type":"string"},"description":"Fields that were updated (only for type \"updated\")"},"professorsEnrolledCount":{"type":"number","description":"Number of professors assigned (only for type \"created\")"},"studentsEnrolledCount":{"type":"number","description":"Number of students enrolled (only for type \"created\")"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request courses array"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total courses in the request"},"createdCount":{"type":"number","description":"Number of courses created"},"updatedCount":{"type":"number","description":"Number of courses updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/courses/{id}/students":{"put":{"summary":"Assign students to a course","description":"Assign students and/or groups to a single course. Uses replace semantics: provided student/group lists replace existing enrollments. Omitted fields remain unchanged.\n\n**XOR rules:**\n- `studentIds` XOR `studentExternalReferenceIds` (optional)\n- `groupIds` XOR `groupExternalReferenceIds` (optional)\n- At least one of students or groups must be provided\n\n**Error codes:** `AMBIGUOUS_STUDENT_IDENTIFIER`, `AMBIGUOUS_GROUP_IDENTIFIER`, `MISSING_ENROLLMENT_DATA`, `COURSE_NOT_FOUND`, `ARCHIVED_COURSE_EXISTS`, `STUDENTS_NOT_FOUND`, `ARCHIVED_STUDENT_EXISTS`, `GROUPS_NOT_FOUND`, `ARCHIVED_GROUP_EXISTS`, `MAX_STUDENTS_EXCEEDED`.\n\n**Rate limit:** HEAVY. **Idempotency:** 5s deduplication window.","tags":["Courses"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The Course ID"},"description":"The Course ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studentIds":{"type":"array","items":{"type":"string"},"description":"Array of internal Edusign student IDs"},"studentExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"Array of external reference IDs for students"},"groupIds":{"type":"array","items":{"type":"string"},"description":"Array of internal Edusign group IDs"},"groupExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"Array of external reference IDs for groups"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"courseId":{"type":"string","description":"Resolved internal course ID"},"externalReferenceId":{"type":"string","description":"External reference ID of the course if set"},"studentsAddedCount":{"type":"number","description":"Number of students newly enrolled"},"studentsRemovedCount":{"type":"number","description":"Number of students removed"},"studentsUnchangedCount":{"type":"number","description":"Number of students already enrolled and unchanged"},"studentsEnrolledCount":{"type":"number","description":"Total number of students enrolled in the course after the operation"},"processedAt":{"type":"string","description":"ISO timestamp when the operation was processed"}},"required":["courseId","studentsAddedCount","studentsRemovedCount","studentsUnchangedCount","studentsEnrolledCount","processedAt"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/courses/by-reference-id/{externalReferenceId}/students":{"put":{"summary":"Assign students to a course by external reference ID","description":"Assign students and/or groups to a single course, identified by its external reference ID. Uses replace semantics: provided student/group lists replace existing enrollments. Omitted fields remain unchanged.\n\n**XOR rules:**\n- `studentIds` XOR `studentExternalReferenceIds` (optional)\n- `groupIds` XOR `groupExternalReferenceIds` (optional)\n- At least one of students or groups must be provided\n\n**Error codes:** `AMBIGUOUS_STUDENT_IDENTIFIER`, `AMBIGUOUS_GROUP_IDENTIFIER`, `MISSING_ENROLLMENT_DATA`, `COURSE_NOT_FOUND`, `ARCHIVED_COURSE_EXISTS`, `STUDENTS_NOT_FOUND`, `ARCHIVED_STUDENT_EXISTS`, `GROUPS_NOT_FOUND`, `ARCHIVED_GROUP_EXISTS`, `MAX_STUDENTS_EXCEEDED`.\n\n**Rate limit:** HEAVY. **Idempotency:** 5s deduplication window.","tags":["Courses"],"parameters":[{"in":"path","name":"externalReferenceId","required":true,"schema":{"type":"string","description":"The external reference ID of the course"},"description":"The external reference ID of the course"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studentIds":{"type":"array","items":{"type":"string"},"description":"Array of internal Edusign student IDs"},"studentExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"Array of external reference IDs for students"},"groupIds":{"type":"array","items":{"type":"string"},"description":"Array of internal Edusign group IDs"},"groupExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"Array of external reference IDs for groups"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"courseId":{"type":"string","description":"Resolved internal course ID"},"externalReferenceId":{"type":"string","description":"External reference ID of the course if set"},"studentsAddedCount":{"type":"number","description":"Number of students newly enrolled"},"studentsRemovedCount":{"type":"number","description":"Number of students removed"},"studentsUnchangedCount":{"type":"number","description":"Number of students already enrolled and unchanged"},"studentsEnrolledCount":{"type":"number","description":"Total number of students enrolled in the course after the operation"},"processedAt":{"type":"string","description":"ISO timestamp when the operation was processed"}},"required":["courseId","studentsAddedCount","studentsRemovedCount","studentsUnchangedCount","studentsEnrolledCount","processedAt"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/courses/{id}/teachers":{"delete":{"summary":"Delete teachers from a course","description":"Delete teachers from a course using its course ID.","tags":["Courses"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The Course ID"},"description":"The Course ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"teacherIds":{"type":"array","items":{"type":"string"}}},"required":["teacherIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"deletedCount":{"type":"number"},"message":{"type":"string"}},"required":["success","deletedCount","message"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/trainings":{"get":{"summary":"Get all trainings with optional filters","description":"Get all trainings with optional filters","tags":["Trainings"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"trainingName","required":false,"schema":{"type":"string"}},{"in":"query","name":"trainingStartDate","required":false,"schema":{"type":"string"}},{"in":"query","name":"trainingEndDate","required":false,"schema":{"type":"string"}},{"in":"query","name":"isArchived","required":false,"schema":{"type":"string"}},{"in":"query","name":"creatorId","required":false,"schema":{"type":"string"}},{"in":"query","name":"courseId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tags","required":false,"schema":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},{"in":"query","name":"apiId","required":false,"schema":{"type":"string"}},{"in":"query","name":"apiType","required":false,"schema":{"type":"string"}},{"in":"query","name":"includeStudents","required":false,"schema":{"type":"string"}},{"in":"query","name":"includeProfessors","required":false,"schema":{"type":"string"}},{"in":"query","name":"includeInscriptionOptions","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"startDate":{"oneOf":[{"type":"string"},{"type":"string"}]},"endDate":{"oneOf":[{"type":"string"},{"type":"string"}]},"creatorId":{"type":"string"},"isArchived":{"type":"boolean"},"goals":{"type":"string"},"tags":{"type":"array","items":{"type":"string"},"nullable":true},"dateCreated":{"oneOf":[{"type":"string"},{"type":"string"}]},"dateUpdated":{"oneOf":[{"type":"string"},{"type":"string"}]},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"professors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"inscriptionOptions":{"type":"object","properties":{"forms":{"type":"string","nullable":true},"options":{"type":"object","properties":{"past":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"future":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"pastRessources":{"type":"boolean"},"futureResources":{"type":"boolean"}},"additionalProperties":false,"nullable":true},"requireApproval":{"type":"boolean"},"maxStudents":{"type":"number"},"waitingList":{"type":"boolean"},"openUntil":{"type":"string"},"notifyAdmin":{"type":"boolean"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"options":{"type":"array","items":{"type":"string"}}},"required":["id","label","type","required"],"additionalProperties":false}}},"required":["options"],"additionalProperties":false,"nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","name","startDate","endDate","creatorId","isArchived","goals","tags","dateCreated","dateUpdated","apiId","apiType"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/trainings/{trainingId}/courses/{courseId}":{"post":{"summary":"Add a course to a training program","description":"Link an existing course to a training program. If the course dates fall outside the training date range, training dates are automatically extended.","tags":["Trainings"],"parameters":[{"in":"path","name":"trainingId","required":true,"schema":{"type":"string"}},{"in":"path","name":"courseId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"courseId":{"type":"string"},"trainingId":{"type":"string"}},"required":["courseId","trainingId"],"additionalProperties":false},"meta":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/trainings/{id}":{"get":{"summary":"Get a training by ID","description":"Retrieve a single training using its training ID.","tags":["Trainings"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"startDate":{"oneOf":[{"type":"string"},{"type":"string"}]},"endDate":{"oneOf":[{"type":"string"},{"type":"string"}]},"creatorId":{"type":"string"},"isArchived":{"type":"boolean"},"goals":{"type":"string"},"tags":{"type":"array","items":{"type":"string"},"nullable":true},"dateCreated":{"oneOf":[{"type":"string"},{"type":"string"}]},"dateUpdated":{"oneOf":[{"type":"string"},{"type":"string"}]},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"professors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"inscriptionOptions":{"type":"object","properties":{"forms":{"type":"string","nullable":true},"options":{"type":"object","properties":{"past":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"future":{"type":"object","properties":{"sheets":{"type":"boolean"},"surveys":{"type":"boolean"},"documents":{"type":"boolean"}},"required":["sheets","surveys","documents"],"additionalProperties":false},"pastRessources":{"type":"boolean"},"futureResources":{"type":"boolean"}},"additionalProperties":false,"nullable":true},"requireApproval":{"type":"boolean"},"maxStudents":{"type":"number"},"waitingList":{"type":"boolean"},"openUntil":{"type":"string"},"notifyAdmin":{"type":"boolean"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"options":{"type":"array","items":{"type":"string"}}},"required":["id","label","type","required"],"additionalProperties":false}}},"required":["options"],"additionalProperties":false,"nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","name","startDate","endDate","creatorId","isArchived","goals","tags","dateCreated","dateUpdated","apiId","apiType"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/students":{"post":{"summary":"Create a new student","description":"Create a single student.","tags":["Students"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string","description":"Student phone number. Max 20 characters."},"photoUrl":{"type":"string","description":"URL or path to student photo. Max 255 characters."},"fileNumber":{"type":"string","description":"Student file number or reference. Max 128 characters."},"curriculumName":{"type":"string","description":"Name of the curriculum program. Max 160 characters."},"company":{"type":"string","description":"Company associated with the student. Max 64 characters."},"tags":{"type":"array","items":{"type":"string"},"description":"Custom tags. Max 15 tags, each max 35 characters."},"externalReferenceId":{"type":"string","description":"Unique external reference. New version of apiId. Max 64 characters."},"externalReferenceType":{"type":"string","description":"External reference type. Used to identify the external system that created the student. Used by Edusign connectors Max 30 characters. (e.g. Ypareo, Hyperplanning...)"},"badgeId":{"type":"string","description":"ID of the student badge. Max 20 characters."},"newPasswordNeeded":{"type":"boolean","description":"Whether the student needs to set a new password"},"sendCredentials":{"type":"boolean","default":false,"description":"Whether to send login credentials email to the student. If true, email is required."}},"required":["firstName","lastName"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"apiId":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"createdAt":{"type":"string"}},"required":["createdAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}},"get":{"summary":"Get all students with pagination and filters","description":"Get all students with pagination and filters","tags":["Students"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"includeVariables","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"includeGroups","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"includeTrainings","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"includeStudentFollower","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"includeOptions","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"includeStudentCardInfo","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"schoolId":{"type":"string"},"photo":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"badgeId":{"type":"string","nullable":true},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true}},"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"trainingIds":{"type":"array","items":{"type":"string"}},"studentFollowerId":{"type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"identificationNumber":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"curriculumName":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"external":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"data":{"type":"string"}},"required":["id","type"],"additionalProperties":false}},"card":{"type":"object","properties":{"studentNationalId":{"type":"string","description":"Student national ID"},"schoolYear":{"type":"string","description":"Academic year (YYYY-YYYY)"},"diploma":{"type":"string","description":"Diploma information"},"birthDate":{"type":"string","description":"Birth date (YYYY-MM-DD)"},"expirationDate":{"type":"string","description":"Expiration date (YYYY-MM-DD)"},"photoUrl":{"type":"string","description":"Photo URL"},"partnerIdentifier":{"type":"string","description":"ISIC card ID"},"isExpired":{"type":"boolean","description":"Whether the card is expired"}},"required":["isExpired"],"additionalProperties":false}},"required":["id","firstName","lastName","username","schoolId","isArchived","createdAt","updatedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/students/cards:bulkUpsert":{"post":{"summary":"Bulk upsert student cards","description":"Create or update, 1000 max at once, student cards in a single operation. Supports both Student card Partner identifier only and full card information.","tags":["Students"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"studentId":{"type":"string","description":"Internal student ID or External API student ID for lookup"},"partnerIdentifier":{"type":"string","description":"Student card partner identifier"},"studentNationalId":{"type":"string","description":"Student national identifier"},"schoolYear":{"type":"string","description":"Academic year in YYYY-YYYY format (e.g., \"2026-2027\")"},"birthDate":{"type":"string","description":"Birth date in YYYY-MM-DD format"},"diploma":{"type":"string","description":"Diploma or degree information"},"expirationDate":{"type":"string","description":"Card expiration date in YYYY-MM-DD format"},"photoUrl":{"type":"string","description":"HTTPS URL to student photo (will be downloaded, validated, and stored)"}},"required":["studentId"],"additionalProperties":false}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Overall operation success status"},"processed":{"type":"number","description":"Number of student cards processed"},"updated":{"type":"number","description":"Number of student cards updated"},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"Index of the card in the request array"},"studentId":{"type":"string","description":"Student ID if identifiable"},"error":{"type":"string","description":"Description of the error"},"code":{"type":"string","description":"Error code for programmatic handling"}},"required":["index","error","code"],"additionalProperties":false}},"warnings":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"Index of the card in the request array"},"studentId":{"type":"string","description":"Student ID"},"field":{"type":"string","description":"Field that caused the warning"},"message":{"type":"string","description":"Warning message"},"code":{"type":"string","description":"Warning code for programmatic handling"}},"required":["index","field","message","code"],"additionalProperties":false},"description":"Array of non-blocking warnings (e.g., photo processing failures)"},"summary":{"type":"object","properties":{"total":{"type":"number","description":"Total number of cards processed"},"successful":{"type":"number","description":"Number of successful operations"},"failed":{"type":"number","description":"Number of failed operations"}},"required":["total","successful","failed"],"additionalProperties":false}},"required":["success","processed","updated","errors","summary"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/students/{id}":{"get":{"summary":"Get a student by ID","description":"Get a student by ID","tags":["Students"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The student ID"},"description":"The student ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"schoolId":{"type":"string"},"photo":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"badgeId":{"type":"string","nullable":true},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true}},"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"trainingIds":{"type":"array","items":{"type":"string"}},"studentFollowerId":{"type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"identificationNumber":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"curriculumName":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"external":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"data":{"type":"string"}},"required":["id","type"],"additionalProperties":false}},"card":{"type":"object","properties":{"studentNationalId":{"type":"string","description":"Student national ID"},"schoolYear":{"type":"string","description":"Academic year (YYYY-YYYY)"},"diploma":{"type":"string","description":"Diploma information"},"birthDate":{"type":"string","description":"Birth date (YYYY-MM-DD)"},"expirationDate":{"type":"string","description":"Expiration date (YYYY-MM-DD)"},"photoUrl":{"type":"string","description":"Photo URL"},"partnerIdentifier":{"type":"string","description":"ISIC card ID"},"isExpired":{"type":"boolean","description":"Whether the card is expired"}},"required":["isExpired"],"additionalProperties":false}},"required":["id","firstName","lastName","username","schoolId","isArchived","createdAt","updatedAt","variables","trainingIds","studentFollowerId","options","external"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/students:search":{"post":{"summary":"Search for a student by email or API ID","description":"Search for a student by email or API ID","tags":["Students"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"apiId":{"type":"string"},"username":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"schoolId":{"type":"string"},"photo":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"badgeId":{"type":"string","nullable":true},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true}},"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"trainingIds":{"type":"array","items":{"type":"string"}},"studentFollowerId":{"type":"array","items":{"type":"string"}},"options":{"type":"object","properties":{"identificationNumber":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"curriculumName":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"external":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"data":{"type":"string"}},"required":["id","type"],"additionalProperties":false}},"card":{"type":"object","properties":{"studentNationalId":{"type":"string","description":"Student national ID"},"schoolYear":{"type":"string","description":"Academic year (YYYY-YYYY)"},"diploma":{"type":"string","description":"Diploma information"},"birthDate":{"type":"string","description":"Birth date (YYYY-MM-DD)"},"expirationDate":{"type":"string","description":"Expiration date (YYYY-MM-DD)"},"photoUrl":{"type":"string","description":"Photo URL"},"partnerIdentifier":{"type":"string","description":"ISIC card ID"},"isExpired":{"type":"boolean","description":"Whether the card is expired"}},"required":["isExpired"],"additionalProperties":false}},"required":["id","firstName","lastName","username","schoolId","isArchived","createdAt","updatedAt","variables","trainingIds","studentFollowerId","options","external"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/students/batch-upsert":{"post":{"summary":"Batch create or update students","description":"Create or update multiple students in a single request with partial success support. Uses externalReferenceId as the unique match key. Min 1, max 1000 students per request.","tags":["Students"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"students":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name. Min 1, max 100 characters."},"lastName":{"type":"string","description":"Last name. Min 1, max 100 characters."},"email":{"type":"string","nullable":true,"description":"Student email address."},"externalReferenceId":{"type":"string","description":"Unique external reference for matching. New version of apiId. Max 64 characters."},"externalReferenceType":{"type":"string","nullable":true,"description":"External reference type (e.g. connector name). Max 64 characters."},"phone":{"type":"string","nullable":true,"description":"Phone number. Max 20 characters."},"photoUrl":{"type":"string","nullable":true,"description":"URL to student photo. Max 255 characters."},"fileNumber":{"type":"string","nullable":true,"description":"File number or reference. Max 128 characters."},"curriculumName":{"type":"string","nullable":true,"description":"Curriculum program name. Max 160 characters."},"company":{"type":"string","nullable":true,"description":"Company. Max 64 characters."},"badgeId":{"type":"string","nullable":true,"description":"Badge ID assigned to the student. Max 20 characters."},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Custom tags. Max 15 tags, each max 35 characters."}},"additionalProperties":false}},"options":{"type":"object","properties":{"allowUnarchive":{"type":"boolean","default":false,"description":"Whether to automatically unarchive archived students instead of rejecting them"},"onStudentCreated":{"type":"object","properties":{"sendCredentials":{"type":"boolean","default":false,"description":"Whether to send login credentials to newly created students"},"newPasswordNeeded":{"type":"boolean","default":false,"description":"Whether newly created students need to set a new password"}},"additionalProperties":false}},"additionalProperties":false,"description":"Options applied when creating new students."}},"required":["students"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the student in the request students array"},"id":{"type":"string","description":"EduSign internal student ID"},"type":{"type":"string","description":"Whether the student was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided. New version of the legacy field apiId"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request students array"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"fields":{"type":"array","items":{"type":"string"},"description":"Fields that caused the error"}},"required":["code","message"],"additionalProperties":false},"externalReferenceId":{"type":"string","description":"External reference ID if provided"}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total students in the request"},"createdCount":{"type":"number","description":"Number of students created"},"updatedCount":{"type":"number","description":"Number of students updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"207":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the student in the request students array"},"id":{"type":"string","description":"EduSign internal student ID"},"type":{"type":"string","description":"Whether the student was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided. New version of the legacy field apiId"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request students array"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"fields":{"type":"array","items":{"type":"string"},"description":"Fields that caused the error"}},"required":["code","message"],"additionalProperties":false},"externalReferenceId":{"type":"string","description":"External reference ID if provided"}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total students in the request"},"createdCount":{"type":"number","description":"Number of students created"},"updatedCount":{"type":"number","description":"Number of students updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the student in the request students array"},"id":{"type":"string","description":"EduSign internal student ID"},"type":{"type":"string","description":"Whether the student was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided. New version of the legacy field apiId"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request students array"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"fields":{"type":"array","items":{"type":"string"},"description":"Fields that caused the error"}},"required":["code","message"],"additionalProperties":false},"externalReferenceId":{"type":"string","description":"External reference ID if provided"}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total students in the request"},"createdCount":{"type":"number","description":"Number of students created"},"updatedCount":{"type":"number","description":"Number of students updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/assessments":{"get":{"summary":"List assessments","description":"Retrieve a paginated list of assessments with optional filtering","tags":["Assessments"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"subjectId","required":false,"schema":{"type":"string"}},{"in":"query","name":"startDateTime","required":false,"schema":{"type":"string"}},{"in":"query","name":"endDateTime","required":false,"schema":{"type":"string"}},{"in":"query","name":"apiId","required":false,"schema":{"type":"string"}},{"in":"query","name":"apiType","required":false,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"required":["id","maxScore","weight","startDateTime","endDateTime","schoolId"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"post":{"summary":"Create assessment","description":"Create a new assessment","tags":["Assessments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"required":["maxScore","weight","startDateTime","endDateTime"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"required":["id","maxScore","weight","startDateTime","endDateTime","schoolId"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessments/{id}":{"get":{"summary":"Get assessment by ID","description":"Retrieve a single assessment by its unique identifier","tags":["Assessments"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"required":["id","maxScore","weight","startDateTime","endDateTime","schoolId"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"put":{"summary":"Update assessment","description":"Update an existing assessment","tags":["Assessments"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"maxScore":{"type":"number"},"weight":{"type":"number"},"startDateTime":{"type":"string"},"endDateTime":{"type":"string"},"name":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"subjectId":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"required":["id","maxScore","weight","startDateTime","endDateTime","schoolId"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete assessment","description":"Delete an assessment by its unique identifier","tags":["Assessments"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions":{"get":{"summary":"List assessment submissions","description":"Retrieve a paginated list of assessment submissions with optional filtering by status, student, assessment, dates, etc.","tags":["Assessment Submissions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"post":{"summary":"Create assessment submission","description":"Create a new assessment submission (usually starts as todo)","tags":["Assessment Submissions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studentId":{"type":"string"},"assessmentId":{"type":"string"},"submissionStatus":{"type":"string","default":"todo"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean","default":false},"attemptNumber":{"type":"number","default":1},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean","default":false},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["studentId","assessmentId"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions/{id}":{"get":{"summary":"Get assessment submission by ID","description":"Retrieve a single assessment submission by its unique identifier","tags":["Assessment Submissions"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"put":{"summary":"Update assessment submission","description":"Update an existing assessment submission. Final submissions cannot be modified.","tags":["Assessment Submissions"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete assessment submission","description":"Delete an assessment submission. Final submissions cannot be deleted.","tags":["Assessment Submissions"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions/student/{studentId}":{"get":{"summary":"Get assessment submissions by student","description":"Retrieve all assessment submissions for a specific student","tags":["Assessment Submissions"],"parameters":[{"in":"path","name":"studentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions/assessment/{assessmentId}":{"get":{"summary":"Get assessment submissions by assessment","description":"Retrieve all submissions for a specific assessment","tags":["Assessment Submissions"],"parameters":[{"in":"path","name":"assessmentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions/{id}/submit":{"post":{"summary":"Submit assessment submission","description":"Submit a todo assessment submission. Changes status from todo to done.","tags":["Assessment Submissions","Actions"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"submittedAt":{"type":"string"},"isLate":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/assessment-submissions/{id}/grade":{"post":{"summary":"Grade assessment submission","description":"Grade an assessment submission with score and feedback. Changes status to GRADED.","tags":["Assessment Submissions","Actions"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"gradedBy":{"type":"string"},"isGradeFinal":{"type":"boolean","default":false}},"required":["score","gradedBy"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"studentId":{"type":"string"},"assessmentId":{"type":"string"},"schoolId":{"type":"string"},"submissionStatus":{"type":"string"},"submittedAt":{"type":"string","nullable":true},"isLate":{"type":"boolean"},"attemptNumber":{"type":"number"},"score":{"type":"number","nullable":true},"feedback":{"type":"string","nullable":true},"isGradeFinal":{"type":"boolean"},"gradedAt":{"type":"string","nullable":true},"gradedBy":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["id","studentId","assessmentId","schoolId","submissionStatus","isLate","attemptNumber","isGradeFinal"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/professors":{"post":{"summary":"Create a professor","description":"Create a new professor in the system.","tags":["Professors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string","description":"Professor phone number"},"speciality":{"type":"string","description":"Professor speciality"},"tags":{"type":"array","items":{"type":"string"},"description":"Your custom tags associated with the professor. Maximum 15 tags, each up to 35 characters."},"externalReferenceId":{"type":"string","description":"Your system's unique identifier for this specific record."},"externalReferenceType":{"type":"string","description":"The name of the third-party system that owns this record's original ID"},"sendCredentials":{"type":"boolean","default":false}},"required":["firstName","lastName","email"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"type":{"type":"string","enum":["created"]},"createdAt":{"type":"string"}},"required":["type","createdAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"get":{"summary":"Get all professors","description":"Retrieve all professors from the system.","tags":["Professors"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"search","required":false,"schema":{"type":"string","description":"Search in professor name and email"},"description":"Search in professor name and email"},{"in":"query","name":"professorFirstname","required":false,"schema":{"type":"string","description":"Filter by professor first name"},"description":"Filter by professor first name"},{"in":"query","name":"professorLastname","required":false,"schema":{"type":"string","description":"Filter by professor last name"},"description":"Filter by professor last name"},{"in":"query","name":"professorEmail","required":false,"schema":{"type":"string","description":"Filter by professor email"},"description":"Filter by professor email"},{"in":"query","name":"professorSpeciality","required":false,"schema":{"type":"string","description":"Filter by professor speciality"},"description":"Filter by professor speciality"},{"in":"query","name":"speciality","required":false,"schema":{"type":"string","description":"Filter by professor speciality"},"description":"Filter by professor speciality"},{"in":"query","name":"tags","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Filter by professor tags (array or comma-separated string)"},"description":"Filter by professor tags (array or comma-separated string)"},{"in":"query","name":"dateCreated","required":false,"schema":{"type":"string","description":"Filter by creation date (YYYY-MM-DD format)"},"description":"Filter by creation date (YYYY-MM-DD format)"},{"in":"query","name":"dateUpdated","required":false,"schema":{"type":"string","description":"Filter by update date (YYYY-MM-DD format)"},"description":"Filter by update date (YYYY-MM-DD format)"},{"in":"query","name":"isArchived","required":false,"schema":{"type":"boolean","description":"Filter to retrieve only archived or non-archived professors"},"description":"Filter to retrieve only archived or non-archived professors"},{"in":"query","name":"creatorId","required":false,"schema":{"type":"string","description":"Filter by creator ID"},"description":"Filter by creator ID"},{"in":"query","name":"includeSchool","required":false,"schema":{"type":"boolean","default":false,"description":"Include school information in the response"},"description":"Include school information in the response"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"speciality":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"apiId":{"type":"string"},"apiType":{"type":"string"},"phone":{"type":"string"},"pin":{"type":"string"},"zoom_id":{"type":"array","items":{"type":"string"}},"teams_id":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"}},"required":["id","firstName","lastName","email","speciality","tags","createdAt","updatedAt","apiId","apiType","phone","pin","zoom_id","teams_id","isArchived"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/professors/{id}":{"get":{"summary":"Get a professor by ID","description":"Retrieve a professor by their ID.","tags":["Professors"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The professor ID"},"description":"The professor ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"speciality":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"apiId":{"type":"string"},"apiType":{"type":"string"},"phone":{"type":"string"},"pin":{"type":"string"},"zoom_id":{"type":"array","items":{"type":"string"}},"teams_id":{"type":"array","items":{"type":"string"}},"isArchived":{"type":"boolean"}},"required":["id","firstName","lastName","email","speciality","tags","createdAt","updatedAt","apiId","apiType","phone","pin","zoom_id","teams_id","isArchived"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"patch":{"summary":"Update a professor","description":"Partial update of professor information. Only provided fields are modified.","tags":["Professors"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The professor ID"},"description":"The professor ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"Professor first name"},"lastName":{"type":"string","description":"Professor last name"},"email":{"type":"string","description":"Professor email address"},"phone":{"type":"string","nullable":true,"description":"Professor phone number"},"speciality":{"type":"string","nullable":true,"description":"Professor speciality"},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Your custom tags associated with the professor. Maximum 15 tags, each up to 35 characters."},"externalReferenceId":{"type":"string","nullable":true,"description":"External system unique identifier for this professor"},"externalReferenceType":{"type":"string","nullable":true,"description":"Name of the external system that owns this ID"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"type":{"type":"string","enum":["updated"]},"updatedAt":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}},"required":["type","updatedAt","updatedFields"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/professors/by-reference-id/{externalReferenceId}":{"patch":{"summary":"Update a professor by external reference ID","description":"Partial update of professor information by external reference ID. Only provided fields are modified.","tags":["Professors"],"parameters":[{"in":"path","name":"externalReferenceId","required":true,"schema":{"type":"string","description":"The external reference ID"},"description":"The external reference ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"Professor first name"},"lastName":{"type":"string","description":"Professor last name"},"email":{"type":"string","description":"Professor email address"},"phone":{"type":"string","nullable":true,"description":"Professor phone number"},"speciality":{"type":"string","nullable":true,"description":"Professor speciality"},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Your custom tags associated with the professor. Maximum 15 tags, each up to 35 characters."},"externalReferenceId":{"type":"string","nullable":true,"description":"External system unique identifier for this professor"},"externalReferenceType":{"type":"string","nullable":true,"description":"Name of the external system that owns this ID"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"type":{"type":"string","enum":["updated"]},"updatedAt":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}},"required":["type","updatedAt","updatedFields"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/professors/batch-upsert":{"post":{"summary":"Bulk upsert professors","description":"Upsert up to 1000 professors in a single request. Matches by externalReferenceId, or professorId or email within school scope. Returns 200 for all success, 207 for partial success with failures.","tags":["Professors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"professors":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the professor (required for creation)"},"lastName":{"type":"string","description":"Last name of the professor (required for creation)"},"email":{"type":"string","description":"The professor's contact email address"},"professorId":{"type":"string","description":"Unique professor ID generated by Edusign - match key for update"},"externalReferenceId":{"type":"string","description":"Your system's unique identifier for this specific record - used as unique match key for upsert"},"externalReferenceType":{"type":"string","description":"The name of the third-party system that owns this record's original ID"},"speciality":{"type":"string","nullable":true,"description":"Professor speciality or department."},"phone":{"type":"string","nullable":true,"description":"Phone number"},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Tags for categorization"}},"additionalProperties":false}},"options":{"type":"object","properties":{"onProfessorCreated":{"type":"object","properties":{"sendCredentials":{"type":"boolean","default":false,"description":"Send registration email with login credentials"},"newPasswordNeeded":{"type":"boolean","default":false,"description":"Whether newly created professors need to set a new password on first login"}},"additionalProperties":false}},"additionalProperties":false}},"required":["professors"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number"},"id":{"type":"string"},"type":{"type":"string"},"externalReferenceId":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number"},"externalReferenceId":{"type":"string"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number"},"createdCount":{"type":"number"},"updatedCount":{"type":"number"},"failureCount":{"type":"number"},"processedAt":{"type":"string"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"207":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number"},"id":{"type":"string"},"type":{"type":"string"},"externalReferenceId":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number"},"externalReferenceId":{"type":"string"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number"},"createdCount":{"type":"number"},"updatedCount":{"type":"number"},"failureCount":{"type":"number"},"processedAt":{"type":"string"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/surveys":{"get":{"summary":"Get surveys based on filter criterias","description":"Get surveys based on filter criterias","tags":["Surveys"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"search","required":false,"schema":{"type":"string","description":"Search in survey name and description"},"description":"Search in survey name and description"},{"in":"query","name":"type","required":false,"schema":{"type":"number","description":"Filter by survey type"},"description":"Filter by survey type"},{"in":"query","name":"status","required":false,"schema":{"type":"string","description":"Filter by survey status"},"description":"Filter by survey status"},{"in":"query","name":"startDate","required":false,"schema":{"type":"string","description":"Filter surveys starting from this date (ISO format)"},"description":"Filter surveys starting from this date (ISO format)"},{"in":"query","name":"endDate","required":false,"schema":{"type":"string","description":"Filter surveys ending before this date (ISO format)"},"description":"Filter surveys ending before this date (ISO format)"},{"in":"query","name":"trainingId","required":false,"schema":{"type":"string","description":"Filter by training ID"},"description":"Filter by training ID"},{"in":"query","name":"includeSurveyAnswers","required":false,"schema":{"type":"boolean","description":"Include survey answers"},"description":"Include survey answers"},{"in":"query","name":"includeTraining","required":false,"schema":{"type":"boolean","description":"Include training"},"description":"Include training"},{"in":"query","name":"includeCourse","required":false,"schema":{"type":"boolean","description":"Include course"},"description":"Include course"},{"in":"query","name":"includeTemplate","required":false,"schema":{"type":"boolean","description":"Include template"},"description":"Include template"},{"in":"query","name":"filterAnonymous","required":false,"schema":{"type":"boolean","description":"Filter anonymous surveys"},"description":"Filter anonymous surveys"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"type":{"type":"string"},"scheduledSendDate":{"type":"string"},"isSent":{"type":"boolean"},"surveyTemplate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isArchived":{"type":"boolean"}},"required":["id","name","isArchived"],"additionalProperties":false,"nullable":true},"recipientIds":{"type":"array","items":{"type":"string"}},"reminderEmailsNbSent":{"type":"number"},"isAnonymous":{"type":"boolean"},"isArchived":{"type":"boolean"},"filterSendToAbsents":{"type":"boolean"},"trainingId":{"type":"string","nullable":true},"trainingSchedule":{"type":"string","nullable":true},"studentAnswers":{"type":"array","items":{"type":"string"}},"courseId":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"courseName":{"type":"string","nullable":true},"course":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"training":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","type","createdAt","updatedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/surveys/{id}":{"get":{"summary":"Get a survey by ID","description":"Retrieve a single survey using its survey ID.","tags":["Surveys"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The survey ID"},"description":"The survey ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"type":{"type":"string"},"scheduledSendDate":{"type":"string"},"isSent":{"type":"boolean"},"surveyTemplate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isArchived":{"type":"boolean"}},"required":["id","name","isArchived"],"additionalProperties":false,"nullable":true},"recipientIds":{"type":"array","items":{"type":"string"}},"reminderEmailsNbSent":{"type":"number"},"isAnonymous":{"type":"boolean"},"isArchived":{"type":"boolean"},"filterSendToAbsents":{"type":"boolean"},"trainingId":{"type":"string","nullable":true},"trainingSchedule":{"type":"string","nullable":true},"studentAnswers":{"type":"array","items":{"type":"string"}},"courseId":{"type":"string","nullable":true},"template":{"type":"string","nullable":true},"courseName":{"type":"string","nullable":true},"course":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"training":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","type","isSent","surveyTemplate","isAnonymous","isArchived","filterSendToAbsents","course","training","createdAt","updatedAt"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/justified-absences":{"get":{"summary":"Get all justified absences","description":"\n Retrieves a list of justified absences with optional filtering parameters:\n - Filter by date range (start and end)\n - Filter by creation date\n - Filter by absence reason\n - Filter by course ID\n - Filter by student ID\n \n Results are paginated with 100 justified absences per page by default.\n ","tags":["Absences"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"start","required":false,"schema":{"type":"string","description":"Start date for filtering absences (YYYY-MM-DD)"},"description":"Start date for filtering absences (YYYY-MM-DD)"},{"in":"query","name":"end","required":false,"schema":{"type":"string","description":"End date for filtering absences (YYYY-MM-DD)"},"description":"End date for filtering absences (YYYY-MM-DD)"},{"in":"query","name":"creationDate","required":false,"schema":{"type":"string","description":"Filter by creation date (YYYY-MM-DD)"},"description":"Filter by creation date (YYYY-MM-DD)"},{"in":"query","name":"sortOrder","required":false,"schema":{"type":"string","description":"Sort order - Start or CreatedAt - asc"},"description":"Sort order - Start or CreatedAt - asc"},{"in":"query","name":"absenceReason","required":false,"schema":{"type":"string","description":"Filter by absence reason ID or name"},"description":"Filter by absence reason ID or name"},{"in":"query","name":"courseId","required":false,"schema":{"type":"string","description":"Filter by course ID"},"description":"Filter by course ID"},{"in":"query","name":"studentId","required":false,"schema":{"type":"string","description":"Filter by student ID"},"description":"Filter by student ID"},{"in":"query","name":"type","required":false,"schema":{"type":"number","description":"Filter by absence type"},"description":"Filter by absence type"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"number"},"start":{"type":"string","nullable":true},"end":{"type":"string","nullable":true},"comment":{"type":"string"},"courseId":{"type":"string"},"studentId":{"type":"string"},"schoolId":{"type":"string"},"fileUrl":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"requestDate":{"type":"string","nullable":true}},"required":["id","type","start","end","comment","courseId","studentId","schoolId","fileUrl","apiId","apiType","createdAt","requestDate"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/justified-absences/{id}":{"get":{"summary":"Get a single justified absence by ID","description":"Retrieves detailed information about a specific justified absence","tags":["Absences"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The justified absence ID"},"description":"The justified absence ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"number"},"start":{"type":"string","nullable":true},"end":{"type":"string","nullable":true},"comment":{"type":"string"},"courseId":{"type":"string"},"studentId":{"type":"string"},"schoolId":{"type":"string"},"fileUrl":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"requestDate":{"type":"string","nullable":true}},"required":["id","type","start","end","comment","courseId","studentId","schoolId","fileUrl","apiId","apiType","createdAt","requestDate"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/own-school":{"get":{"summary":"Get a school by ID","description":"Get a school by ID","tags":["Schools"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string"},"NAME":{"type":"string"},"LOGO":{"type":"string"},"LOGOS":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"filename":{"type":"string"}},"required":["url","filename"],"additionalProperties":false}},"STREET_ADDRESS":{"type":"string"},"CITY":{"type":"string"},"POSTALCODE":{"type":"string"},"COUNTRY":{"type":"string"},"PHONE":{"type":"string"},"SIGNATURE_NB":{"type":"number"},"WEBHOOKS":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"CONNECTOR":{"type":"string"},"ABSENCES_TYPE":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"number"},"NAME":{"type":"string"}},"required":["ID"],"additionalProperties":false}},"NB_CREDITS_DOCUMENT_LEFT":{"type":"number"},"TIMEZONE":{"type":"string"},"LANGUAGE":{"type":"string"}},"required":["ID","NAME"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/subjects":{"get":{"summary":"Get all subjects with filters","description":"Retrieve all the subjects of your school with optional filtering and pagination.","tags":["Subjects"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","schoolId","createdAt","updatedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"post":{"summary":"Create a new subject","description":"Create a new subject in your school.","tags":["Subjects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","schoolId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/subjects/{id}":{"get":{"summary":"Get a subject by ID","description":"Retrieve a single subject using its subject ID.","tags":["Subjects"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","schoolId","createdAt","updatedAt"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"put":{"summary":"Update a subject","description":"Update an existing subject by its ID.","tags":["Subjects"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"periodName":{"type":"string","nullable":true},"periodStart":{"type":"string","nullable":true},"periodEnd":{"type":"string","nullable":true},"schoolId":{"type":"string"},"apiId":{"type":"string","nullable":true},"apiType":{"type":"string","nullable":true},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","schoolId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"delete":{"summary":"Delete a subject","description":"Delete an existing subject by its ID.","tags":["Subjects"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/groups":{"get":{"summary":"Get all groups with filters","description":"Retrieve all the groups of your school with optional filtering and pagination.","tags":["Groups"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"number","default":"1"},"description":"Page number for pagination (min: 1)"},{"in":"query","name":"limit","required":false,"schema":{"type":"number","default":"100"},"description":"Number of items per page (max: 100)"},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"filterIsArchived","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"parentId","required":false,"schema":{"type":"string"}},{"in":"query","name":"includeStudents","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"updatedAfter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"schoolId":{"type":"string"},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["id","firstName","lastName","email"],"additionalProperties":false}},"parent":{"type":"string","nullable":true},"logoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"externalReferenceId":{"type":"string","nullable":true},"externalReferenceType":{"type":"string","nullable":true},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"valueId":{"type":"number"},"schoolVariableId":{"type":"number"},"name":{"type":"string"},"schoolId":{"type":"string"},"ressourceType":{"type":"string"},"ressourceId":{"type":"string"},"type":{"type":"string"},"selectTypeValues":{"type":"string"},"value":{"type":"string"},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"}},"required":["id","valueId","schoolVariableId","name","schoolId","ressourceType","ressourceId","type","dateCreated","dateUpdated"],"additionalProperties":false}}},"required":["id","name","schoolId","isArchived","dateCreated","dateUpdated"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"},"page":{"type":"number"},"offset":{"type":"number"},"pageCount":{"type":"number"},"hasPrevPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}},"required":["total","limit","page","offset","pageCount","hasPrevPage","hasNextPage"],"additionalProperties":false}},"required":["results","pagination"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"post":{"summary":"Create a new group","description":"Create a single group resource. Note: Student membership is managed separately via dedicated endpoint. Nullable fields (description, parentId, logo) are stored as empty strings when set to null or omitted.","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Group name"},"description":{"type":"string","description":"Group description"},"parentId":{"type":"string"},"logoUrl":{"type":"string","description":"URL to group logo"},"externalReferenceId":{"type":"string","description":"External system identifier"},"externalReferenceType":{"type":"string","description":"Connector type (e.g., \"hyperplanning\", \"ypareo\")"}},"required":["name"],"additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"createdAt":{"type":"string"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["createdAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/groups/{id}":{"get":{"summary":"Get a group by ID","description":"Retrieve a single group using its group ID.","tags":["Groups"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The group ID"},"description":"The group ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"schoolId":{"type":"string"},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["id","firstName","lastName","email"],"additionalProperties":false}},"parent":{"type":"string","nullable":true},"logoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"externalReferenceId":{"type":"string","nullable":true},"externalReferenceType":{"type":"string","nullable":true},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"valueId":{"type":"number"},"schoolVariableId":{"type":"number"},"name":{"type":"string"},"schoolId":{"type":"string"},"ressourceType":{"type":"string"},"ressourceId":{"type":"string"},"type":{"type":"string"},"selectTypeValues":{"type":"string"},"value":{"type":"string"},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"}},"required":["id","valueId","schoolVariableId","name","schoolId","ressourceType","ressourceId","type","dateCreated","dateUpdated"],"additionalProperties":false}}},"required":["id","name","schoolId","isArchived","dateCreated","dateUpdated"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}},"patch":{"summary":"Update a group by internal ID","description":"Update group attributes by internal Edusign ID. Setting nullable fields (description, logo) to null clears them. Parent removal will be handled via dedicated endpoint in future release.","tags":["Groups"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","description":"The internal Edusign group ID"},"description":"The internal Edusign group ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Group name"},"description":{"type":"string","nullable":true,"description":"Group description. Set to null to clear."},"parentId":{"type":"string"},"logoUrl":{"type":"string","nullable":true,"description":"URL to group logo. Set to null to clear."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["updatedAt","updatedFields"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/groups:search":{"post":{"summary":"Search for a group","description":"Search for a group using name or API ID. Returns the first matching group.","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"externalReferenceId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"schoolId":{"type":"string"},"students":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["id","firstName","lastName","email"],"additionalProperties":false}},"parent":{"type":"string","nullable":true},"logoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"externalReferenceId":{"type":"string","nullable":true},"externalReferenceType":{"type":"string","nullable":true},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"valueId":{"type":"number"},"schoolVariableId":{"type":"number"},"name":{"type":"string"},"schoolId":{"type":"string"},"ressourceType":{"type":"string"},"ressourceId":{"type":"string"},"type":{"type":"string"},"selectTypeValues":{"type":"string"},"value":{"type":"string"},"dateCreated":{"type":"string"},"dateUpdated":{"type":"string"}},"required":["id","valueId","schoolVariableId","name","schoolId","ressourceType","ressourceId","type","dateCreated","dateUpdated"],"additionalProperties":false}}},"required":["id","name","schoolId","isArchived","dateCreated","dateUpdated"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}}}},"/groups/by-reference-id/{externalReferenceId}":{"patch":{"summary":"Update a group by external reference ID","description":"Update group attributes by external reference ID (apiId). Setting nullable fields (description, logo) to null clears them. Parent removal will be handled via dedicated endpoint in future release.","tags":["Groups"],"parameters":[{"in":"path","name":"externalReferenceId","required":true,"schema":{"type":"string","description":"The external reference ID (apiId)"},"description":"The external reference ID (apiId)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Group name"},"description":{"type":"string","nullable":true,"description":"Group description. Set to null to clear."},"parentId":{"type":"string"},"logoUrl":{"type":"string","nullable":true,"description":"URL to group logo. Set to null to clear."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["updatedAt","updatedFields"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"409":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"code":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/groups/batch-upsert":{"post":{"summary":"Batch create or update groups by external reference ID","description":"Upsert up to 1000 groups in a single request. Matches by externalReferenceId within school scope. Returns 200 for all success, 207 for partial success with failures.","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"externalReferenceId":{"type":"string","description":"External system identifier - used for matching. If omitted, group is always created."},"name":{"type":"string","description":"Group name"},"description":{"type":"string","nullable":true,"description":"Group description"},"parentExternalReferenceId":{"type":"string","nullable":true,"description":"External parent reference ID (resolved to parentId)"},"logoUrl":{"type":"string","nullable":true,"description":"URL to group logo"},"externalReferenceType":{"type":"string","nullable":true,"description":"Connector type (e.g., \"ypareo\", \"hyperplanning\")"}},"required":["name"],"additionalProperties":false}}},"required":["groups"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the group in the request groups array"},"id":{"type":"string","description":"EduSign internal group ID"},"type":{"type":"string","description":"Whether the group was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"updatedFields":{"type":"array","items":{"type":"string"},"description":"Fields that were updated (only for type \"updated\")"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request groups array"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total groups in the request"},"createdCount":{"type":"number","description":"Number of groups created"},"updatedCount":{"type":"number","description":"Number of groups updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"207":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index representing the position of the group in the request groups array"},"id":{"type":"string","description":"EduSign internal group ID"},"type":{"type":"string","description":"Whether the group was created or updated"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"updatedFields":{"type":"array","items":{"type":"string"},"description":"Fields that were updated (only for type \"updated\")"}},"required":["inputIndex","id","type"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index in the request groups array"},"externalReferenceId":{"type":"string","description":"External reference ID if provided"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total groups in the request"},"createdCount":{"type":"number","description":"Number of groups created"},"updatedCount":{"type":"number","description":"Number of groups updated"},"failureCount":{"type":"number","description":"Number of failures"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","createdCount","updatedCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}},"/groups/students/batch-upsert":{"post":{"summary":"Batch assign students to groups","description":"Assign students to groups in bulk. Each assignment maps one group (by ID or external reference) to multiple students (by IDs or external references). Returns 200 for all success, 207 for partial success.","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignments":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","description":"Internal Edusign group ID"},"groupExternalReferenceId":{"type":"string","description":"External reference ID for the group"},"studentIds":{"type":"array","items":{"type":"string"},"description":"Array of internal Edusign student IDs"},"studentExternalReferenceIds":{"type":"array","items":{"type":"string"},"description":"Array of external reference IDs for students"}},"additionalProperties":false}}},"required":["assignments"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index of the assignment in the request"},"groupId":{"type":"string","description":"Resolved internal group ID"},"addedCount":{"type":"number","description":"Number of students newly added"},"alreadyMemberCount":{"type":"number","description":"Number of students already in the group"}},"required":["inputIndex","groupId","addedCount","alreadyMemberCount"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index of the assignment in the request"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total assignments in the request"},"successCount":{"type":"number","description":"Number of assignments that succeeded"},"failureCount":{"type":"number","description":"Number of assignments that failed"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","successCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"207":{"description":"Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index of the assignment in the request"},"groupId":{"type":"string","description":"Resolved internal group ID"},"addedCount":{"type":"number","description":"Number of students newly added"},"alreadyMemberCount":{"type":"number","description":"Number of students already in the group"}},"required":["inputIndex","groupId","addedCount","alreadyMemberCount"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"inputIndex":{"type":"number","description":"Zero-based index of the assignment in the request"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code for programmatic handling"},"message":{"type":"string","description":"Human-readable error message"},"field":{"type":"string","description":"Field that caused the error"}},"required":["code","message"],"additionalProperties":false}},"required":["inputIndex","error"],"additionalProperties":false}}},"required":["succeeded","failed"],"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total assignments in the request"},"successCount":{"type":"number","description":"Number of assignments that succeeded"},"failureCount":{"type":"number","description":"Number of assignments that failed"},"processedAt":{"type":"string","description":"ISO timestamp when the batch was processed"}},"required":["total","successCount","failureCount","processedAt"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["status","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"]},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your Bearer token in the format \"Bearer \""}}}} ```

OpenApi specs ?