{ "swagger": "2.0", "info": { "description": "MEF Sonata API for Orange EVPL", "title": "EVPL", "version": "1", "contact": {} }, "host": "ope-obs.apibackbone.orange.com", "basePath": "/internationalcarriers/mefApi/sonata", "tags": [{ "name": "Geographic Address Management", "description": "This API allows to retrieve address information including exact formats, for addresses known to Orange IC" }, { "name": "Geographic Site Management", "description": "This API allows to retrieve a list of Geographic site and to get all information for one geographic site" }, { "name": "Product Offering Qualification Management", "description": "This API allows to check whether a product or set of products could be delivered" }, { "name": "Quote Management", "description": "This API allows to request a quote for the installation of one or more of the Product Offerings or for an action to be performed on an existing Product" }, { "name": "Product Order Management", "description": "This API provides the complete set of use cases needed to support the ordering of product" }, { "name": "Product Inventory Management", "description": "This provides the ability to retrieve a set of product instances based upon a filter of product inventory attributes, or a specific product instance based upon a product" } ], "paths": { "/geographicAddressManagement/v1/geographicAddress/{id}": { "get": { "tags": ["Geographic Address Management"], "summary": "get", "operationId": "getUsingGET", "produces": ["*/*"], "parameters": [{ "name": "buyerId", "in": "query", "description": "The unique identifier of the organization that is acting as the a Buyer.", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" }, { "name": "sellerId", "in": "query", "description": "The unique identifier of the organization that is acting as the Seller.", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeographicAddress" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/geographicAddressManagement/v1/geographicAddressValidation": { "post": { "tags": ["Geographic Address Management"], "summary": "geographicAddressValidation", "operationId": "geographicAddressValidationUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "name": "buyerId", "in": "query", "description": "The unique identifier of the organization that is acting as the a Buyer.", "required": false, "type": "string", "allowEmptyValue": false }, { "in": "body", "name": "geographicAddressValidationCreate", "description": "geographicAddressValidationCreate", "required": true, "schema": { "$ref": "#/definitions/GeographicAddressValidationCreate" } }, { "name": "sellerId", "in": "query", "description": "The unique identifier of the organization that is acting as the Seller.", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeographicAddressValidation" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/geographicSiteManagement/v1/geographicSite": { "get": { "tags": ["Geographic Site Management"], "summary": "find", "operationId": "findUsingGET", "produces": ["*/*"], "parameters": [ { "name": "geographicAddress.city", "in": "query", "description": "City of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicAddress.country", "in": "query", "description": "Country of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicAddress.postcode", "in": "query", "description": "Postcode of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicAddress.streetName", "in": "query", "description": "Street Name of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicAddress.streetNr", "in": "query", "description": "Street Nr of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicAddress.streetType", "in": "query", "description": "Street Type of the geographic site address", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "siteName", "in": "query", "description": "A name commonly used by people to refer to this Service Site.", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "siteType", "in": "query", "description": "This defines whether a Service Site is public or private.", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["public", "private"] }, { "name": "status", "in": "query", "description": "Status of the site", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["planned", "cancelled", "underConstruction", "existing", "former"] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GeographicSiteFindResp" } } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/geographicSiteManagement/v1/geographicSite/{siteId}": { "get": { "tags": ["Geographic Site Management"], "summary": "get", "operationId": "getUsingGET_1", "produces": ["*/*"], "parameters": [{ "name": "siteId", "in": "path", "description": "siteId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeographicSite" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/productInventoryManagement/v1/product": { "get": { "tags": ["Product Inventory Management"], "summary": "find", "operationId": "findUsingGET_1", "produces": ["*/*"], "parameters": [{ "name": "buyerId", "in": "query", "description": "Identifier of the party who role is buyer.", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "geographicalSiteId", "in": "query", "description": "A site identifier which is associated to the product", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "lastUpdateDate.gt", "in": "query", "description": "Minimum date that the last change affecting this ProductRef was complet-ed", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "lastUpdateDate.lt", "in": "query", "description": "Maximum date that the last change affecting this ProductRef was completed", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "productOfferingId", "in": "query", "description": "A reference to a product offering by id", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "productOrderId", "in": "query", "description": "Identifies ProductRef Order(s) associated with the ProductRef", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "productSpecificationId", "in": "query", "description": "A reference to a product spec by id", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "startDate.gt", "in": "query", "description": "Minimum initial install date for the ProductRef", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "startDate.lt", "in": "query", "description": "Maximum initial install date for the ProductRef", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "status", "in": "query", "description": "The status of the product", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["active", "suspended", "activePendingTerminate", "terminated", "pendingActive", "suspendedPendingTerminate"] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductInventoryFindResp" } } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/productInventoryManagement/v1/product/{productId}": { "get": { "tags": ["Product Inventory Management"], "summary": "get", "operationId": "getUsingGET_2", "produces": ["*/*"], "parameters": [{ "name": "productId", "in": "path", "description": "ProductRef ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductInventoryGetResp" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/productOfferingQualificationManagement/v1/productOfferingQualification": { "post": { "tags": ["Product Offering Qualification Management"], "summary": "productOfferingQualificationCreate", "operationId": "productOfferingQualificationCreateUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "poqCreate", "description": "poqCreate", "required": true, "schema": { "$ref": "#/definitions/ProductOfferingQualificationCreate" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ProductOfferingQualification" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "422": { "description": "Supported error codes: \n100: Enumeration value is unknown\n101: A relatedParty with a role 'buyer' must be provided at root level\n102: ProductOffering Identifier is unknown\n103: ProductRef Specification Identifier is unknown\n104: Product identifier not existing in inventory\n105: The place informations are invalid\n106: At least a productOffering Id or a product.id or a productSpec.id must be provided in item\n107: Provided date is invalid\n108: The item list is ill-formed or some items provided are invalid\n109: Missing item\n110: Invalid number of items\n111: Item identifier is invalid\n112: Item/Product relationship is invalid\n113: Product id is required for all actions other than 'add'\n114: All items must have action 'add'\n115: The currency is not valid for this product\n116: Type Identifier is unknown\n117: Address is invalid\n118: No pricing found\n119: Modification operation on UNI connectivity is not allowed\n120: ENNI cannot be in the same country as the UNI\n121: currency is not available.", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/productOrderManagement/v1/productOrder": { "get": { "tags": ["Product Order Management"], "summary": "find", "operationId": "findUsingGET_2", "produces": ["*/*"], "parameters": [{ "name": "buyerRequestDate.gt", "in": "query", "description": "Minimum buyer order creation date. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "buyerRequestDate.lt", "in": "query", "description": "Maximum buyer order creation date. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "completionDate.gt", "in": "query", "description": "Minimum date when the order was completed. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "completionDate.lt", "in": "query", "description": "Maximum date when the order was completed. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "expectedCompletionDate.gt", "in": "query", "description": "Minimum expected delivery date amended by the provider", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "expectedCompletionDate.lt", "in": "query", "description": "Maximum expected delivery date amended by the provider", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "externalId", "in": "query", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards.", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "orderDate.gt", "in": "query", "description": "Minimum date when the order was created by seller. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "orderDate.lt", "in": "query", "description": "Maximum date when the order was created by seller. Format is YYYY-MM-DDThh:mmTZD", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "projectId", "in": "query", "description": "This value MAY be assigned by the Buyer/Seller to identify a project the quoting request is associated with", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "requestedCompletionDate.gt", "in": "query", "description": "Minimum buyer's desired due date (requested delivery date)", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "requestedCompletionDate.lt", "in": "query", "description": "Maximum buyer's desired due date (requested delivery date)", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "state", "in": "query", "description": "state", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["pending", "inProgress", "completed"] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductOrderSummary" } } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false }, "post": { "tags": ["Product Order Management"], "summary": "postProductOrder", "operationId": "postProductOrderUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "productOrderCreate", "description": "productOrderCreate", "required": true, "schema": { "$ref": "#/definitions/ProductOrderCreate" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ProductOrder" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "422": { "description": "Supported error codes: \n100: Enumeration value is unknown\n101: A relatedParty with a role 'buyer' must be provided at root level\n101: Missing Buyer at order level\n102: ProductOffering Identifier is unknown\n103: ProductRef Specification Identifier is unknown\n104: Product identifier not existing in inventory\n105: The place informations are invalid\n106: At least a productOffering Id or a product.id or a productSpec.id must be provided in item\n107: Provided date is invalid\n108: The item list is ill-formed or some items provided are invalid\n109: Missing item\n110: Invalid number of items\n111: Item identifier is invalid\n112: Item/Product relationship is invalid\n113: Product id is required for all actions other than 'add'\n114: All items must have action 'add'\n115: The currency is not valid for this product\n116: Type Identifier is unknown\n117: Address is invalid\n118: No pricing found\n119: Modification operation on UNI connectivity is not allowed\n120: ENNI cannot be in the same country as the UNI\n121: currency is not available.\n302: Product status does not allow this operation\n303: Commercial operation not authorized with current contract term.\n304: Incomplete product configuration provided\n304: The desired bandwidth is not specified\n306: Provided interface(s) not related to the connectivity\n404: Missing Buyer Commercial Contact at order level\n405: Missing Buyer Technical contact at order level\n410: Referred quote cannot be used for ordering due to its status\n411: Billing Account information must not be both at order level and order item level\n413: Referred Serviceability request is expired\n415: Referred Offer is not existing\n420: Missing Billing Contact information\n421: Missing Buyer Fault Contact at order level\n422: Missing mandatory attribute(s) for commercial contact\n422: For a UNI product the minimum term is 1 year\n423: Missing mandatory attribute(s) for technical contact\n424: Missing mandatory attribute(s) for fault contact\n425: Missing mandatory attribute(s) for billing contact\n426: Commercial operation not authorized\n429: Invalid requestedCompletionDate provided (in the past)\n429: Invalid requestedCompletionDate provided (more than 30 days in the future)\n429: UNI id corresponds to an ENNI, please provide requestedCompletionDate between 5 and 30 days in the future\n429: Invalid requestedCompletionDate provided (must be in 5 and 30 days in the future)\n429: Invalid requestedCompletionDate provided (must be in 60 and 90 days in the future)\n434: Product ordered did not reflect referenced quote\n435: Missing Signatory Contact at order level\n436: Missing mandatory attribute(s) for signatory contact\n437: Missing mandatory attribute(s) for buyer contact", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/productOrderManagement/v1/productOrder/{productOrderId}": { "get": { "tags": ["Product Order Management"], "summary": "get", "operationId": "getUsingGET_3", "produces": ["*/*"], "parameters": [{ "name": "productOrderId", "in": "path", "description": "Product Order ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductOrder" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/quoteManagement/v1/quote": { "get": { "tags": ["Quote Management"], "summary": "find", "operationId": "findUsingGET_3", "produces": ["*/*"], "parameters": [{ "name": "effectiveQuoteCompletionDate.gt", "in": "query", "description": "Minimum date when the quoted was Cancelled or Rejected or Accepted", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "effectiveQuoteCompletionDate.lt", "in": "query", "description": "Maximum date when the quoted was Cancelled or Rejected or Accepted", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "externalId", "in": "query", "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards.", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response requested by client", "required": false, "type": "integer", "format": "int32", "allowEmptyValue": false }, { "name": "projectId", "in": "query", "description": "This value MAY be assigned by the Buyer/Seller to identify a project the quoting request is associated with", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "quoteDate.gt", "in": "query", "description": "Minimum date when the quote was created", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "quoteDate.lt", "in": "query", "description": "Maximum date when the quote was created", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false }, { "name": "quoteLevel", "in": "query", "description": "quoteLevel", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["budgetary", "indicative", "firm"] }, { "name": "state", "in": "query", "description": "state", "required": false, "type": "string", "allowEmptyValue": false, "enum": ["accepted", "approved", "approvedAnswered", "approvedOrderableAlternate", "cancelled", "cancelledInsufficientInformationProvided", "cancelledUnableToProvide", "inProgress", "inProgressDraft", "rejected", "rejectedExpired", "pending"] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/QuoteSummary" } } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false }, "post": { "tags": ["Quote Management"], "summary": "postQuote", "operationId": "postQuoteUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "quote", "description": "quote", "required": true, "schema": { "$ref": "#/definitions/QuoteCreate" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Quote" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "422": { "description": "Supported error codes: \n100: Enumeration value is unknown\n101: A relatedParty with a role 'buyer' must be provided at root level\n102: ProductOffering Identifier is unknown\n103: ProductRef Specification Identifier is unknown\n104: Product identifier not existing in inventory\n105: The place informations are invalid\n106: At least a productOffering Id or a product.id or a productSpec.id must be provided in item\n107: Provided date is invalid\n108: The item list is ill-formed or some items provided are invalid\n109: Missing item\n110: Invalid number of items\n111: Item identifier is invalid\n112: Item/Product relationship is invalid\n113: Product id is required for all actions other than 'add'\n114: All items must have action 'add'\n115: The currency is not valid for this product\n116: Type Identifier is unknown\n117: Address is invalid\n118: No pricing found\n119: Modification operation on UNI connectivity is not allowed\n120: ENNI cannot be in the same country as the UNI\n121: currency is not available.\n302: Product status does not allow this operation\n303: Commercial operation not authorized with current contract term.\n304: Incomplete product configuration provided\n304: The desired bandwidth is not specified\n306: Provided interface(s) not related to the connectivity", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } }, "/quoteManagement/v1/quote/{id}": { "get": { "tags": ["Quote Management"], "summary": "get", "operationId": "getUsingGET_4", "produces": ["*/*"], "parameters": [{ "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Quote" } }, "400": { "description": "Supported error codes: \n20: Invalid URL parameter\n21: Missing body\n22: Invalid body\n23: Missing body field\n24: Invalid body field\n25: Missing header\n26: Invalid header value\n27: Missing query string parameter value\n28: Invalid query string parameter value\n29: Bad request", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "401": { "description": "Supported error codes: \n40: Missing credentials\n41: Invalid credentials\n42: Expired credentials", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "403": { "description": "Supported error codes: \n69: Forbidden", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "404": { "description": "Supported error codes: \n60: Resource not found", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "405": { "description": "Supported error codes: \n61: Method not allowed", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "406": { "description": "Supported error codes: \n62: Not acceptable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "408": { "description": "Supported error codes: \n63: Request time-out", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "415": { "description": "Supported error codes: \n68: Unsupported media type", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "500": { "description": "Supported error codes: \n1: Internal Error\n70: Something went wrong", "schema": { "$ref": "#/definitions/ErrorRepresentation" } }, "503": { "description": "Supported error codes: \n5: The service is temporarily unavailable", "schema": { "$ref": "#/definitions/ErrorRepresentation" } } }, "deprecated": false } } }, "definitions": { "AccessInterfaceConfiguration": { "title": "AccessInterfaceConfiguration", "allOf": [{ "$ref": "#/definitions/MEFProductConfiguration" }, { "type": "object", "discriminator": "@type", "properties": { "@type": { "type": "string", "enum": ["AccessInterface"] }, "physicalInterface": { "type": "string" }, "router": { "type": "string" } }, "title": "AccessInterfaceConfiguration", "description": "Implements MEFProductConfiguration. Discriminator @type must have value 'AccessInterface'" } ], "description": "Implements MEFProductConfiguration. Discriminator @type must have value 'AccessInterface'" }, "Agreement": { "type": "object", "required": ["id", "name", "path"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" } }, "title": "Agreement" }, "AlternateProductProposal": { "type": "object", "required": ["id"], "properties": { "availableCurrencies": { "type": "array", "items": { "type": "string", "enum": ["EUR", "USD"] } }, "eligibleProductOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "id": { "type": "string", "description": "Identifier of the Product Offering Qualification alternate proposal" }, "installationInterval": { "$ref": "#/definitions/TimeInterval" }, "productConfiguration": { "$ref": "#/definitions/MEFProductConfiguration" }, "productSpecification": { "$ref": "#/definitions/ProductSpecificationRef" } }, "title": "AlternateProductProposal" }, "ApiStatus": { "type": "object", "required": ["name", "status", "version"], "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "string" } }, "title": "ApiStatus" }, "ApiVersion": { "type": "object", "required": ["major", "minor", "patch"], "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "patch": { "type": "integer", "format": "int32" } }, "title": "ApiVersion" }, "BillingAccount": { "type": "object", "required": ["id"], "properties": { "id": { "type": "string" } }, "title": "BillingAccount" }, "BillingAccountRef": { "type": "object", "properties": { "billingContact": { "$ref": "#/definitions/Contact" }, "id": { "type": "string" }, "name": { "type": "string" } }, "title": "BillingAccountRef" }, "Contact": { "type": "object", "properties": { "city": { "type": "string" }, "companyName": { "type": "string" }, "contactFirstName": { "type": "string" }, "contactLastName": { "type": "string" }, "contactName": { "type": "string" }, "country": { "type": "string" }, "emailAddress": { "type": "string" }, "invoicesRecipientEmail": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberExtension": { "type": "string" }, "postCode": { "type": "string" }, "streetAddress": { "type": "string" }, "title": { "type": "string" }, "vatNumber": { "type": "string" } }, "title": "Contact" }, "Describing": { "type": "object", "properties": { "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "title": "Describing" }, "Duration": { "type": "object", "required": ["amount", "units"], "properties": { "amount": { "type": "integer", "format": "int32" }, "units": { "type": "string", "enum": ["day", "week", "month", "year"] } }, "title": "Duration" }, "ErrorRepresentation": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "reason": { "type": "string" }, "referenceError": { "type": "string" }, "status": { "type": "string" } }, "title": "ErrorRepresentation" }, "EthernetNowConfiguration": { "title": "EthernetNowConfiguration", "allOf": [{ "$ref": "#/definitions/MEFProductConfiguration" }, { "type": "object", "discriminator": "@type", "properties": { "@type": { "type": "string", "enum": ["EVPL"] }, "bandwidth": { "type": "integer", "format": "int32" }, "classOfService": { "type": "string", "enum": ["STANDARD", "PREMIUM"] }, "vlanNumberA": { "type": "string" }, "vlanNumberB": { "type": "string" } }, "title": "EthernetNowConfiguration", "description": "Implements MEFProductConfiguration. Discriminator @type must have one of values 'EVPL'" } ], "description": "Implements MEFProductConfiguration. Discriminator @type must have one of values 'EVPL'" }, "FieldedAddress": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "geographicSubAddress": { "$ref": "#/definitions/GeographicSubAddress" }, "id": { "type": "string" }, "locality": { "type": "string" }, "postcode": { "type": "string" }, "postcodeExtension": { "type": "string" }, "role": { "type": "string" }, "stateOrProvince": { "type": "string" }, "streetName": { "type": "string" }, "streetNr": { "type": "string" }, "streetNrLast": { "type": "string" }, "streetNrLastSuffix": { "type": "string" }, "streetNrSuffix": { "type": "string" }, "streetSuffix": { "type": "string" }, "streetType": { "type": "string" } }, "title": "FieldedAddress" }, "FormattedAddress": { "type": "object", "properties": { "addrLine1": { "type": "string" }, "addrLine2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "id": { "type": "string" }, "locality": { "type": "string" }, "postcode": { "type": "string" }, "postcodeExtension": { "type": "string" }, "stateOrProvince": { "type": "string" } }, "title": "FormattedAddress" }, "GeographicAddress": { "type": "object", "properties": { "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "allowsNewSite": { "type": "boolean" }, "associatedGeographicAddress": { "$ref": "#/definitions/FieldedAddress" }, "hasPublicSite": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" } }, "title": "GeographicAddress" }, "GeographicAddressCreate": { "type": "object", "required": ["@type"], "properties": { "@type": { "type": "string" }, "@schemaLocation": { "type": "string" }, "associatedGeographicAddress": { "$ref": "#/definitions/FieldedAddress" } }, "title": "GeographicAddressCreate" }, "GeographicAddressFindResp": { "type": "object", "properties": { "fieldedAddress": { "$ref": "#/definitions/FieldedAddress" }, "formattedAddress": { "$ref": "#/definitions/FormattedAddress" } }, "title": "GeographicAddressFindResp" }, "GeographicAddressValidation": { "type": "object", "required": ["provideAlternative", "submittedGeographicAddress"], "properties": { "@type": { "type": "string" }, "alternateGeographicAddress": { "type": "array", "items": { "$ref": "#/definitions/GeographicAddress" } }, "bestMatchGeographicAddress": { "$ref": "#/definitions/GeographicAddress" }, "provideAlternative": { "type": "boolean" }, "submittedGeographicAddress": { "$ref": "#/definitions/GeographicAddress" }, "validationResult": { "type": "string", "enum": ["fail", "PARTIAL", "success"] } }, "title": "GeographicAddressValidation" }, "GeographicAddressValidationCreate": { "type": "object", "required": ["submittedGeographicAddress"], "properties": { "provideAlternative": { "type": "boolean" }, "submittedGeographicAddress": { "$ref": "#/definitions/GeographicAddressCreate" }, "@type": { "type": "string" } }, "title": "GeographicAddressValidationCreate" }, "GeographicLocation": { "type": "object", "required": ["geographicPoint", "role", "spatialRef"], "properties": { "additionalSiteInformation": { "type": "string" }, "geographicPoint": { "$ref": "#/definitions/GeographicPoint" }, "id": { "type": "string" }, "role": { "type": "string" }, "siteCompanyName": { "type": "string" }, "siteCustomerName": { "type": "string" }, "siteDescription": { "type": "string" }, "siteName": { "type": "string" }, "spatialRef": { "type": "string" } }, "title": "GeographicLocation" }, "GeographicPoint": { "type": "object", "required": ["latitude", "longitude"], "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "title": "GeographicPoint" }, "GeographicSite": { "type": "object", "properties": { "additionalSiteInformation": { "type": "string" }, "description": { "type": "string" }, "fieldedAddress": { "$ref": "#/definitions/FieldedAddress" }, "formattedAddress": { "$ref": "#/definitions/FormattedAddress" }, "geographicLocation": { "$ref": "#/definitions/GeographicLocation" }, "id": { "type": "string" }, "referencedAddress": { "$ref": "#/definitions/ReferencedAddress" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "siteCompanyName": { "type": "string" }, "siteCustomerName": { "type": "string" }, "siteName": { "type": "string" }, "siteType": { "type": "string", "enum": ["public", "private"] }, "status": { "type": "string", "enum": ["planned", "cancelled", "underConstruction", "existing", "former"] } }, "title": "GeographicSite" }, "GeographicSiteFindResp": { "type": "object", "properties": { "geographicAddress": { "$ref": "#/definitions/GeographicAddressFindResp" }, "id": { "type": "string" }, "siteCompanyName": { "type": "string" }, "siteContactName": { "type": "string" }, "siteCustomerName": { "type": "string" }, "siteDescription": { "type": "string" }, "siteName": { "type": "string" }, "siteType": { "type": "string", "enum": ["public", "private"] }, "status": { "type": "string", "enum": ["planned", "cancelled", "underConstruction", "existing", "former"] } }, "title": "GeographicSiteFindResp" }, "GeographicSubAddress": { "type": "object", "properties": { "buildingName": { "type": "string" }, "id": { "type": "string" }, "levelNumber": { "type": "string" }, "levelType": { "type": "string" }, "privateStreetName": { "type": "string" }, "privateStreetNumber": { "type": "string" }, "subUnit": { "type": "array", "items": { "$ref": "#/definitions/SubUnit" } } }, "title": "GeographicSubAddress" }, "ItemPrice": { "type": "object", "required": ["price", "priceType"], "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/Price" }, "priceType": { "type": "string", "enum": ["recurring", "nonRecurring"] }, "recurringChargePeriod": { "type": "string", "enum": ["day", "week", "month", "year"] } }, "title": "ItemPrice" }, "ItemRelationship": { "type": "object", "required": ["id", "type"], "properties": { "id": { "type": "string" }, "productOrderId": { "type": "string" }, "type": { "type": "string", "enum": ["hasENNIEndPoint", "hasUNIEndPoint"] } }, "title": "ItemRelationship" }, "ItemStateChange": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time" }, "changeReason": { "type": "string" }, "state": { "type": "string", "enum": ["done", "terminatedWithErrorUnableToProvide", "terminatedWithErrorInsufficientInformationProvided", "inProgress"] } }, "title": "ItemStateChange" }, "ItemTerm": { "type": "object", "required": ["duration"], "properties": { "description": { "type": "string" }, "duration": { "$ref": "#/definitions/Duration" }, "name": { "type": "string" } }, "title": "ItemTerm" }, "MEFProductConfiguration": { "type": "object", "discriminator": "@type", "properties": { "@type": { "type": "string", "enum": ["Essential", "Dynamic", "Intense", "AccessInterface"] } }, "title": "MEFProductConfiguration", "description": "Abstract class declinated as AccessInterfaceConfiguration and EthernetNowConfiguration" }, "MEFSubUnit": { "type": "object", "required": ["subUnitNumber", "subUnitType"], "properties": { "subUnitNumber": { "type": "string" }, "subUnitType": { "type": "string" } }, "title": "MEFSubUnit" }, "Money": { "type": "object", "properties": { "unit": { "type": "string" }, "value": { "type": "number" } }, "title": "Money" }, "Price": { "type": "object", "properties": { "preTaxAmount": { "$ref": "#/definitions/Money" }, "priceRange": { "type": "string" }, "taxIncludedAmount": { "type": "string" } }, "title": "Price" }, "ProductInventoryFindResp": { "type": "object", "required": ["id", "productOffering", "productSpecification", "status"], "properties": { "buyerProductId": { "type": "string" }, "id": { "type": "string" }, "productOffering": { "$ref": "#/definitions/ProductOffering" }, "productSpecification": { "$ref": "#/definitions/ProductSpecificationRef" }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": ["pending", "active", "suspended", "activePendingTerminate", "terminated", "pendingActive", "suspendedPendingTerminate", "notApplicable"] } }, "title": "ProductInventoryFindResp" }, "ProductInventoryGetResp": { "type": "object", "required": ["@type", "id", "productConfiguration", "productOffering", "productSpecification", "relatedSite", "status"], "properties": { "@type": { "type": "string" }, "agreement": { "type": "array", "items": { "$ref": "#/definitions/Agreement" } }, "billingAccount": { "type": "array", "items": { "$ref": "#/definitions/BillingAccount" } }, "buyerProductId": { "type": "string" }, "id": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "productConfiguration": { "$ref": "#/definitions/MEFProductConfiguration" }, "productOffering": { "$ref": "#/definitions/ProductOffering" }, "productOrder": { "type": "array", "items": { "$ref": "#/definitions/ProductOrder" } }, "productOrderId": { "type": "integer", "format": "int64" }, "productPrice": { "type": "array", "items": { "$ref": "#/definitions/ProductPrice" } }, "productRelationship": { "type": "array", "items": { "$ref": "#/definitions/ProductRelationship" } }, "productSpecification": { "$ref": "#/definitions/ProductSpecificationRef" }, "productTerm": { "type": "array", "items": { "$ref": "#/definitions/ProductTerm" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "relatedSite": { "type": "array", "items": { "$ref": "#/definitions/Site" } }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": ["pending", "active", "suspended", "activePendingTerminate", "terminated", "pendingActive", "suspendedPendingTerminate", "notApplicable"] }, "statusChange": { "type": "array", "items": { "$ref": "#/definitions/StatusChange" } }, "terminationDate": { "type": "string", "format": "date-time" } }, "title": "ProductInventoryGetResp" }, "ProductOffering": { "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "enum": ["Essential", "Dynamic", "Intense", "AccessInterface"] } }, "title": "ProductOffering" }, "ProductOfferingQualification": { "type": "object", "required": ["id", "productOfferingQualificationItem", "relatedParty", "state"], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "effectiveQualificationCompletionDate": { "type": "string", "format": "date-time", "description": "Effective date seller provides qualification result (UTC)" }, "expectedResponseDate": { "type": "string", "format": "date-time", "description": "The date the seller is expected to provide qualification result (UTC)" }, "id": { "type": "string", "description": "The Serviceability Request's unique identifier." }, "instantSyncQualification": { "type": "boolean", "description": "If this flag is set to Yes, Buyer requests to have instant qualificationto be provided in operation POST response" }, "productOfferingQualificationItem": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingQualificationItem" } }, "projectId": { "type": "string", "description": "This value MAY be assigned by the Buyer/Seller to identify a project the serviceability request is associated with." }, "provideAlternative": { "type": "boolean", "description": "This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available." }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestCurrency": { "type": "string", "enum": ["EUR", "USD"] }, "requestedResponseDate": { "type": "string", "format": "date-time", "description": "Corresponds to desiredResponseDate - The date a response for the service request is desired (UTC)" }, "state": { "type": "string", "enum": ["done", "terminatedWithErrorUnableToProvide", "terminatedWithErrorInsufficientInformationProvided", "inProgress"] }, "stateChange": { "type": "array", "items": { "$ref": "#/definitions/StateChange" } } }, "title": "ProductOfferingQualification" }, "ProductOfferingQualificationCreate": { "type": "object", "required": ["productOfferingQualificationItem", "relatedParty"], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "instantSyncQualification": { "type": "boolean", "description": "If this flag is set to Yes, Buyer requests to have instant qualification to be provided in operation POST response" }, "productOfferingQualificationItem": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingQualificationItemCreate" } }, "projectId": { "type": "string", "description": "This value MAY be assigned by the Buyer/Seller to identify a project the qualification request is associated with." }, "provideAlternative": { "type": "boolean", "description": "This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available." }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestedCurrency": { "type": "string", "enum": ["EUR", "USD"] }, "requestedResponseDate": { "type": "string", "format": "date-time", "description": "Corresponds to desiredResponseDate - The date a response for the service request is desired (UTC)" } }, "title": "ProductOfferingQualificationCreate" }, "ProductOfferingQualificationItem": { "type": "object", "required": ["action", "id", "state"], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "alternateProductProposal": { "type": "array", "items": { "$ref": "#/definitions/AlternateProductProposal" } }, "eligibleProductOffering": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingRef" } }, "guaranteedUntilDate": { "type": "string", "format": "date-time", "description": "Date until seller is guaranteed the qualification result (UTC)" }, "id": { "type": "string", "description": "Id of this POQ item" }, "installationInterval": { "$ref": "#/definitions/TimeInterval" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "productOfferingQualificationItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingQualificationItemRelationship" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "serviceConfidenceReason": { "type": "string", "description": "A description of the reason a particular color is being provided. This may include a specific standard reason codes and descriptions." }, "serviceabilityConfidence": { "type": "string", "enum": ["green", "red", "yellow"] }, "state": { "type": "string", "enum": ["done", "terminatedWithErrorUnableToProvide", "terminatedWithErrorInsufficientInformationProvided", "inProgress"] }, "stateChange": { "type": "array", "items": { "$ref": "#/definitions/ItemStateChange" } }, "terminationError": { "type": "array", "items": { "$ref": "#/definitions/TerminationError" } } }, "title": "ProductOfferingQualificationItem" }, "ProductOfferingQualificationItemCreate": { "type": "object", "required": ["id", "product"], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "id": { "type": "string", "description": "Id of the productOfferingQualification item. This id must be unique within POQ create request" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "productOfferingQualificationItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingQualificationItemRelationship" } } }, "title": "ProductOfferingQualificationItemCreate" }, "ProductOfferingQualificationItemRelationship": { "type": "object", "required": ["id", "type"], "properties": { "id": { "type": "string", "description": "id of the targeted POQ item" }, "type": { "type": "string", "description": "Type of POQ relationship" } }, "title": "ProductOfferingQualificationItemRelationship" }, "ProductOfferingQualificationRef": { "type": "object", "required": ["id", "qualificationItem"], "properties": { "id": { "type": "string" }, "qualificationItem": { "type": "string" } }, "title": "ProductOfferingQualificationRef" }, "ProductOfferingRef": { "type": "object", "properties": { "id": { "type": "string", "enum": ["Essential", "Dynamic", "Intense", "AccessInterface"] } }, "title": "ProductOfferingRef" }, "ProductOrder": { "type": "object", "required": ["requestCurrency"], "properties": { "billingAccount": { "$ref": "#/definitions/BillingAccountRef" }, "buyerRequestDate": { "type": "string", "format": "date-time" }, "cancellationDate": { "type": "string", "format": "date-time" }, "cancellationReason": { "type": "string" }, "completionDate": { "type": "string", "format": "date-time" }, "desiredResponse": { "type": "string", "enum": ["confirmationAndEngineeringDesign", "confirmationOnly", "none"] }, "expectedCompletionDate": { "type": "string", "format": "date-time" }, "expeditePriority": { "type": "boolean" }, "externalId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "note": { "type": "array", "items": { "type": "string" } }, "orderActivity": { "type": "string", "enum": ["install", "change", "disconnect"] }, "orderDate": { "type": "string", "format": "date-time" }, "orderMessage": { "type": "array", "items": { "type": "string" } }, "orderVersion": { "type": "string" }, "pricingMethod": { "type": "string" }, "pricingReference": { "type": "string" }, "pricingTerm": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "productOrderItem": { "type": "array", "items": { "$ref": "#/definitions/ProductOrderItem" } }, "projectId": { "type": "string" }, "relatedBuyerPON": { "type": "string" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestCurrency": { "type": "string", "enum": ["EUR", "USD"] }, "requestedCompletionDate": { "type": "string", "format": "date-time" }, "requestedStartDate": { "type": "string", "format": "date-time" }, "state": { "type": "string", "enum": ["acknowledged", "rejected", "inProgress", "pending", "held", "assessingCancellation", "pendingCancellation", "cancelled", "inProgressConfigured", "inProgressConfirmed", "inProgressJeopardy", "failed", "partial", "completed"] }, "stateChange": { "type": "array", "items": { "type": "string" } }, "tspRestorationPriority": { "type": "string" } }, "title": "ProductOrder" }, "ProductOrderCreate": { "type": "object", "required": ["buyerRequestDate", "desiredResponse", "orderActivity", "orderVersion", "productOrderItem", "relatedParty", "requestedCompletionDate"], "properties": { "externalId": { "type": "string" }, "buyerRequestDate": { "type": "string", "format": "date-time" }, "requestedCompletionDate": { "type": "string", "format": "date-time" }, "orderActivity": { "type": "string", "enum": ["install", "change", "disconnect"] }, "desiredResponse": { "type": "string", "enum": ["confirmationAndEngineeringDesign", "confirmationOnly", "none"] }, "orderVersion": { "type": "string" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "productOrderItem": { "type": "array", "items": { "$ref": "#/definitions/ProductOrderItemCreate" } }, "requestedStartDate": { "type": "string", "format": "date-time" }, "expeditePriority": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "projectId": { "type": "string" }, "tspRestorationPriority": { "type": "string" }, "relatedBuyerPON": { "type": "string" }, "pricingMethod": { "type": "string" }, "pricingReference": { "type": "string" }, "pricingTerm": { "type": "integer", "format": "int32" }, "billingAccount": { "$ref": "#/definitions/BillingAccountRef" }, "note": { "type": "array", "items": { "type": "string" } }, "requestedCurrency": { "type": "string", "enum": ["EUR", "USD"] } }, "title": "ProductOrderCreate" }, "ProductOrderItem": { "type": "object", "required": ["action", "id", "product", "state"], "properties": { "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "billingAccount": { "$ref": "#/definitions/BillingAccountRef" }, "id": { "type": "string" }, "orderItemPrice": { "type": "array", "items": { "$ref": "#/definitions/ItemPrice" } }, "orderItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ItemRelationship" } }, "pricingMethod": { "type": "string" }, "pricingReference": { "type": "string" }, "pricingTerm": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "qualification": { "type": "string" }, "quote": { "$ref": "#/definitions/QuoteRef" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestedOrderItemTerm": { "$ref": "#/definitions/ItemTerm" }, "state": { "type": "string", "enum": ["acknowledged", "rejected", "inProgress", "pending", "held", "assessingCancellation", "pendingCancellation", "cancelled", "inProgressConfigured", "inProgressConfirmed", "inProgressJeopardy", "failed", "partial", "completed"] }, "stateChange": { "type": "array", "items": { "type": "string" } } }, "title": "ProductOrderItem" }, "ProductOrderItemCreate": { "type": "object", "required": ["action", "id", "product"], "properties": { "id": { "type": "string" }, "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "pricingMethod": { "type": "string" }, "pricingReference": { "type": "string" }, "pricingTerm": { "type": "integer", "format": "int32" }, "billingAccount": { "$ref": "#/definitions/BillingAccountRef" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "orderItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ItemRelationship" } }, "qualification": { "type": "string" }, "quote": { "$ref": "#/definitions/QuoteRef" }, "requestedOrderItemTerm": { "$ref": "#/definitions/ItemTerm" } }, "title": "ProductOrderItemCreate" }, "ProductOrderSummary": { "type": "object", "required": ["state"], "properties": { "externalId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "orderDate": { "type": "string", "format": "date-time" }, "state": { "type": "string", "enum": ["acknowledged", "rejected", "inProgress", "pending", "held", "assessingCancellation", "pendingCancellation", "cancelled", "inProgressConfigured", "inProgressConfirmed", "inProgressJeopardy", "failed", "partial", "completed"] } }, "title": "ProductOrderSummary" }, "ProductPrice": { "type": "object", "required": ["price", "priceType"], "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "price": { "$ref": "#/definitions/Price" }, "priceType": { "type": "string", "enum": ["recurring", "nonRecurring"] }, "recurringChargePeriod": { "type": "string", "enum": ["day", "week", "month", "year"] }, "type": { "type": "string" }, "unitOfMeasure": { "type": "string" } }, "title": "ProductPrice" }, "ProductRef": { "type": "object", "properties": { "buyerProductId": { "type": "string" }, "id": { "type": "string" } }, "title": "ProductRef" }, "ProductRefOrValue": { "type": "object", "properties": { "id": { "type": "string" }, "place": { "type": "array", "items": { "$ref": "#/definitions/RelatedPlaceRefOrValue" } }, "productConfiguration": { "$ref": "#/definitions/MEFProductConfiguration" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "productRelationship": { "type": "array", "items": { "$ref": "#/definitions/ProductRelationship" } }, "productSpecification": { "$ref": "#/definitions/ProductSpecificationRef" } }, "title": "ProductRefOrValue" }, "ProductRelationship": { "type": "object", "required": ["product", "type"], "properties": { "product": { "$ref": "#/definitions/ProductRef" }, "type": { "type": "string", "enum": ["hasENNIEndPoint", "hasUNIEndPoint"] } }, "title": "ProductRelationship" }, "ProductSpecificationRef": { "type": "object", "required": ["id"], "properties": { "describing": { "$ref": "#/definitions/Describing" }, "id": { "type": "string", "enum": ["TransitELine", "AccessELine", "ENNI", "UNI"] } }, "title": "ProductSpecificationRef" }, "ProductTerm": { "type": "object", "required": ["description", "duration", "name"], "properties": { "description": { "type": "string" }, "duration": { "$ref": "#/definitions/Duration" }, "name": { "type": "string" }, "validFor": { "$ref": "#/definitions/ValidFor" } }, "title": "ProductTerm" }, "Quote": { "type": "object", "required": ["requestCurrency"], "properties": { "@type": { "type": "string" }, "agreement": { "type": "string" }, "description": { "type": "string" }, "effectiveQuoteCompletionDate": { "type": "string", "format": "date-time" }, "expectedFulfillmentStartDate": { "type": "string", "format": "date-time" }, "expectedQuoteCompletionDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "instantSyncQuoting": { "type": "boolean" }, "note": { "type": "string" }, "projectId": { "type": "string" }, "quoteDate": { "type": "string", "format": "date-time" }, "quoteItem": { "type": "array", "items": { "$ref": "#/definitions/QuoteItem" } }, "quoteLevel": { "type": "string", "enum": ["budgetary", "indicative", "firm"] }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestCurrency": { "type": "string", "enum": ["EUR", "USD"] }, "requestedQuoteCompletionDate": { "type": "string", "format": "date-time" }, "state": { "type": "string" }, "validFor": { "$ref": "#/definitions/TimePeriod" } }, "title": "Quote" }, "QuoteCreate": { "type": "object", "required": ["quoteItem", "requestedQuoteCompletionDate"], "properties": { "requestedQuoteCompletionDate": { "type": "string", "format": "date-time" }, "quoteItem": { "type": "array", "items": { "$ref": "#/definitions/QuoteItemCreate" } }, "externalId": { "type": "string" }, "projectId": { "type": "string" }, "quoteLevel": { "type": "string", "enum": ["budgetary", "indicative", "firm"] }, "instantSyncQuoting": { "type": "boolean" }, "description": { "type": "string" }, "expectedFulfillmentStartDate": { "type": "string", "format": "date-time" }, "note": { "type": "array", "items": { "type": "string" } }, "agreement": { "type": "array", "items": { "type": "string" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "@type": { "type": "string" }, "requestedCurrency": { "type": "string", "enum": ["EUR", "USD"] } }, "title": "QuoteCreate" }, "QuoteItem": { "type": "object", "required": ["action", "id", "state"], "properties": { "@type": { "type": "string" }, "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "id": { "type": "string" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "qualification": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingQualificationRef" } }, "quoteItemPrice": { "type": "array", "items": { "$ref": "#/definitions/ItemPrice" } }, "quoteItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ItemRelationship" } }, "quoteItemTerm": { "$ref": "#/definitions/ItemTerm" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "requestedQuoteItemTerm": { "$ref": "#/definitions/ItemTerm" }, "state": { "type": "string" } }, "title": "QuoteItem" }, "QuoteItemCreate": { "type": "object", "required": ["action", "id"], "properties": { "id": { "type": "string" }, "action": { "type": "string", "enum": ["add", "modify", "delete"] }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef" }, "requestedQuoteItemTerm": { "$ref": "#/definitions/ItemTerm" }, "product": { "$ref": "#/definitions/ProductRefOrValue" }, "qualification": { "$ref": "#/definitions/ProductOfferingQualificationRef" }, "quoteItemRelationship": { "type": "array", "items": { "$ref": "#/definitions/ItemRelationship" } }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" } }, "note": { "type": "array", "items": { "type": "string" } } }, "title": "QuoteItemCreate" }, "QuoteRef": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "quoteItem": { "type": "string" } }, "title": "QuoteRef" }, "QuoteSummary": { "type": "object", "properties": { "effectiveQuoteCompletionDate": { "type": "string", "format": "date-time" }, "externalId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "projectId": { "type": "string" }, "quoteDate": { "type": "string", "format": "date-time" }, "quoteLevel": { "type": "string", "enum": ["budgetary", "indicative", "firm"] }, "state": { "type": "string" } }, "title": "QuoteSummary" }, "ReferencedAddress": { "type": "object", "properties": { "externalReferenceId": { "type": "string" }, "externalReferenceType": { "type": "string" }, "referenceId": { "type": "string" }, "referenceType": { "type": "string" }, "role": { "type": "string" } }, "title": "ReferencedAddress" }, "RelatedParty": { "type": "object", "required": ["role"], "properties": { "@referredType": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "country": { "type": "string" }, "emailAddress": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "numberExtension": { "type": "string" }, "postCode": { "type": "string" }, "role": { "type": "string", "enum": ["buyer", "seller", "commercial", "technical", "billing", "fault", "orangeCommercial", "gdpr", "developer", "signatory"] }, "streetAddress": { "type": "string" }, "title": { "type": "string" } }, "title": "RelatedParty" }, "RelatedPlaceRefOrValue": { "type": "object", "required": ["role"], "properties": { "@referredType": { "type": "string", "enum": ["GeographicSiteRef", "GeographicAddressRef"] }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name. Used when place is described by value (literally) then must be valued to FormattedAddress, FieldedAddress, GeographicLocation or (external) ReferencedAddress Used when place is described by reference - must be valued to PlaceRef", "enum": ["GeographicSiteRef", "GeographicAddressRef"] }, "id": { "type": "string" }, "role": { "type": "string", "description": "Role of this place" } }, "title": "RelatedPlaceRefOrValue" }, "Site": { "type": "object", "properties": { "@referredType": { "type": "string" }, "@type": { "type": "string" }, "href": { "type": "string" }, "id": { "type": "string" }, "role": { "type": "string" }, "siteName": { "type": "string" } }, "title": "Site" }, "StateChange": { "type": "object", "properties": { "changeDate": { "type": "string", "format": "date-time", "description": "Date time when state change occurred (UTC)" }, "changeReason": { "type": "string", "description": "Reason for the state change" }, "state": { "type": "string", "enum": ["done", "terminatedWithErrorUnableToProvide", "terminatedWithErrorInsufficientInformationProvided", "inProgress"] } }, "title": "StateChange" }, "StatusChange": { "type": "object", "required": ["status"], "properties": { "changeDate": { "type": "string", "format": "date-time" }, "changeReason": { "type": "string", "enum": ["FULL_AUTO_NEW_SERVICE", "SEMI_AUTO_NEW_SERVICE", "UPDATE_SERVICE", "RENEW_SERVICE", "OTI_NEW_SERVICE", "OTI_UPDATE_SERVICE"] }, "status": { "type": "string", "enum": ["pending", "active", "suspended", "activePendingTerminate", "terminated", "pendingActive", "suspendedPendingTerminate", "notApplicable"] } }, "title": "StatusChange" }, "SubUnit": { "type": "object", "required": ["subUnitIdentifier", "subUnitType"], "properties": { "subUnitIdentifier": { "type": "string" }, "subUnitType": { "type": "string" } }, "title": "SubUnit" }, "TerminationError": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the termination error" }, "value": { "type": "string", "description": "Value (text) for the termination error" } }, "title": "TerminationError" }, "TimeInterval": { "type": "object", "required": ["amount", "timeUnit"], "properties": { "amount": { "type": "integer", "format": "int32" }, "timeUnit": { "type": "string", "enum": ["calendarDays", "calendarHours", "calendarMinutes", "businessDays", "businessHours", "businessMinutes"] } }, "title": "TimeInterval" }, "TimePeriod": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" } }, "title": "TimePeriod" }, "ValidFor": { "type": "object", "properties": { "endDateTime": { "type": "string", "format": "date-time" }, "startDateTime": { "type": "string", "format": "date-time" } }, "title": "ValidFor" }, "Version": { "type": "object", "required": ["apiVersion", "deprecated"], "properties": { "apiVersion": { "$ref": "#/definitions/ApiVersion" }, "deprecated": { "type": "boolean" }, "retirementDate": { "type": "string", "format": "date-time" } }, "title": "Version" } } }