GetDevicesInformation

Validates whether the devices in the request are in a given account, and returns information about each device.

Uses and Requirements

The device order in the response will be the in the same order as in the request.

Request Parameters

Parameter	Type	Description
AccountName optional	string	The name of the biling account that you want to check the devices against. If the request includes both AccountName and AccountNumber, AccountNumber will be ignored. If you don't specify an AccountName or an Account Number, the DeviceList will be compared against all accounts that you have access to. In most cases, the account name is the same as the account number. it is usually numeric, and must include any leading zeros.
AccountNumber optional	string	The biling account number that you want to check the devices against. If the request includes both AccountName and AccountNumber, AccountNumber will be ignored. If you don't specify an AccountName or an Account Number, the DeviceList will be compared against all accounts that you have access to. An account number is 10 digits, a hyphen, and then five more digits, such as 0252067890-00001.
DeviceList required	DeviceIdentifierCollection	A list of the devices that you want to verify, specified by device identifier. Specify only one identifier per device. You can use GetDeviceList to get a list of all devices in the account. For each device in DeviceList, use this structure of nested parameters: <DeviceIdentifierCollection> <DeviceIndentifiers> <DeviceIdentifier> <Kind></Kind> <Identifier></Identifier> </DeviceIdentifier> </DeviceIndentifiers> </DeviceIdentifierCollection>
Kind required for DeviceList	string	The type of the device identifier. Valid types of identifiers are: ESN (decimal) ICCID (up to 20 digits) IMEI (up to 15 digits) MDN MEID (hexadecimal) MSISDN EID (up to 32 characters)
Identifier required for DeviceList	string	The value of the device identifier.

Response Parameters

The response contains information about each device in the request, returned in the same order.

Parameter	Type	Description
Devices	array of DeviceInfo	The list of requested devices.
AccountName	string	The account that the device is associated with.
AccountNumber	string	The billing account number that the device is associated with.
CarrierInformation	CarrierInformation	The carrier information associated with the device.
CarrierName	string	The name of the carrier.
ServicePlan	string	The service plan that the device is assigned to.
State	string	The current state of the device, which will be one of these values: Pre-active active deactive suspend pending resume pending MDN change pending PRL Update pending preactive pending activation pending deactivation pending suspend pending service plan change pending ESN / MEID change pending account update
DeviceIdentifiers	DeviceIdentifier	One or more identifiers for the device.
Kind	string	The type of the device identifier. Valid types of identifiers are: ESN (decimal) ICCID (up to 20 digits) IMEI (up to 15 digits) MDN MEID (hexadecimal) MIN MSISDN EID
Identifier	string	The value of the device identifier.
IPAddress	string	The IP address of the device.
Exists	Boolean	True if the device exists in the specified account. If the request did not include AccountName or AccountNumber, True if the device exists in any account that the user has access to.
DeviceGroupName	string	The device groups that the device belongs to.
CreatedAt	dateTime	The date and time that the device was added to the system.
LastActivationDate	dateTime	The date and time that the device was last activated.
LastActivationBy	string	The user who last activated the device.
BillingCycleEndDate	dateTime	The date that the device's current billing cycle ends.
Connected	boolean	True if the device is connected; false if it is not.
LastConnectionDate	dateTime	If the device is not connected, this indicates the last known connection date.
CustomFields	CustomFieldObj	The custom fields and values that have been set for the device.
Name	string	The name of the custom field. Valid names are CustomField1, CustomField2, CustomField3, CustomField4, and CustomField5.
Value	string	The value of the custom field. Allowed characters in custom field values: Alphanumeric characters / (forward slash) SPACE @ (at sign) . (period) , (comma) : (colon) - (hyphen) _ (underscore) ( (open parenthesis) ) (close parenthesis) [ (open bracket) ] (close bracket) # (number sign or hash)
FeatureCodes	FeatureCode	The feature codes for the device. Feature codes are only available with the Verizon Wholesale network.
Code	string
Description	string
ExtendedAttributes	ExtendedAttributesObj	Any extended attributes for the device, as Key and Value pairs. Extended attributes are currently used for promotional codes and Verizon Partner Program lead information.
Keys Values	strings strings	The customer name and the address of the device's primary place of use. PrimaryPlaceOfUseTitle PrimaryPlaceOfUseFirstName PrimaryPlaceOfUseMiddleName PrimaryPlaceOfUseLastName PrimaryPlaceOfUseSuffix PrimaryPlaceOfUseAddressLine1 PrimaryPlaceOfUseAddressLine2 PrimaryPlaceOfUseCity PrimaryPlaceOfUseState PrimaryPlaceOfUseCountry PrimaryPlaceOfUseZipCode PrimaryPlaceOfUseZipCode4 PrimaryPlaceOfUseCBRPhone PrimaryPlaceOfUseCBRPhoneType PrimaryPlaceOfUseEmailAddress The name, address, and contact information values for the current device.
Key Value	string string	SmsrOid For eUICC devices, the Object ID of the SMSR system.
Key Value	string string	ProfileStatus For eUICC devices, the current status of the local profile. Nil for all other devices.

Example SOAP Request

Check whether two specific devices are in a particular account:

<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.DeviceService"
  xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  <soapenv:Header>
    <v2:token>91bd36d3-a063-4600-928b-bb57eeccb9ac</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetDevicesInformation>
      <v2:Input>
        <nph:AccountName></nph:AccountName>
        <nph:AccountNumber>0212398765-00001</nph:AccountNumber>
        <nph:DeviceList>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>84756489065285555673</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>IMEI</nph1:Kind>
                <nph1:Identifier>848456472655553</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
        </nph:DeviceList>
      </v2:Input>
    </v2:GetDevicesInformation>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

This response shows that one of the two requested devices is in the account but the other is not (exists = false).

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetDevicesInformationResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Devices>
          <a:DeviceInfo>
            <a:AccountName>0212398765-00001</a:AccountName>
            <a:AccountNumber>0212398765-00001</a:AccountNumber>
            <a:CarrierInformation>
              <a:CarrierInformation>
                <a:CarrierName>Verizon Wireless</a:CarrierName>
                <a:ServicePlan>4092</a:ServicePlan>
                <a:State>active</a:State>
              </a:CarrierInformation>
            </a:CarrierInformation>
            <a:DeviceIdentifiers xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:DeviceIdentifier>
                <b:Kind>iccid</b:Kind>
                <b:Identifier>84756489065285555673</b:Identifier>
              </b:DeviceIdentifier>
              <b:DeviceIdentifier>
                <b:Kind>mdn</b:Kind>
                <b:Identifier>5796483383</b:Identifier>
              </b:DeviceIdentifier>
              <b:DeviceIdentifier>
                <b:Kind>imei</b:Kind>
                <b:Identifier>848456472655553</b:Identifier>
              </b:DeviceIdentifier>
              <b:DeviceIdentifier>
                <b:Kind>msisdn</b:Kind>
                <b:Identifier>15796483383</b:Identifier>
              </b:DeviceIdentifier>
            </a:DeviceIdentifiers>
            <a:IPAddress>101.0.2.33</a:IPAddress>
            <a:SmsrOId i:nil="true"/>
            <a:ProfileStatus i:nil="true"/>
            <a:Exists>true</a:Exists>
            <a:DeviceGroupName xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <b:string>Default: Knit-O-Matic machines</b:string>
            </a:DeviceGroupName>
            <a:CreatedAt>2013-04-12T20:20:03Z</a:CreatedAt>
            <a:LastActivationDate>2013-04-12T20:20:05Z</a:LastActivationDate>
            <a:LastActivationBy>User Verizon</a:LastActivationBy>
            <a:BillingCycleEndDate>2013-05-01T00:00:00Z</a:BillingCycleEndDate>
            <a:Connected>false</a:Connected>
            <a:LastConnectionDate i:nil="true"/>
            <a:CustomFields i:nil="true"/>
            <a:FeatureCodes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
            <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:ExtendedAttributesObj>
                <b:Key>PromoCodes</b:Key>
                <b:Value>Data=Machine to Machine 60KB,SMS=Machine to Machine 15 SMS</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>PromotionStartDate</b:Key>
                <b:Value>12/3/2012 12:00:00 AM</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>PromotionScheduledEndDate</b:Key>
                <b:Value>6/6/2013 12:00:00 AM</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>LeadId</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerName</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerAddressLine1</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerAddressLine2</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerAddressCity</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerAddressState</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CustomerAddressZipCode</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>ServiceZipCode</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>SkuNumber</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>CostCenterCode</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>PreIMEI</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>PreSKU</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>SIMOTADate</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>RoamingStatus</b:Key>
                <b:Value>NotRoaming</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>LastRomaingStatusUpdate</b:Key>
                <b:Value>2/9/2017 9:28:34 PM</b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>RoamingCountry</b:Key>
                <b:Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>SmsrOid</b:Key>
                <b:Value i:nil="true"/Value></b:Value>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>ProfileStatus</b:Key>
                <b:Value i:nil="true"/>
              </b:ExtendedAttributesObj>
              <b:ExtendedAttributesObj>
                <b:Key>AccountNumber</b:Key>
                <b:Value>0245078689-00001</b:Value>
              </b:ExtendedAttributesObj>
            </a:ExtendedAttributes>
         </a:Device>

             <a:DeviceInfo>
            <a:AccountName i:nil="true>
            <a:AccountNumber i:nil="true>
            <a:CarrierInformation i:nil="true>
            <a:DeviceIdentifiers xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:DeviceIdentifier>
                <b:Kind>IMEI</b:Kind>
                <b:Identifier>848456472655553</b:Identifier>
              </b:DeviceIdentifier>
            </a:DeviceIdentifiers>
            <a:IPAddress i:nil="true>
            <a:smsrOId i:nil="true"/>
            <a:profileStatus i:nil="true"/>
            <a:exists>false</a:exists>
          </a:DeviceInfo>
        </a:Devices>
      </Output>
    </GetDevicesInformationResponse>
  </s:Body>
</s:Envelope>