ChangeDeviceProfileState

Manage eUICC local profiles on devices, including downloading, enabling, disabling, and deleting profiles.

NOTE: This API method requires eUICC devices that can accept downloadable profiles.

Uses and Requirements

You can only change the profile state on one device at a time. The device must have been activated and have an assigned ICCID before you can download a local profile to it or make profile changes.

The ThingSpace Platform sends an asynchronous DeviceProfileService callback message when it receives a response from the SM-SR system about a profile state change. If a time-out situation occurs, such as when a device is unreachable, the initial callback will include a "warning" status, and a later response will indicate either success or failure.

Request Parameters

<DeviceIdentifierCollection>
  <DeviceIndentifiers>
    <DeviceIdentifier>
      <Kind>eid</Kind>
      <Identifier>eid_value</Identifier>
    </DeviceIdentifier>
    <DeviceIdentifier>
      <Kind>iccid</Kind>
      <Identifier>iccid_value</Identifier>
    </DeviceIdentifier>
  </DeviceIndentifiers>
</DeviceIdentifierCollection>

Response Parameters

Callback Response Parameters

Example SOAP Request

<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:v2="http://nphase.com/unifiedwebservice/v2" 
  xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService" 
  xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common" 
  xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <soapenv:Header>
    <v2:token>current_session_token</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:ChangeDeviceProfileState>
      <v2:Input>
        <nph:DeviceList>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>eid</nph1:Kind> 
                <nph1:Identifier>12345678954357688412445678912398</nph1:Identifier>
              </nph1:DeviceIdentifier>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind> 
                <nph1:Identifier>11245013879359100199</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
        </nph:DeviceList>
        <nph:AccountName>1223334444</nph:AccountName>
        <nph:DeviceProfileAction>Download_Enable</nph:DeviceProfileAction>
        <nph:SmsrOid>634.32418.489196.513</nph:SmsrOid>
      </v2:Input>
    </v2:ChangeDeviceProfileState>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<ChangeDeviceProfileStateResponse xmlns="http://nphase.com/unifiedwebservice/v2">
  <Output xmlns:a="http://schemas.datacontract.org/2004/07NPhase.UnifiedWebService.APIs.v2.Contract.DeviceProfileService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <a:RequestId>2c90bd28-ece4-42ef-9f02-7e3bd4fbff33</a:RequestId>
  </Output>
</ChangeDeviceProfileStateResponse>

Example SOAP Callback

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
      <Username/>
      <Password/>
      <RequestId>2c90bd28-ece4-42ef-9f02-7e3bd4fbff33</RequestId>
      <Device xmlns="http://nphase.com/unifiedwebservice/v2">
        <Kind>Iccid</Kind>
        <Identifier>11245013879359100199</Identifier>
      </Device>
      <Device xmlns="http://nphase.com/unifiedwebservice/v2">
        <Kind>Eid</Kind>
        <Identifier>123456789543576884124456789123</Identifier>
      </Device>
      <Data xmlns="http://nphase.com/unifiedwebservice/v2">
        <Data xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://nphase.com/unifiedwebservice/v2">
          <CarrierService xsi:nil="true" />
          <ExternalProvisioningChange xsi:nil="true" />
          <PromoChange xsi:nil="true" />
          <SMSDelivery xsi:nil="true" />
          <PRLInformation xsi:nil="true" />
          <DeviceService xsi:nil="true" />
          <GoToState xsi:nil="true" />
          <DeviceProfileService>
            <DownloadDeviceProfile xsi:nil="true" />
            <ChangeDeviceProfileState>
              <DeviceIdentifierCollection>
                <Kind>iccid</Kind>
                <Identifier>11245013879359100199</Identifier>
              </DeviceIdentifierCollection>
              <DeviceIdentifierCollection>
                <Kind>eid</Kind>
                <Identifier>12345678954357688412445678912398</Identifier>
              </DeviceIdentifierCollection>
              <IpAddress xsi:nil="true" />
              <State>Active</State>
              <ServicePlan xsi:nil="true" />
              <DeviceCredential />
              <SmsrOid>634.32418.489196.513<</SmsrOid>
              <ProfileStatus>DOWNLOAD_ENABLE</ProfileStatus>
              <updateSubAddressStatus>SUCCESS</updateSubAddressStatus>
              <updateSubAddressStatusCode>1</updateSubAddressStatusCode>
              <updateSubAddressStatusDesc>SUCCESS: Address has been updated</updateSubAddressStatusDesc>
              <EuiccErrorCode xsi:nil="true" />
              <EuiccErrorDesc xsi:nil="true" />
            </ChangeDeviceProfileState>
          </DeviceProfileService>
          <Fault xsi:nil="true" />
          <Comment xsi:nil="true" />
          <Summary xsi:nil="true" />
          <Status xsi:nil="true" />
          <CallbackCount>1</CallbackCount>
          <MaxCallbackThreshold>4</MaxCallbackThreshold>
          <ExtendedEnhancedConnectivityService xsi:nil="true" />
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram