Edge SIM can be ordered by the customer anytime over the console ordering portal, similar to other Console Connect services.
The newly ordered Edge SIMs can be added to any of the existing SIMPool or if require, the customer can setup a new SIMPool. SIMPools can be added to the Customer’s existing or newly defined sites on Cloud Router.
What is Edge SIM?
What are the major differences between the Console Connect Edge SIM and the Console Connect IoT SIM solution?
This is aimed at simplifying the ordering, deployment and change management of your entire global IoT network with Console Connect.
Retrieves all Edge SIM orders enlisted under provided id field and filtered accordingly based on the Filter parameter
OK
Error
[- {
- "id": "017d9187-2452-45d6-97de-69b4cb4f7a0f",
- "friendlyId": "IOTC38C11E9BC",
- "simPoolId": null,
- "simPoolName": "test 123456",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
- "connectivityType": "PRIVATE",
- "name": "test 123456",
- "simQuantity": 1,
- "deliveryAddress": null,
- "companyAddress": "Lorem , Ipsum Text",
- "orderType": "PAYG",
- "dnsPreferred": "10.100.1.1",
- "dnsAlternate": "10.100.1.2",
- "useDefaultDNS": true,
- "status": "ORDERED",
- "error": null,
- "userEmail": "user@example.com",
- "deliveryEmail": null,
- "paymentType": "INVOICE",
- "offerType": null,
- "endUser": null,
- "skipUserEmail": false,
- "skipAdminEmail": false,
- "skipSupportEmail": false,
- "skipCompliance": false,
- "skipSlack": false,
- "skipInsightSr": false,
- "sourceEnterpriseId": null,
- "simType": "PHYSICAL-SIM",
- "productId": 1143474,
- "description": "Lorem , Ipsum Text",
- "manufacturer": "Thales (MADE IN CHINA)",
- "purchaseDate": "2020-05-26T00:00:00.000Z",
- "originalPurchaseOrder": "ZM1124438",
- "purchaseProject": "IoT",
- "eccn": "EAR99",
- "hkHsCode": 85235200,
- "currency": "USD",
- "unitPrice": null,
- "imsiProfileId": null,
- "createdAt": "2024-07-08T11:09:19.386Z",
- "updatedAt": "2024-07-15T12:38:48.933Z",
- "deletedAt": null,
- "updatedById": null,
- "company_id": "5f97d3d2d85fbe0014fd1812",
- "deleted_at": null,
- "created_at": "2024-07-08T11:09:19.386Z",
- "updated_at": "2024-07-15T12:38:48.933Z"
}
]
Creates a new Edge SIM order of this model type and returns it as a response
OK
Error
{- "name": "test 123456",
- "orderType": "PAYG",
- "simPoolName": "test 123456",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
- "connectivityType": "PRIVATE",
- "simQuantity": 1,
- "simType": "PHYSICAL-SIM",
- "dnsAlternate": "100.100.1.0",
- "dnsPreferred": "100.100.2.0",
- "useDefaultDNS": "true",
- "paymentType": "INVOICE"
}
{- "id": "0433187-29b2-40d6-97de-69b3cb4f7a0f",
- "friendlyId": "IOTC38C11E9BD",
- "simPoolId": null,
- "simPoolName": "test 123456",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
- "connectivityType": "PRIVATE",
- "name": "test 123456",
- "simQuantity": 1,
- "deliveryAddress": null,
- "companyAddress": "Lorem , Ipsum Text",
- "orderType": "PAYG",
- "dnsPreferred": "10.100.1.1",
- "dnsAlternate": "10.100.1.2",
- "useDefaultDNS": true,
- "status": "ORDERED",
- "error": null,
- "userEmail": "user@pccwglobal.com",
- "deliveryEmail": null,
- "paymentType": "INVOICE",
- "offerType": null,
- "endUser": null,
- "skipUserEmail": false,
- "skipAdminEmail": false,
- "skipSupportEmail": false,
- "skipCompliance": false,
- "skipSlack": false,
- "skipInsightSr": false,
- "sourceEnterpriseId": null,
- "simType": "PHYSICAL-SIM",
- "productId": 1143474,
- "description": "Lorem , Ipsum Text",
- "manufacturer": "Thales (MADE IN CHINA)",
- "purchaseDate": "2020-05-26T00:00:00.000Z",
- "originalPurchaseOrder": "ZM1124438",
- "purchaseProject": "IoT",
- "eccn": "EAR99",
- "hkHsCode": 85235200,
- "currency": "USD",
- "unitPrice": null,
- "imsiProfileId": null,
- "createdAt": "2024-07-08T11:09:19.386Z",
- "updatedAt": "2024-07-15T12:38:48.933Z",
- "deletedAt": null,
- "updatedById": null,
- "company_id": "5f97d3d2d85fbe0014fd1412",
- "deleted_at": null,
- "created_at": "2024-07-08T11:09:19.386Z",
- "updated_at": "2024-07-15T12:38:48.933Z"
}
Get an Edge SIM order by id
OK
Error
{- "id": "0433187-29b2-40d6-97de-69b3cb4f7a0f",
- "friendlyId": "IOTC38C11E9BD",
- "simPoolId": null,
- "simPoolName": "test 123456",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "apnId": "e3f8ae76-3b1a-40e0-ae29-4ed336b143e3",
- "connectivityType": "PRIVATE",
- "name": "test 123456",
- "simQuantity": 1,
- "deliveryAddress": null,
- "companyAddress": "Lorem , Ipsum Text",
- "orderType": "PAYG",
- "dnsPreferred": "10.100.1.1",
- "dnsAlternate": "10.100.1.2",
- "useDefaultDNS": true,
- "status": "ORDERED",
- "error": null,
- "userEmail": "user@pccwglobal.com",
- "deliveryEmail": null,
- "paymentType": "INVOICE",
- "offerType": null,
- "endUser": null,
- "skipUserEmail": false,
- "skipAdminEmail": false,
- "skipSupportEmail": false,
- "skipCompliance": false,
- "skipSlack": false,
- "skipInsightSr": false,
- "sourceEnterpriseId": null,
- "simType": "PHYSICAL-SIM",
- "productId": 1143474,
- "description": "Lorem , Ipsum Text",
- "manufacturer": "Thales (MADE IN CHINA)",
- "purchaseDate": "2020-05-26T00:00:00.000Z",
- "originalPurchaseOrder": "ZM1124438",
- "purchaseProject": "IoT",
- "eccn": "EAR99",
- "hkHsCode": 85235200,
- "currency": "USD",
- "unitPrice": null,
- "imsiProfileId": null,
- "createdAt": "2024-07-08T11:09:19.386Z",
- "updatedAt": "2024-07-15T12:38:48.933Z",
- "deletedAt": null,
- "updatedById": null,
- "company_id": "5f97d3d2d85fbe0014fd1412",
- "deleted_at": null,
- "created_at": "2024-07-08T11:09:19.386Z",
- "updated_at": "2024-07-15T12:38:48.933Z"
}
List Edge SIM SIMPools for the logged-in user's company based on the given Company Id.
Returns a list of all Edge SIM SIMPools.
Throws an error for not found Edge SIM SIMPools under Company Id.
[- {
- "id": "022bbd4d-42ae-4d2f-a563-7c517d50daaa",
- "name": "Test Sim Pool",
- "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "subnet": "10.10.10.10/18",
- "firewall": "DISABLED",
- "firewallStatus": "SUCCESS",
- "status": "CREATED",
- "error": null,
- "simCount": 2,
- "primaryDNS": null,
- "secondaryDNS": null,
- "defaultPrimaryDNS": "1.1.1.1",
- "defaultSecondaryDNS": "2.2.2.2",
- "useDefaultDNS": true,
- "customFirewallEnabled": false,
- "customFirewallPolicies": [ ],
- "apn": { },
- "company_id": "5f97d3d2d85fbe0014fd1812",
- "apn_id": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "created_at": "2024-08-16T08:46:45.476Z",
- "updated_at": "2024-08-16T08:46:45.476Z"
}
]
Creates a new instance of an Edge SIM SIMPool under current Company Id.
Field contains Information on Edge SIM SIMPool to be created.
Returns an Edge SIM SIMPools.
Throws an error for not found Edge SIM SIMPools under Company Id.
{- "name": "Test SIM Pool",
- "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "useDefaultDNS": true
}
{- "id": "022bbd4d-42ae-4d2f-a563-7c517d50daaa",
- "name": "Test SIM Pool",
- "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "subnet": "10.10.10.10/18",
- "firewall": "DISABLED",
- "firewallStatus": "SUCCESS",
- "status": "CREATED",
- "error": null,
- "simCount": 2,
- "primaryDNS": null,
- "secondaryDNS": null,
- "defaultPrimaryDNS": "1.1.1.1",
- "defaultSecondaryDNS": "2.2.2.2",
- "useDefaultDNS": true,
- "customFirewallEnabled": false,
- "customFirewallPolicies": [ ],
- "apn": { },
- "company_id": "5f97d3d2d85fbe0014fd1812",
- "apn_id": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "created_at": "2024-08-16T08:46:45.476Z",
- "updated_at": "2024-08-16T08:46:45.476Z"
}
Updates a related item by id on respective Edge SIM SIMPool for the logged-in user's company based on the given Company Id.
Field contains Information on Edge SIM SIMPool to be updated.
Returns the respective Edge SIM SIMPool.
Throws an error for not found Foreign Key on Edge SIM SIMPool under Company Id. /app-user/{id}/iot-sim-pools/{destSimPoolId}/sims
{- "id": "string",
- "name": "string",
- "apnId": "string",
- "subnet": "string",
- "firewall": "ENABLED",
- "firewallStatus": "SUCCESS",
- "status": "SUCCESS",
- "error": "string",
- "primaryDNS": "string",
- "secondaryDNS": "string",
- "companyId": "string",
- "defaultPrimaryDNS": "string",
- "defaultSecondaryDNS": "string",
- "useDefaultDNS": true,
- "customFirewallEnabled": true,
- "customFirewallPolicies": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "id": "022bbd4d-42ae-4d2f-a563-7c517d50daaa",
- "name": "Test SIM Pool",
- "apnId": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "companyId": "5f97d3d2d85fbe0014fd1812",
- "subnet": "10.10.10.10/18",
- "firewall": "DISABLED",
- "firewallStatus": "SUCCESS",
- "status": "CREATED",
- "error": null,
- "simCount": 2,
- "primaryDNS": null,
- "secondaryDNS": null,
- "defaultPrimaryDNS": "1.1.1.1",
- "defaultSecondaryDNS": "2.2.2.2",
- "useDefaultDNS": true,
- "customFirewallEnabled": false,
- "customFirewallPolicies": [ ],
- "apn": { },
- "company_id": "5f97d3d2d85fbe0014fd1812",
- "apn_id": "e3408b3b-6d67-4983-3db2-ae0ddd4837df",
- "created_at": "2024-08-16T08:46:45.476Z",
- "updated_at": "2024-08-16T08:46:45.476Z"
}
Deletes a related item from the respective Edge SIM SIMPool by Id from logged-in user's company based on the given Company Id.
Request was successfully executed.
Throws an error for not found Foreign Key on Edge SIM SIMPools under Company Id.
{- "error": {
- "message": "string",
- "status": 0,
- "statusCode": 0,
- "name": "string"
}
}
Updates a related item by id on respective Edge SIM SIMPool for the logged-in user's company based on the given Company Id.
SIMs to be moved.
object |
Request was successfully executed.
Throws an error for not found Foreign Key on Edge SIM SIMPools under Company Id.
{- "sims": {
- "25794c1d-36f8-4619-ab79-df742fba0b68": [
- "454003050504933",
- "454003050504723"
]
}
}
{- "error": {
- "message": "string",
- "status": 0,
- "statusCode": 0,
- "name": "string"
}
}
Get a list of Edge SIM.
Returns an array of Edge SIMs.
Throws an error for not found Keys or SIMs.
[- {
- "id": "string",
- "iotSimPoolId": "string",
- "iotOrderId": "string",
- "state": "string",
- "iccid": "string",
- "imsi": "string",
- "msisdn": "string",
- "detectedImei": "string",
- "ipAddress": "string",
- "companyId": "string",
- "label": "string",
- "status": "string",
- "simTransferId": "string",
- "createdAt": "2024-08-13T09:38:50.268Z",
- "updatedAt": "2024-08-13T09:38:50.268Z",
- "simProvider": "string",
- "company_id": "string",
- "iot_order_id": "string",
- "created_at": "2024-08-13T09:38:50.268Z",
- "updated_at": "2024-08-13T09:38:50.268Z",
- "iot_sim_pool_id": "string"
}
]
Get single Edge SIM.
Returns a related item of Edge SIM.
Throws an error for not found Keys or SIMs.
{- "id": "string",
- "iotSimPoolId": "string",
- "iotOrderId": "string",
- "state": "string",
- "iccid": "string",
- "imsi": "string",
- "msisdn": "string",
- "detectedImei": "string",
- "ipAddress": "string",
- "companyId": "string",
- "label": "string",
- "status": "string",
- "simTransferId": "string",
- "createdAt": "2024-08-13T09:38:50.268Z",
- "updatedAt": "2024-08-13T09:38:50.268Z",
- "simProvider": "string",
- "company_id": "string",
- "iot_order_id": "string",
- "created_at": "2024-08-13T09:38:50.268Z",
- "updated_at": "2024-08-13T09:38:50.268Z",
- "iot_sim_pool_id": "string"
}
Attributes of the SIM can be updated(one or multiple together).
Further details for some of the field.
Returns a related item of Edge SIM.
Throws an error for not found Keys or SIMs.
{- "status": "PAUSED"
}
{- "id": "string",
- "iotSimPoolId": "string",
- "iotOrderId": "string",
- "state": "string",
- "iccid": "string",
- "imsi": "string",
- "msisdn": "string",
- "detectedImei": "string",
- "ipAddress": "string",
- "companyId": "string",
- "label": "string",
- "status": "string",
- "simTransferId": "string",
- "createdAt": "2024-08-13T09:38:50.268Z",
- "updatedAt": "2024-08-13T09:38:50.268Z",
- "simProvider": "string",
- "company_id": "string",
- "iot_order_id": "string",
- "created_at": "2024-08-13T09:38:50.268Z",
- "updated_at": "2024-08-13T09:38:50.268Z",
- "iot_sim_pool_id": "string"
}