Schema DeviceService.xsd


schema location C:\m2mmc\branches\4.7.0\win\unified-web-service\APIs\v2\Schema\DeviceService.xsd
attributeFormDefault
elementFormDefault qualified
targetNamespace http://nphase.com/unifiedwebservice/v2
 
Elements 
AddDevicesRequest 
AddDevicesResponse 
GetAggregateDeviceUsageRequest 
GetAggregateDeviceUsageResponse 
GetDeviceCapabilitiesRequest 
GetDeviceCapabilitiesResponse 
GetDeviceConnectionHistoryRequest 
GetDeviceConnectionHistoryResponse 
GetDeviceInformationRequest 
GetDeviceInformationResponse 
GetDeviceListRequest 
GetDeviceListResponse 
GetDevicePRLInformationRequest 
GetDevicePRLInformationResponse 
GetDeviceProvisioningHistoryRequest 
GetDeviceProvisioningHistoryResponse 
GetDeviceSuspensionStatusRequest 
GetDeviceSuspensionStatusResponse 
GetDeviceUsageHistoryRequest 
GetDeviceUsageHistoryResponse 
GetRatedDeviceUsageRequest 
GetRatedDeviceUsageResponse 


schema location C:\m2mmc\branches\4.7.0\win\unified-web-service\APIs\v2\Schema\Types\DeviceServiceTypes.xsd
attributeFormDefault
elementFormDefault qualified
targetNamespace http://nphase.com/unifiedwebservice/v2
 
Complex types 
CarrierInformation 
ConnectionEventAttribute 
CustomFieldObj 
DeviceCapability 
DeviceConnectionEvent 
DeviceInformation 
DeviceUsage 
Messages 
ProvisioningEvent 


schema location C:\m2mmc\branches\4.7.0\win\unified-web-service\APIs\v2\Schema\Types\Common\CommonTypes.xsd
attributeFormDefault
elementFormDefault qualified
targetNamespace http://nphase.com/unifiedwebservice/v2
 
Complex types 
CustomFieldFilterObj 
Date 
DeviceIdentifier 
DeviceIdentifierCollection 
ErrorInformation 
ExtendedAttributesObj 
FeatureCode 
InclusiveDateTimeRange 
PrimaryPlaceOfUse 
PrimaryPlaceOfUseAddress 
PrimaryPlaceOfUseCustomerName 
Time 
TimeRange 
TimeRangePerDay 


element AddDevicesRequest
diagram DeviceService_p1.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children DeviceToAdd AccountName DeviceGroupNames CustomFields State SkuNumber
annotation
documentation
Adds up to 200 devices to the account, in the Pre-Active state.
source <xs:element name="AddDevicesRequest">
 
<xs:annotation>
   
<xs:documentation>Adds up to 200 devices to the account, in the Pre-Active state.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="DeviceToAdd" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>A list of 1-200 devices to add, specified by device identifier.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The account under which the devices will be added. If you have access to multiple billing accounts, then you must specify an account.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupNames" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>The name of a device group to add the devices to when they are added to the account. Currently, each device can only belong to one device group.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="CustomFields" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>The names and values for any custom fields that you want set for the devices that you are adding.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="State" type="xs:string" nillable="false">
       
<xs:annotation>
         
<xs:documentation>The initial service state for the device. The only valid state is “PreActive”.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="SkuNumber" type="xs:string" nillable="true">
       
<xs:annotation>
         
<xs:documentation>Specify SKU (4G devices only). If you specify a SKU, supply only the SIM ICCID(s) in DeviceIdentifierCollection.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element AddDevicesRequest/DeviceToAdd
diagram DeviceService_p2.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifierCollection
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children DeviceIdentifiers
annotation
documentation
A list of 1-200 devices to add, specified by device identifier.
source <xs:element name="DeviceToAdd" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>A list of 1-200 devices to add, specified by device identifier.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesRequest/AccountName
diagram DeviceService_p3.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The account under which the devices will be added. If you have access to multiple billing accounts, then you must specify an account.
source <xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The account under which the devices will be added. If you have access to multiple billing accounts, then you must specify an account.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesRequest/DeviceGroupNames
diagram DeviceService_p4.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc unbounded
content simple
nillable true
annotation
documentation
The name of a device group to add the devices to when they are added to the account. Currently, each device can only belong to one device group.
source <xs:element name="DeviceGroupNames" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The name of a device group to add the devices to when they are added to the account. Currently, each device can only belong to one device group.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesRequest/CustomFields
diagram DeviceService_p5.png
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Name Value
annotation
documentation
The names and values for any custom fields that you want set for the devices that you are adding.
source <xs:element name="CustomFields" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The names and values for any custom fields that you want set for the devices that you are adding.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesRequest/State
diagram DeviceService_p6.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable false
annotation
documentation
The initial service state for the device. The only valid state is “PreActive”.
source <xs:element name="State" type="xs:string" nillable="false">
 
<xs:annotation>
   
<xs:documentation>The initial service state for the device. The only valid state is “PreActive”.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesRequest/SkuNumber
diagram DeviceService_p7.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
annotation
documentation
Specify SKU (4G devices only). If you specify a SKU, supply only the SIM ICCID(s) in DeviceIdentifierCollection.
source <xs:element name="SkuNumber" type="xs:string" nillable="true">
 
<xs:annotation>
   
<xs:documentation>Specify SKU (4G devices only). If you specify a SKU, supply only the SIM ICCID(s) in DeviceIdentifierCollection.</xs:documentation>
 
</xs:annotation>
</xs:element>

element AddDevicesResponse
diagram DeviceService_p8.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children ReturnMessage
annotation
documentation
Returns a success or failure message for each device that was specified in the request, indicating whether the device was successfully added or not.
source <xs:element name="AddDevicesResponse">
 
<xs:annotation>
   
<xs:documentation>Returns a success or failure message for each device that was specified in the request, indicating whether the device was successfully added or not.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="ReturnMessage" type="Messages" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>This element specifies a list of devices, along with a success or failure message for each device. When a failure occurs, the returned message is one of the Device Service Errors. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element AddDevicesResponse/ReturnMessage
diagram DeviceService_p9.png
namespace http://nphase.com/unifiedwebservice/v2
type Messages
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Device Message
annotation
documentation
This element specifies a list of devices, along with a success or failure message for each device. When a failure occurs, the returned message is one of the Device Service Errors.
source <xs:element name="ReturnMessage" type="Messages" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>This element specifies a list of devices, along with a success or failure message for each device. When a failure occurs, the returned message is one of the Device Service Errors. </xs:documentation>
 
</xs:annotation>
</xs:element>

element GetAggregateDeviceUsageRequest
diagram DeviceService_p10.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children DeviceList DeviceGroupName AccountName TimestampFilter
annotation
documentation
Returns the total amount of data sent and the total number of SMS messages sent or received by a set of devices in a specified timeframe. The information is returned in a callback response, so you must register a URL for DeviceUsage using the Register Callback API in the Callback Registration Service.
source <xs:element name="GetAggregateDeviceUsageRequest">
 
<xs:annotation>
   
<xs:documentation>Returns the total amount of data sent and the total number of SMS messages sent or received by a set of devices in a specified timeframe. The information is returned in a callback response, so you must register a URL for DeviceUsage using the Register Callback API in the Callback Registration Service. </xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>A list of one or more devices for which you want usage data. Cannot be used with DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The device group for which you want usage data. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="AccountName" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="TimestampFilter" type="TimeRange">
       
<xs:annotation>
         
<xs:documentation>The time period for which you want usage data, specified as a Start and End dateTime. Start cannot be more than 6 months before the current date, and there cannot be more than one month between Start and End. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetAggregateDeviceUsageRequest/DeviceList
diagram DeviceService_p11.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Kind Identifier
annotation
documentation
A list of one or more devices for which you want usage data. Cannot be used with DeviceGroupName.
source <xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>A list of one or more devices for which you want usage data. Cannot be used with DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetAggregateDeviceUsageRequest/DeviceGroupName
diagram DeviceService_p12.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The device group for which you want usage data. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The device group for which you want usage data. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetAggregateDeviceUsageRequest/AccountName
diagram DeviceService_p13.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.
source <xs:element name="AccountName" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetAggregateDeviceUsageRequest/TimestampFilter
diagram DeviceService_p14.png
namespace http://nphase.com/unifiedwebservice/v2
type TimeRange
properties
content complex
children Start End
annotation
documentation
The time period for which you want usage data, specified as a Start and End dateTime. Start cannot be more than 6 months before the current date, and there cannot be more than one month between Start and End.
source <xs:element name="TimestampFilter" type="TimeRange">
 
<xs:annotation>
   
<xs:documentation>The time period for which you want usage data, specified as a Start and End dateTime. Start cannot be more than 6 months before the current date, and there cannot be more than one month between Start and End. </xs:documentation>
 
</xs:annotation>
</xs:element>

element GetAggregateDeviceUsageResponse
diagram DeviceService_p15.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children RequestId
annotation
documentation
Returns a unique request ID if the request was successfully sent.
source <xs:element name="GetAggregateDeviceUsageResponse">
 
<xs:annotation>
   
<xs:documentation>Returns a unique request ID if the request was successfully sent.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="RequestId" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetAggregateDeviceUsageResponse/RequestId
diagram DeviceService_p16.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
A unique ID that associates the request with the results that are sent via a callback service.
source <xs:element name="RequestId" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceCapabilitiesRequest
diagram DeviceService_p17.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device
annotation
documentation
This API is no longer supported.
source <xs:element name="GetDeviceCapabilitiesRequest">
 
<xs:annotation>
   
<xs:documentation>This API is no longer supported.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier"/>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceCapabilitiesRequest/Device
diagram DeviceService_p18.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
source <xs:element name="Device" type="DeviceIdentifier"/>

element GetDeviceCapabilitiesResponse
diagram DeviceService_p19.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Capabilities
source <xs:element name="GetDeviceCapabilitiesResponse">
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Capabilities" type="DeviceCapability" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceCapabilitiesResponse/Capabilities
diagram DeviceService_p20.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceCapability
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Key Name Value Type
source <xs:element name="Capabilities" type="DeviceCapability" nillable="true" minOccurs="0" maxOccurs="unbounded"/>

element GetDeviceConnectionHistoryRequest
diagram DeviceService_p21.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device OccurredAtFilter
annotation
documentation
Returns a list of network connection events for a specified device. You can specify a time period to see only events during that period.
source <xs:element name="GetDeviceConnectionHistoryRequest">
 
<xs:annotation>
   
<xs:documentation>Returns a list of network connection events for a specified device. You can specify a time period to see only events during that period.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which you want connnection history. Identify the device by the ESN, MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="OccurredAtFilter" type="InclusiveDateTimeRange">
       
<xs:annotation>
         
<xs:documentation>Restrict the results to only connection events that occurred between an Earliest and Latest dateTime.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceConnectionHistoryRequest/Device
diagram DeviceService_p22.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which you want connnection history. Identify the device by the ESN, MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which you want connnection history. Identify the device by the ESN, MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceConnectionHistoryRequest/OccurredAtFilter
diagram DeviceService_p23.png
namespace http://nphase.com/unifiedwebservice/v2
type InclusiveDateTimeRange
properties
content complex
children Earliest Latest
annotation
documentation
Restrict the results to only connection events that occurred between an Earliest and Latest dateTime.
source <xs:element name="OccurredAtFilter" type="InclusiveDateTimeRange">
 
<xs:annotation>
   
<xs:documentation>Restrict the results to only connection events that occurred between an Earliest and Latest dateTime.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceConnectionHistoryResponse
diagram DeviceService_p24.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device ConnectionHistory IsComplete
annotation
documentation
The list of connection events for a device over a specified time range.
source <xs:element name="GetDeviceConnectionHistoryResponse">
 
<xs:annotation>
   
<xs:documentation>The list of connection events for a device over a specified time range.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which the connection history has been returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="ConnectionHistory" type="DeviceConnectionEvent" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>This element contains the connection history records.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="IsComplete" type="xs:boolean">
       
<xs:annotation>
         
<xs:documentation>This element indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAt filter in the request and calling this API again.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceConnectionHistoryResponse/Device
diagram DeviceService_p25.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which the connection history has been returned.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which the connection history has been returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceConnectionHistoryResponse/ConnectionHistory
diagram DeviceService_p26.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceConnectionEvent
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children OccurredAt ConnectionEventAttributes ExtendedAttributes
annotation
documentation
This element contains the connection history records.
source <xs:element name="ConnectionHistory" type="DeviceConnectionEvent" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>This element contains the connection history records.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceConnectionHistoryResponse/IsComplete
diagram DeviceService_p27.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:boolean
properties
content simple
annotation
documentation
This element indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAt filter in the request and calling this API again.
source <xs:element name="IsComplete" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>This element indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAt filter in the request and calling this API again.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceInformationRequest
diagram DeviceService_p28.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device
annotation
documentation
Returns information about a specified device, including its provisioning state, service plan, MDN, MIN, feature codes, IP address, and VPP lead information if applicable.
source <xs:element name="GetDeviceInformationRequest">
 
<xs:annotation>
   
<xs:documentation>Returns information about a specified device, including its provisioning state, service plan, MDN, MIN, feature codes, IP address, and VPP lead information if applicable.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which information will be returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceInformationRequest/Device
diagram DeviceService_p29.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which information will be returned.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which information will be returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceInformationResponse
diagram DeviceService_p30.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device
annotation
documentation
Returns device information for a specified device.
source <xs:element name="GetDeviceInformationResponse">
 
<xs:annotation>
   
<xs:documentation>Returns device information for a specified device.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceInformation">
       
<xs:annotation>
         
<xs:documentation>A list of information about the device.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceInformationResponse/Device
diagram DeviceService_p31.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceInformation
properties
content complex
children AccountName CarrierInformation DeviceGroupName DeviceIdentifiers CreatedAt IPAddress LastActivationDate LastActivationBy BillingCycleEndDate Connected LastConnectionDate CustomFields FeatureCodes ExtendedAttributes
annotation
documentation
A list of information about the device.
source <xs:element name="Device" type="DeviceInformation">
 
<xs:annotation>
   
<xs:documentation>A list of information about the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest
diagram DeviceService_p32.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children AccountName CreatedAtFilter DeviceStateFilter DeviceGroupName ServicePlanFilter DeviceCustomFieldFilter LargestDeviceIdSeen MaxNumberOfDevices
annotation
documentation
Returns a list of all the devices associated with an account.
source <xs:element name="GetDeviceListRequest">
 
<xs:annotation>
   
<xs:documentation>Returns a list of all the devices associated with an account.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The account for which a list of devices will be returned. If you don't specify an AccountName, the list will include all devices to which you have access.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="CreatedAtFilter" type="InclusiveDateTimeRange" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Filter the results to only include devices that were added to the account between an Earliest and Latest dateTime. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceStateFilter" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Filter the results to only include devices in this device state.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Filter the results to only include devices in this device group.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="ServicePlanFilter" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Filter the results to only include devices wth this service plan.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Filter the results to only include devices that have these custom field names and values.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="LargestDeviceIdSeen" type="xs:long" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Only return information about devices that have an ID greater than this value. Each successful response will include a LargestDeviceIdSeen value.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="MaxNumberOfDevices" type="xs:int" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Returns the number of devices specified by user between 500 to 2000</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceListRequest/AccountName
diagram DeviceService_p33.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The account for which a list of devices will be returned. If you don't specify an AccountName, the list will include all devices to which you have access.
source <xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The account for which a list of devices will be returned. If you don't specify an AccountName, the list will include all devices to which you have access.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/CreatedAtFilter
diagram DeviceService_p34.png
namespace http://nphase.com/unifiedwebservice/v2
type InclusiveDateTimeRange
properties
minOcc 0
maxOcc 1
content complex
nillable true
children Earliest Latest
annotation
documentation
Filter the results to only include devices that were added to the account between an Earliest and Latest dateTime.
source <xs:element name="CreatedAtFilter" type="InclusiveDateTimeRange" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Filter the results to only include devices that were added to the account between an Earliest and Latest dateTime. </xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/DeviceStateFilter
diagram DeviceService_p35.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
Filter the results to only include devices in this device state.
source <xs:element name="DeviceStateFilter" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Filter the results to only include devices in this device state.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/DeviceGroupName
diagram DeviceService_p36.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
Filter the results to only include devices in this device group.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Filter the results to only include devices in this device group.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/ServicePlanFilter
diagram DeviceService_p37.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
Filter the results to only include devices wth this service plan.
source <xs:element name="ServicePlanFilter" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Filter the results to only include devices wth this service plan.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/DeviceCustomFieldFilter
diagram DeviceService_p38.png
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Name Value
annotation
documentation
Filter the results to only include devices that have these custom field names and values.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
source <xs:element name="DeviceCustomFieldFilter" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Filter the results to only include devices that have these custom field names and values.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/LargestDeviceIdSeen
diagram DeviceService_p39.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:long
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
Only return information about devices that have an ID greater than this value. Each successful response will include a LargestDeviceIdSeen value.
source <xs:element name="LargestDeviceIdSeen" type="xs:long" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Only return information about devices that have an ID greater than this value. Each successful response will include a LargestDeviceIdSeen value.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListRequest/MaxNumberOfDevices
diagram DeviceService_p40.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:int
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
Returns the number of devices specified by user between 500 to 2000
source <xs:element name="MaxNumberOfDevices" type="xs:int" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Returns the number of devices specified by user between 500 to 2000</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListResponse
diagram DeviceService_p41.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Devices IsComplete
annotation
documentation
The list of requested devices associated with an account.
source <xs:element name="GetDeviceListResponse">
 
<xs:annotation>
   
<xs:documentation>The list of requested devices associated with an account.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Devices" type="DeviceInformation" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>The list of devices that was returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="IsComplete" type="xs:boolean">
       
<xs:annotation>
         
<xs:documentation>Indicates whether or not the response contains all devices that matched the request criteria. A maximum of 500 records are returned per call to this API. Retrieve more records by setting the CreatedAtFilter dates based on the newest device in the response, and calling this API again.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceListResponse/Devices
diagram DeviceService_p42.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceInformation
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children AccountName CarrierInformation DeviceGroupName DeviceIdentifiers CreatedAt IPAddress LastActivationDate LastActivationBy BillingCycleEndDate Connected LastConnectionDate CustomFields FeatureCodes ExtendedAttributes
annotation
documentation
The list of devices that was returned.
source <xs:element name="Devices" type="DeviceInformation" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The list of devices that was returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceListResponse/IsComplete
diagram DeviceService_p43.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:boolean
properties
content simple
annotation
documentation
Indicates whether or not the response contains all devices that matched the request criteria. A maximum of 500 records are returned per call to this API. Retrieve more records by setting the CreatedAtFilter dates based on the newest device in the response, and calling this API again.
source <xs:element name="IsComplete" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>Indicates whether or not the response contains all devices that matched the request criteria. A maximum of 500 records are returned per call to this API. Retrieve more records by setting the CreatedAtFilter dates based on the newest device in the response, and calling this API again.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationRequest
diagram DeviceService_p44.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter
annotation
documentation
Returns the PRL version of the device. The information is returned in a callback response, so you must register a URL for DevicePRLInformation using the Register Callback API in the Callback Registration Service.
source <xs:element name="GetDevicePRLInformationRequest">
 
<xs:annotation>
   
<xs:documentation>Returns the PRL version of the device. The information is returned in a callback response, so you must register a URL for DevicePRLInformation using the Register Callback API in the Callback Registration Service. </xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>A list of one or more devices for which you want PRL Info. Cannot be used with DeviceGroupName or other filter criteria.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The device group for which you want PRL Info. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="AccountName" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the PRL Info for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDevicePRLInformationRequest/DeviceList
diagram DeviceService_p45.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Kind Identifier
annotation
documentation
A list of one or more devices for which you want PRL Info. Cannot be used with DeviceGroupName or other filter criteria.
source <xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>A list of one or more devices for which you want PRL Info. Cannot be used with DeviceGroupName or other filter criteria.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationRequest/DeviceGroupName
diagram DeviceService_p46.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The device group for which you want PRL Info. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The device group for which you want PRL Info. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationRequest/AccountName
diagram DeviceService_p47.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
You must specify an AccountName if you specified DeviceGroupName. To retrieve the PRL Info for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.
source <xs:element name="AccountName" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the PRL Info for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationRequest/DeviceServicePlanFilter
diagram DeviceService_p48.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.
source <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationRequest/DeviceCustomFieldFilter
diagram DeviceService_p49.png
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldFilterObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Name Value
annotation
documentation
Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.
source <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDevicePRLInformationResponse
diagram DeviceService_p50.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children RequestId
annotation
documentation
Returns a unique request ID if the request was successfully sent.
source <xs:element name="GetDevicePRLInformationResponse">
 
<xs:annotation>
   
<xs:documentation>Returns a unique request ID if the request was successfully sent.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="RequestId" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDevicePRLInformationResponse/RequestId
diagram DeviceService_p51.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
A unique ID that associates the request with the results that are sent via a callback service.
source <xs:element name="RequestId" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceProvisioningHistoryRequest
diagram DeviceService_p52.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device OccurredAtFilter
annotation
documentation
Returns the provisioning history of a specified device. You can specify a time period to see only events during that period.
source <xs:element name="GetDeviceProvisioningHistoryRequest">
 
<xs:annotation>
   
<xs:documentation>Returns the provisioning history of a specified device. You can specify a time period to see only events during that period.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which the provisioning history will be returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="OccurredAtFilter" type="InclusiveDateTimeRange">
       
<xs:annotation>
         
<xs:documentation>Restrict the results to only include provisioning events that occurred between an Earliest and Latest dateTime. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceProvisioningHistoryRequest/Device
diagram DeviceService_p53.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which the provisioning history will be returned.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which the provisioning history will be returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceProvisioningHistoryRequest/OccurredAtFilter
diagram DeviceService_p54.png
namespace http://nphase.com/unifiedwebservice/v2
type InclusiveDateTimeRange
properties
content complex
children Earliest Latest
annotation
documentation
Restrict the results to only include provisioning events that occurred between an Earliest and Latest dateTime.
source <xs:element name="OccurredAtFilter" type="InclusiveDateTimeRange">
 
<xs:annotation>
   
<xs:documentation>Restrict the results to only include provisioning events that occurred between an Earliest and Latest dateTime. </xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceProvisioningHistoryResponse
diagram DeviceService_p55.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device ProvisioningHistory IsComplete
annotation
documentation
Returns the provisioning history for the specified device.
source <xs:element name="GetDeviceProvisioningHistoryResponse">
 
<xs:annotation>
   
<xs:documentation>Returns the provisioning history for the specified device.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which the provisioning history was returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="ProvisioningHistory" type="ProvisioningEvent" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>List of device provisioning events, sorted by the OccurredAt timestamp, oldest first.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="IsComplete" type="xs:boolean">
       
<xs:annotation>
         
<xs:documentation>Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAtFilter in the request based on the last OccurredAt timestamp in the response, and calling this API again.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceProvisioningHistoryResponse/Device
diagram DeviceService_p56.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which the provisioning history was returned.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which the provisioning history was returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceProvisioningHistoryResponse/ProvisioningHistory
diagram DeviceService_p57.png
namespace http://nphase.com/unifiedwebservice/v2
type ProvisioningEvent
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children OccurredAt Status EventBy EventType ServicePlan Mdn Msisdn ExtendedAttributes
annotation
documentation
List of device provisioning events, sorted by the OccurredAt timestamp, oldest first.
source <xs:element name="ProvisioningHistory" type="ProvisioningEvent" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>List of device provisioning events, sorted by the OccurredAt timestamp, oldest first.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceProvisioningHistoryResponse/IsComplete
diagram DeviceService_p58.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:boolean
properties
content simple
annotation
documentation
Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAtFilter in the request based on the last OccurredAt timestamp in the response, and calling this API again.
source <xs:element name="IsComplete" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the OccurredAtFilter in the request based on the last OccurredAt timestamp in the response, and calling this API again.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusRequest
diagram DeviceService_p59.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter
annotation
documentation
Returns the Suspension Status of the device. The information is returned in a callback response, so you must register a URL for DeviceSuspendStatus using the Register Callback API in the Callback Registration Service.
source <xs:element name="GetDeviceSuspensionStatusRequest">
 
<xs:annotation>
   
<xs:documentation>Returns the Suspension Status of the device. The information is returned in a callback response, so you must register a URL for DeviceSuspendStatus using the Register Callback API in the Callback Registration Service. </xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>A list of one or more devices for which you want suspension status. Cannot be used with DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The device group for which you want suspension status. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="AccountName" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the suspension status for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceSuspensionStatusRequest/DeviceList
diagram DeviceService_p60.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Kind Identifier
annotation
documentation
A list of one or more devices for which you want suspension status. Cannot be used with DeviceGroupName.
source <xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>A list of one or more devices for which you want suspension status. Cannot be used with DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusRequest/DeviceGroupName
diagram DeviceService_p61.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The device group for which you want suspension status. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The device group for which you want suspension status. You must also specify AccountName, since the same device group name can be used in multiple accounts. Cannot be used with DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusRequest/AccountName
diagram DeviceService_p62.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
You must specify an AccountName if you specified DeviceGroupName. To retrieve the suspension status for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.
source <xs:element name="AccountName" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the suspension status for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusRequest/DeviceServicePlanFilter
diagram DeviceService_p63.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.
source <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The name of a service plan if you  devices under that plan. Cannot be used by DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusRequest/DeviceCustomFieldFilter
diagram DeviceService_p64.png
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldFilterObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Name Value
annotation
documentation
Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.
source <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Custom field names and values, if you want devices with matching custom fields. Cannot be used by DeviceList.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceSuspensionStatusResponse
diagram DeviceService_p65.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children RequestId
annotation
documentation
Returns a unique request ID if the request was successfully sent.
source <xs:element name="GetDeviceSuspensionStatusResponse">
 
<xs:annotation>
   
<xs:documentation>Returns a unique request ID if the request was successfully sent.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="RequestId" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceSuspensionStatusResponse/RequestId
diagram DeviceService_p66.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
A unique ID that associates the request with the results that are sent via a callback service.
source <xs:element name="RequestId" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>A unique ID that associates the request with the results that are sent via a callback service.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceUsageHistoryRequest
diagram DeviceService_p67.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device TimestampFilter
annotation
documentation
Returns the network data usage history of a device during a specified time period.
source <xs:element name="GetDeviceUsageHistoryRequest">
 
<xs:annotation>
   
<xs:documentation>Returns the network data usage history of a device during a specified time period.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which you want usage history.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="TimestampFilter" type="InclusiveDateTimeRange">
       
<xs:annotation>
         
<xs:documentation>Restrict the results to only include usage that occurred between an Earliest and Latest dateTime.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceUsageHistoryRequest/Device
diagram DeviceService_p68.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which you want usage history.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which you want usage history.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceUsageHistoryRequest/TimestampFilter
diagram DeviceService_p69.png
namespace http://nphase.com/unifiedwebservice/v2
type InclusiveDateTimeRange
properties
content complex
children Earliest Latest
annotation
documentation
Restrict the results to only include usage that occurred between an Earliest and Latest dateTime.
source <xs:element name="TimestampFilter" type="InclusiveDateTimeRange">
 
<xs:annotation>
   
<xs:documentation>Restrict the results to only include usage that occurred between an Earliest and Latest dateTime.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceUsageHistoryResponse
diagram DeviceService_p70.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children Device UsageHistory IsComplete
annotation
documentation
Teturns the usage history for a specific device.
source <xs:element name="GetDeviceUsageHistoryResponse">
 
<xs:annotation>
   
<xs:documentation>Teturns the usage history for a specific device.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="Device" type="DeviceIdentifier">
       
<xs:annotation>
         
<xs:documentation>The device for which the usage history was returned.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="UsageHistory" type="DeviceUsage" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>The usage history for the device.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="IsComplete" type="xs:boolean">
       
<xs:annotation>
         
<xs:documentation>Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the TimeStampFilter in the request based on the last Timestamp in this response, and calling this API again.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetDeviceUsageHistoryResponse/Device
diagram DeviceService_p71.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
content complex
children Kind Identifier
annotation
documentation
The device for which the usage history was returned.
source <xs:element name="Device" type="DeviceIdentifier">
 
<xs:annotation>
   
<xs:documentation>The device for which the usage history was returned.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceUsageHistoryResponse/UsageHistory
diagram DeviceService_p72.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceUsage
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Timestamp ServicePlan BytesUsed SmsUsed Source ExtendedAttributes
annotation
documentation
The usage history for the device.
source <xs:element name="UsageHistory" type="DeviceUsage" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The usage history for the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetDeviceUsageHistoryResponse/IsComplete
diagram DeviceService_p73.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:boolean
properties
content simple
annotation
documentation
Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the TimeStampFilter in the request based on the last Timestamp in this response, and calling this API again.
source <xs:element name="IsComplete" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>Indicates whether or not the response contains all records queried by the request. A maximum of 500 records are returned per call to this API. Retrieve more records by adjusting the TimeStampFilter in the request based on the last Timestamp in this response, and calling this API again.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetRatedDeviceUsageRequest
diagram DeviceService_p74.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children DeviceList DeviceGroupName AccountName
annotation
documentation
Returns rated usage data for the current billing cycle for each specified device. The information is returned in a callback response, so you must register a URL for DeviceUsage using the Register Callback API in the Callback Registration Service.
source <xs:element name="GetRatedDeviceUsageRequest">
 
<xs:annotation>
   
<xs:documentation>Returns rated usage data for the current billing cycle for each specified device. The information is returned in a callback response, so you must register a URL for DeviceUsage using the Register Callback API in the Callback Registration Service.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>A list of one or more devices for which you want usage data. You can pass either the DeviceList parameter or DeviceGroupName parameter, but not both.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>The name of a device group to get usage data for all the devices in the device group. You can pass either the DeviceGroupName parameter or DeviceList parameter, but not both.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="AccountName" type="xs:string" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetRatedDeviceUsageRequest/DeviceList
diagram DeviceService_p75.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Kind Identifier
annotation
documentation
A list of one or more devices for which you want usage data. You can pass either the DeviceList parameter or DeviceGroupName parameter, but not both.
source <xs:element name="DeviceList" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>A list of one or more devices for which you want usage data. You can pass either the DeviceList parameter or DeviceGroupName parameter, but not both.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetRatedDeviceUsageRequest/DeviceGroupName
diagram DeviceService_p76.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The name of a device group to get usage data for all the devices in the device group. You can pass either the DeviceGroupName parameter or DeviceList parameter, but not both.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The name of a device group to get usage data for all the devices in the device group. You can pass either the DeviceGroupName parameter or DeviceList parameter, but not both.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetRatedDeviceUsageRequest/AccountName
diagram DeviceService_p77.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.
source <xs:element name="AccountName" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>You must specify an AccountName if you specified DeviceGroupName. To retrieve the aggregate device usage for all devices associated with the account, specify the AccountName without specifying either DeviceList or DeviceGroupName.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetRatedDeviceUsageResponse
diagram DeviceService_p78.png
namespace http://nphase.com/unifiedwebservice/v2
properties
content complex
children RequestId
annotation
documentation
Returns a GUID for the request ID if the request was successfully sent.
source <xs:element name="GetRatedDeviceUsageResponse">
 
<xs:annotation>
   
<xs:documentation>Returns a GUID for the request ID if the request was successfully sent.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="RequestId" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>A unique ID that associates the request with the result sent via the callback service.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element GetRatedDeviceUsageResponse/RequestId
diagram DeviceService_p79.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
A unique ID that associates the request with the result sent via the callback service.
source <xs:element name="RequestId" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>A unique ID that associates the request with the result sent via the callback service.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType CarrierInformation
diagram DeviceService_p80.png
namespace http://nphase.com/unifiedwebservice/v2
children CarrierName ServicePlan State
used by
element DeviceInformation/CarrierInformation
annotation
documentation
Zero or more reocrds of this type will be returned as part of GetDeviceList and GetDeviceInformation API calls.
source <xs:complexType name="CarrierInformation">
 
<xs:annotation>
   
<xs:documentation>Zero or more reocrds of this type will be returned as part of GetDeviceList and GetDeviceInformation API calls.</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="CarrierName" type="xs:string" nillable="true">
     
<xs:annotation>
       
<xs:documentation>The name of the carrier.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ServicePlan" type="xs:string" nillable="true">
     
<xs:annotation>
       
<xs:documentation>The service plan associated with the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="State" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The state of the device, indicated by any of the following values:

deactive
active
pending activation
pending deactivation
pending service plan change
pending suspend
suspend
pending ESN / MEID change
pending MDN change
pending resume
</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element CarrierInformation/CarrierName
diagram DeviceService_p81.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
annotation
documentation
The name of the carrier.
source <xs:element name="CarrierName" type="xs:string" nillable="true">
 
<xs:annotation>
   
<xs:documentation>The name of the carrier.</xs:documentation>
 
</xs:annotation>
</xs:element>

element CarrierInformation/ServicePlan
diagram DeviceService_p82.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
annotation
documentation
The service plan associated with the device.
source <xs:element name="ServicePlan" type="xs:string" nillable="true">
 
<xs:annotation>
   
<xs:documentation>The service plan associated with the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element CarrierInformation/State
diagram DeviceService_p83.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The state of the device, indicated by any of the following values:

deactive
active
pending activation
pending deactivation
pending service plan change
pending suspend
suspend
pending ESN / MEID change
pending MDN change
pending resume
source <xs:element name="State" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The state of the device, indicated by any of the following values:

deactive
active
pending activation
pending deactivation
pending service plan change
pending suspend
suspend
pending ESN / MEID change
pending MDN change
pending resume
</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType ConnectionEventAttribute
diagram DeviceService_p84.png
namespace http://nphase.com/unifiedwebservice/v2
children Key Value
used by
element DeviceConnectionEvent/ConnectionEventAttributes
source <xs:complexType name="ConnectionEventAttribute">
 
<xs:sequence>
   
<xs:element name="Key" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The key for an attribute.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Value" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The value for an attribute.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element ConnectionEventAttribute/Key
diagram DeviceService_p85.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The key for an attribute.
source <xs:element name="Key" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The key for an attribute.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ConnectionEventAttribute/Value
diagram DeviceService_p86.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The value for an attribute.
source <xs:element name="Value" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The value for an attribute.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType CustomFieldObj
diagram DeviceService_p87.png
namespace http://nphase.com/unifiedwebservice/v2
children Name Value
used by
elements AddDevicesRequest/CustomFields DeviceInformation/CustomFields GetDeviceListRequest/DeviceCustomFieldFilter
source <xs:complexType name="CustomFieldObj">
 
<xs:sequence>
   
<xs:element name="Name" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The name of the custom field.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5
</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Value" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The value of the custom field.

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element CustomFieldObj/Name
diagram DeviceService_p88.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The name of the custom field.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5
source <xs:element name="Name" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The name of the custom field.

The legal custom field names are:

•  CustomField1
•  CustomField2
•  CustomField3
•  CustomField4
•  CustomField5
</xs:documentation>
 
</xs:annotation>
</xs:element>

element CustomFieldObj/Value
diagram DeviceService_p89.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The value of the custom field.

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
source <xs:element name="Value" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The value of the custom field.

Legal custom field values include the following characters:

•  Alphanumeric characters
•  SPACE
•  , (comma)
•  . (period)
•  : (colon)
•  - (hyphen)
•  _ (underscore)
•  / (forward slash)
•  @ (at sign)
•  ( (open parenthesis)
•  ) (close parenthesis)
•  [ (open bracket)
•  ] (close bracket)
•  # (number sign or hash)
</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType DeviceCapability
diagram DeviceService_p90.png
namespace http://nphase.com/unifiedwebservice/v2
children Key Name Value Type
used by
element GetDeviceCapabilitiesResponse/Capabilities
annotation
documentation
.
source <xs:complexType name="DeviceCapability">
 
<xs:annotation>
   
<xs:documentation>.</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="Key" type="xs:int">
     
<xs:annotation>
       
<xs:documentation>The numeric key for the capabilty.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Name" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The name of the capability.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Value" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The value of the capability.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Type" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>This element specifies whether the capability is standard or custom. Standard capabilities are those capabilities that are supported by the Verizon Device Side Framework, which runs on the device. Examples include:  “Compression supported?” and “Configuration supported?”. Custom capabilities are defined by the OEM of the particular device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element DeviceCapability/Key
diagram DeviceService_p91.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:int
properties
content simple
annotation
documentation
The numeric key for the capabilty.
source <xs:element name="Key" type="xs:int">
 
<xs:annotation>
   
<xs:documentation>The numeric key for the capabilty.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceCapability/Name
diagram DeviceService_p92.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The name of the capability.
source <xs:element name="Name" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The name of the capability.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceCapability/Value
diagram DeviceService_p93.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The value of the capability.
source <xs:element name="Value" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The value of the capability.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceCapability/Type
diagram DeviceService_p94.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
This element specifies whether the capability is standard or custom. Standard capabilities are those capabilities that are supported by the Verizon Device Side Framework, which runs on the device. Examples include:  “Compression supported?” and “Configuration supported?”. Custom capabilities are defined by the OEM of the particular device.
source <xs:element name="Type" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>This element specifies whether the capability is standard or custom. Standard capabilities are those capabilities that are supported by the Verizon Device Side Framework, which runs on the device. Examples include:  “Compression supported?” and “Configuration supported?”. Custom capabilities are defined by the OEM of the particular device.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType DeviceConnectionEvent
diagram DeviceService_p95.png
namespace http://nphase.com/unifiedwebservice/v2
children OccurredAt ConnectionEventAttributes ExtendedAttributes
used by
element GetDeviceConnectionHistoryResponse/ConnectionHistory
source <xs:complexType name="DeviceConnectionEvent">
 
<xs:sequence>
   
<xs:element name="OccurredAt" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>The date and time when the connection event occurred.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ConnectionEventAttributes" type="ConnectionEventAttribute" nillable="true" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The attributes that describe the connection event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The extended attributes that describe the connection event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element DeviceConnectionEvent/OccurredAt
diagram DeviceService_p96.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
The date and time when the connection event occurred.
source <xs:element name="OccurredAt" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>The date and time when the connection event occurred.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceConnectionEvent/ConnectionEventAttributes
diagram DeviceService_p97.png
namespace http://nphase.com/unifiedwebservice/v2
type ConnectionEventAttribute
properties
minOcc 1
maxOcc unbounded
content complex
nillable true
children Key Value
annotation
documentation
The attributes that describe the connection event.
source <xs:element name="ConnectionEventAttributes" type="ConnectionEventAttribute" nillable="true" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The attributes that describe the connection event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceConnectionEvent/ExtendedAttributes
diagram DeviceService_p98.png
namespace http://nphase.com/unifiedwebservice/v2
type ExtendedAttributesObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Key Value
annotation
documentation
The extended attributes that describe the connection event.
source <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The extended attributes that describe the connection event.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType DeviceInformation
diagram DeviceService_p99.png
namespace http://nphase.com/unifiedwebservice/v2
children AccountName CarrierInformation DeviceGroupName DeviceIdentifiers CreatedAt IPAddress LastActivationDate LastActivationBy BillingCycleEndDate Connected LastConnectionDate CustomFields FeatureCodes ExtendedAttributes
used by
elements GetDeviceInformationResponse/Device GetDeviceListResponse/Devices
annotation
documentation
Zero or more reocrds of this type will be returned as part of GetDeviceInformation and GetDeviceList API calls.
source <xs:complexType name="DeviceInformation">
 
<xs:annotation>
   
<xs:documentation>Zero or more reocrds of this type will be returned as part of GetDeviceInformation and GetDeviceList API calls.</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="AccountName" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The account that the device is associated with.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="CarrierInformation" type="CarrierInformation" nillable="true" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The carrier information associated with the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The device groups to which the device belongs.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="DeviceIdentifiers" type="DeviceIdentifier" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The device identifiers for the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="CreatedAt" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>The date and time the device was added to the system.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="IPAddress" type="xs:string" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>The IP address for the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="LastActivationDate" type="xs:dateTime" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>The date and time that the device was last activated.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="LastActivationBy" type="xs:string" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>The user who last activated the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="BillingCycleEndDate" type="xs:dateTime" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>The date that the device's billling cycle ends.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Connected" type="xs:boolean">
     
<xs:annotation>
       
<xs:documentation>True if the device is connected; false if it is not.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="LastConnectionDate" type="xs:dateTime" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>If the device is not connected, this element indicates the last known connection date.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="CustomFields" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The custom fields for the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="FeatureCodes" type="FeatureCode" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The feature codes for the device. Feature codes are only available with the Verizon Wholesale network.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The extended attributes for the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element DeviceInformation/AccountName
diagram DeviceService_p100.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The account that the device is associated with.
source <xs:element name="AccountName" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The account that the device is associated with.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/CarrierInformation
diagram DeviceService_p101.png
namespace http://nphase.com/unifiedwebservice/v2
type CarrierInformation
properties
minOcc 1
maxOcc unbounded
content complex
nillable true
children CarrierName ServicePlan State
annotation
documentation
The carrier information associated with the device.
source <xs:element name="CarrierInformation" type="CarrierInformation" nillable="true" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The carrier information associated with the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/DeviceGroupName
diagram DeviceService_p102.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 1
maxOcc unbounded
content simple
nillable true
annotation
documentation
The device groups to which the device belongs.
source <xs:element name="DeviceGroupName" type="xs:string" nillable="true" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The device groups to which the device belongs.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/DeviceIdentifiers
diagram DeviceService_p103.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 1
maxOcc unbounded
content complex
children Kind Identifier
annotation
documentation
The device identifiers for the device.
source <xs:element name="DeviceIdentifiers" type="DeviceIdentifier" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The device identifiers for the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/CreatedAt
diagram DeviceService_p104.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
The date and time the device was added to the system.
source <xs:element name="CreatedAt" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>The date and time the device was added to the system.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/IPAddress
diagram DeviceService_p105.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The IP address for the device.
source <xs:element name="IPAddress" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The IP address for the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/LastActivationDate
diagram DeviceService_p106.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The date and time that the device was last activated.
source <xs:element name="LastActivationDate" type="xs:dateTime" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The date and time that the device was last activated.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/LastActivationBy
diagram DeviceService_p107.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The user who last activated the device.
source <xs:element name="LastActivationBy" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The user who last activated the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/BillingCycleEndDate
diagram DeviceService_p108.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The date that the device's billling cycle ends.
source <xs:element name="BillingCycleEndDate" type="xs:dateTime" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The date that the device's billling cycle ends.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/Connected
diagram DeviceService_p109.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:boolean
properties
content simple
annotation
documentation
True if the device is connected; false if it is not.
source <xs:element name="Connected" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>True if the device is connected; false if it is not.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/LastConnectionDate
diagram DeviceService_p110.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
If the device is not connected, this element indicates the last known connection date.
source <xs:element name="LastConnectionDate" type="xs:dateTime" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>If the device is not connected, this element indicates the last known connection date.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/CustomFields
diagram DeviceService_p111.png
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Name Value
annotation
documentation
The custom fields for the device.
source <xs:element name="CustomFields" type="CustomFieldObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The custom fields for the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/FeatureCodes
diagram DeviceService_p112.png
namespace http://nphase.com/unifiedwebservice/v2
type FeatureCode
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Code Description
annotation
documentation
The feature codes for the device. Feature codes are only available with the Verizon Wholesale network.
source <xs:element name="FeatureCodes" type="FeatureCode" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The feature codes for the device. Feature codes are only available with the Verizon Wholesale network.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceInformation/ExtendedAttributes
diagram DeviceService_p113.png
namespace http://nphase.com/unifiedwebservice/v2
type ExtendedAttributesObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Key Value
annotation
documentation
The extended attributes for the device.
source <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The extended attributes for the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType DeviceUsage
diagram DeviceService_p114.png
namespace http://nphase.com/unifiedwebservice/v2
children Timestamp ServicePlan BytesUsed SmsUsed Source ExtendedAttributes
used by
element GetDeviceUsageHistoryResponse/UsageHistory
source <xs:complexType name="DeviceUsage">
 
<xs:sequence>
   
<xs:element name="Timestamp" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>The date and time when the device usage event occurred.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ServicePlan" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The service plan associated with the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="BytesUsed" type="xs:long">
     
<xs:annotation>
       
<xs:documentation>The number of bytes that were sent over the network as a result of this device usage event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="SmsUsed" type="xs:int">
     
<xs:annotation>
       
<xs:documentation>The number of SMS messages that occurred a result of this device usage event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Source" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The source of the device usage information for this device usage event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The extended attributes that apply to this device usage event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element DeviceUsage/Timestamp
diagram DeviceService_p115.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
The date and time when the device usage event occurred.
source <xs:element name="Timestamp" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>The date and time when the device usage event occurred.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceUsage/ServicePlan
diagram DeviceService_p116.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The service plan associated with the device.
source <xs:element name="ServicePlan" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The service plan associated with the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceUsage/BytesUsed
diagram DeviceService_p117.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:long
properties
content simple
annotation
documentation
The number of bytes that were sent over the network as a result of this device usage event.
source <xs:element name="BytesUsed" type="xs:long">
 
<xs:annotation>
   
<xs:documentation>The number of bytes that were sent over the network as a result of this device usage event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceUsage/SmsUsed
diagram DeviceService_p118.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:int
properties
content simple
annotation
documentation
The number of SMS messages that occurred a result of this device usage event.
source <xs:element name="SmsUsed" type="xs:int">
 
<xs:annotation>
   
<xs:documentation>The number of SMS messages that occurred a result of this device usage event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceUsage/Source
diagram DeviceService_p119.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The source of the device usage information for this device usage event.
source <xs:element name="Source" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The source of the device usage information for this device usage event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DeviceUsage/ExtendedAttributes
diagram DeviceService_p120.png
namespace http://nphase.com/unifiedwebservice/v2
type ExtendedAttributesObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Key Value
annotation
documentation
The extended attributes that apply to this device usage event.
source <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The extended attributes that apply to this device usage event.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType Messages
diagram DeviceService_p121.png
namespace http://nphase.com/unifiedwebservice/v2
children Device Message
used by
element AddDevicesResponse/ReturnMessage
source <xs:complexType name="Messages">
 
<xs:sequence>
   
<xs:element name="Device" type="DeviceIdentifierCollection">
     
<xs:annotation>
       
<xs:documentation>DeviceIdentifiers for the current devices.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Message" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The success message or error message for the current device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element Messages/Device
diagram DeviceService_p122.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifierCollection
properties
content complex
children DeviceIdentifiers
annotation
documentation
DeviceIdentifiers for the current devices.
source <xs:element name="Device" type="DeviceIdentifierCollection">
 
<xs:annotation>
   
<xs:documentation>DeviceIdentifiers for the current devices.</xs:documentation>
 
</xs:annotation>
</xs:element>

element Messages/Message
diagram DeviceService_p123.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The success message or error message for the current device.
source <xs:element name="Message" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The success message or error message for the current device.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType ProvisioningEvent
diagram DeviceService_p124.png
namespace http://nphase.com/unifiedwebservice/v2
children OccurredAt Status EventBy EventType ServicePlan Mdn Msisdn ExtendedAttributes
used by
element GetDeviceProvisioningHistoryResponse/ProvisioningHistory
source <xs:complexType name="ProvisioningEvent">
 
<xs:sequence>
   
<xs:element name="OccurredAt" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>The time that the provisioning event occurred.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Status" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The success or failure of the provisioning event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="EventBy" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The user who performed the provisioning event.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="EventType" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The provisioning action. It may be Suspend, Activate, Deactivate, or Restore</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ServicePlan" type="xs:string" nillable="true" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>The ServicePlan of the device after the provisioning action occurred.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Mdn" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The MDN assigned to the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Msisdn" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The MSISDN assigned to the device.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>The extended attributes assigned to the device. </xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element ProvisioningEvent/OccurredAt
diagram DeviceService_p125.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
The time that the provisioning event occurred.
source <xs:element name="OccurredAt" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>The time that the provisioning event occurred.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/Status
diagram DeviceService_p126.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The success or failure of the provisioning event.
source <xs:element name="Status" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The success or failure of the provisioning event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/EventBy
diagram DeviceService_p127.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The user who performed the provisioning event.
source <xs:element name="EventBy" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The user who performed the provisioning event.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/EventType
diagram DeviceService_p128.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The provisioning action. It may be Suspend, Activate, Deactivate, or Restore
source <xs:element name="EventType" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The provisioning action. It may be Suspend, Activate, Deactivate, or Restore</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/ServicePlan
diagram DeviceService_p129.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
annotation
documentation
The ServicePlan of the device after the provisioning action occurred.
source <xs:element name="ServicePlan" type="xs:string" nillable="true" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The ServicePlan of the device after the provisioning action occurred.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/Mdn
diagram DeviceService_p130.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The MDN assigned to the device.
source <xs:element name="Mdn" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The MDN assigned to the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/Msisdn
diagram DeviceService_p131.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The MSISDN assigned to the device.
source <xs:element name="Msisdn" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The MSISDN assigned to the device.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ProvisioningEvent/ExtendedAttributes
diagram DeviceService_p132.png
namespace http://nphase.com/unifiedwebservice/v2
type ExtendedAttributesObj
properties
minOcc 0
maxOcc unbounded
content complex
nillable true
children Key Value
annotation
documentation
The extended attributes assigned to the device.
source <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>The extended attributes assigned to the device. </xs:documentation>
 
</xs:annotation>
</xs:element>

complexType CustomFieldFilterObj
diagram DeviceService_p133.png
namespace http://nphase.com/unifiedwebservice/v2
children Name Value
used by
elements GetDevicePRLInformationRequest/DeviceCustomFieldFilter GetDeviceSuspensionStatusRequest/DeviceCustomFieldFilter
source <xs:complexType name="CustomFieldFilterObj">
 
<xs:sequence>
   
<xs:element name="Name" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>
            This element specifies the name of the custom field.

            The legal custom field names are:

            •  CustomField1
            •  CustomField2
            •  CustomField3
            •  CustomField4
            •  CustomField5
         
</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Value" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>
            This element specifies the value of the custom field.

            Legal custom field values include the following characters:

            •  Alphanumeric characters
            •  SPACE
            •  , (comma)
            •  . (period)
            •  : (colon)
            •  - (hyphen)
            •  _ (underscore)
            •  / (forward slash)
            •  @ (at sign)
            •  ( (open parenthesis)
            •  ) (close parenthesis)
            •  [ (open bracket)
            •  ] (close bracket)
            •  # (number sign or hash)
         
</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element CustomFieldFilterObj/Name
diagram DeviceService_p134.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation

            This element specifies the name of the custom field.

            The legal custom field names are:

            •  CustomField1
            •  CustomField2
            •  CustomField3
            •  CustomField4
            •  CustomField5
         
source <xs:element name="Name" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>
            This element specifies the name of the custom field.

            The legal custom field names are:

            •  CustomField1
            •  CustomField2
            •  CustomField3
            •  CustomField4
            •  CustomField5
         
</xs:documentation>
 
</xs:annotation>
</xs:element>

element CustomFieldFilterObj/Value
diagram DeviceService_p135.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation

            This element specifies the value of the custom field.

            Legal custom field values include the following characters:

            •  Alphanumeric characters
            •  SPACE
            •  , (comma)
            •  . (period)
            •  : (colon)
            •  - (hyphen)
            •  _ (underscore)
            •  / (forward slash)
            •  @ (at sign)
            •  ( (open parenthesis)
            •  ) (close parenthesis)
            •  [ (open bracket)
            •  ] (close bracket)
            •  # (number sign or hash)
         
source <xs:element name="Value" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>
            This element specifies the value of the custom field.

            Legal custom field values include the following characters:

            •  Alphanumeric characters
            •  SPACE
            •  , (comma)
            •  . (period)
            •  : (colon)
            •  - (hyphen)
            •  _ (underscore)
            •  / (forward slash)
            •  @ (at sign)
            •  ( (open parenthesis)
            •  ) (close parenthesis)
            •  [ (open bracket)
            •  ] (close bracket)
            •  # (number sign or hash)
         
</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType Date
diagram DeviceService_p136.png
namespace http://nphase.com/unifiedwebservice/v2
children Month Day Year
source <xs:complexType name="Date">
 
<xs:sequence>
   
<xs:element name="Month" type="xs:unsignedByte"/>
   
<xs:element name="Day" type="xs:unsignedByte"/>
   
<xs:element name="Year" type="xs:unsignedShort"/>
 
</xs:sequence>
</xs:complexType>

element Date/Month
diagram DeviceService_p137.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
properties
content simple
source <xs:element name="Month" type="xs:unsignedByte"/>

element Date/Day
diagram DeviceService_p138.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
properties
content simple
source <xs:element name="Day" type="xs:unsignedByte"/>

element Date/Year
diagram DeviceService_p139.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedShort
properties
content simple
source <xs:element name="Year" type="xs:unsignedShort"/>

complexType DeviceIdentifier
diagram DeviceService_p140.png
namespace http://nphase.com/unifiedwebservice/v2
children Kind Identifier
used by
elements GetDeviceConnectionHistoryRequest/Device GetDeviceConnectionHistoryResponse/Device GetDeviceInformationRequest/Device GetDeviceUsageHistoryRequest/Device GetDeviceUsageHistoryResponse/Device GetDeviceProvisioningHistoryRequest/Device GetDeviceProvisioningHistoryResponse/Device GetDeviceCapabilitiesRequest/Device DeviceInformation/DeviceIdentifiers DeviceIdentifierCollection/DeviceIdentifiers GetAggregateDeviceUsageRequest/DeviceList GetRatedDeviceUsageRequest/DeviceList GetDevicePRLInformationRequest/DeviceList GetDeviceSuspensionStatusRequest/DeviceList
source <xs:complexType name="DeviceIdentifier">
 
<xs:sequence>
   
<xs:element name="Kind">
     
<xs:annotation>
       
<xs:documentation>This element specifies the kind of the device identifier.</xs:documentation>
     
</xs:annotation>
     
<xs:simpleType>
       
<xs:restriction base="xs:string">
         
<xs:enumeration value="Esn">
           
<xs:annotation>
             
<xs:documentation>Electronic Serial Number (8-digit hexadecimal or 11-digit decimal format).</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Iccid">
           
<xs:annotation>
             
<xs:documentation>Integrated Circuit Card ID  (used with a SIM card).</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Imsi">
           
<xs:annotation>
             
<xs:documentation>International Mobile Subscriber Identity</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Mdn">
           
<xs:annotation>
             
<xs:documentation>Mobile Directory Number</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Meid">
           
<xs:annotation>
             
<xs:documentation>Mobile Equipment Identifier</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Imei">
           
<xs:annotation>
             
<xs:documentation>International Mobile Station Equipment Identity</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
         
<xs:enumeration value="Msisdn">
           
<xs:annotation>
             
<xs:documentation>Mobile Subscriber Integrated Services Digital Network-Number</xs:documentation>
           
</xs:annotation>
         
</xs:enumeration>
       
</xs:restriction>
     
</xs:simpleType>
   
</xs:element>
   
<xs:element name="Identifier" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>This element specifies the value of the device identifier.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element DeviceIdentifier/Kind
diagram DeviceService_p141.png
namespace http://nphase.com/unifiedwebservice/v2
type restriction of xs:string
properties
content simple
facets
Kind Value Annotation
enumeration Esn
documentation
Electronic Serial Number (8-digit hexadecimal or 11-digit decimal format).
enumeration Iccid
documentation
Integrated Circuit Card ID  (used with a SIM card).
enumeration Imsi
documentation
International Mobile Subscriber Identity
enumeration Mdn
documentation
Mobile Directory Number
enumeration Meid
documentation
Mobile Equipment Identifier
enumeration Imei
documentation
International Mobile Station Equipment Identity
enumeration Msisdn
documentation
Mobile Subscriber Integrated Services Digital Network-Number
annotation
documentation
This element specifies the kind of the device identifier.
source <xs:element name="Kind">
 
<xs:annotation>
   
<xs:documentation>This element specifies the kind of the device identifier.</xs:documentation>
 
</xs:annotation>
 
<xs:simpleType>
   
<xs:restriction base="xs:string">
     
<xs:enumeration value="Esn">
       
<xs:annotation>
         
<xs:documentation>Electronic Serial Number (8-digit hexadecimal or 11-digit decimal format).</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Iccid">
       
<xs:annotation>
         
<xs:documentation>Integrated Circuit Card ID  (used with a SIM card).</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Imsi">
       
<xs:annotation>
         
<xs:documentation>International Mobile Subscriber Identity</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Mdn">
       
<xs:annotation>
         
<xs:documentation>Mobile Directory Number</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Meid">
       
<xs:annotation>
         
<xs:documentation>Mobile Equipment Identifier</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Imei">
       
<xs:annotation>
         
<xs:documentation>International Mobile Station Equipment Identity</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
     
<xs:enumeration value="Msisdn">
       
<xs:annotation>
         
<xs:documentation>Mobile Subscriber Integrated Services Digital Network-Number</xs:documentation>
       
</xs:annotation>
     
</xs:enumeration>
   
</xs:restriction>
 
</xs:simpleType>
</xs:element>

element DeviceIdentifier/Identifier
diagram DeviceService_p142.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
This element specifies the value of the device identifier.
source <xs:element name="Identifier" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>This element specifies the value of the device identifier.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType DeviceIdentifierCollection
diagram DeviceService_p143.png
namespace http://nphase.com/unifiedwebservice/v2
children DeviceIdentifiers
used by
elements Messages/Device AddDevicesRequest/DeviceToAdd
annotation
documentation
Collection of all the identifiers assigned to the device.
source <xs:complexType name="DeviceIdentifierCollection">
 
<xs:annotation>
   
<xs:documentation>Collection of all the identifiers assigned to the device.</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="DeviceIdentifiers" type="DeviceIdentifier" nillable="true" minOccurs="1" maxOccurs="unbounded"/>
 
</xs:sequence>
</xs:complexType>

element DeviceIdentifierCollection/DeviceIdentifiers
diagram DeviceService_p144.png
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
properties
minOcc 1
maxOcc unbounded
content complex
nillable true
children Kind Identifier
source <xs:element name="DeviceIdentifiers" type="DeviceIdentifier" nillable="true" minOccurs="1" maxOccurs="unbounded"/>

complexType ErrorInformation
diagram DeviceService_p145.png
namespace http://nphase.com/unifiedwebservice/v2
children Code Message
source <xs:complexType name="ErrorInformation">
 
<xs:sequence>
   
<xs:element name="Code" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The error code associated with the operation failure.  This should be treated as a named constant string.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Message" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>The error message text associated with the operation failure.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element ErrorInformation/Code
diagram DeviceService_p146.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The error code associated with the operation failure.  This should be treated as a named constant string.
source <xs:element name="Code" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The error code associated with the operation failure.  This should be treated as a named constant string.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ErrorInformation/Message
diagram DeviceService_p147.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
annotation
documentation
The error message text associated with the operation failure.
source <xs:element name="Message" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>The error message text associated with the operation failure.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType ExtendedAttributesObj
diagram DeviceService_p148.png
namespace http://nphase.com/unifiedwebservice/v2
children Key Value
used by
elements DeviceConnectionEvent/ExtendedAttributes DeviceInformation/ExtendedAttributes DeviceUsage/ExtendedAttributes ProvisioningEvent/ExtendedAttributes
source <xs:complexType name="ExtendedAttributesObj">
 
<xs:sequence>
   
<xs:element name="Key" type="xs:string" nillable="true">
     
<xs:annotation>
       
<xs:documentation>This element specifies the key for an extended attribute.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Value" type="xs:string" nillable="true">
     
<xs:annotation>
       
<xs:documentation>This element specifies the value for an extended attribute.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element ExtendedAttributesObj/Key
diagram DeviceService_p149.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
annotation
documentation
This element specifies the key for an extended attribute.
source <xs:element name="Key" type="xs:string" nillable="true">
 
<xs:annotation>
   
<xs:documentation>This element specifies the key for an extended attribute.</xs:documentation>
 
</xs:annotation>
</xs:element>

element ExtendedAttributesObj/Value
diagram DeviceService_p150.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
annotation
documentation
This element specifies the value for an extended attribute.
source <xs:element name="Value" type="xs:string" nillable="true">
 
<xs:annotation>
   
<xs:documentation>This element specifies the value for an extended attribute.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType FeatureCode
diagram DeviceService_p151.png
namespace http://nphase.com/unifiedwebservice/v2
children Code Description
used by
element DeviceInformation/FeatureCodes
source <xs:complexType name="FeatureCode">
 
<xs:sequence>
   
<xs:element name="Code" type="xs:string" nillable="true"/>
   
<xs:element name="Description" type="xs:string" nillable="true"/>
 
</xs:sequence>
</xs:complexType>

element FeatureCode/Code
diagram DeviceService_p152.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="Code" type="xs:string" nillable="true"/>

element FeatureCode/Description
diagram DeviceService_p153.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="Description" type="xs:string" nillable="true"/>

complexType InclusiveDateTimeRange
diagram DeviceService_p154.png
namespace http://nphase.com/unifiedwebservice/v2
children Earliest Latest
used by
elements GetDeviceListRequest/CreatedAtFilter GetDeviceConnectionHistoryRequest/OccurredAtFilter GetDeviceProvisioningHistoryRequest/OccurredAtFilter GetDeviceUsageHistoryRequest/TimestampFilter
source <xs:complexType name="InclusiveDateTimeRange">
 
<xs:sequence>
   
<xs:element name="Earliest" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>This element specifies the earliest date and time in the range.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="Latest" type="xs:dateTime">
     
<xs:annotation>
       
<xs:documentation>This element specifies the latest date and time in the range.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
</xs:complexType>

element InclusiveDateTimeRange/Earliest
diagram DeviceService_p155.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
This element specifies the earliest date and time in the range.
source <xs:element name="Earliest" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>This element specifies the earliest date and time in the range.</xs:documentation>
 
</xs:annotation>
</xs:element>

element InclusiveDateTimeRange/Latest
diagram DeviceService_p156.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
annotation
documentation
This element specifies the latest date and time in the range.
source <xs:element name="Latest" type="xs:dateTime">
 
<xs:annotation>
   
<xs:documentation>This element specifies the latest date and time in the range.</xs:documentation>
 
</xs:annotation>
</xs:element>

complexType PrimaryPlaceOfUse
diagram DeviceService_p157.png
namespace http://nphase.com/unifiedwebservice/v2
children CustomerName Address
source <xs:complexType name="PrimaryPlaceOfUse">
 
<xs:sequence>
   
<xs:element name="CustomerName" type="PrimaryPlaceOfUseCustomerName" nillable="true"/>
   
<xs:element name="Address" type="PrimaryPlaceOfUseAddress" nillable="true"/>
 
</xs:sequence>
</xs:complexType>

element PrimaryPlaceOfUse/CustomerName
diagram DeviceService_p158.png
namespace http://nphase.com/unifiedwebservice/v2
type PrimaryPlaceOfUseCustomerName
properties
content complex
nillable true
children Title FirstName MiddleName LastName Suffix
source <xs:element name="CustomerName" type="PrimaryPlaceOfUseCustomerName" nillable="true"/>

element PrimaryPlaceOfUse/Address
diagram DeviceService_p159.png
namespace http://nphase.com/unifiedwebservice/v2
type PrimaryPlaceOfUseAddress
properties
content complex
nillable true
children AddressLine1 AddressLine2 City State ZipCode Country ZipCode4 CBRPhone CBRPhoneType EmailAddress
source <xs:element name="Address" type="PrimaryPlaceOfUseAddress" nillable="true"/>

complexType PrimaryPlaceOfUseAddress
diagram DeviceService_p160.png
namespace http://nphase.com/unifiedwebservice/v2
children AddressLine1 AddressLine2 City State ZipCode Country ZipCode4 CBRPhone CBRPhoneType EmailAddress
used by
element PrimaryPlaceOfUse/Address
source <xs:complexType name="PrimaryPlaceOfUseAddress">
 
<xs:sequence>
   
<xs:element name="AddressLine1" type="xs:string" nillable="true"/>
   
<xs:element name="AddressLine2" type="xs:string" nillable="true" minOccurs="0"/>
   
<xs:element name="City" type="xs:string" nillable="true"/>
   
<xs:element name="State" type="xs:string" nillable="true"/>
   
<xs:element name="ZipCode" type="xs:string" nillable="true"/>
   
<xs:element name="Country" type="xs:string" nillable="true"/>
   
<xs:element name="ZipCode4" type="xs:string" nillable="true"/>
   
<xs:element name="CBRPhone" type="xs:string" nillable="true"/>
   
<xs:element name="CBRPhoneType" type="xs:string" nillable="true"/>
   
<xs:element name="EmailAddress" type="xs:string" nillable="true"/>
 
</xs:sequence>
</xs:complexType>

element PrimaryPlaceOfUseAddress/AddressLine1
diagram DeviceService_p161.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="AddressLine1" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/AddressLine2
diagram DeviceService_p162.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
source <xs:element name="AddressLine2" type="xs:string" nillable="true" minOccurs="0"/>

element PrimaryPlaceOfUseAddress/City
diagram DeviceService_p163.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="City" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/State
diagram DeviceService_p164.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="State" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/ZipCode
diagram DeviceService_p165.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="ZipCode" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/Country
diagram DeviceService_p166.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="Country" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/ZipCode4
diagram DeviceService_p167.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="ZipCode4" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/CBRPhone
diagram DeviceService_p168.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="CBRPhone" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/CBRPhoneType
diagram DeviceService_p169.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="CBRPhoneType" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseAddress/EmailAddress
diagram DeviceService_p170.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="EmailAddress" type="xs:string" nillable="true"/>

complexType PrimaryPlaceOfUseCustomerName
diagram DeviceService_p171.png
namespace http://nphase.com/unifiedwebservice/v2
children Title FirstName MiddleName LastName Suffix
used by
element PrimaryPlaceOfUse/CustomerName
source <xs:complexType name="PrimaryPlaceOfUseCustomerName">
 
<xs:sequence>
   
<xs:element name="Title" type="xs:string" nillable="true" minOccurs="0"/>
   
<xs:element name="FirstName" type="xs:string" nillable="true"/>
   
<xs:element name="MiddleName" type="xs:string" nillable="true" minOccurs="0"/>
   
<xs:element name="LastName" type="xs:string" nillable="true"/>
   
<xs:element name="Suffix" type="xs:string" nillable="true"/>
 
</xs:sequence>
</xs:complexType>

element PrimaryPlaceOfUseCustomerName/Title
diagram DeviceService_p172.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
source <xs:element name="Title" type="xs:string" nillable="true" minOccurs="0"/>

element PrimaryPlaceOfUseCustomerName/FirstName
diagram DeviceService_p173.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="FirstName" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseCustomerName/MiddleName
diagram DeviceService_p174.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
minOcc 0
maxOcc 1
content simple
nillable true
source <xs:element name="MiddleName" type="xs:string" nillable="true" minOccurs="0"/>

element PrimaryPlaceOfUseCustomerName/LastName
diagram DeviceService_p175.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="LastName" type="xs:string" nillable="true"/>

element PrimaryPlaceOfUseCustomerName/Suffix
diagram DeviceService_p176.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
properties
content simple
nillable true
source <xs:element name="Suffix" type="xs:string" nillable="true"/>

complexType Time
diagram DeviceService_p177.png
namespace http://nphase.com/unifiedwebservice/v2
children Hour Minute Second
used by
elements TimeRangePerDay/End TimeRangePerDay/Start
source <xs:complexType name="Time">
 
<xs:sequence>
   
<xs:element name="Hour" type="xs:unsignedByte"/>
   
<xs:element name="Minute" type="xs:unsignedByte"/>
   
<xs:element name="Second" type="xs:unsignedByte"/>
 
</xs:sequence>
</xs:complexType>

element Time/Hour
diagram DeviceService_p178.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
properties
content simple
source <xs:element name="Hour" type="xs:unsignedByte"/>

element Time/Minute
diagram DeviceService_p179.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
properties
content simple
source <xs:element name="Minute" type="xs:unsignedByte"/>

element Time/Second
diagram DeviceService_p180.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
properties
content simple
source <xs:element name="Second" type="xs:unsignedByte"/>

complexType TimeRange
diagram DeviceService_p181.png
namespace http://nphase.com/unifiedwebservice/v2
children Start End
used by
element GetAggregateDeviceUsageRequest/TimestampFilter
source <xs:complexType name="TimeRange">
 
<xs:sequence>
   
<xs:element name="Start" type="xs:dateTime"/>
   
<xs:element name="End" type="xs:dateTime"/>
 
</xs:sequence>
</xs:complexType>

element TimeRange/Start
diagram DeviceService_p182.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
source <xs:element name="Start" type="xs:dateTime"/>

element TimeRange/End
diagram DeviceService_p183.png
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
properties
content simple
source <xs:element name="End" type="xs:dateTime"/>

complexType TimeRangePerDay
diagram DeviceService_p184.png
namespace http://nphase.com/unifiedwebservice/v2
children Start End
source <xs:complexType name="TimeRangePerDay">
 
<xs:sequence>
   
<xs:element name="Start" type="Time"/>
   
<xs:element name="End" type="Time"/>
 
</xs:sequence>
</xs:complexType>

element TimeRangePerDay/Start
diagram DeviceService_p185.png
namespace http://nphase.com/unifiedwebservice/v2
type Time
properties
content complex
children Hour Minute Second
source <xs:element name="Start" type="Time"/>

element TimeRangePerDay/End
diagram DeviceService_p186.png
namespace http://nphase.com/unifiedwebservice/v2
type Time
properties
content complex
children Hour Minute Second
source <xs:element name="End" type="Time"/>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy