{ "openapi": "3.0.1", "info": { "title": "API Center", "version": "1.0" }, "paths": { "/api/apps/accounts/{guid}": { "get": { "tags": [ "App" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } } }, "/api/v2/apps/accounts/{guid}": { "get": { "tags": [ "App" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } } }, "/api/apps/login/{userGuids}": { "post": { "tags": [ "App" ], "parameters": [ { "name": "userGuids", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppUserAccountDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/apps/login/{userGuids}": { "post": { "tags": [ "App" ], "parameters": [ { "name": "userGuids", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppUserAccountDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/apps/register": { "post": { "tags": [ "App" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectivityServiceRegisterDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/apps/register": { "post": { "tags": [ "App" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterAppPayloadDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/projects/{project_id}/licenses/active-on-date": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/projects/{project_id}/licenses/all": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/projects/{project_id}/licenses/date-range": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/v1/plan/skus/list": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/v1/plan/features/list": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/v1/plan/sku": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "sku", "in": "query", "schema": { "type": "string" } }, { "name": "feature", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseNew" } } } } } } }, "/api/products/{productId}": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userGuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } } }, "/api/v2/products/{productId}": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userGuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/products/provision/status/{guid}": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultProvision" } } } } } } }, "/api/v2/products/provision/status/{guid}": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultProvision" } } } } } } }, "/api/product/Bulk/provision/{guid}": { "post": { "tags": [ "Product" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionBulkInsertWithTaskIdDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } } }, "/api/v2/product/Bulk/provision/{guid}": { "post": { "tags": [ "Product" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionBulkInsertWithTaskIdDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } } }, "/api/product/provision": { "delete": { "tags": [ "Product" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionDeleteDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/product/provision": { "delete": { "tags": [ "Product" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionDeleteDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/products/levelservice/seats": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "userGuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/products/levelservice/seats": { "get": { "tags": [ "Product" ], "parameters": [ { "name": "userGuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/products/queue/{taskId}": { "get": { "tags": [ "Queue" ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userGuid", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/products/queue/{taskId}": { "get": { "tags": [ "Queue" ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userGuid", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/product/queue/provision/{guid}": { "post": { "tags": [ "Queue" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } } }, "/api/v2/product/queue/provision/{guid}": { "post": { "tags": [ "Queue" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } } }, "/api/authenticate": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthConfig" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v2/authenticate": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthConfig" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/users": { "get": { "tags": [ "User" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } } }, "/api/v2/users": { "get": { "tags": [ "User" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } } }, "/api/user/{id}": { "get": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } }, "put": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } }, "delete": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/user/{id}": { "get": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } }, "put": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateDTO_v2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } }, "delete": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } }, "/api/user": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v1" } } } } } } }, "/api/v2/user": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateDTO_v2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_v2" } } } } } } } }, "components": { "schemas": { "ApiResponseNew": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "result": { "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiResponse_v1": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "nullable": true }, "taskId": { "type": "integer", "format": "int32" }, "result": { "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "statusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "msg": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ApiResponse_v2": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "nullable": true }, "taskId": { "type": "integer", "format": "int32" }, "result": { "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "msg": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AppUserAccountDTO": { "type": "object", "properties": { "appUserName": { "type": "string", "nullable": true }, "appUserEmail": { "type": "string", "nullable": true }, "appPassword": { "type": "string", "nullable": true }, "appName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthConfig": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectivityServiceRegisterDTO": { "type": "object", "properties": { "userGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "defaultEmail": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceAssociationInsert": { "type": "object", "properties": { "serialNumber": { "type": "string", "nullable": true }, "deviceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HttpStatusCode": { "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 ], "type": "integer", "format": "int32" }, "InfoDetail": { "type": "object", "properties": { "serialNumber": { "type": "string", "nullable": true }, "deviceID": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "msg": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProvisionBulkInsertWithTaskIdDTO": { "type": "object", "properties": { "provisionOptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deviceAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceAssociationInsert" }, "nullable": true }, "consoleFlowCompanyName": { "type": "string", "nullable": true }, "connectivityServicesUserName": { "type": "string", "nullable": true }, "registerTo": { "type": "string", "nullable": true }, "taskId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProvisionDeleteDTO": { "type": "object", "properties": { "serialNo": { "type": "string", "nullable": true }, "deviceID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProvisionDetailStatus": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InfoDetail" }, "nullable": true }, "register": { "type": "array", "items": { "$ref": "#/components/schemas/InfoDetail" }, "nullable": true }, "consoleFlow": { "type": "array", "items": { "$ref": "#/components/schemas/InfoDetail" }, "nullable": true }, "connectivityService": { "type": "array", "items": { "$ref": "#/components/schemas/InfoDetail" }, "nullable": true }, "levelService": { "type": "array", "items": { "$ref": "#/components/schemas/InfoDetail" }, "nullable": true } }, "additionalProperties": false }, "RegisterAppPayloadDTO": { "type": "object", "properties": { "userGuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "defaultEmail": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "appName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResultProvision": { "type": "object", "properties": { "provisionDetailStatuses": { "$ref": "#/components/schemas/ProvisionDetailStatus" } }, "additionalProperties": false }, "UserCreateDTO": { "type": "object", "properties": { "userEmail": { "type": "string", "nullable": true }, "userFname": { "type": "string", "nullable": true }, "userMname": { "type": "string", "nullable": true }, "userLname": { "type": "string", "nullable": true }, "userPhone": { "type": "string", "nullable": true }, "userAddress": { "type": "string", "nullable": true }, "userCity": { "type": "string", "nullable": true }, "userState": { "type": "string", "nullable": true }, "userCountry": { "type": "string", "nullable": true }, "userZipcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserCreateDTO_v2": { "type": "object", "properties": { "userEmail": { "type": "string", "nullable": true }, "userFname": { "type": "string", "nullable": true }, "userMname": { "type": "string", "nullable": true }, "userLname": { "type": "string", "nullable": true }, "userPhone": { "type": "string", "nullable": true }, "userAddress": { "type": "string", "nullable": true }, "userCity": { "type": "string", "nullable": true }, "userState": { "type": "string", "nullable": true }, "userCountry": { "type": "string", "nullable": true }, "userZipcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserUpdateDTO": { "type": "object", "properties": { "userEmail": { "type": "string", "nullable": true }, "userFname": { "type": "string", "nullable": true }, "userMname": { "type": "string", "nullable": true }, "userLname": { "type": "string", "nullable": true }, "userPhone": { "type": "string", "nullable": true }, "userAddress": { "type": "string", "nullable": true }, "userCity": { "type": "string", "nullable": true }, "userState": { "type": "string", "nullable": true }, "userCountry": { "type": "string", "nullable": true }, "userZipcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserUpdateDTO_v2": { "type": "object", "properties": { "userEmail": { "type": "string", "nullable": true }, "userFname": { "type": "string", "nullable": true }, "userMname": { "type": "string", "nullable": true }, "userLname": { "type": "string", "nullable": true }, "userPhone": { "type": "string", "nullable": true }, "userAddress": { "type": "string", "nullable": true }, "userCity": { "type": "string", "nullable": true }, "userState": { "type": "string", "nullable": true }, "userCountry": { "type": "string", "nullable": true }, "userZipcode": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Token Authorization header using the bearer scheme", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }