.wpb_animate_when_almost_visible { opacity: 1; }
Core Information - Documentation
Commercial and technical inventory for Customers of Orange Business Services (CMDB)
2.5
Download

Core Information
 2.4.0 
OAS 3.0

https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/m7SPJpGL8FzTElI2/products/9o5OZf2T2w6Ga6Rk/contents/swagger/IUDAIZE5zJwKWywG/coreresources-prod-swagger.json

Core Information provides several methods to access transversal information and the global inventory. It is an API restricted to Orange Business customers.

This API allows to retrieve the list of Customer Accounts, Location, Resources, Products and Services.

Internationalization

This API Provides data only in English

Resources

  • accounts : Customer Accounts (International customers only)

  • locations : Geographic place identified by a postal address where equipment are deployed.

  • servicePoints : Installed offers / solutions.

  • configurationItems : Equipments or supports installed based on Service Points.

  • doc : Documentation of the API in Swagger format.

  • status : Health of the API component.

  • version : Version of the API component.

Copyright © OB 2021. All Rights Reserved.

Scopes

ScopeFeatures
b2b:core-informationFull access of the API.
b2b:core-information:readonlyAPI limited to read actions

Authentication

The authentication is based on OAuth 2.0 and and API Key provided by Orange Business Services for 'Machine2Machine' mode.

Servers

Locations

A location represents a geographic place with a postal address. Normally, it is the premises where equipment are deployed or buildings/offices where employees work

Service Points

Retrieve information on Installed offers, solutions

Configuration Items

List of installed equipments such as Routers, Switches etc... and also Access Lines.

Accounts

Customer Account is a key object for API for Business catalog.

Miscellaneous

Functions for Tracking the status of the API, versioning and ability to download the Swagger

    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      409List of supported error codes:
      - 69: Conflict
      {
        "code": 69,
        "message": "Conflict",
        "description": "The request could not be completed due to a conflict with the current state of the resource."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of the request/response (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      429List of supported error codes:
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "Internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      502List of supported error codes:
      - 1: Internal error
      - 3: Bad gateway
      {
        "code": 1,
        "message": "Bad gateway",
        "description": "A runtime execution error occurs (RaiseFault)."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }
      504List of supported error codes:
      - 6: Gateway timeout
      {
        "code": 6,
        "message": "Gateway timeout",
        "description": "No response was received in time from a backend server acting as gateway or proxy."
      }