OTA updates

OTA updates operations

List OTA updates

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[status]
string

Filter by a specific status of the resource's lifecycle.

Enum: "in-progress" "completed" "failed"
Example: filter[status]=in-progress
filter[sim_card_id]
string

The SIM card identification UUID.

filter[type]
string

Filter by type.

Value: "sim_card_network_preferences"
Example: filter[type]=sim_card_network_preferences
Responses
200

Successful response

Response Schema: application/json
Array of objects (OTAUpdate)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/ota_updates
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "ota_update",
      • "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "status": "in-progress",
      • "type": "sim_card_network_preferences",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Get OTA update
This API returns the details of an Over the Air (OTA) update.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (CompleteOTAUpdate) 
This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. 



 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
 
object
A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.


 
sim_card_id
string <uuid> 
The identification UUID of the related SIM card resource.


 
status
string
 Enum: "in-progress" "completed" "failed"  
type
string
Represents the type of the operation requested. This will relate directly to the source of the request.


 Value: "sim_card_network_preferences"  
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/ota_updates/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "ota_update",
    • "settings": {
      • "mobile_operator_networks_preferences": [
        • {
          • "mobile_operator_network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
          • "mobile_operator_network_name": "AT&T Mobility (USACG)",
          • "priority": 0
          }
        ]
      },
    • "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "in-progress",
    • "type": "sim_card_network_preferences",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}