Schema EnhancedConnectivityService.xsd


schema location:  C:\Working\SVN\m2mmc\branches\4.4.3\win\unified-web-service\APIs\v2\Schema\EnhancedConnectivityService.xsd
targetNamespace:  http://nphase.com/unifiedwebservice/v2
 
Elements 
GetSmsMessagesRequest 
GetSmsMessagesResponse 
RemotePrlUpdateRequest 
RemotePrlUpdateResponse 
SendSmsMessageRequest 
SendSmsMessageResponse 
StartSmsCallbackRequest 
StartSmsCallbackResponse 
WakeUpDeviceRequest 
WakeUpDeviceResponse 


schema location:  C:\Working\SVN\m2mmc\branches\4.4.3\win\unified-web-service\APIs\v2\Schema\Types/EnhancedConnectivityServiceTypes.xsd
targetNamespace:  http://nphase.com/unifiedwebservice/v2
 
Complex types 
RetrievedSmsMessage 


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


element GetSmsMessagesRequest
diagram
namespace http://nphase.com/unifiedwebservice/v2
children AccountName PreviousToken
annotation
documentation 
Retrieves SMS messages sent by all devices associated with an account. This API retrieves up to 100 SMS messages in a single call.

GetSmsMessages provides a syncrhonous method for retrieving SMS messages. Most applications are more likely to use an asynchronous approach, and retrieve SMS messages via a callback. However, if your callback service fails, you can retrieve any messages that were not successfully retrieved by using this API. Another approach for handling callback failures is to simply restart the callback service, by using StartSmsCallbackRequest.
source
<xs:element name="GetSmsMessagesRequest">
  <xs:annotation>
    <xs:documentation>Retrieves SMS messages sent by all devices associated with an account. This API retrieves up to 100 SMS messages in a single call.

GetSmsMessages provides a syncrhonous method for retrieving SMS messages. Most applications are more likely to use an asynchronous approach, and retrieve SMS messages via a callback. However, if your callback service fails, you can retrieve any messages that were not successfully retrieved by using this API. Another approach for handling callback failures is to simply restart the callback service, by using StartSmsCallbackRequest.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="AccountName" type="xs:string">
        <xs:annotation>
          <xs:documentation>An account name. SMS messages that were sent from devices associated with this account will be retrieved.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="PreviousToken" type="xs:string" nillable="true" minOccurs="0">
        <xs:annotation>
          <xs:documentation>A string returned in the response to the previous GetSmsMessages request. Call GetSmsMessages again with the token from the previous response to acknowledge receiving that set of messages and to request the next set. Set PreviousToken to null to retrieve the first set of SMS messages for the account.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element GetSmsMessagesRequest/AccountName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
An account name. SMS messages that were sent from devices associated with this account will be retrieved.
source
<xs:element name="AccountName" type="xs:string">
  <xs:annotation>
    <xs:documentation>An account name. SMS messages that were sent from devices associated with this account will be retrieved.</xs:documentation>
  </xs:annotation>
</xs:element>

element GetSmsMessagesRequest/PreviousToken
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
A string returned in the response to the previous GetSmsMessages request. Call GetSmsMessages again with the token from the previous response to acknowledge receiving that set of messages and to request the next set. Set PreviousToken to null to retrieve the first set of SMS messages for the account.
source
<xs:element name="PreviousToken" type="xs:string" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>A string returned in the response to the previous GetSmsMessages request. Call GetSmsMessages again with the token from the previous response to acknowledge receiving that set of messages and to request the next set. Set PreviousToken to null to retrieve the first set of SMS messages for the account.</xs:documentation>
  </xs:annotation>
</xs:element>

element GetSmsMessagesResponse
diagram
namespace http://nphase.com/unifiedwebservice/v2
children RetrievedSmsMessages Token
annotation
documentation 
Returns the SMS messages that were sent by devices associated with the specified account.
source
<xs:element name="GetSmsMessagesResponse">
  <xs:annotation>
    <xs:documentation>Returns the SMS messages that were sent by devices associated with the specified account.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="RetrievedSmsMessages" type="RetrievedSmsMessage" maxOccurs="100">
        <xs:annotation>
          <xs:documentation>A list of up to 100 of the SMS messages that have been retrieved.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Token" type="xs:string">
        <xs:annotation>
          <xs:documentation>A string representing the set of SMS messages in this response. To retrieve the next set of messages for the account (if any messages are still waiting in the queue), use this token in the PreviousToken parameter of the GetSmsMessagesRequest call. </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element GetSmsMessagesResponse/RetrievedSmsMessages
diagram
namespace http://nphase.com/unifiedwebservice/v2
type RetrievedSmsMessage
children Device Message TimeStamp
annotation
documentation 
A list of up to 100 of the SMS messages that have been retrieved.
source
<xs:element name="RetrievedSmsMessages" type="RetrievedSmsMessage" maxOccurs="100">
  <xs:annotation>
    <xs:documentation>A list of up to 100 of the SMS messages that have been retrieved.</xs:documentation>
  </xs:annotation>
</xs:element>

element GetSmsMessagesResponse/Token
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
A string representing the set of SMS messages in this response. To retrieve the next set of messages for the account (if any messages are still waiting in the queue), use this token in the PreviousToken parameter of the GetSmsMessagesRequest call. 
source
<xs:element name="Token" type="xs:string">
  <xs:annotation>
    <xs:documentation>A string representing the set of SMS messages in this response. To retrieve the next set of messages for the account (if any messages are still waiting in the queue), use this token in the PreviousToken parameter of the GetSmsMessagesRequest call. </xs:documentation>
  </xs:annotation>
</xs:element>

element RemotePrlUpdateRequest
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Devices DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter
annotation
documentation 
This API is no longer supported.
source
<xs:element name="RemotePrlUpdateRequest">
  <xs:annotation>
    <xs:documentation>This API is no longer supported.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"/>
      <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element RemotePrlUpdateRequest/Devices
diagram
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
children Kind Identifier
source
<xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded"/>

element RemotePrlUpdateRequest/DeviceGroupName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"/>

element RemotePrlUpdateRequest/AccountName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0"/>

element RemotePrlUpdateRequest/DeviceServicePlanFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"/>

element RemotePrlUpdateRequest/DeviceCustomFieldFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldFilterObj
children Name Value
source
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded"/>

element RemotePrlUpdateResponse
diagram
namespace http://nphase.com/unifiedwebservice/v2
children RequestId
source
<xs:element name="RemotePrlUpdateResponse">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="RequestId" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element RemotePrlUpdateResponse/RequestId
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="RequestId" type="xs:string"/>

element SendSmsMessageRequest
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Devices DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter DataEncoding SmsMessage
annotation
documentation 
Sends an SMS message to one or more devices.
source
<xs:element name="SendSmsMessageRequest">
  <xs:annotation>
    <xs:documentation>Sends an SMS message to one or more devices.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>A list of one or more devices. This API sends the SMS message to all specified devices. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter..</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 send the SMS message to all devices in the group.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
        <xs:annotation>
          <xs:documentation>The account that is associated with the device group. If you have access to multiple billing accounts and you specify a device group, the account must be specified, since a device group name can be reused in multiple accounts.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>A service plan name if you only want to send the SMS messages to devices under this service plan.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>The names and values of custom fields, if you only want to send the SMS messages to devices matching these custom fields.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="DataEncoding" minOccurs="0">
        <xs:annotation>
          <xs:documentation>The SMS message encoding, which can be: 7-bit (default), 8-bit ASCII, 8-bit UTF-8, or 8-bit DATA formats.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="7-bit"/>
            <xs:enumeration value="8-bit-ASCII"/>
            <xs:enumeration value="8-bit-UTF-8"/>
            <xs:enumeration value="8-bit-DATA"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element name="SmsMessage" type="xs:string">
        <xs:annotation>
          <xs:documentation>The contents of the SMS message. The SMS message is limited to 160 characters in 7-bit format, or 140 characters in 8-bit format.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element SendSmsMessageRequest/Devices
diagram
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
children Kind Identifier
annotation
documentation 
A list of one or more devices. This API sends the SMS message to all specified devices. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter..
source
<xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>A list of one or more devices. This API sends the SMS message to all specified devices. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter..</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageRequest/DeviceGroupName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
The name of a device group to send the SMS message to all devices in the group.
source
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The name of a device group to send the SMS message to all devices in the group.</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageRequest/AccountName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
The account that is associated with the device group. If you have access to multiple billing accounts and you specify a device group, the account must be specified, since a device group name can be reused in multiple accounts.
source
<xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The account that is associated with the device group. If you have access to multiple billing accounts and you specify a device group, the account must be specified, since a device group name can be reused in multiple accounts.</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageRequest/DeviceServicePlanFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
A service plan name if you only want to send the SMS messages to devices under this service plan.
source
<xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>A service plan name if you only want to send the SMS messages to devices under this service plan.</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageRequest/DeviceCustomFieldFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldFilterObj
children Name Value
annotation
documentation 
The names and values of custom fields, if you only want to send the SMS messages to devices matching these custom fields.
source
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>The names and values of custom fields, if you only want to send the SMS messages to devices matching these custom fields.</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageRequest/DataEncoding
diagram
namespace http://nphase.com/unifiedwebservice/v2
type restriction of xs:string
facets
enumeration 7-bit
enumeration 8-bit-ASCII
enumeration 8-bit-UTF-8
enumeration 8-bit-DATA
annotation
documentation 
The SMS message encoding, which can be: 7-bit (default), 8-bit ASCII, 8-bit UTF-8, or 8-bit DATA formats.
source
<xs:element name="DataEncoding" minOccurs="0">
  <xs:annotation>
    <xs:documentation>The SMS message encoding, which can be: 7-bit (default), 8-bit ASCII, 8-bit UTF-8, or 8-bit DATA formats.</xs:documentation>
  </xs:annotation>
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="7-bit"/>
      <xs:enumeration value="8-bit-ASCII"/>
      <xs:enumeration value="8-bit-UTF-8"/>
      <xs:enumeration value="8-bit-DATA"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

element SendSmsMessageRequest/SmsMessage
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
The contents of the SMS message. The SMS message is limited to 160 characters in 7-bit format, or 140 characters in 8-bit format.
source
<xs:element name="SmsMessage" type="xs:string">
  <xs:annotation>
    <xs:documentation>The contents of the SMS message. The SMS message is limited to 160 characters in 7-bit format, or 140 characters in 8-bit format.</xs:documentation>
  </xs:annotation>
</xs:element>

element SendSmsMessageResponse
diagram
namespace http://nphase.com/unifiedwebservice/v2
children RequestId
annotation
documentation 
This API response indicates that the request to send the SMS message was accepted. Neither the synchronous API response nor the asynchronous result indicate that the SMS message was successfully sent to the devices, but only that the SMS message and the target devices or device group were valid, and that delivery of the SMS message will be attempted.
source
<xs:element name="SendSmsMessageResponse">
  <xs:annotation>
    <xs:documentation>This API response indicates that the request to send the SMS message was accepted. Neither the synchronous API response nor the asynchronous result indicate that the SMS message was successfully sent to the devices, but only that the SMS message and the target devices or device group were valid, and that delivery of the SMS message will be attempted.</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. A callback is sent for each device, indicating whether or not the operation succeeded for the device.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element SendSmsMessageResponse/RequestId
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
A unique ID that associates the request with the results that are sent via a callback service. A callback is sent for each device, indicating whether or not the operation succeeded for the device.
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. A callback is sent for each device, indicating whether or not the operation succeeded for the device.</xs:documentation>
  </xs:annotation>
</xs:element>

element StartSmsCallbackRequest
diagram
namespace http://nphase.com/unifiedwebservice/v2
children AccountName
annotation
documentation 
Restarts delivery of queued SMS messages for the specified account.
source
<xs:element name="StartSmsCallbackRequest">
  <xs:annotation>
    <xs:documentation>Restarts delivery of queued SMS messages for the specified account.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="AccountName" type="xs:string">
        <xs:annotation>
          <xs:documentation>This element specifies the account associated with the registered callback URL and SMS messages.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element StartSmsCallbackRequest/AccountName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
This element specifies the account associated with the registered callback URL and SMS messages.
source
<xs:element name="AccountName" type="xs:string">
  <xs:annotation>
    <xs:documentation>This element specifies the account associated with the registered callback URL and SMS messages.</xs:documentation>
  </xs:annotation>
</xs:element>

element StartSmsCallbackResponse
diagram
namespace http://nphase.com/unifiedwebservice/v2
annotation
documentation 
Returns an empty response object if the SMS callback delivery was successfully started.
source
<xs:element name="StartSmsCallbackResponse">
  <xs:annotation>
    <xs:documentation>Returns an empty response object if the SMS callback delivery was successfully started.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence/>
  </xs:complexType>
</xs:element>

element WakeUpDeviceRequest
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Devices DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter WakeUpMethod
annotation
documentation 
This API is no longer supported.
source
<xs:element name="WakeUpDeviceRequest">
  <xs:annotation>
    <xs:documentation>This API is no longer supported.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"/>
      <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="WakeUpMethod">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="IpWakeUp"/>
            <xs:enumeration value="SmsWakeUp"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element WakeUpDeviceRequest/Devices
diagram
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
children Kind Identifier
source
<xs:element name="Devices" type="DeviceIdentifier" nillable="true" minOccurs="0" maxOccurs="unbounded"/>

element WakeUpDeviceRequest/DeviceGroupName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"/>

element WakeUpDeviceRequest/AccountName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="AccountName" type="xs:string" nillable="true" minOccurs="0"/>

element WakeUpDeviceRequest/DeviceServicePlanFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"/>

element WakeUpDeviceRequest/DeviceCustomFieldFilter
diagram
namespace http://nphase.com/unifiedwebservice/v2
type CustomFieldFilterObj
children Name Value
source
<xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded"/>

element WakeUpDeviceRequest/WakeUpMethod
diagram
namespace http://nphase.com/unifiedwebservice/v2
type restriction of xs:string
facets
enumeration IpWakeUp
enumeration SmsWakeUp
source
<xs:element name="WakeUpMethod">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="IpWakeUp"/>
      <xs:enumeration value="SmsWakeUp"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

element WakeUpDeviceResponse
diagram
namespace http://nphase.com/unifiedwebservice/v2
children RequestId
source
<xs:element name="WakeUpDeviceResponse">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="RequestId" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element WakeUpDeviceResponse/RequestId
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="RequestId" type="xs:string"/>

complexType RetrievedSmsMessage
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Device Message TimeStamp
used by
element GetSmsMessagesResponse/RetrievedSmsMessages
annotation
documentation 
Used to represent an SMS message sent by a single device, this element includes the message and the device identifier for originating device.
source
<xs:complexType name="RetrievedSmsMessage">
  <xs:annotation>
    <xs:documentation>Used to represent an SMS message sent by a single device, this element includes the message and the device identifier for originating device.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="Device" type="DeviceIdentifierCollection">
      <xs:annotation>
        <xs:documentation>The device which sent the SMS message.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Message" type="xs:string">
      <xs:annotation>
        <xs:documentation>The contents of the SMS message.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TimeStamp" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>The time that the message was received by the Verizon ThingSpace Platform.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

element RetrievedSmsMessage/Device
diagram
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifierCollection
children DeviceIdentifiers
annotation
documentation 
The device which sent the SMS message.
source
<xs:element name="Device" type="DeviceIdentifierCollection">
  <xs:annotation>
    <xs:documentation>The device which sent the SMS message.</xs:documentation>
  </xs:annotation>
</xs:element>

element RetrievedSmsMessage/Message
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
annotation
documentation 
The contents of the SMS message.
source
<xs:element name="Message" type="xs:string">
  <xs:annotation>
    <xs:documentation>The contents of the SMS message.</xs:documentation>
  </xs:annotation>
</xs:element>

element RetrievedSmsMessage/TimeStamp
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
annotation
documentation 
The time that the message was received by the Verizon ThingSpace Platform.
source
<xs:element name="TimeStamp" type="xs:dateTime">
  <xs:annotation>
    <xs:documentation>The time that the message was received by the Verizon ThingSpace Platform.</xs:documentation>
  </xs:annotation>
</xs:element>

complexType CustomFieldFilterObj
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Name Value
used by
elements RemotePrlUpdateRequest/DeviceCustomFieldFilter WakeUpDeviceRequest/DeviceCustomFieldFilter SendSmsMessageRequest/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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
source
<xs:element name="Month" type="xs:unsignedByte"/>

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

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

complexType DeviceIdentifier
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Kind Identifier
used by
elements DeviceIdentifierCollection/DeviceIdentifiers RemotePrlUpdateRequest/Devices WakeUpDeviceRequest/Devices SendSmsMessageRequest/Devices
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
namespace http://nphase.com/unifiedwebservice/v2
type restriction of xs:string
facets
enumeration Esn
enumeration Iccid
enumeration Imsi
enumeration Mdn
enumeration Meid
enumeration Imei
enumeration Msisdn
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
children DeviceIdentifiers
used by
element RetrievedSmsMessage/Device
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" maxOccurs="unbounded"/>
  </xs:sequence>
</xs:complexType>

element DeviceIdentifierCollection/DeviceIdentifiers
diagram
namespace http://nphase.com/unifiedwebservice/v2
type DeviceIdentifier
children Kind Identifier
source
<xs:element name="DeviceIdentifiers" type="DeviceIdentifier" nillable="true" maxOccurs="unbounded"/>

complexType ErrorInformation
diagram
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
children Key Value
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
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
namespace http://nphase.com/unifiedwebservice/v2
children Code Description
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="Code" type="xs:string" nillable="true"/>

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

complexType InclusiveDateTimeRange
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Earliest Latest
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
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
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
namespace http://nphase.com/unifiedwebservice/v2
type PrimaryPlaceOfUseCustomerName
children Title FirstName MiddleName LastName
source
<xs:element name="CustomerName" type="PrimaryPlaceOfUseCustomerName" nillable="true"/>

element PrimaryPlaceOfUse/Address
diagram
namespace http://nphase.com/unifiedwebservice/v2
type PrimaryPlaceOfUseAddress
children AddressLine1 AddressLine2 City State ZipCode Country
source
<xs:element name="Address" type="PrimaryPlaceOfUseAddress" nillable="true"/>

complexType PrimaryPlaceOfUseAddress
diagram
namespace http://nphase.com/unifiedwebservice/v2
children AddressLine1 AddressLine2 City State ZipCode Country
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:sequence>
</xs:complexType>

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

element PrimaryPlaceOfUseAddress/AddressLine2
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="AddressLine2" type="xs:string" nillable="true" minOccurs="0"/>

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

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

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

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

complexType PrimaryPlaceOfUseCustomerName
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Title FirstName MiddleName LastName
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:sequence>
</xs:complexType>

element PrimaryPlaceOfUseCustomerName/Title
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="Title" type="xs:string" nillable="true" minOccurs="0"/>

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

element PrimaryPlaceOfUseCustomerName/MiddleName
diagram
namespace http://nphase.com/unifiedwebservice/v2
type xs:string
source
<xs:element name="MiddleName" type="xs:string" nillable="true" minOccurs="0"/>

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

complexType Time
diagram
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:unsignedByte
source
<xs:element name="Hour" type="xs:unsignedByte"/>

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

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

complexType TimeRange
diagram
namespace http://nphase.com/unifiedwebservice/v2
children Start End
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
namespace http://nphase.com/unifiedwebservice/v2
type xs:dateTime
source
<xs:element name="Start" type="xs:dateTime"/>

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

complexType TimeRangePerDay
diagram
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
namespace http://nphase.com/unifiedwebservice/v2
type Time
children Hour Minute Second
source
<xs:element name="Start" type="Time"/>

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


XML Schema documentation generated with
XMLSPY Schema Editor http://www.altova.com/xmlspy