The Document API provides automated access to customer documents.
Access to this API is restricted to authorized users. Access requires a specific authorization defined by the "api-document" scope. If you haven't already done so, we suggest you follow the registration steps explained in the "Register your application" section.
For developers and other engineering teams, an Open API documentation generated by Swagger is available at this URL:
https://document.api.cegos.fr/swagger
Search for documents.
Allows you to search for documents.
Route
GET https://document.api.cegos.fr/v1/documents
Parameters
| Name | Type | Description |
|---|---|---|
| CaseNumber | String | Cegos Case ID. Required if RegistrationNumber and EstablishmentBuyerCode are empty. |
| RegistrationNumber | String | Cegos registration ID. Required if CaseNumber and EstablishmentBuyerCode are empty. |
| EstablishmentBuyerCode | String | Buyer establishment code. Required if RegistrationNumber and CaseNumber are empty. |
| DocumentTypes | Array<Enum> | Desired document types. If empty, all documents of any type will be returned. |
Result
| Array<DocumentResponse> | ||
|---|---|---|
| Name | Type | Description |
| Id | Int | Document Id. |
| DocumentType | Enum | Document type. |
| HasBack | Boolean | Indicates whether the document is double-sided. |
| NotSigned | Int | Indicates whether the document has been signed or is the original document. |
| TrainingStartDate | DateTime | Training start date. |
Get document data.
Allows you to get document data.
Route
GET https://document.api.cegos.fr/v1/documents/{documentType}/{documentId}/{side}/data
Parameters
| Name | Type | Description |
|---|---|---|
| DocumentType | Enum | Document type. |
| DocumentId | Int | Document ID. |
| Side | Enum | Allows you to request the front or back of the desired document. Back is only available if the document has "hasBack" set to true. |
Result
| DataBase64Response | ||
|---|---|---|
| Name | Type | Description |
| Data | String | Document data in base64. |
| Mime | String | Document mime. |
| FileName | String | File name. |
Get quotation data.
Allows you to obtain quote data.
Route
GET https://document.api.cegos.fr/v1/documents/quotations/{quotationReference}/data
Parameters
| Name | Type | Description |
|---|---|---|
| quotationReference | string | Quoatation reference. |
Result
| DataBase64Response | ||
|---|---|---|
| Name | Type | Description |
| Data | String | Document data in base64. |
| Mime | String | Document mime. |
| FileName | String | File name. |
Get Inter history.
Provides the Inter history of a company or trainee.
Route
GET https://document.api.cegos.fr/v1/history/inter
Parameters
| Name | Type | Description |
|---|---|---|
| TrainingStartDate | DateTime | Training start date. |
| TrainingEndDate | DateTime | Training end date. |
| EstablishmentCode | String | Establishment code. |
| EstablishmentBuyerCode | String | Establishment buyer code. |
| String | Trainee or manager's email. |
Result
| Array<HistoryInterResponse> | ||
|---|---|---|
| Name | Type | Description |
| TraineeFirstName | String | Trainee's first name. |
| TraineeLastName | String | Trainee's last name. |
| TraineeCompanyName | String | Trainee's company name. |
| TraineeEstablishmentCode | String | Trainee's establishment code. |
| TraineeEstablishmentName | String | Trainee's' establishment name. |
| TraineeEmail | String | Trainee's email. |
| RegistrationManagerFirstName | String | First name of registration manager. |
| RegistrationManagerLastName | String | Last name of registration manager. |
| RegistrationManagerEstablishmentCode | String | Establishment code of registration manager. |
| RegistrationManagerEstablishmentName | String | Establishment name of registration manager. |
| RegistrationManagerCompanyName | String | Company name of registration manager. |
| RegistrationManagerEmail | String | Email of registration manager. |
| TrainingTitle | String | Training title. |
| TrainingStartDate | DateTime | Training start date. |
| RegistrationState | String | Registration state. |
| RegistrationNumber | String | Registration number. |
| YearlyProductCode | String | Cegos yearly product code. |
| Accounting | String | Accounting number. |
| SessionNumber | String | Session number. |
| Session | SessionResponse | Session information |
| SessionResponse | ||
|---|---|---|
| Name | Type | Description |
| StartDate | Date | Course start date. |
| EndDate | String | Course end date. |
| DurationInDays | Double | Course duration in days. |
| SessionNumber | Integer | Session number. |
| IsRemote | Boolean | Indicates whether the course is provided remotely. |
| City | String | City. |
| RegistrationCount | Int | Registration count. |
| LimitMin | Int | Registration minimum. |
| LimitMax | Int | Registration maximum. |
| Status | Enum | Possible value: Open, Valid, Invited, Cancel |
Get Intra history.
Provides the Intra history of a company.
Route
GET https://document.api.cegos.fr/v1/history/intra
Parameters
| Name | Type | Description |
|---|---|---|
| TrainingStartDate | DateTime | Training start date. |
| TrainingEndDate | DateTime | Training end date. |
| EstablishmentCode | String | Establishment code. |
| CaseNumber | String | Cegos case number. |
Result
| Array<HistoryIntraResponse> | ||
|---|---|---|
| Name | Type | Description |
| EstablishmentCode | String | Establishment code. |
| EstablishmentName | String | Establishment name. |
| CompanyName | String | Company name. |
| TrainingDescription | String | Training description. |
| TrainingStartDate | String | Training start date. |
| CaseNumber | String | Case number. |