{ "openapi": "3.0.4", "info": { "title": "Mobile Subscriptions Administration API", "description": "Provides a corporate information model, generic for SME and Large. Used for agreement details for existing customers as creating new agreements or subscriptions.

This is an API intended for software developers and system integrators implementing client applications for handling order B2B segment. It is assumed that the reader is familiar with software API concepts such as REST, JSON and OpenAPI interface specification [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification).

Response Codes

This API follows standard response codes for REST APIs please refer to [W3C response codes](https://tools.ietf.org/html/rfc7231#section-6)", "termsOfService": "https://www.telenor.se/foretag/kundservice/villkor-prislistor-och-blanketter/villkor/allmanna-villkor/", "contact": { "name": "Telenor Support", "url": "https://www.telenor.se/foretag/kundservice/", "email": "" }, "version": "1.80.0" }, "servers": [ { "url": "https://apis.telenor.se/", "description": "Production environment" } ], "paths": { "/api/accountManagement/v1/billingAccount": { "get": { "tags": [ "AccountManagement" ], "summary": "Gets billing account details.", "operationId": "AccountManagement_Account", "parameters": [ { "name": "billingAccount", "in": "query", "description": "Billing Account id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/accountManagement/v1/billingAccounts": { "get": { "tags": [ "AccountManagement" ], "summary": "Gets shared billing accounts within an agreement.", "operationId": "AccountManagement_Accounts", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "priceplan", "in": "query", "description": "optional filter", "schema": { "type": "string" } }, { "name": "invoiceRef", "in": "query", "description": "optional filter", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.BillingAccount.CoreBillingAccount" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "post": { "tags": [ "AccountManagement" ], "summary": "Creates a new empty account.", "operationId": "AccountManagement_CreateAccount", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.AccountOrderInput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.AccountOrderInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.AccountOrderInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.BillingAccount.AccountOrderInput" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/agreementManagement/v1/agreementStructure": { "get": { "tags": [ "AgreementManagement" ], "summary": "Gets all details of an agreement using agreement ID or organisation ID.", "operationId": "AgreementManagement_AgreementStructure", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "organisationId", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.EF.AgreementStructureItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/customerLog/item": { "post": { "tags": [ "CustomerLog" ], "summary": "Creates a customer log history item.", "operationId": "CustomerLog_CreateHistoryItem", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "description": "History item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.CustomerLog.HistoryCreate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "put": { "tags": [ "CustomerLog" ], "summary": "Updates a customer log history item.", "operationId": "CustomerLog_UpdateHistoryItem", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "description": "History item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.CustomerLog.HistoryUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "get": { "tags": [ "CustomerLog" ], "summary": "Gets a customer log history item.", "operationId": "CustomerLog_HistoryItem", "parameters": [ { "name": "id", "in": "query", "description": "ID of an existing History item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agreeId", "in": "query", "description": "Agreement ID", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.CustomerLog.HistoryItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/customerLog/item/append": { "put": { "tags": [ "CustomerLog" ], "summary": "Appends a customer log history item.", "operationId": "CustomerLog_AppendHistoryItem", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "description": "History item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.CustomerLog.HistoryAppend" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/customerLog/items": { "get": { "tags": [ "CustomerLog" ], "summary": "Gets customer log history header item's.", "operationId": "CustomerLog_HistoryItems", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "query", "schema": { "type": "string" } }, { "name": "ongoing", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.CustomerLog.HistoryHeader" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder/eSimReservation/{msisdn}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Reserves eSIM for subscription using MSISDN.", "operationId": "ESimReservationV2_ReserveESim", "parameters": [ { "name": "dryRun", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder/eSimReservation": { "post": { "tags": [ "ProductOrdering" ], "summary": "Reserves multiple eSIM for subscriptions using list of phone numbers.", "operationId": "ESimReservationV2_ReserveESimBatch", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchOrder" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription/{phoneNumber}/imei": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Get device data based on IMEI.", "operationId": "Imei_DeviceModel", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "phoneNumber", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.Models.DeviceModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription/list/{agreementId}/imei": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Get device data based on IMEI for a list of phone numbers.", "operationId": "Imei_DeviceModelList", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.Models.DeviceModelList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/invoices/{agreementId}": { "get": { "tags": [ "Invoice" ], "summary": "Gets invoices for an agreement.", "operationId": "Invoice_Invoices", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "agreementId", "in": "path", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoicesView" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/invoices/settings/{agreementId}": { "get": { "tags": [ "Invoice" ], "summary": "Gets invoice settings for an agreement.", "operationId": "Invoice_InvoiceSettings", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "agreementId", "in": "path", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceSettingsView" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/invoices": { "post": { "tags": [ "Invoice" ], "summary": "Creates invoice for an agreement.", "operationId": "Invoice_CreateInvoice", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Create invoice order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.CreateInvoiceInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.CreateInvoiceResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "patch": { "tags": [ "Invoice" ], "summary": "Updates invoice for an agreement.", "operationId": "Invoice_UpdateInvoice", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Update invoice order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.UpdateInvoiceInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.UpdateInvoiceResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/invoices/{msisdn}": { "patch": { "tags": [ "Invoice" ], "summary": "Updates single subscription invoice.", "operationId": "Invoice_UpdateSingleInvoice", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Update single invoice order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.UpdateSingleInvoice.Models.UpdateSingleInvoiceInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.UpdateSingleInvoice.Models.UpdateSingleInvoiceResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/costCentre": { "patch": { "tags": [ "Invoice" ], "summary": "Renames the agreement invoice cost centre.", "operationId": "Invoice_RenameCostCentre", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Rename cost centre order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.RenameCostCentreInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.UpdateInvoiceResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/invoiceManagement/v1/assignCostCentre/{agreementId}": { "patch": { "tags": [ "Invoice" ], "summary": "Assigns cost centre to multiple single accounts.", "operationId": "Invoice_AssignCostCentre", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "agreementId", "in": "path", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Billing account list container", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.UpdateMultipleInvoices.Models.BillingAccountsInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Invoices.UpdateSingleInvoice.Models.AssignCostCentreResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productCatalogManagement/v1/productOffering": { "get": { "tags": [ "ProductCatalog" ], "summary": "Gets available subscription profiles.", "operationId": "ProductCatalog_ProfileIds", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.ProfileIdAndName" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productCatalogManagement/v1/serviceRules": { "get": { "tags": [ "ProductCatalog" ], "summary": "Gets rules describing how services relates to other services.", "operationId": "ProductCatalog_ServiceRules", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.PC.Views.ServiceRulesView" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder": { "post": { "tags": [ "ProductOrdering" ], "summary": "Subscription order. Used for new subscriptions and modify subscriptions. Modify does not support transfer SIM.", "operationId": "SubscriptionOrder_V1", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Order" }, "examples": { "Default": { "summary": "Request body schema", "value": { "ExternalId": "string", "UserId": "string", "OrderItems": [ { "ExternalId": "string", "AgreeId": 0, "ProfileId": "string", "Numbers": [ { "Number": "string", "RangeId": 0, "DestinationCode": "string", "PortDate": "2020-01-23T15:00:00.0000000" } ], "SimNumber": "string", "Sim": { "SimNumber": "string", "ESim": false, "Eid": { "PushActivation": false } }, "BindingPeriod": { "Period": "string", "Amount": 0 }, "CostCenter": "string", "BillingAccount": "string", "Addresses": [ { "CompanyName": "string", "Reference": "string", "Address1": "string", "Address2": "string", "Zip": "string", "City": "string", "CountryCode": "string" } ], "Services": [ { "Name": "string", "Parameters": [ { "Key": "string", "Value": "string" } ] } ], "IncPreSelectedServices": true, "ContactDetails": { "string": "string" }, "Meta": "string", "Billing": { "BillingAccount": "string", "Gln": "string" }, "ExternalProperties": [ { "Action": "string", "Key": "string", "Value": "string" } ] } ] } }, "CostCenter": { "summary": "Update cost center and user details on subscription", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "CostCenter": "Custom cost center", "ContactDetails": { "Email": "user@localhost.local", "FirstName": "SubscriberFirstName", "LastName": "SubscriberLastName", "Titel": "", "Organisation": "", "KeyWords": "", "HideNumber": "", "CustomerGroup": "", "Location": "" } } ] } }, "MoveSim": { "summary": "Move subscription to new billing account", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Invoice" } ], "Billing": { "BillingAccount": "NEW" } } ] } }, "NewInvoiceReference": { "summary": "Change subscription invoice reference for consolidated invoice", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "New invoice reference", "Zip": "12345", "City": "Ignored", "CountryCode": "SE", "Type": "Invoice" } ] } ] } }, "SimDelivery": { "summary": "Subscription with SIM delivery", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "New", "ProfileId": "9999999_CX_C_ABC", "Addresses": [ { "CompanyName": "My Company", "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Delivery" } ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/test": { "post": { "tags": [ "ProductOrdering" ], "summary": "Subscription order. Used for new subscriptions and modify subscriptions. Modify does not support transfer SIM.", "operationId": "SubscriptionOrder_V1_Test", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Order" }, "examples": { "Default": { "summary": "Request body schema", "value": { "ExternalId": "string", "UserId": "string", "OrderItems": [ { "ExternalId": "string", "AgreeId": 0, "ProfileId": "string", "Numbers": [ { "Number": "string", "RangeId": 0, "DestinationCode": "string", "PortDate": "2020-01-23T15:00:00.0000000" } ], "SimNumber": "string", "Sim": { "SimNumber": "string", "ESim": false, "Eid": { "PushActivation": false } }, "BindingPeriod": { "Period": "string", "Amount": 0 }, "CostCenter": "string", "BillingAccount": "string", "Addresses": [ { "CompanyName": "string", "Reference": "string", "Address1": "string", "Address2": "string", "Zip": "string", "City": "string", "CountryCode": "string" } ], "Services": [ { "Name": "string", "Parameters": [ { "Key": "string", "Value": "string" } ] } ], "IncPreSelectedServices": true, "ContactDetails": { "string": "string" }, "Meta": "string", "Billing": { "BillingAccount": "string", "Gln": "string" }, "ExternalProperties": [ { "Action": "string", "Key": "string", "Value": "string" } ] } ] } }, "CostCenter": { "summary": "Update cost center and user details on subscription", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "CostCenter": "Custom cost center", "ContactDetails": { "Email": "user@localhost.local", "FirstName": "SubscriberFirstName", "LastName": "SubscriberLastName", "Titel": "", "Organisation": "", "KeyWords": "", "HideNumber": "", "CustomerGroup": "", "Location": "" } } ] } }, "MoveSim": { "summary": "Move subscription to new billing account", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Invoice" } ], "Billing": { "BillingAccount": "NEW" } } ] } }, "NewInvoiceReference": { "summary": "Change subscription invoice reference for consolidated invoice", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "New invoice reference", "Zip": "12345", "City": "Ignored", "CountryCode": "SE", "Type": "Invoice" } ] } ] } }, "SimDelivery": { "summary": "Subscription with SIM delivery", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "New", "ProfileId": "9999999_CX_C_ABC", "Addresses": [ { "CompanyName": "My Company", "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Delivery" } ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/services": { "post": { "tags": [ "ProductOrdering" ], "summary": "Subscription order. Used for new subscriptions and modify subscriptions. Modify does not support transfer SIM.", "operationId": "ProductOrdering_Services", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Services.ServiceOrder" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Services.ServiceOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/eSimReservation/{msisdn}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges subscription to eSIM using MSISDN.", "operationId": "ProductOrdering_ReserveESim", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/simExchange/{msisdn}/{simNumber}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges SIM on a subscription using MSISDN.", "operationId": "ProductOrdering_ExchangeSim", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "simNumber", "in": "path", "required": true, "schema": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.SimExchange.SimExchangeResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/simReservation/{msisdn}/{simNumber}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges SIM on a subscription using MSISDN.", "operationId": "ProductOrdering_SimReservation", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "simNumber", "in": "path", "required": true, "schema": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.SimExchange.SimExchangeResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/barring/{msisdn}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Deactivates a SIM by MSISDN.", "operationId": "ProductOrdering_BarSim", "parameters": [ { "name": "X-Unlock-Code", "in": "header", "description": "4 digit PIN code, length 4", "schema": { "maxLength": 4, "minLength": 4, "pattern": "^(\\d{4})$", "type": "string" } }, { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Services.ServiceOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "delete": { "tags": [ "ProductOrdering" ], "summary": "Activates a SIM by MSISDN.", "operationId": "ProductOrdering_UnBarSim", "parameters": [ { "name": "X-Unlock-Code", "in": "header", "description": "4 digit PIN code, length 4", "schema": { "maxLength": 4, "minLength": 4, "pattern": "^(\\d{4})$", "type": "string" } }, { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Services.ServiceOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/churn": { "post": { "tags": [ "ProductOrdering" ], "summary": "Churns a subscription or extra data-SIM.", "operationId": "ProductOrdering_Churn", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Churn.ChurnOrder" }, "examples": { "ChurnSchema": { "summary": "Churn request body schema", "value": { "PhoneNumber": null, "CancelDate": "2020-01-23T00:00:00.0000000", "ReferenceLanguage": null, "ReferenceNumber": null, "ConvertToPrepaid": false } }, "ChurnSubscription": { "summary": "Churn subscription", "value": { "PhoneNumber": "0701740605" } }, "ChurnSubscriptionFutureCancel": { "summary": "Churn subscription with future cancel", "value": { "PhoneNumber": "0701740605", "CancelDate": "2026-10-08T00:00:00.0000000" } }, "ChurnSubscriptionReference": { "summary": "Churn subscription with voice reference to another phone number", "value": { "PhoneNumber": "0701740605", "ReferenceLanguage": "SV", "ReferenceNumber": "0701740699" } }, "ChurnExtraDataSim": { "summary": "Churn Extra Data-SIM service", "value": { "PhoneNumber": "07017406050000" } }, "ConvertToPrepaid": { "summary": "Convert subscription to Prepaid", "value": { "PhoneNumber": "0701740605", "ConvertToPrepaid": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Churn.ChurnOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder": { "post": { "tags": [ "ProductOrdering" ], "summary": "Subscription order. Used for new subscriptions and modify subscriptions. Modify does not support transfer SIM.", "operationId": "SubscriptionOrder_V2", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Product order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderNew" }, "examples": { "Default": { "summary": "Request body schema", "value": { "ExternalId": "string", "UserId": "string", "OrderItems": [ { "ExternalId": "string", "AgreeId": 0, "ProfileId": "string", "Numbers": [ { "Number": "string", "RangeId": 0, "DestinationCode": "string" } ], "Sim": { "SimNumber": "string", "ESim": false, "Eid": { "PushActivation": false } }, "BindingPeriod": { "Period": "string", "Amount": 0 }, "CostCenter": "string", "Addresses": [ { "CompanyName": "string", "Reference": "string", "Address1": "string", "Address2": "string", "Zip": "string", "City": "string", "CountryCode": "string" } ], "Services": [ { "Name": "string", "Parameters": [ { "Key": "string", "Value": "string" } ] } ], "IncPreSelectedServices": true, "ContactDetails": { "string": "string" }, "Meta": "string", "Billing": { "BillingAccount": "string", "Gln": "string" }, "ExternalProperties": [ { "Action": "string", "Key": "string", "Value": "string" } ] } ] } }, "CostCenter": { "summary": "Update cost center and user details on subscription", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "CostCenter": "Custom cost center", "ContactDetails": { "Email": "user@localhost.local", "FirstName": "SubscriberFirstName", "LastName": "SubscriberLastName", "Titel": "", "Organisation": "", "KeyWords": "", "HideNumber": "", "CustomerGroup": "", "Location": "" } } ] } }, "MoveSim": { "summary": "Move subscription to new billing account", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Invoice" } ], "Billing": { "BillingAccount": "NEW" } } ] } }, "NewInvoiceReference": { "summary": "Change subscription invoice reference for consolidated invoice", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "New invoice reference", "Zip": "12345", "City": "Ignored", "CountryCode": "SE", "Type": "Invoice" } ] } ] } }, "SimDelivery": { "summary": "Subscription with SIM delivery", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "New", "ProfileId": "9999999_CX_C_ABC", "Addresses": [ { "CompanyName": "My Company", "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Delivery" } ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder/test": { "post": { "tags": [ "ProductOrdering" ], "summary": "Subscription order. Used for new subscriptions and modify subscriptions. Modify does not support transfer SIM.", "operationId": "SubscriptionOrder_V2_Test", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "description": "Test product order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderNew" }, "examples": { "Default": { "summary": "Request body schema", "value": { "ExternalId": "string", "UserId": "string", "OrderItems": [ { "ExternalId": "string", "AgreeId": 0, "ProfileId": "string", "Numbers": [ { "Number": "string", "RangeId": 0, "DestinationCode": "string" } ], "Sim": { "SimNumber": "string", "ESim": false, "Eid": { "PushActivation": false } }, "BindingPeriod": { "Period": "string", "Amount": 0 }, "CostCenter": "string", "Addresses": [ { "CompanyName": "string", "Reference": "string", "Address1": "string", "Address2": "string", "Zip": "string", "City": "string", "CountryCode": "string" } ], "Services": [ { "Name": "string", "Parameters": [ { "Key": "string", "Value": "string" } ] } ], "IncPreSelectedServices": true, "ContactDetails": { "string": "string" }, "Meta": "string", "Billing": { "BillingAccount": "string", "Gln": "string" }, "ExternalProperties": [ { "Action": "string", "Key": "string", "Value": "string" } ] } ] } }, "CostCenter": { "summary": "Update cost center and user details on subscription", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "CostCenter": "Custom cost center", "ContactDetails": { "Email": "user@localhost.local", "FirstName": "SubscriberFirstName", "LastName": "SubscriberLastName", "Titel": "", "Organisation": "", "KeyWords": "", "HideNumber": "", "CustomerGroup": "", "Location": "" } } ] } }, "MoveSim": { "summary": "Move subscription to new billing account", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Invoice" } ], "Billing": { "BillingAccount": "NEW" } } ] } }, "NewInvoiceReference": { "summary": "Change subscription invoice reference for consolidated invoice", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "Update", "Numbers": [ { "Number": "0701740605" } ], "Addresses": [ { "Reference": "New invoice reference", "Zip": "12345", "City": "Ignored", "CountryCode": "SE", "Type": "Invoice" } ] } ] } }, "SimDelivery": { "summary": "Subscription with SIM delivery", "value": { "ExternalId": "CustomOrderExternalId-1", "UserId": "CustomUserId", "OrderItems": [ { "ExternalId": "1", "Action": "New", "ProfileId": "9999999_CX_C_ABC", "Addresses": [ { "CompanyName": "My Company", "Reference": "Reference", "Address1": "My address 1", "Address2": "My address 2", "Zip": "12345", "City": "My City", "CountryCode": "SE", "Type": "Delivery" } ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resources/cliSettings": { "get": { "tags": [ "Resource" ], "summary": "Returns settings for all CLI groups on an agreement.", "operationId": "Resource_CliSettings", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agreementOfferId", "in": "query", "description": "Agreement offer ID", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_agreement_ef.Model.Services.CliSettings" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/numberRanges": { "get": { "tags": [ "ResourcePoolManagement" ], "summary": "Gets number ranges using agreement ID.", "operationId": "ResourcePoolManagement_NumberRanges", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_agreement_ef.Model.NumberRanges.NumberRange" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/validateReservedNumber": { "get": { "tags": [ "ResourcePoolManagement" ], "summary": "Validates that specified number range is reserved to the Agreement ID.", "operationId": "ResourcePoolManagement_ValidateReservedNumber", "parameters": [ { "name": "agreeId", "in": "query", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startNumber", "in": "query", "description": "Start number in number range", "required": true, "schema": { "type": "string" } }, { "name": "endNumber", "in": "query", "description": "End number in number range, can be same as start number.", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "'M' for mobile or 'F' for fixed 'S' for SIP", "required": true, "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/corporate_order_rule_engine.Core.Numbers.RangeValidationResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/nationalDestinationCodes": { "get": { "tags": [ "ResourcePoolManagement" ], "summary": "Gets a list of Swedish area codes.", "operationId": "ResourcePoolManagement_DestinationCodes", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Resources.NationalDestinationCode" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/isSimAvailable": { "post": { "tags": [ "ResourcePoolManagement" ], "summary": "Checks if SIM numbers are free to use. 14 digit SIM numbers.", "operationId": "ResourcePoolManagement_IsSimAvailableToUse", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_order_rule_engine.SPD.Sim.SpdSimStatusResult" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/eSimActivationCode/{msisdn}": { "get": { "tags": [ "ResourcePoolManagement" ], "summary": "Gets eSIM serial number, matching ID.", "operationId": "ResourcePoolManagement_ESimSerialNumberBy", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimQrCode" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/resourcePoolManagement/v1/eSimActivationCode/{simNumber}": { "get": { "tags": [ "ResourcePoolManagement" ], "summary": "Gets eSIM serial number, matching ID.\r\nRoute constraint regex: ensures simNumber is a 14-digit number starting with a non-zero digit.", "operationId": "ResourcePoolManagement_ESimSerialNumberBySim", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "simNumber", "in": "path", "required": true, "schema": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimQrCode" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/serviceConfigurationManagement/v1/callForwarding": { "get": { "tags": [ "ServiceConfigurationManagement" ], "summary": "Gets call forwarding settings for an MSISDN.", "operationId": "ServiceConfigurationManagement_CallForwarding", "parameters": [ { "name": "msisdn", "in": "query", "description": "Swedish mobile or fixed number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "example": "46701740605" }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.ServiceConfigurationManagement.CF.CoreCallForwardingItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ServiceConfigurationManagement.CF.CoreCallForwardingItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ServiceConfigurationManagement.CF.CoreCallForwardingItem" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] }, "put": { "tags": [ "ServiceConfigurationManagement" ], "summary": "Set call forwarding settings for an MSISDN.", "operationId": "ServiceConfigurationManagement_SetCallForwarding", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "requestBody": { "description": "Call forwarding settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/corporate_order_rule_engine.SPD.CF.CallForward" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder/simExchange/{msisdn}/{simNumber}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges SIM on a subscription using MSISDN.", "operationId": "SimExchangeV2_ExchangeSim", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "simNumber", "in": "path", "required": true, "schema": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.SimExchange.SimExchangeResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v1/productOrder/simExchange": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges a new SIM assigned by Telenor on a subscription using MSISDN.", "operationId": "SimExchangeDelivery_SimExchangeDelivery", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Controllers.SimExchangeDeliveryOrderInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Controllers.SimExchangeDeliveryOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/productOrdering/v2/productOrder/simReservation/{msisdn}/{simNumber}": { "post": { "tags": [ "ProductOrdering" ], "summary": "Exchanges SIM on a subscription using MSISDN.", "operationId": "SimReservationV2_SimReservation", "parameters": [ { "name": "X-User-Id", "in": "header", "description": "User identity of who is placing the order", "schema": { "type": "string" } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, { "name": "simNumber", "in": "path", "required": true, "schema": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, { "name": "X-Order-User", "in": "header", "description": "User identity of who is placing the order as a JWT, supported claim types ['sub' * required, 'email', 'family_name', 'given_name']", "example": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOiJoLnNvbG80MiIsImVtYWlsIjoiaGFuQHNvbG8ubG9jYWwiLCJnaXZlbl9uYW1lIjoiSGFuIiwiZmFtaWx5X25hbWUiOiJTb2xvIiwibmJmIjoxNjgzNjM0Mjg1LCJleHAiOjE2ODM2Mzc4ODUsImlhdCI6MTY4MzYzNDI4NX0." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.SimExchange.SimExchangeResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Gets simplified subscription details.", "operationId": "SubscriptionInventory_Subscription", "parameters": [ { "name": "msisdn", "in": "query", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "example": "46701740605" }, { "name": "includeExternalProperties", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.SubscriptionLight" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription/list/{agreeId}": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Gets subscriptions for a given agreement, sorted by first and last name.", "operationId": "SubscriptionInventory_SubscriptionList", "parameters": [ { "name": "agreeId", "in": "path", "description": "Agreement ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "maxItems", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "firstName", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "costCenter", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "invoiceRef", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "billingAccount", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "pricePlan", "in": "query", "schema": { "type": "string" } }, { "name": "includeExternalProperties", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.SubscriptionLightPaging" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription/puk/{msisdn}": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Gets PUK codes for a phone number.", "operationId": "SubscriptionInventory_PukCodes", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "example": "46701740605" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.PukView" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/inventory/subscription/{msisdn}/mex/status": { "get": { "tags": [ "SubscriptionInventory" ], "summary": "Gets MEX status for a phone number.", "operationId": "SubscriptionInventory_MexStatus", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Swedish mobile number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "example": "46701740605" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/corporate_order_rule_engine.Core.Services.MexStatus" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } }, "/api/usageConsumption/v1/subscription/{msisdn}": { "get": { "tags": [ "UsageConsumption" ], "summary": "Gets subscription usage consumption.", "operationId": "UsageConsumption_UsageByMsisdn", "parameters": [ { "name": "X-Transaction-Id", "in": "header", "description": "Transaction id defined by calling system could be for instance Epoch time", "schema": { "type": "string" }, "example": "1580371581117" }, { "name": "msisdn", "in": "path", "description": "Phone number", "required": true, "schema": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.UsageConsumption.SubscriptionUsageConsumptionView" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreApi.Common.ErrorResponse" } } } } }, "security": [ { "bearer-access-token": [ ] } ] } } }, "components": { "schemas": { "CoreApi.BillingAccount.AccountOrderInput": { "required": [ "AgreeId", "InvoiceCity", "InvoiceZip", "ProfileId", "UserId" ], "type": "object", "properties": { "UserId": { "minLength": 1, "type": "string" }, "AgreeId": { "type": "integer", "format": "int32", "nullable": true }, "ProfileId": { "minLength": 1, "type": "string" }, "InvoiceRef": { "type": "string", "nullable": true }, "InvoiceAddress1": { "type": "string", "nullable": true }, "InvoiceAddress2": { "type": "string", "nullable": true }, "InvoiceZip": { "minLength": 1, "type": "string" }, "InvoiceCity": { "minLength": 1, "type": "string" }, "InvoiceCoutryCode": { "type": "string", "nullable": true, "deprecated": true }, "InvoiceCountryCode": { "type": "string", "nullable": true }, "InvoiceCountryCodeValue": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CoreApi.BillingAccount.CoreBillingAccount": { "type": "object", "properties": { "AgreeId": { "type": "integer", "format": "int32" }, "BillingAccount": { "type": "integer", "format": "int32" }, "PricePlan": { "type": "string", "nullable": true }, "Count": { "type": "integer", "format": "int32" }, "InvoiceRef": { "type": "string", "nullable": true }, "InvoiceAddress1": { "type": "string", "nullable": true }, "InvoiceAddress2": { "type": "string", "nullable": true }, "InvoiceCity": { "type": "string", "nullable": true }, "InvoiceZip": { "type": "string", "nullable": true }, "InvoiceCountryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Common.ErrorResponse": { "type": "object", "properties": { "ErrorMessage": { "type": "string", "nullable": true }, "ErrorCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoreApi.Controllers.SimExchangeDeliveryOrderInput": { "required": [ "Address2", "City", "Country", "Name2", "PhoneNumber", "Zip" ], "type": "object", "properties": { "Reserve": { "type": "boolean" }, "PhoneNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "Address1": { "type": "string", "nullable": true }, "Address2": { "minLength": 1, "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Name2": { "minLength": 1, "type": "string", "nullable": true }, "City": { "minLength": 1, "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Controllers.SimExchangeDeliveryOrderResult": { "required": [ "OrderId", "SimNumber" ], "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" }, "SimNumber": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.CustomerLog.HistoryAppend": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Meta": { "type": "string", "nullable": true }, "Keys": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Characteristics": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CoreApi.CustomerLog.HistoryCreate": { "type": "object", "properties": { "Party": { "type": "string", "nullable": true }, "AgreeId": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "UserId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true }, "Meta": { "type": "string", "nullable": true }, "Keys": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Characteristics": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "ParentId": { "type": "integer", "format": "int32", "nullable": true }, "DryRun": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CoreApi.CustomerLog.HistoryHeader": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "UserId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true }, "Party": { "type": "string", "nullable": true }, "Characteristics": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Keys": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Created": { "type": "string", "format": "date-time", "example": "2023-10-10T16:13:10.711" }, "Modified": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-10T16:13:10.711" }, "Finished": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-10T16:13:10.711" }, "ParentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CoreApi.CustomerLog.HistoryItem": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "UserId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true }, "Party": { "type": "string", "nullable": true }, "Characteristics": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Keys": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Created": { "type": "string", "format": "date-time", "example": "2023-10-10T16:13:10.711" }, "Modified": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-10T16:13:10.711" }, "Finished": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-10T16:13:10.711" }, "ParentId": { "type": "integer", "format": "int32", "nullable": true }, "AgreeId": { "type": "integer", "format": "int32" }, "Meta": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.CustomerLog.HistoryUpdate": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.AssignCostCentreItemResult": { "required": [ "AccountId", "CostCentre", "OrderId" ], "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" }, "PhoneNumber": { "type": "string", "nullable": true }, "CostCentre": { "type": "string", "nullable": true }, "AccountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.CostCentreInput": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.CreateInvoiceInput": { "required": [ "Address", "AgreementId", "BillingCycle", "BillingFrequency", "CostCentres", "CreditLimitCode", "InvoiceName", "InvoiceType" ], "type": "object", "properties": { "InvoiceName": { "type": "string", "nullable": true }, "AgreementId": { "type": "integer", "format": "int32", "nullable": true }, "CostCentres": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.CostCentreInput" }, "nullable": true }, "Address": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceAddressInput" }, "BillingFrequency": { "type": "string", "nullable": true }, "BillingCycle": { "type": "string", "nullable": true }, "InvoiceType": { "type": "string", "nullable": true }, "CreditLimitCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.CreateInvoiceResult": { "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" }, "InvoiceName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceAddress": { "type": "object", "properties": { "Address1": { "type": "string", "nullable": true }, "Address2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "CountryCode": { "type": "string", "nullable": true }, "Reference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceAddressInput": { "required": [ "City", "CountryCode", "Zip" ], "type": "object", "properties": { "Address1": { "maxLength": 30, "type": "string", "nullable": true }, "Address2": { "maxLength": 30, "type": "string", "nullable": true }, "Reference": { "maxLength": 20, "type": "string", "nullable": true }, "City": { "maxLength": 20, "minLength": 1, "type": "string" }, "Zip": { "maxLength": 9, "minLength": 1, "type": "string" }, "CountryCode": { "maxLength": 3, "minLength": 2, "type": "string" } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceCostCentreView": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceSettingsValue": { "type": "object", "properties": { "Value": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceSettingsView": { "type": "object", "properties": { "BillingFrequencies": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceSettingsValue" }, "nullable": true }, "BillingCycles": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceSettingsValue" }, "nullable": true }, "CreditLimitCodes": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceSettingsValue" }, "nullable": true }, "InvoiceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceSettingsValue" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoiceView": { "type": "object", "properties": { "InvoiceName": { "type": "string", "nullable": true }, "AccountId": { "type": "integer", "format": "int32" }, "InvoiceReference": { "type": "string", "nullable": true }, "CostCentres": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceCostCentreView" }, "nullable": true }, "Address": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceAddress" }, "BillingCycle": { "type": "string", "nullable": true }, "BillingFrequency": { "type": "string", "nullable": true }, "CreditLimitCode": { "type": "string", "nullable": true }, "InvoiceType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.InvoicesView": { "type": "object", "properties": { "AgreementId": { "type": "integer", "format": "int32", "nullable": true }, "Invoices": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceView" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.RenameCostCentreInput": { "required": [ "AgreementId", "InvoiceName", "NewCostCentre", "OldCostCentre" ], "type": "object", "properties": { "AgreementId": { "type": "integer", "format": "int32", "nullable": true }, "InvoiceName": { "type": "string", "nullable": true }, "OldCostCentre": { "type": "string", "nullable": true }, "NewCostCentre": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.UpdateInvoiceInput": { "required": [ "AgreementId", "CostCentres", "InvoiceName" ], "type": "object", "properties": { "InvoiceName": { "type": "string", "nullable": true }, "AgreementId": { "type": "integer", "format": "int32", "nullable": true }, "CostCentres": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.CostCentreInput" }, "nullable": true }, "Address": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceAddressInput" } }, "additionalProperties": false }, "CoreApi.Invoices.Invoice.Models.UpdateInvoiceResult": { "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" }, "InvoiceName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.UpdateMultipleInvoices.Models.BillingAccountInput": { "type": "object", "properties": { "AccountId": { "type": "string", "nullable": true }, "PhoneNumber": { "type": "string", "nullable": true }, "CostCentre": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.UpdateMultipleInvoices.Models.BillingAccountsInput": { "required": [ "BillingAccounts" ], "type": "object", "properties": { "BillingAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.UpdateMultipleInvoices.Models.BillingAccountInput" } } }, "additionalProperties": false }, "CoreApi.Invoices.UpdateSingleInvoice.Models.AssignCostCentreResult": { "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.Invoices.AssignCostCentreItemResult" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.UpdateSingleInvoice.Models.UpdateSingleInvoiceInput": { "required": [ "InvoiceAddress" ], "type": "object", "properties": { "InvoiceAddress": { "$ref": "#/components/schemas/CoreApi.Invoices.Invoice.Models.InvoiceAddressInput" }, "EventLogCharacteristics": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CoreApi.Invoices.UpdateSingleInvoice.Models.UpdateSingleInvoiceResult": { "type": "object", "properties": { "OrderId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoreApi.ProductCatalog.CoreProfileService": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Category": { "type": "string", "nullable": true }, "Restriction": { "enum": [ "Eligible", "Pre-selected", "Mandatory", "Blocked" ], "type": "string", "description": "Members [Eligible=|Pre-selected=|Mandatory=|Blocked=]", "nullable": true, "example": "Eligible" }, "SaleStartDate": { "type": "string", "format": "date", "nullable": true, "example": "2021-12-31" }, "SaleEndDate": { "type": "string", "format": "date", "nullable": true, "example": "2021-12-31" }, "AllowedInProfileChange": { "type": "boolean" }, "AllowedInNewSubscription": { "type": "boolean" }, "Parameters": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_customer_product_catalog.Services.ProfileServiceParam" }, "nullable": true }, "IsEFService": { "type": "boolean" } }, "additionalProperties": false }, "CoreApi.ProductCatalog.EF.AgreementStructureItem": { "type": "object", "properties": { "AgreeId": { "type": "integer", "format": "int32" }, "OrgId": { "type": "string", "nullable": true }, "ParentAgreementId": { "type": "integer", "format": "int32" }, "StatusId": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.PC.Views.IncompatibleServiceView": { "type": "object", "properties": { "ServiceId": { "type": "string", "nullable": true, "readOnly": true }, "Services": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.PC.Views.ServiceRequiresAllView": { "type": "object", "properties": { "ServiceId": { "type": "string", "nullable": true, "readOnly": true }, "ValidForOfferId": { "type": "string", "nullable": true, "readOnly": true }, "Services": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.PC.Views.ServiceRequiresAnyView": { "type": "object", "properties": { "ServiceId": { "type": "string", "nullable": true }, "ValidForOfferId": { "type": "string", "nullable": true }, "Services": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.PC.Views.ServiceRulesView": { "type": "object", "properties": { "RequiresAny": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.PC.Views.ServiceRequiresAnyView" }, "nullable": true }, "RequiresAll": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.PC.Views.ServiceRequiresAllView" }, "nullable": true }, "Incompatible": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.PC.Views.IncompatibleServiceView" }, "nullable": true }, "KeepList": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_product_catalog.KeepList.KeepListViewItem" }, "nullable": true }, "SubscriptionServiceRequiresAgreementService": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_agreement_ef.Model.AgreeToSubServiceRelation" }, "nullable": true }, "SubscriptionServiceNotAllowedForAgreementService": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_agreement_ef.Model.AgreeToSubServiceRelation" }, "nullable": true }, "RemoveOnTransfer": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.RemoveOnTransferView" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.ProfileIdAndName": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "$ref": "#/components/schemas/corporate_customer_product_catalog.Profiles.ProfileName" }, "Category": { "type": "string", "nullable": true }, "PricePlan": { "type": "string", "nullable": true }, "SortOrder": { "type": "string", "nullable": true }, "ValidTo": { "type": "string", "format": "date", "nullable": true, "example": "2021-12-31" }, "Services": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductCatalog.CoreProfileService" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductCatalog.RemoveOnTransferView": { "type": "object", "properties": { "ServiceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Churn.ChurnOrder": { "required": [ "PhoneNumber" ], "type": "object", "properties": { "PhoneNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "CancelDate": { "type": "string", "format": "date", "nullable": true, "example": "2021-12-31" }, "ReferenceLanguage": { "enum": [ "SV", "EN" ], "type": "string", "description": "Members [SV=|EN=]", "default": "SV", "nullable": true, "example": "SV" }, "ReferenceNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "ConvertToPrepaid": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Churn.ChurnOrderResult": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimQrCode": { "type": "object", "properties": { "ActivationCode": { "type": "string", "nullable": true }, "SmdpHost": { "type": "string", "nullable": true }, "QrCodeData": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchItemResult": { "required": [ "Id", "Message", "PhoneNumber", "ReservedSimNumber" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "PhoneNumber": { "type": "string", "nullable": true }, "ReservedSimNumber": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchOrder": { "type": "object", "properties": { "AgreementId": { "type": "integer", "format": "int32", "nullable": true }, "PhoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationPhoneNumber" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchResult": { "required": [ "Id", "InvalidItems", "Items" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationBatchItemResult" }, "nullable": true }, "InvalidItems": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.ESimReservation.ESimReservationInvalidItemResult" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationInvalidItemResult": { "required": [ "Id", "Message", "PhoneNumber" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "PhoneNumber": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationPhoneNumber": { "type": "object", "properties": { "PhoneNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" } }, "additionalProperties": false }, "CoreApi.ProductOrdering.ESimReservation.ESimReservationResult": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Msisdn": { "type": "string", "nullable": true }, "ReservedSimNumber": { "type": "string", "nullable": true }, "ActivationCode": { "type": "string", "nullable": true }, "SmdpHost": { "type": "string", "nullable": true }, "QrCodeData": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Services.ServiceOrder": { "required": [ "Msisdn", "OrderItems", "UserId" ], "type": "object", "properties": { "UserId": { "maxLength": 20, "minLength": 0, "type": "string" }, "Msisdn": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Services.ServiceOrderService" } } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Services.ServiceOrderResult": { "required": [ "Message" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Services.ServiceOrderService": { "required": [ "Action", "Id" ], "type": "object", "properties": { "Id": { "minLength": 1, "type": "string" }, "Action": { "enum": [ "Add", "Delete" ], "type": "string", "description": "Members [Add=|Delete=]", "example": "Add" }, "Parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderServiceParameter" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.SimExchange.SimExchangeResult": { "required": [ "Id", "Msisdn", "SimNumber" ], "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Msisdn": { "type": "string", "nullable": true }, "SimNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.SimOrderResult": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true, "readOnly": true }, "SimNumber": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true }, "Imsi": { "type": "string", "nullable": true }, "ArticleName": { "type": "string", "nullable": true }, "ArticleId": { "type": "string", "nullable": true }, "ActivationCode": { "type": "string", "nullable": true }, "SmdpHost": { "type": "string", "nullable": true }, "QrCodeData": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.Address": { "required": [ "City", "Type", "Zip" ], "type": "object", "properties": { "CompanyName": { "type": "string", "description": "Required for type 'Delivery'", "nullable": true }, "Reference": { "type": "string", "nullable": true }, "Address1": { "type": "string", "nullable": true }, "Address2": { "type": "string", "nullable": true }, "Zip": { "type": "string", "description": "For Swedish postal code it must only contain 5 digits", "nullable": true }, "City": { "type": "string", "nullable": true }, "CountryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3", "nullable": true }, "Type": { "enum": [ "Legal", "Delivery", "Private", "Invoice" ], "type": "string", "description": "Members [Legal=|Delivery=|Private=|Invoice=]", "nullable": true, "example": "Legal" } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.Billing": { "type": "object", "properties": { "BillingAccount": { "type": "string", "nullable": true }, "GLN": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.BindingPeriod": { "type": "object", "properties": { "Period": { "type": "string", "nullable": true }, "Amount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.EidOrder": { "type": "object", "properties": { "Value": { "type": "string", "nullable": true }, "PushActivation": { "type": "boolean" } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.ExternalPropertyOrderInput": { "required": [ "Key" ], "type": "object", "properties": { "Action": { "type": "string", "nullable": true }, "Key": { "maxLength": 128, "minLength": 0, "type": "string" }, "Value": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.MsisdnInput": { "type": "object", "properties": { "Number": { "type": "string", "nullable": true }, "RangeId": { "type": "integer", "format": "int32", "nullable": true }, "DestinationCode": { "type": "string", "nullable": true }, "PortDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-10T16:13:10.711", "deprecated": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.MsisdnNew": { "type": "object", "properties": { "Number": { "type": "string", "nullable": true }, "RangeId": { "type": "integer", "format": "int32", "nullable": true }, "DestinationCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.Order": { "required": [ "OrderItems" ], "type": "object", "properties": { "ExternalId": { "type": "string", "description": "Represents a client defined id to uniquely identify the order", "nullable": true }, "UserId": { "type": "string", "nullable": true }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderSubscription" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.OrderNew": { "required": [ "OrderItems" ], "type": "object", "properties": { "ExternalId": { "type": "string", "nullable": true }, "UserId": { "type": "string", "nullable": true }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.SubscriptionNew" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.OrderResult": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "nullable": true }, "ExternalId": { "type": "string", "nullable": true }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.SubscriptionResult" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.OrderServiceParameter": { "required": [ "Key" ], "type": "object", "properties": { "Key": { "minLength": 1, "type": "string" }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.OrderSubscription": { "required": [ "Action" ], "type": "object", "properties": { "ExternalId": { "type": "string", "description": "Represents a client defined id to uniquely identify the order item within the order", "nullable": true }, "AgreeId": { "type": "integer", "format": "int32" }, "Action": { "enum": [ "New", "Update", "Delete", "ServiceOrder" ], "type": "string", "description": "Members [New=|Update=|Delete=|ServiceOrder=]", "nullable": true, "example": "New" }, "ProfileId": { "type": "string", "nullable": true }, "Numbers": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.MsisdnInput" }, "nullable": true }, "SimNumber": { "type": "string", "description": "Replaced by Sim.SimNumber in v2 API", "nullable": true }, "Sim": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Sim" }, "BindingPeriod": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.BindingPeriod" }, "CostCenter": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "BillingAccount": { "type": "string", "description": "Replaced by Billing.BillingAccount in v2 API", "nullable": true }, "Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Address" }, "nullable": true }, "Services": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.SubscriptionOrderService" }, "nullable": true }, "IncPreSelectedServices": { "type": "boolean" }, "ContactDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Meta": { "type": "string", "nullable": true }, "Billing": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Billing" }, "ExternalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.ExternalPropertyOrderInput" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.Sim": { "type": "object", "properties": { "SimNumber": { "type": "string", "nullable": true }, "ESim": { "type": "boolean" }, "Eid": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.EidOrder" } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.SubscriptionNew": { "required": [ "Action" ], "type": "object", "properties": { "ExternalId": { "type": "string", "nullable": true }, "AgreeId": { "type": "integer", "format": "int32" }, "Action": { "enum": [ "New", "Update", "Delete", "ServiceOrder" ], "type": "string", "description": "Members [New=|Update=|Delete=|ServiceOrder=]", "nullable": true, "example": "New" }, "ProfileId": { "type": "string", "nullable": true }, "Numbers": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.MsisdnNew" }, "nullable": true }, "Sim": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Sim" }, "BindingPeriod": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.BindingPeriod" }, "CostCenter": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Address" }, "nullable": true }, "Services": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.SubscriptionOrderService" }, "nullable": true }, "IncPreSelectedServices": { "type": "boolean" }, "ContactDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Meta": { "type": "string", "nullable": true }, "Billing": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Billing" }, "ExternalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.ExternalPropertyOrderInput" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.SubscriptionOrderService": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.OrderServiceParameter" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.ProductOrdering.Subscriptions.SubscriptionResult": { "type": "object", "properties": { "ExternalId": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "MobileNumber": { "type": "string", "nullable": true }, "FixedNumber": { "type": "string", "nullable": true }, "ShortNumber": { "type": "string", "nullable": true }, "SubscriptionId": { "type": "integer", "format": "int64", "nullable": true }, "Sims": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.SimOrderResult" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.Resources.NationalDestinationCode": { "required": [ "DestinationCode", "Name" ], "type": "object", "properties": { "DestinationCode": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.ServiceConfigurationManagement.CF.CoreCallForwardingItem": { "type": "object", "properties": { "Msisdn": { "type": "string", "nullable": true }, "CFU": { "type": "string", "nullable": true }, "CFB": { "type": "string", "nullable": true }, "CFNR": { "type": "string", "nullable": true }, "CFNA": { "type": "string", "nullable": true }, "CFNA_Time": { "type": "integer", "format": "int32", "nullable": true }, "CW": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.Models.DeviceModel": { "type": "object", "properties": { "Imei": { "type": "string", "nullable": true, "readOnly": true }, "Model": { "type": "string", "nullable": true, "readOnly": true }, "Msisdn": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "LastUpdateLocationDateTime": { "type": "string", "description": "This is in local time (Swedish time, eg: 2023-10-10T16:13:10.711)", "format": "date-time", "nullable": true, "readOnly": true, "example": "2023-10-10T16:13:10.711" } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.Models.DeviceModelList": { "type": "object", "properties": { "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.Models.DeviceModel" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.MsisdnPukCode": { "type": "object", "properties": { "PhoneNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "PukCode": { "type": "string", "nullable": true }, "SimNumber": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.PukView": { "type": "object", "properties": { "PukCodes": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.MsisdnPukCode" } } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.SubscriptionLight": { "required": [ "AgreeId", "PricePlan", "ProfileId" ], "type": "object", "properties": { "AgreeId": { "type": "integer", "format": "int32" }, "MainAgreeId": { "type": "integer", "format": "int32" }, "MobileNumber": { "type": "string", "nullable": true }, "FixedNumber": { "type": "string", "nullable": true }, "SimNumber": { "type": "string", "nullable": true }, "SimNumberReserved": { "type": "string", "nullable": true }, "ProfileId": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "CostCenter": { "type": "string", "nullable": true }, "BillingAccount": { "type": "integer", "format": "int32", "nullable": true }, "PricePlan": { "type": "string", "nullable": true }, "Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Address" }, "nullable": true }, "SubscriptionId": { "type": "integer", "format": "int64", "nullable": true }, "ExternalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_order_rule_engine.Core.Subscriptions.ExternalProperty" }, "nullable": true }, "Services": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.SubscriptionOrderService" }, "nullable": true }, "ShortNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.SubscriptionLightPaging": { "type": "object", "properties": { "HasMore": { "type": "boolean" }, "Subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.SubscriptionInventory.SubscriptionNoServicesView" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.SubscriptionInventory.SubscriptionNoServicesView": { "required": [ "AgreeId", "PricePlan", "ProfileId" ], "type": "object", "properties": { "AgreeId": { "type": "integer", "format": "int32" }, "MainAgreeId": { "type": "integer", "format": "int32" }, "MobileNumber": { "type": "string", "nullable": true }, "FixedNumber": { "type": "string", "nullable": true }, "SimNumber": { "type": "string", "nullable": true }, "SimNumberReserved": { "type": "string", "nullable": true }, "ProfileId": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "CostCenter": { "type": "string", "nullable": true }, "BillingAccount": { "type": "integer", "format": "int32", "nullable": true }, "PricePlan": { "type": "string", "nullable": true }, "Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.ProductOrdering.Subscriptions.Address" }, "nullable": true }, "SubscriptionId": { "type": "integer", "format": "int64", "nullable": true }, "ExternalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_order_rule_engine.Core.Subscriptions.ExternalProperty" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.UsageConsumption.SubscriptionUsageConsumptionView": { "type": "object", "properties": { "PhoneNumber": { "type": "string", "nullable": true }, "BillingPeriod": { "type": "string", "nullable": true }, "Usage": { "type": "array", "items": { "$ref": "#/components/schemas/CoreApi.UsageConsumption.UsageConsumptionView" }, "nullable": true } }, "additionalProperties": false }, "CoreApi.UsageConsumption.UsageConsumptionView": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Cost": { "type": "string", "nullable": true }, "Duration": { "type": "string", "nullable": true }, "Volume": { "type": "string", "nullable": true }, "Calls": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SupportedUserClaim": { "type": "string", "properties": { "sub": { "type": "string", "description": "Standard claim type 'sub' for external user, exposed in customer event log" }, "email": { "type": "string", "description": "Standard claim type 'email' for external user, exposed in customer event log" }, "family_name": { "type": "string", "description": "Standard claim type 'family_name' for external user, exposed in customer event log" }, "given_name": { "type": "string", "description": "Standard claim type 'email' for external user, exposed in customer event log" } } }, "corporate_agreement_ef.Model.AgreeToSubServiceRelation": { "type": "object", "properties": { "SubscriberServiceID": { "type": "string", "nullable": true }, "SubscriberServiceName": { "type": "string", "nullable": true }, "AgreementServiceID": { "type": "string", "nullable": true }, "AgreementServiceName": { "type": "string", "nullable": true }, "ValidForOfferID": { "type": "string", "nullable": true }, "OfferName": { "type": "string", "nullable": true }, "ParameterRelations": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_agreement_ef.Model.ParameterRelation" }, "nullable": true } }, "additionalProperties": false }, "corporate_agreement_ef.Model.NumberRanges.NumberRange": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "AgreeId": { "type": "integer", "format": "int32" }, "AgreementOfferId": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "RangeStart": { "type": "string", "nullable": true }, "RangeEnd": { "type": "string", "nullable": true } }, "additionalProperties": false }, "corporate_agreement_ef.Model.ParameterRelation": { "type": "object", "properties": { "AgreementParamterID": { "type": "string", "nullable": true }, "BassParameterID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "corporate_agreement_ef.Model.Services.CliSettings": { "type": "object", "properties": { "CliGroupID": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "AgreementOfferId": { "type": "integer", "format": "int32" }, "InitCliSettings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DefaultCommonNumber": { "type": "string", "nullable": true }, "CommonNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "corporate_customer_product_catalog.Profiles.ProfileName": { "type": "object", "properties": { "FullName": { "type": "string", "nullable": true }, "Custom": { "type": "string", "nullable": true }, "Solution": { "type": "string", "nullable": true }, "Offer": { "type": "string", "nullable": true } }, "additionalProperties": false }, "corporate_customer_product_catalog.Services.ProfileServiceParam": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "ParameterValues": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_customer_product_catalog.Services.ProfileServiceParamValue" }, "nullable": true } }, "additionalProperties": false }, "corporate_customer_product_catalog.Services.ProfileServiceParamValue": { "type": "object", "properties": { "Value": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "IsNegotiated": { "type": "boolean" } }, "additionalProperties": false }, "corporate_order_rule_engine.Core.Numbers.RangeValidationResult": { "type": "object", "properties": { "IsValid": { "type": "boolean" }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "corporate_order_rule_engine.Core.Services.MexStatus": { "type": "object", "properties": { "LoggedIn": { "type": "boolean", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "corporate_order_rule_engine.Core.Subscriptions.ExternalProperty": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "corporate_order_rule_engine.SPD.CF.CallForward": { "type": "object", "properties": { "Msisdn": { "type": "string", "nullable": true }, "CallWait": { "type": "boolean", "nullable": true }, "ForwardNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/corporate_order_rule_engine.SPD.CF.CallForwardItem" }, "nullable": true } }, "additionalProperties": false }, "corporate_order_rule_engine.SPD.CF.CallForwardItem": { "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/corporate_order_rule_engine.SPD.CF.CallForwardItem+CallForwardConstants" }, "ForwardNumber": { "type": "string", "nullable": true }, "TimeCfna": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "corporate_order_rule_engine.SPD.CF.CallForwardItem+CallForwardConstants": { "enum": [ "CFNA", "CFNR", "CFU", "CFB" ], "type": "string" }, "corporate_order_rule_engine.SPD.Sim.SpdSimStatusResult": { "type": "object", "properties": { "SimNumber": { "pattern": "^[1-9][0-9]{13}$", "type": "string", "nullable": true }, "AvailableStatus": { "type": "string", "nullable": true }, "ErrorCode": { "type": "integer", "format": "int32" }, "ErrorMessage": { "type": "string", "nullable": true }, "ErrorText": { "type": "string", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Swedish mobile number", "nullable": true, "example": "46701740605" }, "IsAvailable": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "corporate_product_catalog.KeepList.KeepListViewItem": { "required": [ "KeepLevel", "ServiceId" ], "type": "object", "properties": { "ServiceId": { "type": "string", "nullable": true }, "ExcludedSubscriptionForm": { "enum": [ "NX", "IV", "NV", "2J", "EB", "2I", "CX", "NY", "NW" ], "type": "string", "description": "Members [NX=|IV=|NV=|2J=|EB=|2I=|CX=|NY=|NW=]", "nullable": true, "example": "NX" }, "ExcludedSubscriptionType": { "enum": [ "G", "V", "A", "K", "Q", "R", "O", "S", "P", "M", "Y", "N", "C", "J", "L", "F", "E", "D", "T", "I" ], "type": "string", "description": "Members [G=|V=|A=|K=|Q=|R=|O=|S=|P=|M=|Y=|N=|C=|J=|L=|F=|E=|D=|T=|I=]", "nullable": true, "example": "G" }, "KeepLevel": { "type": "boolean" } }, "additionalProperties": false } } }, "tags": [ { "name": "AccountManagement" }, { "name": "AgreementManagement" }, { "name": "CustomerLog" }, { "name": "Invoice" }, { "name": "ProductCatalog" }, { "name": "ProductOrdering" }, { "name": "Resource" }, { "name": "ResourcePoolManagement" }, { "name": "ServiceConfigurationManagement" }, { "name": "SubscriptionInventory" }, { "name": "UsageConsumption" } ] }