Example: \"ip_address:127.0.0.1,imei:4711\"
", "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort values in a comma seperated list. Prepend \"-\" for descending sort. Possible values:Example:\"ip_address,-imei\"
", "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "X-Count-Per-Page": { "description": "Number of results per page.", "schema": { "type": "integer" } }, "X-Current-Page": { "description": "Number of the current page.", "schema": { "type": "integer" } }, "X-Total-Count": { "description": "Total number of results available.", "schema": { "type": "integer" } }, "X-Total-Pages": { "description": "Total number of pages available.", "schema": { "type": "integer" } } }, "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] }, "post": { "tags": [ "General SIMs" ], "summary": "Create Multiple SIM Configuration", "description": "Change a list of SIMS for activate, deactivate, label, IMEI lock, etc. The actual change will be done asynchronously. A positive-response only means that the SIM changes has been successfully placed into the queue.", "operationId": "updateSimsUsingPOST", "requestBody": { "description": "A list of SIM parameters where some parameters should be changed.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Values_for_a_SIM_update" } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "sims" } }, "/v1/sims/{iccid}": { "get": { "tags": [ "General SIMs" ], "summary": "Get Single SIM", "description": "Get detail information (status, label, MSISDN, IMSI, ICCID, Lifetime, etc.) for a singe SIM based on the ICCID.", "operationId": "getSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] }, "put": { "tags": [ "General SIMs" ], "summary": "Create Single SIM Configuration", "description": "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 to be changed.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "requestBody": { "description": "Response with the modified data for the SIM that was selected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Values_for_a_SIM_update" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "sim" } }, "/v1/sims/{iccid}/status": { "get": { "tags": [ "General SIMs" ], "summary": "Get SIM Status", "description": "Query the current status of a specific SIM card.", "operationId": "getStatusForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/simTransfer": { "post": { "tags": [ "General SIMs" ], "summary": "Create SIM Transfer", "description": "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": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "request" } }, "/v1/sims/{iccid}/connectivity_info": { "get": { "tags": [ "Connectivity" ], "summary": "Get SIM Connectivity", "description": "Retrieve connectivity information and cell tower of a device with a given SIM. The API call returns valid information when the 1NCE SIM is attached to a 2G/3G network only.", "operationId": "getConnectivityInfoForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The iccid of the SIM in question.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "subscriber", "in": "query", "description": "Flag indicating if the subscriber information should be retrieved. Default value is true.", "allowEmptyValue": false, "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "ussd", "in": "query", "description": "Flag for retrieving the USSD connectivity info. Default value is 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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/reset": { "post": { "tags": [ "Connectivity" ], "summary": "Create Connectivity Reset", "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.", "operationId": "resetConnectivityUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be reset.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "responses": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/events": { "get": { "tags": [ "SIM Events" ], "summary": "Get SIM Events", "description": "Get diagnostic/event information for a SIM card.", "operationId": "getEventsForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "page", "in": "query", "description": "Number index of the requested SIM event page. Use this parameter to iterate through all SIMs on the different pages. The total amount of pages is listed in the response header.", "allowEmptyValue": false, "schema": { "minimum": 1, "exclusiveMinimum": false, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The number of events per page, maximum allowed value is 1000.", "allowEmptyValue": false, "schema": { "maximum": 1000, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort values based on keys that are listed as a comma seperated list, prepend \"-\" for descending order.", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "-timestamp,id" } ], "responses": { "200": { "description": "OK", "headers": { "X-Count-Per-Page": { "description": "Number of results per page.", "schema": { "type": "integer", "format": "int32" } }, "X-Current-Page": { "description": "Number of the current page.", "schema": { "type": "integer", "format": "int32" } }, "X-Total-Count": { "description": "Total number of results available.", "schema": { "type": "integer", "format": "int32" } }, "X-Total-Pages": { "description": "Total number of pages available.", "schema": { "type": "integer", "format": "int32" } } }, "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/usage": { "get": { "tags": [ "SIM Usage" ], "summary": "Get SIM Usage", "description": "Query the SIM data and SMS usage over a given period of time. The output is limited to the last 6 months.", "operationId": "getUsageForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "start_dt", "in": "query", "description": "Start date used for the query, format: YYYY-MM-DD", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "2022-07-22" }, { "name": "end_dt", "in": "query", "description": "End date used for the usage query, format: YYYY-MM-DD", "allowEmptyValue": false, "schema": { "type": "string" }, "example": "2022-07-22" } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/quota/data": { "get": { "tags": [ "SIM Usage" ], "summary": "Get SIM Data Quota", "description": "Get the current data quota of a particular SIM.", "operationId": "getDataQuotaForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/quota/sms": { "get": { "tags": [ "SIM Usage" ], "summary": "Get SIM SMS Quota", "description": "Get the current SMS quota of a particular SIM.", "operationId": "getSmsQuotaForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/sms": { "get": { "tags": [ "SMS" ], "summary": "Get MT/MO-SMS", "description": "Get a list of SMS sent and received by a specific SIM card.", "operationId": "getSmsForSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "page", "in": "query", "description": "Number index of the requested SIM SMS page. Use this parameter to iterate through all SIMs on the different pages. The total amount of pages is listed in the response header.", "allowEmptyValue": false, "schema": { "minimum": 1, "exclusiveMinimum": false, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "The number of SMS messages per page, maximum allowed value is 100.", "allowEmptyValue": false, "schema": { "maximum": 100, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "type": "integer", "default": 10 } }, { "name": "sort", "in": "query", "description": "Keys by which the SMS messages should be sorted, listed as comma sperated values.", "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] }, "post": { "tags": [ "SMS" ], "summary": "Create SMS", "description": "Create and send a MT-SMS towards a device with a 1NCE SIM.", "operationId": "sendSmsToSimUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM targeted for the MT-SMS.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 } ], "requestBody": { "description": "The MT-SMS message that should be sent to SIM.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMSMessage" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SMSMessage" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "sms" } }, "/v1/sims/{iccid}/sms/{id}": { "get": { "tags": [ "SMS" ], "summary": "Get SMS Details", "description": "Query details about an individual SMS from a specifc SIM card.", "operationId": "getSmsOfSimUsingGET", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "id", "in": "path", "description": "The ID of the SMS message to be queried.", "required": true, "schema": { "type": "number" }, "example": 123 } ], "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": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] }, "delete": { "tags": [ "SMS" ], "summary": "Delete SMS", "description": "Cancel a SMS message that is buffered to be delivered to the device with the SIM card but was not yet delivered.", "operationId": "cancelSmsForSimUsingDELETE", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be queried.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "id", "in": "path", "description": "The ID of the SMS message to be queried.", "required": true, "schema": { "type": "number" }, "example": 123 } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/{iccid}/topup": { "post": { "tags": [ "Volume Top Up" ], "summary": "Create Single Top Up", "description": "Top up the data/SMS volume of one specific SIM.", "operationId": "topUpUsingPOST", "parameters": [ { "name": "iccid", "in": "path", "description": "The ICCID of the SIM to be topped up.", "required": true, "schema": { "type": "string" }, "example": 8988280666000000000 }, { "name": "payment_method", "in": "query", "description": "Optional payment method selection between creditcard, banktransfer, monthlyinvoice or boleto. If the parameter is left empty or is invalid, banktransfer is used as default for the top up order process.", "required": false, "schema": { "type": "string", "enum": [ "banktransfer", "creditcard", "monthlyinvoice", "boleto" ], "default": "banktransfer", "example": "banktransfer" } } ], "responses": { "201": { "description": "Order created successfully.", "headers": { "Location": { "description": "The path to the newly created order.", "schema": { "type": "string", "example": "https://api.1nce.com/management-api/v1/orders/1234" } } }, "content": {} }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid Payment Method": { "value": { "message": "Payment method used is not valid." } } }, "schema": { "title": "Invalid Payment Method", "properties": { "message": { "example": "Payment method used is not valid.", "type": "string" } } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "SIM does not belong to user.", "content": {} }, "404": { "description": "SIM not found.", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/topup": { "post": { "tags": [ "Volume Top Up" ], "summary": "Create Multiple Top Up", "description": "Top up the data/SMS volume of a list of SIM.", "operationId": "topUpMultipleUsingPOST", "parameters": [ { "name": "payment_method", "in": "query", "description": "Optional payment method selection between creditcard, banktransfer, monthlyinvoice or boleto. If the parameter is left empty or is invalid, banktransfer is used as default for the top up order process.", "required": false, "schema": { "type": "string", "enum": [ "banktransfer", "creditcard", "monthlyinvoice", "boleto" ], "default": "banktransfer", "example": "banktransfer" } } ], "requestBody": { "description": "A list of ICCIDs of SIMs where a Top Up should be executed.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "8988280666000000000" } } } }, "required": true }, "responses": { "201": { "description": "Top Up order initiated successfully.", "headers": { "Location": { "description": "The path to the newly created order.", "schema": { "type": "string", "example": "https://api.1nce.com/management-api/v1/orders/1234" } } }, "content": {} }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid Payment Method": { "value": { "message": "Payment method used is not valid." } } }, "schema": { "title": "Invalid Payment Method", "properties": { "message": { "example": "Payment method used is not valid.", "type": "string" } } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "SIM does not belong to user.", "content": {} }, "404": { "description": "SIM not found.", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "sims" } }, "/v1/sims/autoTopup": { "post": { "tags": [ "Volume Top Up" ], "summary": "Enable Auto Top Up", "description": "Trigger an auto top up configuration update for the given SIMs.", "operationId": "autoTopupUsingPOST", "requestBody": { "description": "Auto top up request with ICCIDs of SIMs where the auto top up configuration should be changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopupRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "request" } }, "/v1/sims/limits": { "get": { "tags": [ "Volume Limits" ], "summary": "Get Global Limits", "description": "Get currently configured self-set monthly limits (Data, MT-SMS, MO-SMS) for all SIMs.", "operationId": "getLimitsUsingGET", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Values_for_Limits" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] }, "post": { "tags": [ "Volume Limits" ], "summary": "Create Global Limits", "description": "Configure self-set monthly limits for all SIMs (Data, MT-SMS, MO-SMS).", "operationId": "setLimitsUsingPOST", "requestBody": { "description": "Monthly limits to be set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLimitsRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "request" } }, "/v1/sims/{service}/limits": { "get": { "tags": [ "Volume Limits" ], "summary": "Get SIM Limits", "description": "Get a list of slectable limits for a given service.", "operationId": "getSelectableLimitsUsingGET", "parameters": [ { "name": "service", "in": "path", "description": "The service name (data, smsMO, smsMT) for which to list the avaliable limit options.", "required": true, "schema": { "type": "string", "enum": [ "data", "smsMO", "smsMT" ], "default": "data" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Values_for_Limits" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} }, "422": { "description": "The following SIMs are expired and cannot be modified via API. Only extensions are permitted", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ] } }, "/v1/sims/extension": { "post": { "tags": [ "SIM Extension" ], "summary": "Create SIM Extension", "description": "Trigger the SIM extension for one or more SIM cards to extend their activation period and renew their quota (data and SMS). An invoice is automatically triggered depending on the chosen payment method.", "operationId": "extendSimsUsingPOST", "parameters": [ { "name": "payment_method", "in": "query", "description": "Optional payment method selection between creditcard, banktransfer, monthly invoice or boleto. If the parameter is left empty or is invalid, banktransfer is used as default for the SIM extension process. To use creditcard please save your credit card details in the customer portal via \"account\".", "required": false, "schema": { "type": "string", "enum": [ "banktransfer", "creditcard", "monthlyinvoice", "boleto" ], "default": "banktransfer", "example": "banktransfer" } } ], "requestBody": { "description": "The body shall include a list of atleast one ICCIDs and optionally a product id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMExtensionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": {} }, "400": { "description": "Bad Request", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "security": [ { "BearerAuthentication": [] } ], "x-codegen-request-body-name": "request" } } }, "components": { "schemas": { "SIMExtensionRequest": { "title": "SIM Extension Request", "type": "object", "properties": { "iccids": { "type": "array", "description": "A list of ICCIDs of SIMs which should be extended.", "items": { "type": "string", "example": "8988280666000000000" } }, "productId": { "type": "integer", "description": "Optional product id (see /v1/products) for changing the product during the process of the SIM extension. If left out, the current SIM product will be used for extension." } }, "description": "Request for extending the lifetime of SIMs product." }, "AutoTopupRequest": { "title": "Auto Top Up Request", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating wheather auto top up should be enabled or disabled for the given ICCIDs/SIMs." }, "iccids": { "type": "array", "description": "A list of ICCIDs of SIMs where the auto top up configuration should be changed.", "items": { "type": "string", "example": "8988280666000000000" } } }, "description": "Request with a flag for enabeling and disabeling auto top up for the listed ICCIDs." }, "CellGlobalId": { "title": "Cell Global IDs", "type": "object", "properties": { "cid": { "type": "integer" }, "lac": { "type": "integer" }, "mcc": { "type": "string" }, "mnc": { "type": "string" } }, "description": "Mobile network parameter used to identify the cell tower of a SIM device." }, "Connectivity": { "title": "Connectivity", "type": "object", "properties": { "status": { "type": "string", "description": "The current connectivity status of a SIM.", "example": "OFFLINE", "enum": [ "OFFLINE", "ONLINE", "ATTACHED" ] }, "location": { "$ref": "#/components/schemas/Location" }, "pdp_context": { "$ref": "#/components/schemas/PdpContext" }, "services": { "type": "array", "description": "List of services currently avaliable.", "items": { "type": "string", "description": "Currently used service.", "example": "GPRS" } } }, "description": "Information about the current SIM connectivity status, location and PDP Context of a SIM." }, "ConnectivityInfo": { "title": "Connectivity Info", "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 cell tower information for a given SIM request." }, "CurrentLimitData": { "title": "Current Data Limit", "type": "object", "properties": { "id": { "type": "integer", "description": "Identifer for the currently configured limit.", "example": 1 }, "limit": { "type": "string", "description": "Value of the self-set limit.", "example": "16" }, "unit": { "type": "string", "description": "Unit of the set limit.", "example": "MB" } }, "description": "Currently self-set gloabl data volume limit." }, "CurrentLimitSMS": { "title": "Current SMS Limit", "type": "object", "properties": { "id": { "type": "integer", "description": "Identifer for the currently configured limit.", "example": 1 }, "limit": { "type": "string", "description": "Value of the self-set limit.", "example": "10" }, "unit": { "type": "string", "description": "Unit of the set limit.", "example": "SMS" } }, "description": "Currently self-set gloabl SMS limit for the given service (MT-SMS, MO-SMS)." }, "Daily": { "title": "Daily Usage Record", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data" }, "date": { "type": "string", "description": "Date of the shown usage record.", "example": "2021-06-30T00:00:00.000Z" }, "sms": { "$ref": "#/components/schemas/SmsUsage" } }, "description": "A daily usage record with summarized data about the SMS and data usage." }, "DailyUsage": { "title": "Usage Record", "type": "object", "properties": { "stats": { "type": "array", "description": "List of queried usage statistics for the given SIM.", "items": { "$ref": "#/components/schemas/Daily" } } }, "description": "Information about SIM data and SMS usage." }, "Data": { "title": "Data Usage Record", "type": "object", "properties": { "cost": { "type": "string", "description": "The cost shown here match 1:1 the used SMS. There is no real cost value behind this number.", "example": "0.002803" }, "currency": { "title": "Currency", "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the currency.", "example": 1 }, "symbol": { "type": "string", "description": "ASCII symbol of the currency.", "example": "€" }, "code": { "type": "string", "description": "Standardized currency code.", "example": "EUR" } }, "description": "Description of the currency." }, "traffic_type": { "$ref": "#/components/schemas/TrafficTypeData" }, "volume": { "type": "string", "description": "The summed RX and TX data volume in MB.", "example": "0.002803" }, "volume_rx": { "type": "string", "description": "The used RX (downstream, received by SIM) data volume in MB.", "example": "0.001482" }, "volume_tx": { "type": "string", "description": "The used TX (upstream, send by SIM) data volume in MB.", "example": "0.001321" } }, "description": "A usage record for the data used by a SIM." }, "EventCollection": { "title": "Event Collection", "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/SIM_Event" } }, "totalEvents": { "type": "integer", "example": 10 }, "totalPages": { "type": "integer", "example": 5 } } }, "IccidRange": { "title": "Iccid Range", "type": "object", "properties": { "from": { "type": "string", "description": "The first ICCID of the given range of SIMs.", "example": "8988280666000000000" }, "to": { "type": "string", "description": "The last ICCID of the range of the given SIMs.", "example": "8988280666000000010" } } }, "Location": { "title": "Location", "type": "object", "properties": { "iccid": { "type": "string", "description": "ICCID of a specific 1NCE SIM.", "example": "8988280666000000000" }, "imsi": { "type": "string", "description": "IMSI of the SIM that triggered the event.", "example": "901405100000018" }, "last_updated": { "type": "string", "description": "Timestamp from the last location update.", "format": "date-time" }, "last_updated_gprs": { "type": "string", "description": "Timestamp from the last GPRS location update.", "format": "date-time" }, "sgsn_number": { "type": "string", "description": "Serving GPRS Support Node (SGSN) identifier for the SGSN where the SIM is attached.", "example": "491600300000" }, "vlr_number": { "type": "string", "description": "Visitor Location Register (VLR) identifier.", "example": "491710000000" }, "vlr_number_np": { "type": "string", "description": "Visitor Location Register (VLR) Number NP.", "example": "1" }, "msc_number_np": { "type": "string", "description": "Mobile-services Switching Centre (MSC) Number NP.", "example": "1" }, "sgsn_number_np": { "type": "string", "description": "Serving GPRS Support Node (SGSN) Number NP.", "example": "1" }, "operator_id": { "type": "string", "description": "Identifier for the current operator the SIM is connected to.", "example": "2" }, "msc": { "type": "string", "description": "Mobile-services Switching Centre (MSC) identifier number.", "example": "491710300000" }, "sgsn_ip_address": { "type": "string", "description": "IP address of the used Serving GPRS Support Node (SGSN).", "example": "x.x.x.x" }, "operator": { "title": "Operator", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the operator.", "example": "2" }, "name": { "type": "string", "description": "String name of the operator where the SIM is currently attached to.", "example": "T-Mobile" }, "country": { "title": "Country", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the country.", "example": "74" }, "name": { "type": "string", "description": "String name of the country of the operator where the SIM is currently attached.", "example": "Germany" }, "iso-code": { "type": "string", "description": "ISO code for the country.", "example": "de" } }, "description": "Information about the country of the mobile operator." } }, "description": "Information about the operator." }, "country": { "title": "Country", "type": "object", "properties": { "country_id": { "type": "string", "description": "Identifier of the country.", "example": "74" }, "name": { "type": "string", "description": "String name of the country where the SIM device is currently located.", "example": "Germany" }, "country_code": { "type": "string", "description": "International country code.", "example": "49" }, "mcc": { "type": "string", "description": "Mobile Country Code (MCC) of the SIM device location country.", "example": "262" }, "iso-code": { "type": "string", "description": "ISO code for the country.", "example": "de" }, "latitude": { "type": "string", "description": "Reference latitude of the location country.", "example": "51" }, "longitude": { "type": "string", "description": "Reference longitude of the location country.", "example": "9" } }, "description": "Information about the location country." } }, "description": "Location information of the SIM device." }, "PdpContext": { "title": "PDP Context", "type": "object", "properties": { "pdp_context_id": { "type": "string", "description": "ID of the current PDP Context.", "example": "1898708000" }, "endpoint_id": { "type": "string", "description": "ID of the used SIM endpoint.", "example": "10458000" }, "tariff_profile_id": { "type": "string", "description": "ID of the used tariff profile.", "example": "129700" }, "tariff_id": { "type": "string", "description": "ID of the used tariff.", "example": "442" }, "ratezone_id": { "type": "string", "description": "ID of the used ratezone.", "example": "2171" }, "organisation_id": { "type": "string", "description": "ID of the internal organisation reference.", "example": "26xxx" }, "imsi_id": { "type": "string", "description": "ID of the used IMSI.", "example": "1610xxx" }, "imsi": { "type": "string", "description": "IMSI of the specific SIM.", "example": "901405100000018" }, "sim_id": { "type": "string", "description": "ID of the specific SIM.", "example": "901xxx" }, "teid_data_plane": { "type": "string", "description": "Tunnel ID for the current PDP Context user plane.", "example": "153329900" }, "teid_control_plane": { "type": "string", "description": "Tunnel ID for the current PDP Context control plane.", "example": "153329900" }, "gtp_version": { "type": "string", "description": "Version of the used GPRS Tunneling Protocol (GTP).", "example": "1" }, "nsapi": { "type": "string", "description": "ID of the used Network Service Access Point Identifier (NSAPI).", "example": "5" }, "sgsn_control_plane_ip_address": { "type": "string", "description": "IP address of the Serving GPRS Support Node (SGSN) for the control plane.", "example": "x.x.x.x" }, "sgsn_data_plane_ip_address": { "type": "string", "description": "IP address of the Serving GPRS Support Node (SGSN) for the user data plane.", "example": "x.x.x.x" }, "ggsn_control_plane_ip_address": { "type": "string", "description": "IP address of the Gateway GPRS Support Node (GGSN) for the control plane.", "example": "x.x.x.x" }, "ggsn_data_plane_ip_address": { "type": "string", "description": "IP address of the Gateway GPRS Support Node (GGSN) for the user data plane.", "example": "x.x.x.x" }, "created": { "type": "string", "description": "Timestamp when the PDP Context was created.", "format": "date-time" }, "mcc": { "type": "string", "description": "Mobile Country Code (MCC).", "example": "262" }, "mnc": { "type": "string", "description": "Mobile Network Code (MNC).", "example": "1" }, "operator_id": { "type": "string", "description": "ID of the used SIM endpoint.", "example": "38701" }, "lac": { "type": "string", "description": "Location paramter of the PDP Context.", "example": "10458000" }, "ci": { "type": "string", "description": "Cell Identity (CI).", "example": "5559" }, "ue_ip_address": { "type": "string", "description": "IP address of the device using the SIM.", "example": "x.x.x.x" }, "imeisv": { "type": "string", "description": "IMEISV of the device with the SIM.", "example": "8635760478500000" }, "duration": { "type": "string", "description": "Current duration of the PDP Context.", "example": "02:39:10" }, "rat_type": { "title": "Radio Access Technolog (RAT) Type", "type": "object", "properties": { "rat_type_id": { "type": "string", "description": "ID of the used RAT.", "example": "2" }, "description": { "type": "string", "description": "String description of the used RAT.", "example": "2G", "enum": [ "2G", "3G", "4G", "5G", "NB-IoT" ] } }, "description": "Describes the Radio Access Technology used in the PDP Context." } }, "description": "Information about the current PDP Context of the SIM." }, "Quota": { "title": "Quota", "type": "object", "properties": { "volume": { "type": "number", "description": "Remaning volume of the selected SIM. Dependent on the query, the volume is either the number of SMS reamaining or the avaliable data volume in MB.", "example": 435.787951 }, "total_volume": { "type": "number", "description": "The total data volume in MB or SMS number this SIM has available over its lifetime.", "example": 500 }, "expiry_date": { "type": "string", "description": "The date when this current quota will expire.", "example": "2029-01-01T00:00:00.000Z" }, "peak_throughput": { "type": "integer", "description": "The optional throughput in bit/s (only for data quotas).", "example": 1000000 }, "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": "Timestamp of the last change to the quota.", "example": "2018-10-01T11:59:44.000Z" }, "threshold_percentage": { "type": "integer", "description": "Threshold in percentage for which a volume notification will be send.", "example": 20 } } }, "SIM_Event": { "title": "SIM Event", "type": "object", "properties": { "timestamp": { "type": "string", "description": "Timestamp of the event.", "example": "2018-05-07T14:08:05.000+0000" }, "event_type": { "type": "string", "description": "A text description of the event type.", "example": "Status of SIM changed from 'Issued' to 'Activated'" }, "iccid": { "type": "string", "description": "ICCID of the SIM that triggered the event.", "example": "8988280666000000000" }, "imei": { "type": "string", "description": "IMEI of the device that triggered the event.", "example": "0000000000000018" }, "imsi": { "type": "string", "description": "IMSI of the SIM that triggered the event.", "example": "901405100000018" }, "country": { "type": "string", "description": "Mobile operator country where the event device is currently located.", "example": "Germany" }, "operator": { "type": "string", "description": "Operator name of the network the device is currently attached to.", "example": "T-Mobile" }, "mcc": { "type": "string", "description": "Mobile Country Code (MCC) of the operator network.", "example": "262" }, "mnc": { "type": "string", "description": "Mobile Network Code (MNC) of the network the device is currently attached to.", "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 responses." }, "SIM_card": { "title": "SIM Card", "type": "object", "properties": { "iccid": { "type": "string", "description": "ICCID identifier of the SIM.", "example": "8988303000123456789" }, "iccid_with_luhn": { "type": "string", "description": "ICCID identifier of the SIM with Luhn check number.", "example": "89883030001234567890" }, "imsi": { "type": "string", "description": "First IMSI of the SIM, used for normal 1NCE network.", "example": "901405100000018" }, "imsi_2": { "type": "string", "description": "Second IMSI of the SIM, used for China+ network.", "example": "901405100000018" }, "current_imsi": { "type": "string", "description": "Currently active IMSI, dependent on the region where the SIM is used.", "example": "901405100000018" }, "msisdn": { "type": "string", "description": "MSISDN of the SIM.", "example": "882285100000018" }, "imei": { "type": "string", "description": "IMEI of the device in which the SIM is inserted.", "example": "0000000000000018" }, "imei_lock": { "type": "boolean", "description": "Indicates if SIM is locked to the current device IMEI.", "example": true }, "status": { "type": "string", "description": "The current status of the SIM card.", "example": "Disabled", "enum": [ "Enabled", "Disabled" ] }, "activation_date": { "type": "string", "description": "The date when the SIM card was activated.", "example": "2018-03-09T07:59:09.000+0000" }, "ip_address": { "type": "string", "description": "The fixed IP address of the SIM card.", "example": "100.100.100.18" }, "current_quota": { "type": "number", "description": "The overall set data quota for the SIM in MB.", "example": 500 }, "quota_status": { "$ref": "#/components/schemas/Quota_Status" }, "current_quota_SMS": { "type": "number", "description": "Current SMS Quota for the SIM.", "example": 250 }, "quota_status_SMS": { "$ref": "#/components/schemas/Quota_Status" }, "label": { "type": "string", "description": "Label set by the customer in the 1NCE Portal for the SIM.", "example": "DX-137-B12" } }, "description": "Detailed information about a SIM card." }, "SMSMessage": { "title": "SMS Message Object", "type": "object", "properties": { "source_address": { "type": "string", "description": "The source address of the SMS. This value can be set to any number as it is not used by the 1NCE network.", "example": "1234567890" }, "payload": { "type": "string", "description": "The content body of the SMS message.", "example": "This is a SMS message." }, "udh": { "type": "string", "description": "The optinal User Data Header (UDH) encoded has hex-String can be used to concatenate SMS messages.", "example": "050003CC0301" }, "dcs": { "type": "integer", "description": "The optional Data Coding Scheme (DCS) can be used for setting the message body format to HEX String or normal Text Mode.", "example": 0 }, "source_address_type": { "$ref": "#/components/schemas/Source_Address_Type" }, "expiry_date": { "type": "string", "description": "Expiry Date of the sent SMS in ISO8601 format.", "example": "2018-03-14T16:10:29Z" } }, "description": "SMS message object used to describe a SMS message." }, "SMS-Data": { "title": "SMS Data Object", "type": "object", "properties": { "id": { "type": "number", "description": "ID of the SMS Data Object.", "example": 590 }, "submit_date": { "type": "string", "description": "The date and time on which this SMS was submitted.", "example": "2015-10-05T13:56:59.000Z" }, "delivery_date": { "type": "string", "description": "The date and time on which this SMS was delivered.", "example": "2015-10-05T13:56:59.000Z" }, "expiry_date": { "type": "string", "description": "The date and time on which this SMS will expire.", "example": "2015-10-06T13:56:59.000Z" }, "final_date": { "type": "string", "description": "The final date and time.", "example": "2015-10-05T13:57:03.000Z" }, "retry_date": { "type": "string", "description": "The date and time on which the delivery was retried.", "example": "2015-10-05T13:57:03.000Z" }, "last_delivery_attempt": { "type": "string", "description": "The date and time on which the last delivery was attempted.", "example": "2015-10-05T13:57:03.000Z" }, "retry_count": { "type": "string", "description": "The SMS delivery retry count.", "example": "1" }, "source_address": { "type": "string", "description": "The source address of the SMS message.", "example": "1234567890" }, "iccid": { "type": "string", "description": "The ICCID of the SIM involved in the SMS message.", "example": "8988303000000001000" }, "msisdn": { "type": "string", "description": "MSISDN of the SIM involved in the SMS message.", "example": "883XXXXXXXXXXXX" }, "imsi": { "type": "string", "description": "IMSI of the SIM involved in the SMS message.", "example": "901XXXXXXXXXXXX" }, "msc": { "type": "string", "description": "MSC involved in processing the SMS message.", "example": "491600190000" }, "dcs": { "type": "integer", "description": "The Data Coding Scheme (DCS) of the SMS.", "format": "int32", "example": 0, "enum": [ 0, 4, 8 ] }, "udh": { "type": "string", "description": "User Data Header encoded has hex-String.", "example": "050003CC0301" }, "payload": { "type": "string", "description": "The content body of the SMS message.", "example": "This is a SMS message." }, "status": { "$ref": "#/components/schemas/SmsStatus" }, "sms_type": { "$ref": "#/components/schemas/Type_definition_for_a_SMS" }, "source_address_type": { "$ref": "#/components/schemas/Source_Address_Type" } }, "description": "The SMS data object contains all information about a SMS message." }, "SetLimitsRequest": { "title": "Set Limits Request", "type": "object", "properties": { "dataLimitId": { "type": "integer", "description": "Data Limit ID (from /sims/data/limits list) to be set for the self-set data limit." }, "smsMtLimitId": { "type": "integer", "description": "SMS MT Limit ID (from /sims/smsMT/limits list) to be set for self-set MT-SMS limit." }, "smsMoLimitId": { "type": "integer", "description": "SMS MO Limit ID (from /sims/smsMO/limits list) to be set for self-set MO-SMS limit." } }, "description": "Configure the self-set limits (data, MT-SMS, MO-SMS) of all SIMs. Use /sims/{service}/limits to get a list of IDs for setting the limits." }, "SimTransfer": { "title": "Sim Transfer Request", "type": "object", "properties": { "target_organisation": { "type": "integer", "description": "The organisation id to transfer the SIMs TO. Required if transferring to a suborganisation.", "example": 2000000001 }, "iccid_ranges": { "type": "array", "description": "ICCID range of SIMs included or affected by this transfer.", "items": { "$ref": "#/components/schemas/IccidRange" } }, "iccids": { "type": "array", "description": "Individual ICCIDs of SIMs included or affected by this transfer.", "items": { "type": "string", "description": "List of ICCIDs of individual SIMs.", "example": "8988280666000000000" } } }, "description": "Request data for transferring SIMs from one customer account to another." }, "SmsUsage": { "title": "SMS Usage Record", "type": "object", "properties": { "cost": { "type": "string", "description": "The cost shown here match 1:1 the used SMS. There is no real cost value behind this number.", "example": "4" }, "currency": { "title": "Currency", "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the currency.", "example": 1 }, "symbol": { "type": "string", "description": "ASCII symbol of the currency.", "example": "€" }, "code": { "type": "string", "description": "Standardized currency code.", "example": "EUR" } }, "description": "Description of the currency." }, "traffic_type": { "$ref": "#/components/schemas/TrafficTypeSMS" }, "volume": { "type": "string", "description": "The summed MO- and MT-SMS messages count.", "example": "3" }, "volume_rx": { "type": "string", "description": "The used MO-SMS message count.", "example": "2" }, "volume_tx": { "type": "string", "description": "The used MT-SMS message count.", "example": "1" } }, "description": "A usage record for the SMS used by a SIM." }, "SmsStatus": { "title": "SMS Status", "type": "object", "properties": { "id": { "type": "number", "description": "Numerical status identifier for a SMS message.", "example": 4 }, "description": { "type": "string", "description": "Text description of the message status.", "example": "DELIVERED" } } }, "Quota_Status": { "title": "Quota Status", "type": "object", "properties": { "id": { "type": "number", "description": "Numeric indicator for the threshold levels: