The Registration API enables new registrations or cancellations to be sent directly to the Cegos IS.
Access to this API is restricted to authorized users. Access requires a specific authorization defined by the "api-registration" 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://registration.api.cegos.fr/swagger
Create a lead.
Enables automated lead transmission.
Route
POST https://registration.api.cegos.fr/v1/leads
Parameters
| Array<HistoryIntraResponse> | ||
|---|---|---|
| Name | Type | Description |
| Civility | Enum | Training start date. |
| LastName | DateTime | Last name. |
| FirstName | String | First name. |
| PhoneNumber | String | Phone number. |
| String | Email. | |
| CompanyName | String | Company name. |
| EstablishmentName | String | Establishment name. |
| Siren | String | Siren. |
| Siret | String | Siret. |
| Address | String | Address. |
| PostalCode | String | Postal code. |
| City | String | City. |
| Country | String | Country. |
| PositionCode | String | Contact's position in the company. |
| ActivityCode | String | Activity code. |
| UserWebId | String | UserWebId. |
| Emailing | Int | Emailing. |
| Type | String | Type. |
Result
| RequestStatusWithIdResponse | ||
|---|---|---|
| Name | Type | Description |
| Code | String | Status code. |
| Reason | String | Error message. |
| Id | String | Lead ID. |
Create a registration.
Enables automated registration transmission.
Route
POST https://registration.api.cegos.fr/v1/registrations
Parameters
| RequestStatusWithIdResponse | ||
|---|---|---|
| Name | Type | Description |
| ManagerCrmId | string | Manager CRM ID. |
| ManagerCrmIsLead | string | Indicates whether the manager is a lead or a contact. |
| TraineeCrmId | String | Trainee CRM ID. |
| TraineeCrmIsLead | String | Indicates whether the trainee is a lead or a contact. |
| ClientReference | String | Client reference. |
| SessionId | String | Cegos dession Id. |
| Canal | String | Canal. |
| Comments | String | Comments. |
| IsCPF | Boolean | Indicates if the CPF will be used. |
| CpfHours | String | CPF hours. |
| IncludeMeal | Boolean | Indicates whether the meal will be included. |
| Overbooking | Boolean | Overbooking. |
| WebSaleId | String | WebSaleId. |
Result
| RequestStatusWithIdResponse | ||
|---|---|---|
| Name | Type | Description |
| Code | String | Status code. |
| Reason | String | Error message. |
| Id | String | Registration ID. |
Defer a registration.
This action uses a queue to process your request. You'll get a transaction ID number, which you can check the status of and get a response from.
Route
POST https://registration.api.cegos.fr/v1/registrations/defer
Parameters
| RequestStatus | ||
|---|---|---|
| Name | Type | Description |
| RegistrationNumber | string | Cegos registration number or Cegos Lead ID. |
| SessionId | string | Session Id. |
Result
| TransactionResponse | ||
|---|---|---|
| Name | Type | Description |
| TransactionId | String | Transaction Id. |
Check transaction status.
Check the status of a deferred registration request from a transaction ID.
Route
GET https://registration.api.cegos.fr/v1/registrations/defer/{TransactionId}
Parameters
| RequestStatus | ||
|---|---|---|
| Name | Type | Description |
| TransactionId | string | Transaction ID. |
Result
| RequestStatusWithIdMessageConsumedResponse | ||
|---|---|---|
| Name | Type | Description |
| Response | RequestStatusWithId | Response generated by the request. |
| Error | String | Error message. |
| Status | Enum | Possible value: Scheduled, Success, Failed. |
| RequestStatusWithId | ||
|---|---|---|
| Name | Type | Description |
| Id | String | Id. |
| Code | String | Status code. |
| Reason | String | Error message. |
Cancel a registration.
Route
DELETE https://registration.api.cegos.fr/v1/registrations
Parameters
| RequestStatusWithIdResponse | ||
|---|---|---|
| Name | Type | Description |
| RegistrationNumber | string | Cegos registration number. |
| Reason | string | Reason. |
| User | String | User. |
Result
| RequestStatus | ||
|---|---|---|
| Name | Type | Description |
| Code | String | Status code. |
| Reason | String | Error message. |