{ "openapi": "3.0.1", "info": { "title": "1NCE API", "description": "API by 1NCE GmbH", "contact": { "name": "© 1NCE GmbH", "url": "https://1nce.com", "email": "info@1nce.com" }, "version": "v1", "x-jentic-source-url": "https://api.swaggerhub.com/apis/gjorgoski/1-nce_api/v1" }, "servers": [ { "url": "//portal.1nce.com/management-api" } ], "paths": { "/v1/orders": { "get": { "tags": [ "/orders" ], "summary": "Get a List of Orders", "operationId": "getOrdersUsingGET", "parameters": [ { "name": "page", "in": "query", "description": "Number of the requested page", "allowEmptyValue": false, "schema": { "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int64", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The size of the page, maximum allowed value is 10", "allowEmptyValue": false, "schema": { "maximum": 10, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort values (order_number, order_status and/or order_date) in a comma seperated list, defaults to order_number if not used", "allowEmptyValue": false, "schema": { "type": "string", "default": "order_number" }, "example": "order_status,order_date" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get a List of Orders" }, "post": { "tags": [ "/orders" ], "summary": "Post an order", "operationId": "postOrderUsingPOST", "requestBody": { "description": "An order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Additional Order" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Additional Order" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Additional Order" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Additional Order" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "order", "description": "Post an order" } }, "/v1/orders/{order_number}": { "get": { "tags": [ "/orders" ], "summary": "Get a single Order, identified by its order_number", "operationId": "getOrderUsingGET", "parameters": [ { "name": "order_number", "in": "path", "description": "Order number identifying the order", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get a single Order, identified by its order_number" } }, "/v1/products": { "get": { "tags": [ "/products" ], "summary": "Get a list of products", "operationId": "getProductsUsingGET", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get a list of products" } }, "/v1/sims": { "get": { "tags": [ "/sims" ], "summary": "Get a List of SIMs", "operationId": "getSimsUsingGET", "parameters": [ { "name": "page", "in": "query", "description": "Number of the requested page", "allowEmptyValue": false, "schema": { "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The size of the page, maximum allowed value is 100", "allowEmptyValue": false, "schema": { "maximum": 100, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 10 } }, { "name": "q", "in": "query", "description": "Filter values in a comma seperated list", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "iccid:9999" }, { "name": "sort", "in": "query", "description": "Sort values in a comma seperated list", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "status,ip_address" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SIM card" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SIM card" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get a List of SIMs" }, "post": { "tags": [ "/sims" ], "summary": "Change a list of SIMS for activate, deactivate, label, IMEI lock, etc.", "operationId": "updateSimsUsingPOST", "requestBody": { "description": "A list of SIMs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SIM card" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SIM card" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "sims", "description": "Change a list of SIMS for activate, deactivate, label, IMEI lock, etc." } }, "/v1/sims/autoTopup": { "post": { "tags": [ "/sims" ], "summary": "Trigger an auto topup config update for given SIMs.", "operationId": "autoTopupUsingPOST", "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "request", "description": "Trigger an auto topup config update for given SIMs." } }, "/v1/sims/simTransfer": { "post": { "tags": [ "/sims" ], "summary": "Trigger a SIM transfer workflow - if possible - for moving SIMs from one customer to another", "operationId": "simTransferUsingPOST", "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimTransfer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "request", "description": "Trigger a SIM transfer workflow - if possible - for moving SIMs from one customer to another" } }, "/v1/sims/topup": { "post": { "tags": [ "/sims" ], "summary": "Top up the data volume of the specified SIMs", "operationId": "topUpMultipleUsingPOST", "requestBody": { "description": "A list of SIMs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "201": { "description": "Order created successfully", "headers": { "Location": { "description": "The path to the newly created order", "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "SIM does not belong to user", "content": {} }, "404": { "description": "SIM not found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "sims", "description": "Top up the data volume of the specified SIMs" } }, "/v1/sims/{iccid}": { "get": { "tags": [ "/sims" ], "summary": "Get status information i.e. status, label, MSISDN, IMSI, ICCID, Lifetime, for a device with a ICCID", "operationId": "getSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIM card" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SIM card" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get status information i.e. status, label, MSISDN, IMSI, ICCID, Lifetime, for a device with a ICCID" }, "put": { "tags": [ "/sims" ], "summary": "Modification of a SIM card to activate, deactivate, change label, change IMEI lock, etc.", "operationId": "updateSimUsingPUT", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The modified SIM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Values for a SIM update" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Values for a SIM update" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "sim", "description": "Modification of a SIM card to activate, deactivate, change label, change IMEI lock, etc." } }, "/v1/sims/{iccid}/connectivity_info": { "get": { "tags": [ "/sims" ], "summary": "Retrieve connectivity information and location for a SIM", "operationId": "getConnectivityInfoForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "subscriber", "in": "query", "description": "If true, the Subscriber connectivity info is retrieved. Default is true, i.e. subscriber=true", "allowEmptyValue": false, "schema": { "type": "boolean", "default": true } }, { "name": "ussd", "in": "query", "description": "If true, the USSD connectivity info is retrieved. Default is false, i.e. ussd=false", "allowEmptyValue": false, "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectivityInfo" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ConnectivityInfo" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Retrieve connectivity information and location for a SIM" } }, "/v1/sims/{iccid}/events": { "get": { "tags": [ "/sims" ], "summary": "Get diagnostic/event information for a SIM card i.e. network events", "operationId": "getEventsForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Number of the requested page", "allowEmptyValue": false, "schema": { "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The size of the page, maximum allowed value is 1000", "allowEmptyValue": false, "schema": { "maximum": 1000, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort values in a comma seperated list, prepend \"-\" for descending order", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "-timestamp,id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventCollection" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/EventCollection" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get diagnostic/event information for a SIM card i.e. network events" } }, "/v1/sims/{iccid}/quota/data": { "get": { "tags": [ "/sims" ], "summary": "Get the data quota of a SIM", "operationId": "getDataQuotaForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quota" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Quota" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get the data quota of a SIM" } }, "/v1/sims/{iccid}/quota/sms": { "get": { "tags": [ "/sims" ], "summary": "Get the SMS quota of a SIM", "operationId": "getSmsQuotaForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quota" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Quota" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get the SMS quota of a SIM" } }, "/v1/sims/{iccid}/reset": { "post": { "tags": [ "/sims" ], "summary": "Trigger a connectivity reset for a given SIM. The actual reset will be done asynchronously. A positive-response only means that the connectivity-reset has been successfully placed into the queue.", "operationId": "resetConnectivityUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Trigger a connectivity reset for a given SIM. The actual reset will be done asynchronously. A positive-response only means that the connectivity-reset has been successfully placed into the queue." } }, "/v1/sims/{iccid}/sms": { "get": { "tags": [ "/sims" ], "summary": "Get the list of SMS sent and received by this SIM card", "operationId": "getSmsForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Number of the requested page", "allowEmptyValue": false, "schema": { "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The size of the page, maximum allowed value is 100", "allowEmptyValue": false, "schema": { "maximum": 100, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort values in a comma seperated list", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "status,ip_address" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SMS-Data" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SMS-Data" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get the list of SMS sent and received by this SIM card" }, "post": { "tags": [ "/sims" ], "summary": "Submit SMS to specified SIM card", "operationId": "sendSmsToSimUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SMS that should be sent to SIM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMS" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SMS" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "sms", "description": "Submit SMS to specified SIM card" } }, "/v1/sims/{iccid}/sms/{id}": { "get": { "tags": [ "/sims" ], "summary": "Get details about the SMS", "operationId": "getSmsOfSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The id of the SMS", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMS-Data" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SMS-Data" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get details about the SMS" }, "delete": { "tags": [ "/sims" ], "summary": "Cancel SMS that is buffered for SIM card and not yet delivered", "operationId": "cancelSmsForSimUsingDELETE", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The id of the SMS", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Cancel SMS that is buffered for SIM card and not yet delivered" } }, "/v1/sims/{iccid}/status": { "get": { "tags": [ "/sims" ], "summary": "Get current status of SIM", "operationId": "getStatusForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connectivity" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Connectivity" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get current status of SIM" } }, "/v1/sims/{iccid}/topup": { "post": { "tags": [ "/sims" ], "summary": "Top up the data volume of a specified SIM", "operationId": "topUpUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Order created successfully", "headers": { "Location": { "description": "The path to the newly created order", "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "SIM does not belong to user", "content": {} }, "404": { "description": "SIM not found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Top up the data volume of a specified SIM" } }, "/v1/sims/{iccid}/usage": { "get": { "tags": [ "/sims" ], "summary": "Get the daily usage generated by a SIM", "operationId": "getUsageForSimUsingGET", "parameters": [ { "name": "end_dt", "in": "query", "description": "End date used for the query, format: YYYY-MM-DD", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "2018-04-30" }, { "name": "iccid", "in": "path", "description": "The iccid of the SIM", "required": true, "schema": { "type": "string" } }, { "name": "start_dt", "in": "query", "description": "Start date used for the query, format: YYYY-MM-DD", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "2018-04-23" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyUsage" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/DailyUsage" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get the daily usage generated by a SIM" } }, "/v1/support": { "get": { "tags": [ "/support" ], "summary": "Get a list of service requests", "operationId": "getServiceRequestsUsingGET", "parameters": [ { "name": "page", "in": "query", "description": "Number of the requested page", "allowEmptyValue": false, "schema": { "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The size of the page, maximum allowed value is 100", "allowEmptyValue": false, "schema": { "maximum": 100, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Service request" } } }, "application/json;charset=UTF-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Service request" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "description": "Get a list of service requests" }, "post": { "tags": [ "/support" ], "summary": "Create a new service request", "operationId": "createServiceRequestUsingPOST", "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementApiServiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "application/json;charset=UTF-8": { "schema": { "type": "string" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "oauth2": [] } ], "x-codegen-request-body-name": "request", "description": "Create a new service request" } } }, "components": { "schemas": { "Additional Order": { "title": "Additional Order", "required": [ "products" ], "type": "object", "properties": { "products": { "type": "array", "description": "The products you want to order", "items": { "$ref": "#/components/schemas/Ordered product" } }, "delivery_address": { "$ref": "#/components/schemas/Address" }, "billing_address": { "$ref": "#/components/schemas/Address" }, "customer_reference": { "type": "string", "description": "Optional customer-specific reference for the order" } }, "description": "General information about an order" }, "Address": { "title": "Address", "required": [ "address_line2", "city", "company", "country", "first_name", "last_name", "salutation", "street", "zip" ], "type": "object", "properties": { "salutation": { "type": "string", "description": "Salutation - currently supported values are '1' for 'Mr' and '2' for 'Ms'", "example": "2", "enum": [ "1", "2" ] }, "first_name": { "type": "string", "description": "First name" }, "last_name": { "type": "string", "description": "Last name" }, "company": { "type": "string", "description": "Company name", "example": "1nce GmbH" }, "street": { "type": "string", "description": "Street" }, "address_line2": { "type": "string", "description": "Address Line2" }, "house_number": { "type": "string", "description": "House number" }, "zip": { "type": "string", "description": "ZIP" }, "city": { "type": "string", "description": "City" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "DE" } }, "description": "Address information" }, "AutoTopupRequest": { "title": "AutoTopupRequest", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether auto topup is enabled for the given SIMs" }, "iccids": { "type": "array", "description": "A list of ICCIDs", "items": { "type": "string" } } }, "description": "Contains a list of ICCIDs and a boolean flag for auto topup" }, "CellGlobalId": { "title": "CellGlobalId", "type": "object", "properties": { "cid": { "type": "integer", "format": "int64" }, "lac": { "type": "integer", "format": "int64" }, "mcc": { "type": "string" }, "mnc": { "type": "string" } } }, "Charge": { "title": "Charge", "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "amount_net": { "type": "number", "description": "Net amount" }, "currency": { "type": "string", "description": "Currency" } }, "description": "A product charge" }, "Communication": { "title": "Communication", "type": "object", "properties": { "communicationDate": { "type": "string" }, "direction": { "type": "string", "enum": [ "IN", "OUT" ] }, "id": { "type": "string" }, "originator": { "type": "string" }, "subject": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string", "enum": [ "PORTAL", "PHONE_IN", "PHONE_OUT", "MAIL_IN", "MAIL_OUT" ] } } }, "Connectivity": { "title": "Connectivity", "type": "object", "properties": { "status": { "type": "string", "description": "The status of the connectivity" }, "location": { "$ref": "#/components/schemas/Location" }, "pdp_context": { "$ref": "#/components/schemas/PdpContext" }, "services": { "type": "array", "description": "List of services", "items": { "type": "string" } } }, "description": "Contains connectivity status" }, "ConnectivityInfo": { "title": "ConnectivityInfo", "type": "object", "properties": { "ussd_info": { "$ref": "#/components/schemas/UssdInfo" }, "subscriber_info": { "$ref": "#/components/schemas/SubscriberInfo" }, "request_timestamp": { "type": "string", "description": "Time in UTC the request was received", "example": "2018-11-07T17:21:46.121+0000" }, "reply_timestamp": { "type": "string", "description": "Time in UTC the response was sent", "example": "2018-11-07T17:21:46.263+0000" } }, "description": "Contains connectivity and location information" }, "Country": { "title": "Country", "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "iso_code": { "type": "string" }, "name": { "type": "string" } }, "description": "Country of the operator" }, "Daily": { "title": "Daily", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data" }, "date": { "type": "string" }, "sms": { "$ref": "#/components/schemas/Sms" } } }, "DailyUsage": { "title": "DailyUsage", "type": "object", "properties": { "stats": { "type": "array", "description": "List of daily usage statistics", "items": { "$ref": "#/components/schemas/Daily" } } }, "description": "Information about daily SIM usage" }, "Data": { "title": "Data", "type": "object", "properties": { "cost": { "type": "string" }, "currency": { "type": "object", "properties": {} }, "traffic_type": { "$ref": "#/components/schemas/TrafficType" }, "volume": { "type": "string" }, "volume_rx": { "type": "string" }, "volume_tx": { "type": "string" } } }, "EventCollection": { "title": "EventCollection", "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/SIM Event" } }, "totalEvents": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } } }, "IccidRange": { "title": "IccidRange", "type": "object", "properties": { "from": { "type": "string", "description": "The first ICCID of the range" }, "to": { "type": "string", "description": "The last ICCID of the range" } } }, "Link": { "title": "Link", "type": "object", "properties": { "rel": { "type": "string", "description": "rel", "example": "self" }, "href": { "type": "string", "description": "href", "example": "https://api.1nce.com/api/v1/sims/9999999999000000001" } } }, "Location": { "title": "Location", "type": "object", "properties": { "description": { "type": "string" }, "rat_type_id": { "type": "string" } }, "description": "Location information." }, "ManagementApiServiceRequest": { "title": "ManagementApiServiceRequest", "type": "object", "properties": { "replyToMail": { "type": "string" }, "senderName": { "type": "string" }, "subject": { "type": "string" }, "text": { "type": "string" } } }, "Order": { "title": "Order", "type": "object", "properties": { "order_number": { "type": "number", "description": "Order No. - the unique numerical identifier for a order", "example": 2000000001 }, "order_type": { "type": "string", "description": "The order type indicates whether this is a first order, additional order or a topup", "example": "FIRST_ORDER", "enum": [ "FIRST_ORDER", "ADDITIONAL_ORDER", "TOPUP", "BULK_TOPUP" ] }, "order_date": { "type": "string", "description": "Order date", "format": "date-time" }, "order_status": { "type": "string", "description": "Status of the Order", "example": "COMPLETED" }, "invoice_number": { "type": "string", "description": "Invoice No. - unique alphanumerical identifier for the corresponding invoice", "example": "20000002" }, "invoice_amount": { "type": "string", "description": "The gross value which this order amounts to, as printed on the invoice", "example": "19.99" }, "currency": { "type": "string", "description": "ISO 4217 currency code used for the invoice amount", "example": "EUR" }, "shipping_address": { "$ref": "#/components/schemas/Address" }, "sims": { "type": "array", "description": "SIMs included or affected by this Order", "items": { "$ref": "#/components/schemas/SIM" } }, "products": { "type": "array", "description": "IDs and quantity of ordered products", "items": { "$ref": "#/components/schemas/Product information" } } }, "description": "General information about an order" }, "Ordered product": { "title": "Ordered product", "type": "object", "properties": { "productId": { "type": "integer", "format": "int64" }, "quantity": { "type": "integer", "format": "int32" } }, "description": "What you want and how much of it" }, "PdpContext": { "title": "PdpContext", "type": "object", "properties": { "breakout_ip": { "type": "string" }, "ci": { "type": "object", "properties": {} }, "created": { "type": "string" }, "duration": { "type": "string" }, "endpoint_id": { "type": "string" }, "ggsn_control_plane_ip_address": { "type": "string" }, "ggsn_data_plane_ip_address": { "type": "string" }, "gtp_version": { "type": "string" }, "imeisv": { "type": "string" }, "imsi": { "type": "string" }, "imsi_id": { "type": "string" }, "lac": { "type": "string" }, "mcc": { "type": "string" }, "mnc": { "type": "string" }, "nsapi": { "type": "string" }, "operator_id": { "type": "string" }, "organisation_id": { "type": "string" }, "pdp_context_id": { "type": "string" }, "rac": { "type": "object", "properties": {} }, "rat_type": { "$ref": "#/components/schemas/Location" }, "ratezone_id": { "type": "string" }, "region": { "type": "string" }, "sac": { "type": "string" }, "sgsn_control_plane_ip_address": { "type": "string" }, "sgsn_data_plane_ip_address": { "type": "string" }, "sim_id": { "type": "string" }, "tariff_id": { "type": "string" }, "tariff_profile_id": { "type": "string" }, "teid_control_plane": { "type": "string" }, "teid_data_plane": { "type": "string" }, "ue_ip_address": { "type": "string" } }, "description": "Pdp Context" }, "Product": { "title": "Product", "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "product": { "type": "string", "description": "Product name" }, "material": { "type": "string", "description": "Material" }, "package_size": { "type": "integer", "description": "Package size", "format": "int64" }, "maxQuantity": { "type": "integer", "description": "Maximum quantity of product per order", "format": "int64" }, "min_contract_duration": { "type": "integer", "description": "Minimum contract duration", "format": "int64" }, "one_time_charges": { "type": "array", "description": "One-Time charges", "items": { "$ref": "#/components/schemas/Charge" } }, "recurring_charges": { "type": "array", "description": "Recurring charges", "items": { "$ref": "#/components/schemas/Charge" } } }, "description": "Information about a product" }, "Product information": { "title": "Product information", "type": "object", "properties": { "product_id": { "type": "integer", "description": "Product ID", "format": "int64" }, "quantity": { "type": "integer", "description": "Quantity of SIM with this product ordered", "format": "int64" } }, "description": "General information about an ordered product" }, "Quota": { "title": "Quota", "type": "object", "properties": { "volume": { "type": "number", "description": "Currently available Volume, either SMS or data in MB", "example": 435.787951 }, "total_volume": { "type": "number", "description": "The total data volume or SMS this SIM has available over its lifetime", "example": 500 }, "expiry_date": { "type": "string", "description": "Date this quota will expire", "example": "2029-01-01 00:00:00" }, "peak_throughput": { "type": "integer", "description": "The optional throughput in bit/s (only for data quotas)", "format": "int32", "example": 128000 }, "last_volume_added": { "type": "number", "description": "Amount of SMS or data volume which was last purchased for this SIM", "example": 500 }, "last_status_change_date": { "type": "string", "description": "Last date and time on which this quota was changed, e.g. by purchasing a TopUp", "example": "2018-10-01 11:59:44" }, "threshold_percentage": { "type": "integer", "description": "Threshold in percentage for which a volume notification will be send", "format": "int32", "example": 20 } } }, "SIM": { "title": "SIM", "type": "object", "properties": { "iccid": { "type": "string", "description": "ICCID", "example": "8988280666000000000" }, "_links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } }, "description": "SIMs included/affected by an order" }, "SIM Event": { "title": "SIM Event", "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp", "example": "2018-05-07T14:08:05.000+0000" }, "event_type": { "type": "string", "description": "A description of the event type", "example": "Status of SIM changed from 'Issued' to 'Activated'" }, "iccid": { "type": "string", "description": "ICCID", "example": "8988280666000000000" }, "imei": { "type": "string", "description": "IMEI", "example": "0000000000000018" }, "imsi": { "type": "string", "description": "IMSI", "example": "901405100000018" }, "country": { "type": "string", "description": "Country", "example": "Germany" }, "operator": { "type": "string", "description": "Operator name", "example": "T-Mobile" }, "mcc": { "type": "string", "description": "MCC", "example": "262" }, "mnc": { "type": "string", "description": "MNC", "example": "01" }, "alert": { "type": "boolean", "description": "Boolean flag determining if this event is treated as an alert", "example": false }, "event_severity": { "type": "string", "description": "Textual representation of the severity of the event", "example": "Info" } }, "description": "Information about a Event. Besides the timestamp and the event_type all other values are optional and might not be included in the actual response" }, "SIM card": { "title": "SIM card", "type": "object", "properties": { "iccid": { "type": "string", "description": "ICCID", "example": "8988280666000000000" }, "imsi": { "type": "string", "description": "IMSI", "example": "901405100000018" }, "imsi_2": { "type": "string", "description": "IMSI_2", "example": "901405100000018" }, "current_imsi": { "type": "string", "description": "CURRENT_IMSI", "example": "901405100000018" }, "msisdn": { "type": "string", "description": "MSISDN", "example": "882285100000018" }, "imei": { "type": "string", "description": "IMEI", "example": "0000000000000018" }, "imei_lock": { "type": "boolean", "description": "Indicates if SIM is locked to the current IMEI", "example": true }, "status": { "type": "string", "description": "Current Status", "example": "Disabled", "enum": [ "Enabled", "Disabled" ] }, "activation_date": { "type": "string", "description": "Activation date", "example": "2018-03-09T07:59:09.000+0000" }, "ip_address": { "type": "string", "description": "IP Address", "example": "100.100.100.18" }, "current_quota": { "type": "number", "description": "Current Quota for this SIM in MB", "example": 500 }, "quota_status": { "$ref": "#/components/schemas/Status indicating whether or not the treshold or the quota has been reached" }, "label": { "type": "string", "description": "Label", "example": "DX-137-B12" } }, "description": "Information about a SIM card" }, "SMS": { "title": "SMS", "type": "object", "properties": { "source_address": { "type": "string", "description": "The source address", "example": "1234567890" }, "payload": { "type": "string", "description": "The content of the SMS", "example": "This is a text" }, "udh": { "type": "string", "description": "User Data Header encoded has hex-String (optional)" }, "dcs": { "type": "integer", "description": "Data Coding Scheme (optional)", "format": "int32", "example": 8 }, "source_address_type": { "$ref": "#/components/schemas/Type definition for the source address" }, "expiry_date": { "type": "string", "description": "Expiry Date in ISO8601", "example": "2018-03-14T16:10:29.000+0000" } }, "description": "SMS to be send to SIM" }, "SMS-Data": { "title": "SMS-Data", "type": "object", "properties": { "id": { "type": "number", "description": "id", "example": 590 }, "submit_date": { "type": "string", "description": "The date and time on which this SMS was submitted", "example": "2015-10-05 13:56:59" }, "delivery_date": { "type": "string", "description": "The date and time on which this SMS was delivered", "example": "2015-10-05 13:56:59" }, "expiry_date": { "type": "string", "description": "The date and time on which this SMS will expire", "example": "2015-10-06 13:56:59" }, "final_date": { "type": "string", "description": "The final date and time", "example": "2015-10-05 13:57:03" }, "retry_date": { "type": "string", "description": "The date and time on which the delivery was retried", "example": "2015-10-05 13:57:03" }, "last_delivery_attempt": { "type": "string", "description": "The date and time on which the last delivery was attempted", "example": "2015-10-05 13:57:03" }, "retry_count": { "type": "string", "description": "The retry count", "example": "1" }, "source_address": { "type": "string", "description": "The source address", "example": "1234567890" }, "iccid": { "type": "string", "description": "ICCID", "example": "8988303000000001000" }, "msisdn": { "type": "string", "description": "MSISDN", "example": "883XXXXXXXXXXXX" }, "imsi": { "type": "string", "description": "IMSI", "example": "901XXXXXXXXXXXX" }, "msc": { "type": "string", "description": "MSC", "example": "491600190000" }, "dcs": { "type": "integer", "description": "DCS", "format": "int32" }, "udh": { "type": "string", "description": "User Data Header encoded has hex-String (optional)" }, "payload": { "type": "string", "description": "The content of the SMS", "example": "This is a text" }, "status": { "$ref": "#/components/schemas/SmsStatus" }, "sms_type": { "$ref": "#/components/schemas/Type definition for a SMS" }, "source_address_type": { "$ref": "#/components/schemas/Type definition for the source address" } }, "description": "Information about a SMS" }, "Service request": { "title": "Service request", "type": "object", "properties": { "caseId": { "type": "string" }, "communications": { "type": "array", "items": { "$ref": "#/components/schemas/Communication" } }, "createDate": { "type": "string" }, "solvedDate": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "IN_PROGRESS", "CLOSED" ] }, "subject": { "type": "string" }, "text": { "type": "string" } }, "description": "General information about a service request" }, "SimTransfer": { "title": "SimTransfer", "type": "object", "properties": { "target_organisation": { "type": "integer", "description": "The organisation to transfer the SIMs TO. Required if transferring to a suborganisation.", "format": "int64", "example": 2000000001 }, "iccid_ranges": { "type": "array", "description": "SIMs included or affected by this order", "items": { "$ref": "#/components/schemas/IccidRange" } }, "iccids": { "type": "array", "description": "SIMs included or affected by this order", "items": { "type": "string" } } }, "description": "A SIM Transfer request" }, "Sms": { "title": "Sms", "type": "object", "properties": { "cost": { "type": "string" }, "currency": { "type": "object", "properties": {} }, "traffic_type": { "$ref": "#/components/schemas/TrafficType_" }, "volume": { "type": "string" }, "volume_rx": { "type": "string" }, "volume_tx": { "type": "string" } } }, "SmsStatus": { "title": "SmsStatus", "type": "object", "properties": { "id": { "type": "number", "description": "Numerical status identifier", "example": 4 }, "description": { "type": "string", "description": "Status description", "example": "DELIVERED" } } }, "Status indicating whether or not the treshold or the quota has been reached": { "title": "Status indicating whether or not the treshold or the quota has been reached", "type": "object", "properties": { "id": { "type": "number", "description": "Numerical status on of 0, 1 or 2", "example": 0 }, "description": { "type": "string", "description": "Status description" }, "threshold_reached_date": { "type": "string", "description": "Date on which the threshold of 80% of the quota was reached.", "format": "date-time" }, "quota_exceeded_date": { "type": "string", "description": "Date on which the quota has Exceeded.", "format": "date-time" } } }, "SubscriberInfo": { "title": "SubscriberInfo", "type": "object", "properties": { "current_location_retrieved": { "type": "boolean", "description": "Boolean flag indicating if the retrieved location is current", "example": true }, "age_of_location": { "type": "integer", "description": "Age of the location information in minutes", "format": "int32", "example": 0 }, "cell_global_id": { "$ref": "#/components/schemas/CellGlobalId" } }, "description": "Optional information about the current location" }, "TrafficType": { "title": "TrafficType", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "unit": { "type": "string" } } }, "TrafficType_": { "title": "TrafficType_", "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "unit": { "type": "string" } } }, "Type definition for a SMS": { "title": "Type definition for a SMS", "type": "object", "properties": { "id": { "type": "number", "description": "Numerical identifier for the type", "example": 1 }, "description": { "type": "string", "description": "Type description", "example": "MT" } } }, "Type definition for the source address": { "title": "Type definition for the source address", "type": "object", "properties": { "id": { "type": "number", "description": "Numerical identifier for the type", "example": 145 } } }, "UssdInfo": { "title": "UssdInfo", "type": "object", "properties": { "success": { "type": "boolean", "description": "Boolean flag indicating the success", "example": false }, "error": { "type": "string", "description": "Optional information if some error occurred", "example": "Request Timeout Error" } }, "description": "Optional ussd information, only set if the parameter 'ussd' is set to true." }, "Values for a SIM update": { "title": "Values for a SIM update", "type": "object", "properties": { "iccid": { "type": "string", "description": "ICCID" }, "label": { "type": "string", "description": "Label" }, "imei_lock": { "type": "boolean", "description": "Indicates if SIM is locked to the current IMEI", "example": true }, "status": { "type": "string", "description": "Current Status", "example": "Disabled" } }, "description": "Information about a SIM card" } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/management-api/oauth/token", "scopes": {} } } } } }, "tags": [ { "name": "/orders", "description": "Order Controller" }, { "name": "/products", "description": "Product information" }, { "name": "/sims", "description": "Manage your SIMs" }, { "name": "/support", "description": "Support Controller" } ], "x-original-swagger-version": "2.0" }