2.0 (October 2019)

Version 2.0 brings a few changes to the API that might require adjustements on your side. Some endpoints are also deprecated and should be replaced by their newer versions described in the documentation.

Clients should ensure their systems compatibility as soon as possible. Full documentation on the updated APIs is available in French and will soon be made available in English.

Main changes

  • Many error messages have been fixed.

UUID and Operator Order Ref

  • UUIDs on orders and services are now true UUIDs, represented by canonical 32-characters hexadecimal strings. Old UUIDs can still be used to fetch the existing objects but will be deprecated in a near future. Existing objects can therefore be fetched and updated through the old and the new UUID. However, the value returned by the API is the new 32-characters UUID,

  • The operator order reference (operator order ref) must now be unique between all technologies (copper and fiber).

Copper API

  • Field rivoli_code is replaced by kosc_street_code and field insee_code is replaced by kosc_insee_code in the payloads returned by the API in order to bring copper and fiber together. Eligibility and Meeting APIs are unchanged,

  • Field origin is now forced to standard. Its use is deprecated,

  • Field batch_alias is removed,

  • Field profile_uuid* is remved and replaced by **profile_name. Profile UUIDs are deprecated and actions must now use profile names (see Actions (in French)),

  • Some private fields (undocumented) are removed in endpoints[n].characteristics,

  • Fields nra and status are removed in endpoints[n] (duplicate of endpoints[n].characteristics.nra and endpoints[n].info.inactive),

  • POST on /orders/ now return an HTTP status code 201 instead of 200 in case of success,

  • In create_nearby and create_neighbour cases, the field endpoints of orders API now return the final reference of the endpoint delivered by the local loop operator instead of the neighbour endpoint used to create the order.

Fiber API

  • Fields current_order_type and current_order_uuid have been added to the Services API,

  • Field locked has been added to orders-endpoint API. It specifies if the endpoint is editable, depending on the order type.

Product options

  • When an option is disabled, only null value can be passed along.

Meeting API

  • Error messages have been fixed,

  • Date intervals were wrong in the documentation. If the service level is standard, appointments can be booked starting from D+8 (instead of 6). Premium service level allows appointment to be booked starting from D+6.

Events API

  • Parameter direction, which was ignored, is removed. It is now included in the parameter sort.

  • Field comment in the event order-rejected: has been replaced by the field reject_description.