Eligibility Request
Operation
sequenceDiagram
participant Client
participant Covage API
participant Covage Backend
Client->>Covage API: Request for offer families sold by Covage
Covage API-->>Client: List of offer families
Client->>Covage API: Eligibility request for a site to multiple offer families
Covage API-->>Client: Eligibility request ID
Covage API->>Covage Backend: Eligibility request for a site to multiple offers
Covage Backend-->>Covage API: List of eligible offers for this address
Client->>Covage API: Retrieve eligibility results
Covage API-->>Client: Eligibility results
Client->>Covage API: Offer details
Covage API->>Covage Backend: Request for pack details with details and price
Covage Backend-->>Covage API: Pack details
Covage API-->>Client: Offer details
Request for Offer Families Sold by Covage
Retrieving the offer families sold by Covage
GET /api/v1/catalog/category
Response
| Name |
Type |
Description |
Required |
| name |
string |
Name of the offer family ('BPE','BPEA') |
Yes |
| type |
string |
Type of offer family ('OFFER_FAMILY') |
Yes |
| description |
string |
Description of the offer family |
No |
Eligibility Request for a Site to Multiple Offers
Creating an eligibility request to check the eligibility of an address for one or more offers.
POST /api/v1/product_offering_qualification
Request Field Parameters
| Name |
Type |
Description |
Required |
| external_id |
string |
External identifier for the request |
No |
| project_id |
string |
Associated project identifier |
No |
| product_offering_qualification_item |
array |
List of offer qualification items |
Yes |
Offer Qualification Item
| Name |
Type |
Description |
Required |
| offer_families |
array |
Requested offer families |
Yes |
| eligibility_id |
string |
Eligibility identifier (from the address search API) |
Yes |
| address |
object |
Address details to verify |
No |
Address Details
| Name |
Type |
Description |
Required |
| label |
string |
Address label |
No |
| street_ext |
string |
Street extension |
No |
| street_nr |
string |
Street number |
No |
| city |
object |
City details |
No |
| street |
object |
Street details |
No |
City Details
| Name |
Type |
Description |
Required |
| city_id |
string |
City identifier (from the address search API) |
No |
| insee_code |
string |
INSEE code of the city |
No |
| city_name |
string |
City name |
No |
| post_code |
string |
Postal code of the city |
No |
Street Details
| Name |
Type |
Description |
Required |
| street_id |
string |
Street identifier (from the address search API) |
No |
| street_name |
string |
Street name |
No |
Response
| Name |
Type |
Description |
| id |
string |
Eligibility request identifier |
Retrieving Eligibility Results
Retrieving the eligibility results of an eligibility request.
GET /api/v1/product_offering_qualification/{id}
Request Field Parameters
| Name |
Type |
Description |
Required |
| id |
string |
Eligibility request identifier |
Yes |
Response
| Name |
Type |
Description |
Required |
| id |
string |
Eligibility request identifier |
Yes |
| creation_date |
string |
Request creation date |
Yes |
| external_id |
string |
External identifier for the request |
No |
| project_id |
string |
Associated project identifier |
No |
| effective_qualification_date |
string |
Effective eligibility date |
No |
| href |
string |
Link to the resource |
No |
| state |
string |
Current state of the request |
Yes |
| state_change |
array |
State change history |
Yes |
State Change
| Name |
Type |
Description |
Required |
| change_reason |
string |
Reason for the state change |
Yes |
| change_date |
string |
State change date |
Yes |
| state |
string |
New state |
Yes |
Offer Qualification Item Details
| Name |
Type |
Description |
Required |
| id |
string |
Qualification item identifier |
Yes |
| density |
string |
Offer density |
Yes |
| offer_families |
array |
Available offer families |
Yes |
| zone_type_bpe |
string |
BPE zone type |
Yes |
| zone_type_bpea |
string |
BPEA zone type |
Yes |
| zone_bpe |
number |
BPE zone |
Yes |
| zone_bpea |
number |
BPEA zone |
Yes |
| place |
object |
Place details |
Yes |
| address |
object |
Address details |
No |
| guaranteed_until_date |
string |
Date until which the offer is guaranteed |
Yes |
| state |
string |
Current state of the item |
Yes |
| state_change |
array |
State change history of the item |
Yes |
| products_offering |
array |
List of offered products |
Yes |
Place Details
| Name |
Type |
Description |
Required |
| location |
object |
Geographical coordinates |
Yes |
| building_ref |
string |
Building reference |
No |
| eligibility_id |
string |
Eligibility identifier |
Yes |
Address Details
| Name |
Type |
Description |
Required |
| label |
string |
Address label |
No |
| street_ext |
string |
Street extension |
No |
| street_nr |
string |
Street number |
No |
| city |
object |
City details |
No |
| street |
object |
Street details |
No |
City Details
| Name |
Type |
Description |
Required |
| city_id |
string |
City identifier |
No |
| insee_code |
string |
INSEE code of the city |
No |
| city_name |
string |
City name |
No |
| post_code |
string |
Postal code of the city |
No |
Street Details
| Name |
Type |
Description |
Required |
| street_id |
string |
Street identifier |
No |
| street_name |
string |
Street name |
No |
Offer Details
| Name |
Type |
Description |
Required |
| product_id |
string |
Offer identifier (product_offering) |
Yes |
| name |
string |
Product name |
Yes |
| description |
string |
Product description |
Yes |
| bandwidth |
string |
Product bandwidth |
Yes |
| bandwidth_guarantee |
string |
Bandwidth guarantee |
Yes |
| commitment |
string |
Product commitment |
Yes |
| offer_technology |
string |
Offer technology |
Yes |
| offer_family |
string |
Offer family |
Yes |
| tarif_zone |
string |
Tariff zone |
Yes |
Offer Details
Retrieving the details of an offer.
GET /api/v1/product_offering/{id}
Request Field Parameters
| Name |
Type |
Description |
Required |
| id |
string |
Offer identifier (product_offering) |
Yes |
| zone |
integer |
Tariff zone (from eligibility) |
No |
Response
| Name |
Type |
Description |
Required |
| id |
string |
Offer identifier |
Yes |
| href |
string |
Link to the resource |
Yes |
| name |
string |
Offer name |
Yes |
| description |
string |
Offer description |
Yes |
| bandwidth_guarantee |
string |
Bandwidth guarantee |
Yes |
| commitment |
string |
Offer commitment |
Yes |
| tarif_zone |
string |
Tariff zone |
Yes |
| far |
number |
FAR value |
Yes |
| fas |
number |
FAS value |
Yes |
| price |
number |
Offer price |
Yes |
| recurring |
boolean |
Indicates if the offer is recurring |
Yes |
| offer_family |
string |
Offer family |
Yes |
| offer_technology |
string |
Offer technology |
Yes |
| available_options |
array |
Available options for the offer |
Yes |
| last_update |
string |
Last update date |
Yes |
Available Options Details
| Name |
Type |
Description |
Required |
| name |
string |
Option name |
Yes |
| type |
string |
Option type |
Yes |
| values |
array |
Values associated with the option |
Yes |
Option Values Details
| Name |
Type |
Description |
Required |
| option_id |
string |
Option identifier |
Yes |
| label |
string |
Option label |
Yes |
| price |
number |
Option price |
Yes |
| recurring |
boolean |
Indicates if the option is recurring |
Yes |