Retrieves localization information for a specific EID.
Retrieves information for a finished or ongoing localization. Collects all forms of information related to a localization, both about individual process steps and more general information about the eUICC and its localized profile.
Path Parameters
- eid string required
Possible values: Value must match regular expression
^[0-9]{32}$
EID to perform request on.
- 200
- 404
- 500
Information about the localization process for the eUICC.
- application/json
- Schema
- Example (from schema)
Schema
- eid string
Possible values: Value must match regular expression
^[0-9]{32}$
Uniquely identifies an eUICC (eSIM).
- domainId string
Possible values: Value must match regular expression
^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$
Domain the resource belongs to. Used to determine which users have access to the resource.
localizations object[]
localizationInProgress booleanIndicates if localization is still in progress.
localizationSuccessful booleanIndicates if localization process has been successfully completed.
startedAt date-timeAn ISO formatted string indicating when localization/CMP request was started.
localizationTarget stringPossible values: [
BR_DATORA
,BR_DATORA_MULTI
]Specifies where the eUICC is being localized.
localizationStates object[]
Contains status for all states in the localization process. The states included in the localization process are defined per localizationTarget. The localization states are fulfilled in the listed order and a localization is considered finished when the last localization state has finished.
state stringPossible values: [
DOWNLOADED
,ALLOCATED
,ACTIVATED
,PROVISIONED
,ENABLED
,FALLBACK_SET
]isFinished booleaniccid stringPossible values: Value must match regular expression
^89[0-9]{17,18}
The ICCID of the profile that has been added to the eUICC as part of the localization process.
cmpRequests object[]
A collection of asynchronous requests performed to underlying CMPs as part of the localization process.
cmp stringPossible values: [
IOTA_EU
,ARQIA_BR
]The profile's Connectivity Management Platform (CMP) determines which underlying connectivity platform the profile belongs to and determines what kind of data is available for the profile and its connectivity subscription.
targetLocalizationState stringPossible values: [
DOWNLOADED
,ALLOCATED
,ACTIVATED
,PROVISIONED
,ENABLED
,FALLBACK_SET
]requestStatus stringPossible values: [
IN_PROGRESS
,COMPLETED
,FAILED
]The last recorded status of the asynchronous CMP request.
startedAt date-timeAn ISO formatted string indicating when localization/CMP request was started.
lastUpdatedAt date-timeAn ISO formatted string indicating when request was last updated.
{
"eid": "89000000000000000000000000000001",
"domainId": "a1ce25s2-c23edcs9",
"localizations": [
{
"localizationInProgress": true,
"localizationSuccessful": false,
"startedAt": "2024-02-13T10:12:45.000Z",
"localizationTarget": "BR_DATORA_MULTI",
"localizationStates": [
{
"state": "DOWNLOADED",
"isFinished": true
},
{
"state": "ALLOCATED",
"isFinished": true
},
{
"state": "ACTIVATED",
"isFinished": true
},
{
"state": "PROVISIONED",
"isFinished": true
},
{
"state": "ENABLED",
"isFinished": false
}
],
"iccid": "8900000000000000000",
"cmpRequests": [
{
"cmp": "IOTA_EU",
"targetLocalizationState": "ENABLED",
"requestStatus": "FAILED",
"startedAt": "2024-02-13T10:15:36.000Z",
"lastUpdatedAt": "2024-02-13T10:55:15.000Z"
},
{
"cmp": "ARQIA_BR",
"targetLocalizationState": "ACTIVATED",
"requestStatus": "COMPLETED",
"startedAt": "2024-02-13T10:14:52.000Z",
"lastUpdatedAt": "2024-02-13T10:15:33.000Z"
},
{
"cmp": "IOTA_EU",
"targetLocalizationState": "ALLOCATED",
"requestStatus": "COMPLETED",
"startedAt": "2024-02-13T10:14:18.000Z",
"lastUpdatedAt": "2024-02-13T10:14:50.000Z"
},
{
"cmp": "IOTA_EU",
"targetLocalizationState": "DOWNLOADED",
"requestStatus": "COMPLETED",
"startedAt": "2024-02-13T10:12:46.000Z",
"lastUpdatedAt": "2024-02-13T10:14:15.000Z"
}
]
}
]
}
The specified resource was not found
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}
Internal Server Error
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}