SIM Card Groups V1

SIM Card Group operations

Create SIM card group

Creates a new SIM card group. The SIM card group name must be unique.

Request
Request Body schema: application/json
required

Create SIM card payload

name
string

The name of the SIM card group.

billing_plan_id
string <uuid>

The UUID of the billing plan that should be associated with this SIM card group.

Responses
200

Successful response

Response Schema: application/json
object (SIMCardGroup)
id
string

The id of the SIM card group

data_allocation
string

The total data allocation for the group in GB

ingress_site_id
string

The id of the site where data will enter the network

egress_site_id
string

The id of the site where data will exit the network

created_at
string

Timestamp for when the order was created

updated_at
string

Timestamp for when the order was last updated

401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

post/wireless/sim_card_groups
Request samples
application/json
{
  • "name": "string",
  • "billing_plan_id": "3a074193-4d25-4e91-b661-cadacfba52ec"
}
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "data_allocation": "string",
    • "ingress_site_id": "string",
    • "egress_site_id": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Get all SIM card groups

Returns a list of all your sim card groups

Request
query Parameters
include_sim_cards
boolean

Specifies whether the SIM cards be included in the result payload.

include_billing_plans
boolean

Specifies whether the billing plans be included in the result payload.

filter[sim_card_group_id]
string <uuid>

Filter SIM card groups to only the one that matches the provided ID.

filter[sim_card_group_name]
string

Filter SIM card groups to only the ones that contains the provided search string.

page[number]
number

Current page based on pagination settings.

page[size]
number

Number of results to return per page based on pagination settings.

Responses
200

Successful response

Response Schema: application/json
Array of objects (SIMCardGroup)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

get/wireless/sim_card_groups
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "data_allocation": "string",
      • "ingress_site_id": "string",
      • "egress_site_id": "string",
      • "created_at": "string",
      • "updated_at": "string"
      }
    ],
  • "metadata": {
    • "total_pages": 13,
    • "total_results": 13,
    • "page_number": 3,
    • "page_size": 1
    }
}
Delete SIM card group
If the provided SIM card group contains no SIM cards and is not the default SIM card group, it will be deleted.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card group


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCardGroup) 
 
id
string
The id of the SIM card group


 
data_allocation
string
The total data allocation for the group in GB


 
ingress_site_id
string
The id of the site where data will enter the network


 
egress_site_id
string
The id of the site where data will exit the network


 
created_at
string
Timestamp for when the order was created


 
updated_at
string
Timestamp for when the order was last updated


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
delete/wireless/sim_card_groups/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "data_allocation": "string",
    • "ingress_site_id": "string",
    • "egress_site_id": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }
}
Update SIM card group
Updates a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card group


 
Request Body schema: application/json
required
Update SIM card payload.


name
string
The name of the SIM card group.


 
network_id
string
The ID of the network that the SIM card group should associate with.


 
billing_plan_id
string <uuid> 
The UUID of the billing plan that should be associated with this SIM card group.


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCardGroup) 
 
id
string
The id of the SIM card group


 
data_allocation
string
The total data allocation for the group in GB


 
ingress_site_id
string
The id of the site where data will enter the network


 
egress_site_id
string
The id of the site where data will exit the network


 
created_at
string
Timestamp for when the order was created


 
updated_at
string
Timestamp for when the order was last updated


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
patch/wireless/sim_card_groups/{id}
Request samples 
application/json
{
  • "name": "string",
  • "network_id": "string",
  • "billing_plan_id": "3a074193-4d25-4e91-b661-cadacfba52ec"
}
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "data_allocation": "string",
    • "ingress_site_id": "string",
    • "egress_site_id": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }
}
Get SIM card group
Returns the details regarding a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card group


 
query Parameters
include_sim_cards
boolean
Specifies whether the SIM cards be included in the result payload.


 
include_billing_plans
boolean
Specifies whether the billing plans be included in the result payload.


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCardGroup) 
 
id
string
The id of the SIM card group


 
data_allocation
string
The total data allocation for the group in GB


 
ingress_site_id
string
The id of the site where data will enter the network


 
egress_site_id
string
The id of the site where data will exit the network


 
created_at
string
Timestamp for when the order was created


 
updated_at
string
Timestamp for when the order was last updated


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
get/wireless/sim_card_groups/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "data_allocation": "string",
    • "ingress_site_id": "string",
    • "egress_site_id": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }
}