{ "openapi": "3.0.0", "info": { "version": "3.1", "title": "API Ordering For Business - Fr", "description": "Ordering for Business API allows you to submit commercial requests to Orange Business, and to track their progress all the way through to delivery and completion. \n \n**Release: v 3.1**\n\n\n### Ordering for Business API performs the following operations:\n- Submit a new request.\n- Retrieve a collection of catalog items depending on filter criteria.\n\n\n### Resources \n- **requests** : A request created by the customer which defines a commercial order.\n- **catalogItems** : An attachment defines all files about request.\n- **status** : used to know the status of API components.\n\n\n### Scopes \n\n| Scope | Features |\n| --- | --- |\n| b2b:ordering| Full access of the API. Ability to track requests and submit new request|\n| b2b:ordering:readonly | Allow to track requests |\n\n\n# Authentication\nThe authentication is based on OAuth 2.0 and and API Key provided by Orange Business\n\n\n### Internationalization\nBy default, data are in English but you can request data in French by specifying a language code in the Accept-Language header.\n_Example: Accept-Language: fr_\n\n\n***\n\nCopyright © OBS 2019. All Rights Reserved.\n", "contact": { "email": "api.tech-expert@orange.com", "name": "API TECH EXPERT" }, "x-logo": { "url": "/redoc/logo.png", "backgroundColor": "#FFFFFF" } }, "tags": [ { "name": "Request Management", "description": "create and get BVPN requests" }, { "name": "Catalog Management", "description": "get catalog details and schemas" }, { "name": "Miscellaneous", "description": "Swagger file, Status and version of the API" } ], "servers": [ { "url": "https://api.orange.com/ordering/b2b/v3", "description": "Orange Developer" } ], "paths": { "/requests": { "post": { "summary": "create new request (creation, modification, resiliation and cancellation)", "description": "The API for Ordering allows to send new order request to Orange Business.\nThese new requests can be creation, modification of an exiting service, resiliation or cancellation.", "responses": { "201": { "description": "post requests response", "headers": { "Content-Location": { "schema": { "type": "string" }, "description": "location of the created object" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Requests" } } } }, "400": { "description": "Bad Request\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "405": { "description": "Method Not Allowed\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "422": { "description": "Unprocessable entity\n\nBusiness error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "post-requests", "parameters": [ { "$ref": "#/components/parameters/x-api-key" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/deleteBVPNAutomatic" }, { "$ref": "#/components/schemas/createBvpnAutomatic" }, { "$ref": "#/components/schemas/modifyBvpnAutomatic" }, { "$ref": "#/components/schemas/deleteBVPNGeneric" }, { "$ref": "#/components/schemas/createRequestsGeneric" }, { "$ref": "#/components/schemas/modifyRequestsGeneric" }, { "$ref": "#/components/schemas/deleteRequestsGeneric" }, { "$ref": "#/components/schemas/cancelRequestsGeneric" } ], "additionalProperties": true }, "examples": { "delete BVPN automatic": { "$ref": "#/components/examples/delete-BVPN-Automatic" }, "create BVPN automatic": { "$ref": "#/components/examples/create-BVPN-Automatic" }, "modify BVPN automatic": { "$ref": "#/components/examples/modify-BVPN-Automatic" }, "delete BVPN generic": { "$ref": "#/components/examples/delete-BVPN-Generic" }, "delete generic": { "$ref": "#/components/examples/delete-Generic" }, "create generic": { "$ref": "#/components/examples/create-Generic" }, "modify generic": { "$ref": "#/components/examples/modify-Generic" }, "cancel generic": { "$ref": "#/components/examples/cancellation-Generic" } } } } }, "tags": [ "Request Management" ] }, "get": { "summary": "get requests details", "operationId": "get-requests", "tags": [ "Request Management" ], "responses": { "200": { "description": "Example response", "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } }, "content": { "application/json": { "schema": { "x-examples": { "Example 1": { "id": "3-xxxxxxxxxx", "customerReference": "mycustomerreference", "status": "REJECTED", "step": "ORDER", "subStep": "INITIATION", "isOverdue": false, "isArchived": false, "priority": "", "customer": { "id": "33-xxxxxxxxxx", "name": "customer name" }, "keyDates": { "requestedAt": "2022-05-14" }, "type": "R_BVPN_Catalog", "properties": { "network": { "id": "5-xxxxxxxxxx" }, "profile": "profile name", "options": {}, "billingAccount": { "code": "xxxxxxxxxx" }, "location": { "name": "location name", "localCompany": "string", "localCompanyLegalNumber": "xxxxxxxxxx", "building": "building Name", "residence": "residence Name", "floor": "5", "room": "xxx", "stair": "A", "address": { "street": "street name", "extendedStreet": "", "postalCode": "xxxxxxxxxx", "city": "city name", "country": "FR" }, "id": "xxxxxxxxxx" }, "contacts": { "primary": { "title": "Mr", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "email": "myemail@operator.com" } } }, "rejectionReasons": [ { "code": 1234, "reason": "rejection reason", "message": "error message" } ], "attachments": [], "createdAt": "2022-04-07T16:12:31.764Z", "updatedAt": "2022-04-07T16:12:58.067Z" } }, "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/Requests" }, { "type": "object", "properties": { "rejectionReasons": { "type": "array", "items": { "$ref": "#/components/schemas/RejectionReasons" } } } } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/status" }, { "$ref": "#/components/parameters/type" }, { "$ref": "#/components/parameters/customerReference" }, { "$ref": "#/components/parameters/keyDates.requestedAt" }, { "$ref": "#/components/parameters/priority" }, { "$ref": "#/components/parameters/isOverdue" }, { "$ref": "#/components/parameters/isArchived" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/createdAt" }, { "$ref": "#/components/parameters/updatedAt" }, { "$ref": "#/components/parameters/displayLinks" }, { "$ref": "#/components/parameters/displayNulls" } ], "description": "list all order requests. It allows to monitor them" } }, "/requests/{id}": { "get": { "summary": "get the details of a request", "tags": [ "Request Management" ], "responses": { "200": { "description": "Example response", "content": { "application/json": { "schema": { "x-examples": { "Example 1": { "id": "3-xxxxxxxxxx", "customerReference": "#00myCustomerReference", "status": "REJECTED", "rejectionReasons": [ { "code": 1234, "reason": "rejection reason", "message": "error message" } ], "step": "ORDER", "subStep": "INITIATION", "isOverdue": false, "isArchived": false, "priority": "", "customer": { "id": "33-xxxxxxxxxx", "name": "xxxxxxxxxx" }, "keyDates": { "requestedAt": "2022-10-29" }, "type": "xxxxxxxxxx", "properties": { "profile": "xxxxxxxxxx", "network": { "id": "xxxxxxxxxx" }, "billingAccount": { "code": "xxxxxxxxxx" }, "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "location": { "address": { "city": "city name", "postalCode": "xxxxx", "street": "xx street name" }, "name": "location name", "id": "xxxxxxxxxx" }, "options": {} }, "attachments": [], "createdAt": "2022-09-29T14:44:51.198Z", "updatedAt": "2022-09-29T14:45:11.880Z" } }, "allOf": [ { "$ref": "#/components/schemas/Requests" }, { "type": "object", "properties": { "rejectionReasons": { "type": "array", "items": { "$ref": "#/components/schemas/RejectionReasons" } } } } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-requests-requestId", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "Indigo returned id" } ], "description": "GET order request details by Id" } }, "/requests/aggregate": { "get": { "summary": "get aggregate details", "tags": [ "Request Management" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "x-examples": { "Example 1": { "COMPLETED": 10, "IN_PROGRESS": 10, "NEW": 3, "REJECTED": 37 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-requests-aggregate", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/groupBy" } ], "description": "get requests aggregate. it allows to inform the number by object aggregation (example by status)" } }, "/catalogItems": { "get": { "summary": "get available catalog items", "tags": [ "Catalog Management" ], "responses": { "200": { "description": "Example response", "headers": { "X-Total-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The total number of items matching criterias." }, "X-Result-Count": { "schema": { "type": "integer", "format": "int32" }, "description": "The actual number of items returned in the response body." } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-catalogItems", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" } ], "description": "get catalog items. It explains all fields that you have to send for request" } }, "/catalogItems/{id}": { "get": { "summary": "get details of a catalog item", "tags": [ "Catalog Management" ], "responses": { "200": { "description": "Example response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-catalogItems-catalogItemId", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "catalog item ID" } ], "description": "get catalog items by id" } }, "/doc": { "get": { "summary": "simple way to download automatically the Swagger file in json format", "tags": [ "Miscellaneous" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/doc" } } } }, "400": { "description": "Bad Request\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "405": { "description": "Method Not Allowed\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-doc", "description": "get the swagger" } }, "/status": { "get": { "summary": "get api status", "tags": [ "Miscellaneous" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } } }, "400": { "description": "Bad Request\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "405": { "description": "Method Not Allowed\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-status", "description": "get the API status" } }, "/version": { "get": { "summary": "get api version", "tags": [ "Miscellaneous" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/version" } } } }, "400": { "description": "Bad Request\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "405": { "description": "Method Not Allowed\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } }, "operationId": "get-version", "description": "get the API version" } }, "/me": { "get": { "summary": "get user information", "tags": [ "Miscellaneous" ], "description": "This endpoint provides information on the connected user.", "operationId": "get-me", "parameters": [ { "$ref": "#/components/parameters/x-api-key" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ME" } } } }, "400": { "description": "Bad Request\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "401": { "description": "Unauthorized\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "403": { "description": "Forbidden\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "404": { "description": "Not Found\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "405": { "description": "Method Not Allowed\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "500": { "description": "Internal Server Error\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } }, "503": { "description": "Service Unavailable\n\n", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrangeApiError" } } } } } } } }, "components": { "schemas": { "Requests": { "type": "object", "x-examples": { "Example 1": { "id": "3-xxxxxxxx", "customerReference": "#00myCustomerReference", "status": "REJECTED", "step": "ORDER", "subStep": "INITIATION", "isOverdue": false, "isArchived": false, "priority": "", "customer": { "id": "33-xxxxxxxx", "name": "customer name" }, "keyDates": { "requestedAt": "2022-05-14" }, "type": "R_BVPN_FR_1", "properties": { "network": { "id": "5-xxxxxxxxxx" }, "profile": "profile name", "options": {}, "billingAccount": { "code": "xxxxxxxx" }, "location": { "name": "location name", "localCompany": "string", "localCompanyLegalNumber": "xxxxxxxx", "building": "building Name", "residence": "residence Name", "floor": "5", "room": "xxx", "stair": "A", "address": { "street": "street name", "extendedStreet": "", "postalCode": "xxxxx", "city": "city name", "country": "FR" }, "id": "xxxxxxxx" }, "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } } }, "rejectionReasons": [ { "code": 1451, "reason": "rejection reason", "message": "error message" } ], "attachments": [], "createdAt": "2022-04-07T16:12:31.764Z", "updatedAt": "2022-12-09T12:13:01.827Z" } }, "properties": { "id": { "type": "string", "description": "identification number of the request" }, "name": { "type": "string", "description": "Name of the request" }, "customerReference": { "type": "string", "description": "company reference" }, "category": { "type": "string", "description": "type of the request" }, "status": { "type": "string", "description": "status of the request" }, "step": { "type": "string", "description": "state of the request" }, "subStep": { "type": "string", "description": "sub state of the request" }, "isOverdue": { "type": "boolean", "description": "flag indicating if the order is On track or Delayed" }, "isArchived": { "type": "boolean", "description": "status on the delivery of the service" }, "priority": { "type": "string", "description": "priority of the request (not used)" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "company identification number" }, "name": { "type": "string", "description": "company name" } } }, "keyDates": { "$ref": "#/components/schemas/keyDates" }, "type": { "type": "string", "description": "type of the request" }, "properties": { "type": "object", "description": "contains all information depending of the request type", "properties": { "network": { "type": "object", "properties": { "id": { "type": "string", "description": "Orange unique identifier of the Network where the new BVPN site must be assigned" } } }, "profile": { "type": "string", "description": "name of the profile" }, "options": { "type": "object", "description": "additional options added to the request" }, "billingAccount": { "type": "object", "description": "billing account used for the request", "properties": { "code": { "type": "string", "description": "unique identifier of the billing account used for the request" } } }, "location": { "$ref": "#/components/schemas/Location" }, "contacts": { "$ref": "#/components/schemas/Contacts" } } }, "attachments": { "type": "array", "description": "single identifier of the attachment", "items": { "type": "object" } }, "comment": { "type": "string", "description": "additional information on the request" }, "createdAt": { "type": "string", "description": "creation date of the item for efficient data synchronization. There is no Business meaning" }, "updatedAt": { "type": "string", "description": "last update of the item for efficient data synchronization. There is no Business meaning" } } }, "deleteBVPNAutomatic": { "title": "deleteBVPNAutomatic", "description": "automatic delete business VPN request", "allOf": [ { "$ref": "#/components/schemas/MainRequest" }, { "type": "object", "properties": { "type": { "type": "string", "format": "regex", "pattern": "^[CMR]_BVPN_.*$", "example": "R_BVPN_Catalog" } }, "required": [ "type" ] }, { "type": "object", "properties": { "properties": { "type": "object", "description": "request properties", "properties": { "contacts": { "$ref": "#/components/schemas/Contacts" }, "servicePoint": { "$ref": "#/components/schemas/ServicePoint" } }, "required": [ "contacts", "servicePoint" ] } } } ] }, "deleteBVPNGeneric": { "title": "deleteBVPNGeneric", "allOf": [ { "$ref": "#/components/schemas/MainRequest" }, { "type": "object", "properties": { "properties": { "type": "object", "required": [ "servicePoint" ], "properties": { "contacts": { "$ref": "#/components/schemas/Contacts" }, "servicePoint": { "$ref": "#/components/schemas/ServicePoint" }, "location": { "$ref": "#/components/schemas/Location" } } } }, "required": [ "properties" ] } ] }, "createBvpnAutomatic": { "title": "createBvpnAutomatic", "allOf": [ { "$ref": "#/components/schemas/MainRequest" }, { "type": "object", "properties": { "type": { "type": "string", "format": "regex", "pattern": "^[CMR]_BVPN_.*$", "example": "C_BVPN_Catalog" } }, "required": [ "type" ] }, { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/requestProperties" }, { "type": "object", "properties": { "network": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Orange unique identifier of the Network where the new BVPN site must be assigned" } } }, "location": { "$ref": "#/components/schemas/Location" } }, "required": [ "network", "location" ] } ] } } } ] }, "createRequestsGeneric": { "description": "", "required": [ "type", "requestedAt", "attachments", "contract", "properties" ], "type": "object", "properties": { "type": { "type": "string", "example": "C_generique_S0" }, "requestedAt": { "description": "date when you want the request to be executed (at least today's date + 7)", "type": "string", "format": "date" }, "customerReference": { "description": "the Reference that the Customer want to associate to this request (maximum 18 characters)", "type": "string" }, "contract": { "description": "contract Number, often used for also routing the request to the right ADV team (maximum 10 characters)", "type": "string" }, "comment": { "description": "Additional information on the request", "type": "string" }, "attachments": { "description": "attachments information to add to the request", "type": "array", "items": { "required": [ "name", "body" ], "type": "object", "properties": { "name": { "type": "string", "description": "attachment name", "example": "attachment_name" }, "body": { "type": "string", "description": "attachments body in base64Binary", "example": "YXR0YWNobWVudA==" } } } }, "properties": { "oneOf": [ { "description": "", "required": [ "location", "contacts", "options", "installationPlannedAt" ], "type": "object", "properties": { "billingAccount": { "description": "Billing account", "type": "object", "properties": { "code": { "description": "unique identifier of the billing account used for the request", "type": "string" } } }, "location": { "description": "location", "required": [ "address", "localCompany" ], "type": "object", "properties": { "name": { "description": "Name of the location where the service must be installed", "type": "string", "maxLength": 20 }, "localCompany": { "description": "Name of the Local Company", "type": "string" }, "localCompanyLegalNumber": { "description": "Number of the Local Company corresponding to the SIREN", "type": "string" }, "address": { "description": "", "type": "object", "required": [ "street", "postalCode", "city" ], "properties": { "street": { "description": "Main street information", "type": "string" }, "extendedStreet": { "description": "Complementary information allowing to facilitate the elligibily of the Offer", "type": "string" }, "postalCode": { "description": "Postal Code of the Location. For France, must be a 5 digits number", "type": "string" }, "city": { "description": "Name of the City", "type": "string" } } }, "floor": { "description": "Floor number of the location not to exceed 3 characters", "type": "string" }, "room": { "description": "Room number of the location", "type": "string" }, "stair": { "description": "information on the Staircase not to exceed 2 characters", "type": "string" } } }, "contacts": { "description": "site contacts", "required": [ "primary" ], "type": "object", "properties": { "primary": { "description": "site contacts", "required": [ "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "mobile number of the contact", "type": "string" } } }, "secondary": { "description": "site contacts", "required": [ "title", "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact", "type": "string" } } } } }, "options": { "description": "Available options", "required": [ "domain" ], "type": "object", "properties": { "domain": { "description": "domain", "type": "string", "enum": [ "data_managee", "voix", "internet", "convergnetes", "internationnal", "mandat_retour", "domaine_contact", "autre", "contact", "voix_sur_ip", "business_ethernet", "open_videopresence_advanced", "flexible_internet", "flexible360_tenant_management", "flexible360_direct", "audio_and_web_conferencing", "voix_ip_ao6_bvb", "API" ] } } }, "installationPlannedAt": { "description": "date of availability of the premises, must be prior to the \"requested at\" date", "type": "string", "format": "date" }, "productName": { "description": "Product name", "type": "string" }, "complement": { "description": "Complement", "type": "string" } } }, { "description": "", "required": [ "location", "contacts", "options", "installationPlannedAt", "commercialFirstName", "commercialLastName" ], "type": "object", "properties": { "billingAccount": { "description": "Billing account", "type": "object", "properties": { "id": { "description": "Billing Account Number for invoicing the service", "type": "string" }, "code": { "description": "Sub Billing Account Number for invoicing the service", "type": "string" } }, "oneOf": [ { "required": [ "id" ] }, { "required": [ "code" ] } ] }, "location": { "description": "location", "required": [ "address", "localCompany" ], "type": "object", "properties": { "name": { "description": "Name of the location where the service must be installed", "type": "string", "maxLength": 20 }, "localCompany": { "description": "Name of the Local Company", "type": "string" }, "localCompanyLegalNumber": { "description": "Number of the Local Company corresponding to the SIREN", "type": "string" }, "address": { "description": "", "type": "object", "required": [ "street", "postalCode", "city" ], "properties": { "street": { "description": "Main street information", "type": "string" }, "extendedStreet": { "description": "Complementary information allowing to facilitate the elligibily of the Offer", "type": "string" }, "postalCode": { "description": "Postal Code of the Location. For France, must be a 5 digits number", "type": "string" }, "city": { "description": "Name of the City", "type": "string" } } }, "floor": { "description": "Floor number of the location not to exceed 3 characters", "type": "string" }, "room": { "description": "Room number of the location", "type": "string" }, "stair": { "description": "information on the Staircase not to exceed 2 characters", "type": "string" } } }, "contacts": { "description": "site contacts", "required": [ "primary" ], "type": "object", "properties": { "primary": { "description": "site contacts", "required": [ "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact", "type": "string" } } }, "secondary": { "description": "site contacts", "required": [ "title", "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact", "type": "string" } } } } }, "options": { "description": "Available options", "required": [ "domain", "offer" ], "type": "object", "properties": { "domain": { "description": "domain", "type": "string", "enum": [ "data_support" ] }, "offer": { "description": "domain", "type": "string", "enum": [ "business_ethernet_serie2", "local_ethernet", "raccordement_securise", "acces_FIA", "liaison_loue_analogique", "liaison_loue_analogique_ineternationnale", "intersan", "VPN_HD", "BVPN_integrated_access", "BU_internet_integrated_access", "DS_collect_IP" ] } } }, "installationPlannedAt": { "description": "date of availability of the premises, must be prior to the \"requested at\" date", "type": "string", "format": "date" }, "productName": { "description": "Product name", "type": "string" }, "complement": { "description": "Complement", "type": "string" }, "commercialFirstName": { "description": "Commercial first name", "type": "string" }, "commercialLastName": { "description": "Commercial last name", "type": "string" } } } ] } } }, "modifyRequestsGeneric": { "required": [ "type", "requestedAt", "attachments", "contract", "properties" ], "type": "object", "properties": { "type": { "type": "string", "example": "M_generique_S0" }, "requestedAt": { "description": "date when you want the request to be executed (at least today's date + 7)", "type": "string", "format": "date" }, "customerReference": { "description": "the Reference that the Customer want to associate to this request (maximum 18 characters)", "type": "string" }, "contract": { "description": "contract Number, often used for also routing the request to the right ADV team (maximum 10 characters)", "type": "string" }, "comment": { "description": "Additional information on the request", "type": "string" }, "attachments": { "description": "attachments information to add to the request", "type": "array", "items": { "required": [ "name", "body" ], "type": "object", "properties": { "name": { "type": "string", "description": "attachment name", "example": "attachment_name" }, "body": { "type": "string", "description": "attachments body in base64Binary", "example": "YXR0YWNobWVudA==" } } } }, "properties": { "description": "", "required": [ "options", "installationNumber" ], "type": "object", "properties": { "contacts": { "description": "site contacts", "required": [ "primary" ], "type": "object", "properties": { "primary": { "description": "site contacts", "required": [ "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact. It has to start with either '06' or '07'.", "type": "string" } } }, "secondary": { "description": "site contacts", "required": [ "title", "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact. It has to start with either '06' or '07'.", "type": "string" } } } } }, "options": { "description": "Available options", "required": [ "domain" ], "type": "object", "properties": { "domain": { "description": "domain", "type": "string", "enum": [ "data_managee", "data_support", "voix", "voix_sur_IP", "internet", "business_internet", "convergnetes", "internationnal", "contact", "videopresence_Advanced", "flexible_internet", "management", "routing_easy", "meetings", "ao6_bvb", "autre" ] } } }, "productName": { "description": "Product name", "type": "string" }, "complement": { "description": "Complement", "type": "string" }, "installationNumber": { "description": "installation number (maximum 14 characters)", "type": "string" } } } } }, "cancelRequestsGeneric": { "required": [ "type", "attachments", "contract", "properties" ], "type": "object", "properties": { "type": { "type": "string", "example": "A_generique_S0" }, "customerReference": { "description": "the Reference that the Customer want to associate to this request (maximum 18 characters)", "type": "string" }, "contract": { "description": "contract Number, often used for also routing the request to the right ADV team (maximum 10 characters)", "type": "string" }, "comment": { "description": "Additional information on the request", "type": "string" }, "attachments": { "description": "attachments information to add to the request", "type": "array", "items": { "required": [ "name", "body" ], "type": "object", "properties": { "name": { "type": "string", "description": "attachment name", "example": "attachment_name" }, "body": { "type": "string", "description": "attachments body in base64Binary", "example": "YXR0YWNobWVudA==" } } } }, "properties": { "description": "", "required": [ "requestId" ], "type": "object", "properties": { "contacts": { "description": "site contacts", "type": "object", "properties": { "primary": { "description": "site contacts", "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact starting with 06 or 07", "type": "string" } } }, "secondary": { "description": "site contacts", "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact", "type": "string" } } } } }, "requestId": { "description": "Request ID to be cancelled (It has to start with \"W” and have 11 characters in total, or with \"3-” and have 10 characters in total)", "type": "string" }, "productName": { "description": "Product name", "type": "string" }, "complement": { "description": "Complement", "type": "string" } } } } }, "deleteRequestsGeneric": { "required": [ "type", "requestedAt", "attachments", "contract", "properties" ], "type": "object", "properties": { "type": { "type": "string", "example": "R_generique_S0" }, "requestedAt": { "description": "date when you want the request to be executed (at least today's date + 7)", "type": "string", "format": "date" }, "customerReference": { "description": "the Reference that the Customer want to associate to this request (maximum 18 characters)", "type": "string" }, "contract": { "description": "contract Number, often used for also routing the request to the right ADV team (maximum 10 characters)", "type": "string" }, "comment": { "description": "Additional information on the request", "type": "string" }, "attachments": { "description": "attachments information to add to the request", "type": "array", "items": { "required": [ "name", "body" ], "type": "object", "properties": { "name": { "type": "string", "description": "attachment name", "example": "attachment_name" }, "body": { "type": "string", "description": "attachments body in base64Binary", "example": "YXR0YWNobWVudA==" } } } }, "properties": { "description": "", "required": [ "options", "installationNumber" ], "type": "object", "properties": { "contacts": { "description": "site contacts", "required": [ "primary" ], "type": "object", "properties": { "primary": { "description": "site contacts", "required": [ "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact. It has to start with either '06' or '07'.", "type": "string" } } }, "secondary": { "description": "site contacts", "required": [ "title", "firstName", "lastName", "email", "phone", "mobile" ], "type": "object", "properties": { "title": { "description": "contact title", "type": "string", "enum": [ "Mr", "Mrs" ] }, "firstName": { "description": "First Name", "type": "string" }, "lastName": { "description": "Last Name", "type": "string" }, "email": { "description": "Email of the contact", "type": "string" }, "phone": { "description": "Phone number of the contact", "type": "string" }, "mobile": { "description": "Mobile number of the contact", "type": "string" } } } } }, "options": { "description": "Available options", "required": [ "domain" ], "type": "object", "properties": { "domain": { "description": "domain", "type": "string", "enum": [ "data_managee", "data_support", "voix", "voix_sur_IP", "internet", "business_internet", "convergnetes", "internationnal", "contact", "videopresence_Advanced", "flexible_internet", "management", "routing_easy", "meetings", "ao6_bvb", "autre" ] } } }, "productName": { "description": "Product name", "type": "string" }, "complement": { "description": "Complement", "type": "string" }, "installationNumber": { "description": "installation number (maximum 14 characters)", "type": "string" } } } } }, "modifyBvpnAutomatic": { "title": "modifyBvpnAutomatic", "allOf": [ { "$ref": "#/components/schemas/MainRequest" }, { "type": "object", "properties": { "type": { "type": "string", "format": "regex", "pattern": "^[CMR]_BVPN_.*$", "example": "M_BVPN_Catalog" } }, "required": [ "type" ] }, { "type": "object", "properties": { "properties": { "allOf": [ { "type": "object", "properties": { "servicePoint": { "$ref": "#/components/schemas/ServicePoint" } }, "required": [ "servicePoint" ] }, { "$ref": "#/components/schemas/requestProperties" } ] } } } ] }, "ServicePoint": { "title": "ServicePointReferences", "oneOf": [ { "$ref": "#/components/schemas/servicePointById" }, { "$ref": "#/components/schemas/servicePointByCustomerReference" }, { "$ref": "#/components/schemas/servicePointByReference" } ], "additionalProperties": true }, "Contacts": { "type": "object", "x-examples": { "Example 1": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" }, "secondary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } } }, "description": "site contacts", "properties": { "primary": { "type": "object", "description": "primary contact", "required": [ "email", "firstName", "lastName", "mobile", "phone", "title" ], "properties": { "email": { "type": "string", "description": "email of the contact", "format": "email" }, "firstName": { "type": "string", "description": "first Name of the contact" }, "lastName": { "type": "string", "description": "last Name of the contact" }, "mobile": { "type": "string", "description": "mobile number of the contact.\nIt has to start with either '06' or '07'." }, "phone": { "type": "string", "description": "phone number of the contact.\nIt has to start with either '01', '02', '03', '04', '05', or '09'." }, "title": { "type": "string", "enum": [ "Mr", "Mrs" ], "example": "Mr" } } }, "secondary": { "type": "object", "description": "secondary contact", "properties": { "email": { "type": "string", "description": "email of the contact", "format": "email" }, "firstName": { "type": "string", "description": "first Name of the contact" }, "lastName": { "type": "string", "description": "last Name of the contact" }, "mobile": { "type": "string", "description": "mobile number of the contact.\nIt has to start with either '06' or '07'." }, "phone": { "type": "string", "description": "phone number of the contact.\nIt has to start with either '01', '02', '03', '04', '05', or '09'." }, "title": { "type": "string", "enum": [ "Mr", "Mrs" ] } } } }, "required": [ "primary" ] }, "Location": { "type": "object", "x-examples": { "Example 1": { "name": "location name", "localCompany": "string", "localCompanyLegalNumber": "xxxxxxxx", "building": "building Name", "residence": "residence Name", "floor": "5", "room": "xxx", "stair": "A", "address": { "street": "street name", "extendedStreet": "", "postalCode": "xxxxx", "city": "city name", "country": "FR" }, "id": "xxxxxxxx" } }, "properties": { "name": { "type": "string", "description": "location name" }, "customerReference": { "type": "string", "readOnly": true }, "localCompany": { "type": "string", "description": "name of the local company. It is not the Customer Account" }, "localCompanyLegalNumber": { "type": "string", "description": "number of the Local Company corresponding to the SIREN" }, "building": { "type": "string", "description": "building name" }, "residence": { "type": "string", "description": "residence Name" }, "floor": { "type": "string", "description": "floor number of the location not to exceed 3 characters" }, "room": { "type": "string", "description": "room number" }, "stair": { "type": "string", "description": "information on the Staircase not to exceed 2 characters" }, "buildingCode": { "type": "string", "description": "building code number" }, "address": { "type": "object", "description": "information on the address", "required": [ "street", "postalCode", "city" ], "properties": { "street": { "type": "string", "description": "name of the street" }, "extendedStreet": { "type": "string", "description": "additional information on the street" }, "postalCode": { "type": "string", "description": "postalCode (ZipCode) of the address" }, "city": { "type": "string", "description": "city or town of the address" }, "country": { "type": "string", "description": "code of the country" } } }, "id": { "type": "string", "description": "location identification number", "readOnly": true } }, "required": [ "address" ] }, "RejectionReasons": { "type": "object", "properties": { "code": { "type": "integer", "description": "code of the rejection reason" }, "reason": { "type": "string", "description": "rejection reason" }, "message": { "type": "string", "description": "explanation of the rejection reason" } }, "x-examples": { "Example 1": { "code": 1451, "reason": "rejection reason", "message": "error message" } } }, "OrangeApiError": { "description": "See [Orange recommendation](https://recommendations.innov.intraorange/designing-orange-api/#error-format)", "required": [ "code", "message" ], "type": "object", "properties": { "code": { "description": "An integer coding the error type. This is given to caller so he can translate them if required.", "type": "integer", "format": "int32" }, "message": { "description": "A short localized string that describes the error.", "type": "string" }, "description": { "description": "(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.", "type": "string" }, "infoURL": { "description": "(optional) A URL to online documentation that provides more information about the error.", "type": "string" } } }, "CatalogItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Single Identifier of the Catalog Item" }, "name": { "type": "string", "description": "Name of the catalog item" }, "segment": { "type": "string", "description": "market scope: 'fr' or 'intl'" }, "type": { "type": "string", "description": "order" }, "catalog": { "type": "object", "properties": { "id": { "type": "string", "description": "Single Identifier of the Catalog" }, "name": { "type": "string", "description": "Name of the catalog" }, "description": { "type": "string", "description": "Overview of the catalog" } } }, "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Schema of the request" }, "discriminator": { "type": "string", "description": "discriminator of the schema" }, "required": { "type": "array", "description": "parameters required", "items": { "type": "string" } }, "type": { "type": "string" }, "properties": { "type": "object", "properties": { "requestedAt": { "type": "object", "properties": { "description": { "type": "string", "description": "date when you want the request to be executed" }, "type": { "type": "string" }, "format": { "type": "string", "description": "date" } } }, "type": { "type": "object", "properties": { "description": { "type": "string", "description": "type of the request" }, "type": { "type": "string" } } }, "customerReference": { "type": "object", "properties": { "description": { "type": "string", "description": "customer reference to identify the order in your system" }, "type": { "type": "string" } } }, "contract": { "type": "object", "properties": { "description": { "type": "string", "description": "contract Number, often used for also routing the request to the right ADV team" }, "type": { "type": "string" } } }, "comment": { "type": "object", "properties": { "description": { "type": "string", "description": "additional information on the request" }, "type": { "type": "string" } } }, "properties": { "type": "object", "properties": { "description": { "type": "string", "description": "properties of the request" }, "required": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } } } } } }, "createdAt": { "type": "string", "description": "Creation date of the item in Orange Database" }, "updatedAt": { "type": "string", "description": "Date of the last update of the item" } } }, "status": { "title": "status", "type": "object", "properties": { "name": { "type": "string", "description": "API name" }, "status": { "type": "string", "enum": [ "ok", "ko" ], "description": "API status" }, "version": { "type": "string", "description": "API version" } } }, "version": { "title": "version", "type": "object", "properties": { "version": { "type": "object", "properties": { "major": { "type": "string", "description": "API major version number" }, "minor": { "type": "string", "description": "API minor version number" }, "patch": { "type": "string", "description": "API patch version number" } } }, "deprecated": { "type": "boolean", "description": "deprecated information of the version:true or false" } } }, "doc": { "title": "doc", "type": "object" }, "MainRequest": { "title": "MainRequest", "type": "object", "properties": { "requestedAt": { "type": "string", "description": "date when you want the request to be executed", "format": "date", "writeOnly": true }, "comment": { "type": "string", "description": "Additional information on the request" }, "contract": { "type": "string", "description": "contract Number, often used for also routing the request to the right ADV team" }, "customerReference": { "type": "string", "description": "the Reference that the Customer want to associate to this request (maximum 18 characters)" } }, "required": [ "requestedAt", "customerReference" ] }, "servicePointById": { "title": "servicePointById", "type": "object", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the Service Point. This information can be found in the API Core Information in the resource servicePoints..", "example": "5-xxxxxxxx" } }, "required": [ "id" ] }, "servicePointByCustomerReference": { "title": "servicePointByCustomerReference", "type": "object", "properties": { "customerReference": { "type": "string", "example": "xxxxxxxxxxx", "description": "Customer reference identifying the service point" } }, "required": [ "customerReference" ] }, "servicePointByReference": { "title": "servicePointByReference", "type": "object", "properties": { "reference": { "type": "string", "example": "xxxxxxxxxx", "description": "Commercial Reference of the service point" } }, "required": [ "reference" ] }, "requestProperties": { "type": "object", "x-examples": { "Example 1": { "profile": "profileDefinedInCatalog", "network": { "id": "yourVPNref" }, "billingAccount": { "code": "billingAccountNumber" }, "contacts": { "primary": { "email": "myemail@operateur.com", "firstName": " first", "lastName": " last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "location": { "address": { "city": " siteAddressCity", "postalCode": " sitePostalCode ", "street": "siteAddressStreet" }, "name": "siteName" }, "options": { "bandwidth": "bandwidthDefinedInCatalog", "catalog option 1": true } } }, "properties": { "profile": { "type": "string", "description": "name of the profile" }, "billingAccount": { "type": "object", "description": "name of the profile", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "unique identifier of the billing account used for the request" } } }, "contacts": { "$ref": "#/components/schemas/Contacts" }, "options": { "type": "object", "description": "catalog options defined in catalog" } }, "required": [ "profile", "billingAccount", "contacts", "options" ] }, "keyDates": { "title": "keyDates", "type": "object", "description": "contains all dates about the request", "properties": { "issuedAt": { "type": "string", "description": "date when the request was issued", "readOnly": true }, "requestedAt": { "type": "string", "description": "date when you want the request to be executed", "readOnly": true }, "expectedInstallationAt": { "type": "string", "description": "installation date expected", "readOnly": true }, "expectedAt": { "type": "string", "description": "date when the request was expected", "readOnly": true }, "completedAt": { "type": "string", "description": "date when the request was completed", "readOnly": true } } }, "ME": { "title": "Me", "type": "object", "description": "Information on the connected user and the API Key.", "properties": { "id": { "type": "string", "description": "Single Identifier of the API key." }, "login": { "type": "string", "description": "Login of the associated user." }, "name": { "type": "string", "description": "Name of the associated user." }, "phone": { "type": "string", "description": "Phone number of the associated user." }, "mobile": { "type": "string", "description": "Mobile number of the associated user." }, "email": { "type": "string", "description": "Email address of the associated user." }, "application": { "type": "object", "description": "Application identifier in Orange Developer Portal.", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the application in the Orange Developer Portal." }, "name": { "type": "string", "description": "Name of the application in Orange Developer Portal." } } }, "apiKey": { "type": "object", "description": "Token identifier associated to the API Key.", "properties": { "id": { "type": "string", "description": "Orange Single Identifier of the API KEY." }, "status": { "type": "string", "description": "status of the api key" }, "scopes": { "type": "string", "description": "Scopes defined for the API Key for Machine to Machine connection, or negotiated scopes for User to Machine connection." }, "type": { "type": "string", "description": "Type of the environment (Sandbox or Production).", "enum": [ "SANDBOX", "PRODUCTION" ] }, "createdAt": { "type": "string", "format": "date-time", "description": "Date of the creation of the API Key." }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update date of the API Key." }, "expireAt": { "type": "string", "description": "Date of the expiration of the API Key." } } }, "createdAt": { "type": "string", "description": "Date of the creation of the User Account." }, "updatedAt": { "type": "string", "description": "Last update date of the User Account." } } } }, "securitySchemes": { "token": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "", "refreshUrl": "", "scopes": {} } } } }, "parameters": { "sort": { "name": "sort", "in": "query", "description": "sort the output ascending or descending", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "description": "sort the output ascending or descending for a given property", "type": "string", "example": "-createdAt" } } }, "offset": { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "offset" }, "limit": { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 25 }, "description": "limit" }, "fields": { "name": "fields", "in": "query", "description": "fields", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "description": "the name of the field to appear in the result", "type": "string" } } }, "id": { "name": "id", "in": "query", "required": false, "schema": { "type": "string" }, "description": "id" }, "status": { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "status" }, "type": { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "type" }, "customerReference": { "name": "customerReference", "in": "query", "required": false, "schema": { "type": "string" }, "description": "customerReference" }, "keyDates.requestedAt": { "name": "keyDates.requestedAt", "in": "query", "required": false, "schema": { "type": "string" }, "description": "keyDates.requestedAt" }, "priority": { "name": "priority", "in": "query", "required": false, "schema": { "type": "string" }, "description": "priority" }, "isOverdue": { "name": "isOverdue", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "is overdue" }, "isArchived": { "name": "isArchived", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "for archived" }, "groupBy": { "name": "groupBy", "in": "query", "required": true, "style": "form", "explode": false, "schema": { "type": "array", "items": { "description": "Field to groupBy with", "type": "string" } }, "description": "for aggregate use" }, "x-api-key": { "name": "X-API-KEY", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API Key required for using Orange Business Services API." }, "displayNulls": { "name": "displayNulls", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "display nulls" }, "displayLinks": { "name": "displayLinks", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "display links" }, "createdAt": { "name": "createdAt", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "creation date" }, "updatedAt": { "name": "updatedAt", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "update date" } }, "examples": { "delete-BVPN-Automatic": { "value": { "requestedAt": "2023-12-15", "type": "R_BVPN_Catalog", "comment": "my creation", "contract": "xx number of contract xx", "customerReference": "#00myCustomerReference", "properties": { "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" }, "secondary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "servicePoint": { "id": "5-xxxxxxxxxx" } } } }, "create-BVPN-Automatic": { "value": { "requestedAt": "2023-12-15", "type": "C_BVPN_Catalog", "contract": "xxxmycontractnumber", "customerReference": "# mycustomerreference ", "properties": { "profile": "profiledefinedincatalog", "network": { "id": "yourVPNref" }, "billingAccount": { "code": "billlingaccountnumber" }, "contacts": { "primary": { "email": "myemail@operateur.com", "firstName": " first", "lastName": " last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "location": { "address": { "city": " siteadresscity", "postalCode": " sitepostalcode ", "street": "siteadressstreet" }, "name": "sitename" }, "options": { "bandwidth": "bandwidthdefinedincatalog", "catalog option 1": true } } } }, "modify-BVPN-Automatic": { "value": { "requestedAt": "2023-12-15", "type": "M_BVPN_Catalog", "contract": " xxxmycontractnumber ", "customerReference": " mycustomerreference ", "properties": { "servicePoint": { "id": "idofyourservicepoint" }, "profile": " profiledefinedincatalog ", "billingAccount": { "code": " billlingaccountnumber " }, "contacts": { "primary": { "email": "myemail@operateur.com", "firstName": " first", "lastName": " last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" }, "secondary": { "email": "myemail2@operateur.com", "firstName": " first2", "lastName": " last2", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "options": {} } } }, "delete-BVPN-Generic": { "value": { "requestedAt": "2023-12-15", "type": "R_BVPN_S1", "comment": "my termination", "contract": "xxnumber of contractxx", "customerReference": "#00mycustomerreference", "properties": { "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" }, "secondary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "servicePoint": { "id": "5-xxxxxxxxxx" } } } }, "delete-Generic": { "value": { "requestedAt": "2024-09-09", "type": "R_generique_S0", "comment": "my comment", "contract": "xxnumber of contractxx", "customerReference": "00mycustomerreference", "attachments": [ { "name": "name_file", "body": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ], "properties": { "options": { "domain": "domain" }, "productName": "product_name", "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "installationNumber": "XXXXXXXXX" } } }, "create-Generic": { "value": { "requestedAt": "2024-08-23", "type": "C_generique_S0", "contract": "xxxmycontractnumber", "customerReference": "mycustomerreference", "attachments": [ { "name": "name_file", "body": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ], "properties": { "billingAccount": { "code": "billlingaccountnumber" }, "options": { "domain": "domain" }, "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "0xxxxxxxxx", "phone": "0xxxxxxxxx" } }, "location": { "address": { "city": "siteadresscity", "postalCode": "sitepostalcode", "street": "siteadressstreet" }, "localCompany": "name_on_door" }, "installationPlannedAt": "2024-08-22" } } }, "modify-Generic": { "value": { "requestedAt": "2024-09-09", "type": "M_generique_S0", "comment": "my comment", "contract": "xxxmycontractnumber", "customerReference": "mycustomerreference", "attachments": [ { "name": "file_creation_1", "body": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ], "properties": { "options": { "domain": "domain" }, "productName": "product_name", "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "installationNumber": "XXXXXXXXX" } } }, "cancellation-Generic": { "value": { "type": "A_generique_S0", "comment": "my comment", "contract": "xxxmycontractnumber", "customerReference": "mycustomerreference", "attachments": [ { "name": "name_file", "body": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ], "properties": { "options": { "domain": "domain" }, "productName": "product_name", "contacts": { "primary": { "email": "myemail@operator.com", "firstName": "first", "lastName": "last", "mobile": "06xxxxxxxx", "phone": "01xxxxxxxx", "title": "Mr" } }, "requestId": "Wxxxxxxxxxx" } } } } } }