The Api Catalog is designed to provide the entire catalog available on Cegos.fr in an automated way. You can access information on all available training courses. You'll find schedules, prices, training locations, etc.
The data is segmented Into four parts:
Access to this API is restricted to authorized users by the default scope "api-cegos". 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://catalog.api.cegos.fr/swagger
Provides a list of available catalogs.
Route
GET https://catalog.api.cegos.fr/v1/catalogs
Parameters
There are no parameters for this route.
Result
| CatalogResponse | ||
|---|---|---|
| Name | Type | Description |
| Id | Int | Catalog Id. |
| Label | String | Label. |
| CountryId | Int | Country Id. |
| CountryLabel | String | Country label. |
| StartDate | DateTime | Catalog opening date. |
| EndDate | DateTime | Catalog ending date. |
Provide the complete catalog tree.
Route
GET https://catalog.api.cegos.fr/v1/catalogtopics
Parameters
| Name | Type | Required | Input | Description |
|---|---|---|---|---|
| CatalogsId | Array<Int> | Optional | QueryString | Catalog Id. If empty, the default catalog will be used. The default catalog is defined by the current year. |
Result
| CatalogResponse | ||
|---|---|---|
| Name | Type | Description |
| Year | Int | Catalog year. |
| Topics | Array<CatalogTopicsResponse> | All catalog topics. |
| CatalogTopicsResponse | ||
|---|---|---|
| Name | Type | Description |
| Id | Int | Identifier. |
| Label | String | Topic label. |
| SubTopics | Array<CatalogTopicsResponse> | All children's catalog topics linked to this item. |
Provide all product information from a catalog.
Route
GET https://catalog.api.cegos.fr/v1/products
Parameters
| Name | Type | Required | Input | Description |
|---|---|---|---|---|
| Page | Int | Optional | QueryString | The requested page number. Default value is 1. The value "-1" gives all results on a single page. |
| CatalogsId | Array<Int> | Optional | QueryString. | Catalog Id. If empty, the default catalog will be used. The default catalog is defined by the current year. |
| Hydrate | Boolean | Optional | QueryString. | If the value is "true", all product data is returned. A "false" value returns a light version. Default value is true. |
Result
| PagedResponse | ||
|---|---|---|
| Name | Type | Description |
| PageNumber | Int | Current page number. |
| PageSize | Int | Items per pages. |
| TotalItems | Int | Total number of items. |
| TotalPages | Int | Total number of pages. |
| Data | Array<ProductResponse> | Products details |
Provide product information from a unique identifier.
Route
GET https://catalog.api.cegos.fr/v1/products/{yearlyProductCode}
Parameters
| Name | Type | Required | Input | Description |
|---|---|---|---|---|
| YearlyProductCode | String | Required | Route | Unique identifier |
| Hydrate | Boolean | Optional | QueryString. | If the value is "true", all product data is returned. A "false" value returns a light version. Default value is true. |
Result
| Response | ||
|---|---|---|
| Name | Type | Description |
| Data | ProductResponse | Product data |
| ProductResponse | ||
|---|---|---|
| Name | Type | Description |
| YearlyProductCode | String | Unique identifier. |
| ProductCode | String | Reference code. |
| OfferYear | Int | Offer year. |
| Title | String | Course title. |
| EvolutionType | String | Evolution type. |
| CPF | Bool | Indicates whether the course is CPF compatible. |
| RSCode | String | Certification code. |
| RNCPCode | String | Certification code. |
| CPFCode | String | CPF code. |
| TrainingMethod | String | Training method used for the course (virtual classroom, coaching, etc.). |
| FamilyOfferId | Int | Familly offer ID. |
| ModuleDuration | String | Module duration. Only for E-Learning. |
| Languages | Array<String> | Dispensed language. |
| Cities | Array<String> | City where the course takes place. |
| Level | ElementResponse | Course level. |
| ProfessionalChallengesId | Int | Professional challenges ID. |
| BestSeller | Bool | Indicates whether the item is a best seller. |
| Picto4Real | Bool | Indicates whether the item is a picto4Real. |
| Titles | Array<TitleResponse> | All available titles. |
| Formula | FormulaResponse | Fomula details. |
| CatalogTopicRelations | Array<CatalogTopicRelationResponse> | Catalog topic associated with this item. |
| Partners | Array<String> | Partners related to the course. |
| RelatedProducts | Array<RelatedProductResponse> | Related product to the course. |
| Range | ElementResponse | Course range. |
| Price | Double | Price. |
| IPackPrice | Double | IPack Price. |
| Notice | NoticeResponse | Provide marketing information about the course. |
| NoticeUrl | String | Notice URL. |
| NoticeUrlPdf | String | Notice URL in PDF. |
| CertificationInclude | Boolean | Indicate whether the course includes a certification. |
| InternationalProduct | Boolean | Indicate whether the course is international. |
| Certification | String | Certification name. |
| Certifier | String | Certifier name. |
| DeliveryMode | String | Delivery mode. |
| JobSheetTitle | String | Job sheet title. |
| JobSheetUrl | String | Job sheet url. |
| ModalityTitle | String | Modality title. |
| MarketingTitle | String | Marketing title. |
| RelatedProductResponse | ||
|---|---|---|
| Name | Type | Description |
| RelatedProductCode | String | Product code. |
| Type | Enum | Possible value: After, Substition |
| Order | Int | Order. |
| TitleResponse | ||
|---|---|---|
| Name | Type | Description |
| Type | String | Title type. |
| Text | String | Title. |
| MaximumLength | Int | Maximum allowed lenght. |
| FormulaResponse | ||
|---|---|---|
| Name | Type | Description |
| Id | Int | Unique identifier. |
| Label | String | Label. |
| Modules | Array<ModuleResponse> | Modules list. |
| ModuleResponse | ||
|---|---|---|
| Name | Type | Description |
| Code | String | Module code. |
| Order | Int | Order. |
| Optional | Boolean | Indicates whether the module is optional. |
| IsProduct | Boolean | Indicates whether the module is a product. |
| Label | String | Label. |
| DelayInDay | Double | Delay in days. |
| DelayInHour | Double | Delay in hour. |
| DelayInMinute | Double | Delay in minute. |
| DeliveryMode | String | Delivery mode. |
| CatalogTopicRelationResponse | ||
|---|---|---|
| Name | Type | Description |
| CatalogTopicId | Int | Unique identifier. |
| RelationType | Enum RelationType | Indicates relationship type. Possible value: Main, Secondary. |
| ElementResponse | ||
|---|---|---|
| Name | Type | Description |
| Id | Int | Unique identifier. |
| Label | String | Label. |
Provide session information.
Route
GET https://catalog.api.cegos.fr/v1/sessions
Parameters
| Name | Type | Required | Input | Description |
|---|---|---|---|---|
| StartDate | DateTime (yyyy-MM-dd) | Optional | QueryString. | Default value is today. |
| EndDate | DateTime (yyyy-MM-dd) | Optional | QueryString. | End date. |
| YearlyProductCode | String | Optional | QueryString. | Unique product identifier. |
| Hydrate | Boolean | Optional | QueryString. | If the value is "true", all session data is returned. A "false" value returns a light version. Default value is true. |
| Page | Int | Optional | QueryString | The requested page number. Default value is 1. The value "-1" gives all results on a single page. |
| CatalogsId | Array<Int> | Optional | QueryString. | Catalog Id. If empty, the default catalog will be used. The default catalog is defined by the current year. |
Result
| PagedResponse | ||
|---|---|---|
| Name | Type | Description |
| PageNumber | Int | Current page number. |
| PageSize | Int | Items per pages. |
| TotalItems | Int | Total number of items. |
| TotalPages | Int | Total number of pages. |
| Data | Array<SessionResponse> | Session details |
Provide session information from a unique identifier.
Route
GET https://catalog.api.cegos.fr/v1/sessions/{yearlySessionCode}
Parameters
| Name | Type | Required | Input | Description |
|---|---|---|---|---|
| YearlySessionCode | String | Optional | QueryString. | Unique identifier. |
Result
| PagedResponse | ||
|---|---|---|
| Name | Type | Description |
| PageNumber | Int | Current page number. |
| PageSize | Int | Items per pages. |
| TotalItems | Int | Total number of items. |
| TotalPages | Int | Total number of pages. |
| Data | Array<SessionResponse> | Session details |
| SessionResponse | ||
|---|---|---|
| Name | Type | Description |
| YearlySessionCode | String | Unique identifier. |
| SessionNumber | String | Number. |
| YearlyProductCode | String | Unique product identifier. |
| ProductCode | String | Product code. |
| Price | double | Price. |
| InterDiscountPrice | double | IPack Price. |
| StartDate | Date | Start date. |
| EndDate | Date | End date. |
| DurationInDays | Date | End date. |
| GuaranteedSession | Boolean | Indicates whether the session is guaranteed. |
| IsRemote | Boolean | Indicates whether the session is provided remotely. |
| City | String | City where the course is provided. |
| IsFull | Boolean | Indicates whether the session is full. |
| IsLastPlaceAvailable | Boolean | Indicates if there are still places available. |
| IsHighProbability | Boolean | Indicates whether the session has a great chance to be provided. |
| RegistrationCount | Int | Registration count. |
| LimitMin | Int | Minimum registration required. |
| LimitMax | Int | Maximum registration allowed. |
| Status | Enum | Possible value: Open, Valid, Invited, Cancel. |
| Parts | Array<SessionPartResponse> | Information on the different elements of the session. |
| SessionPartResponse | ||
|---|---|---|
| Name | Type | Description |
| IsRemote | Boolean | Indicate whether this session part is provided remotely. |
| StartTimeHour | Int | Start hour. |
| StartTimeMinute | Int | Start minute. |
| EndTimeHour | Int | End hour. |
| EndTimeMinute | Int | End minute. |
| StartDate | Date | Start date. |
| EndDate | Date | End date. |
| DurationInDays | Double | Duration. |
| Number | Int | Number. |
| CenterId | String | Center ID. You can have more information on center from center route. |
Provide center information.
Route
GET https://catalog.api.cegos.fr/v1/referentials/centers
Parameters
There are no parameters for this route.
Result
| Response | ||
|---|---|---|
| Name | Type | Description |
| Data | Array<CenterResponse> | All center information. |
| CenterResponse | ||
|---|---|---|
| Name | Type | Description |
| Code | String | Center code. |
| Name | String | Center name. |
| Address | String | Center address. |
| City | String | City. |
| PostalCode | String | Postal code. |
| Country | String | Country. |