schema location: | C:\m2mmc\branches\4.7.0\win\unified-web-service\APIs\v2\Schema\CarrierService.xsd |
attributeFormDefault: | |
elementFormDefault: | qualified |
targetNamespace: | http://nphase.com/unifiedwebservice/v2 |
schema location: | C:\m2mmc\branches\4.7.0\win\unified-web-service\APIs\v2\Schema\Types\CarrierServiceTypes.xsd |
attributeFormDefault: | |
elementFormDefault: | qualified |
targetNamespace: | http://nphase.com/unifiedwebservice/v2 |
Complex types |
ActivateDeviceRequest |
ChangeDeviceIdentifierObj |
CustomField |
DeactivateDeviceRequest |
ReconnectDeviceRequest |
RestoreDeviceRequest |
SuspendDeviceRequest |
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 |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | Change4GOption Device ChangeDeviceIdentifierTo ServicePlan AssignNonGeoMDN MdnZipCode MdnNpaNxx | ||
annotation |
|
||
source | <xs:element name="Change4GDeviceIdentifierRequest"> <xs:annotation> <xs:documentation>Changes the identifier for a specified device, upgrade 3G to 4G and 4G to 3G.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="Change4GOption" type="xs:string"> <xs:annotation> <xs:documentation>This is request type. It accepts ChangeIMEI, ChangeICCID, ChangeIMEIANDICCID, ChangeMSISDN, 3GTo4G, 4GTo3G</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Device" type="DeviceIdentifierCollection"> <xs:annotation> <xs:documentation>The device that you want to change, specified using the device's ESN (decimal), MDN, MSISDN, IMEI, ICCID or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifierCollection" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN (decimal), IMEI, ICCID or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally set the ServicePlan while changing 4G identifier.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AssignNonGeoMDN" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to assign a non-Geo MDN. If this flag is true; MdnZipCode is mandatory and NPA-NXX is optional. If this flag is false; Npa-nxx is mandatory and MdnZipCode is optional.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ZIP code from which the MDN will be derived. Specify the zip code of the location where the line of service will primarily be used. If you do not specify a zip code, the ThingSpace Platform will assign the zip code associated with the service plan for the device.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The NAP NXX from which the MDN will be derived. Specify the 6-digit NPA NXX of the location where the line of service will primarily be used. This ThingSpace Platform checks to see if a number starting with the NPA NXX is available. If not, it uses the MdnZipCode element, if specified, to assign a number in the area of the line of service.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="Change4GOption" type="xs:string"> <xs:annotation> <xs:documentation>This is request type. It accepts ChangeIMEI, ChangeICCID, ChangeIMEIANDICCID, ChangeMSISDN, 3GTo4G, 4GTo3G</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | DeviceIdentifierCollection | ||
properties |
|
||
children | DeviceIdentifiers | ||
annotation |
|
||
source | <xs:element name="Device" type="DeviceIdentifierCollection"> <xs:annotation> <xs:documentation>The device that you want to change, specified using the device's ESN (decimal), MDN, MSISDN, IMEI, ICCID or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifierCollection" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN (decimal), IMEI, ICCID or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally set the ServicePlan while changing 4G identifier.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:boolean | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="AssignNonGeoMDN" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to assign a non-Geo MDN. If this flag is true; MdnZipCode is mandatory and NPA-NXX is optional. If this flag is false; Npa-nxx is mandatory and MdnZipCode is optional.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ZIP code from which the MDN will be derived. Specify the zip code of the location where the line of service will primarily be used. If you do not specify a zip code, the ThingSpace Platform will assign the zip code associated with the service plan for the device.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The NAP NXX from which the MDN will be derived. Specify the 6-digit NPA NXX of the location where the line of service will primarily be used. This ThingSpace Platform checks to see if a number starting with the NPA NXX is available. If not, it uses the MdnZipCode element, if specified, to assign a number in the area of the line of service.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="Change4GDeviceIdentifierResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the ThingSpace Platform returns an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous result. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous result. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList AccountName PrimaryPlaceOfUse | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceContactInfoRequest"> <xs:annotation> <xs:documentation> Updates the Primary Place of Use information for one or more devices, including the customer name, address, phone, and email address. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> A list of the devices for which you want to change the contact information, specified by device identifier. You only need to provide one identifier per device. NOTE: You can use GetDeviceList to get a list of all devices in the account. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation> The name of a billing account. This parameter is only required if the UWS account used for the current API session has access to multiple billing accounts. An account name is usually numeric, and must include any leading zeroes. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The name, address, phone number, and email address of the owner of the device. This information may be used to notify the owner of account and service changes. NOTE: The Primary Place of Use location may affect taxation or have other legal implications. You may want to speak with legal and/or financial advisers before entering values for these fields. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> A list of the devices for which you want to change the contact information, specified by device identifier. You only need to provide one identifier per device. NOTE: You can use GetDeviceList to get a list of all devices in the account. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation> The name of a billing account. This parameter is only required if the UWS account used for the current API session has access to multiple billing accounts. An account name is usually numeric, and must include any leading zeroes. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | PrimaryPlaceOfUse | ||||||||
properties |
|
||||||||
children | CustomerName Address | ||||||||
annotation |
|
||||||||
source | <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The name, address, phone number, and email address of the owner of the device. This information may be used to notify the owner of account and service changes. NOTE: The Primary Place of Use location may affect taxation or have other legal implications. You may want to speak with legal and/or financial advisers before entering values for these fields. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceContactInfoResponse"> <xs:annotation> <xs:documentation> The ThingSpace Platform will send a separate callback message for each device that matched the request criteria, indicating whether the operation succeeded for that device and containing any requested information. All of the callback messages will have the same RequestId. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation> A unique string 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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation> A unique string that associates the request with the results that are sent via a callback service. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter CostCenterCode RemoveCostCenterCode PrimaryPlaceOfUse | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceCostCenterRequest"> <xs:annotation> <xs:documentation>Changes the cost center and/or primary place of use info for a list of one or more devices, or for all devices in a device group.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</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 if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. </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 only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="CostCenterCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify Cost Center Code.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="RemoveCostCenterCode" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to remove the Cost Center Code. If this flag is true and a cost center code is provided; this flag takes precedence, the cost center code will still be removed. If this flag is false or not specified, Cost Center Code will be updated.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The name, address, phone number, and email address of the owner of the device. This information may be used to notify the owner of account and service changes. NOTE: The Primary Place of Use location may affect taxation or have other legal implications. You may want to speak with legal and/or financial advisers before entering values for these fields. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a device group if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a service plan, if you only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="CostCenterCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify Cost Center Code.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:boolean | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="RemoveCostCenterCode" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to remove the Cost Center Code. If this flag is true and a cost center code is provided; this flag takes precedence, the cost center code will still be removed. If this flag is false or not specified, Cost Center Code will be updated.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | PrimaryPlaceOfUse | ||||||||
properties |
|
||||||||
children | CustomerName Address | ||||||||
annotation |
|
||||||||
source | <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The name, address, phone number, and email address of the owner of the device. This information may be used to notify the owner of account and service changes. NOTE: The Primary Place of Use location may affect taxation or have other legal implications. You may want to speak with legal and/or financial advisers before entering values for these fields. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceCostCenterResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API response returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the system generates an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter CustomFields | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceCustomFieldsRequest"> <xs:annotation> <xs:documentation>Changes the custom fields for one or more devices.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</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 if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts.</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 only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values for the custom fields. 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:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a device group if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a service plan, if you only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"/> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values for the custom fields. 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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceCustomFieldsResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API returns a unique Request ID that associates the API request with the asynchronous callback response. If the request is not successfully sent to the carrier, the ThingSpace Platform generates an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID that associates the API request with the asynchronous callback response.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID that associates the API request with the asynchronous callback response.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | Device ChangeDeviceIdentifierTo AssignNonGeoMDN MdnZipCode MdnNpaNxx ServicePlan | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceIdentifierRequest"> <xs:annotation> <xs:documentation>Changes the identifier for a specified device, and optionally changes the zip code and the NPA NXX associated with the device.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="Device" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The device that you want to change, specified using the device's ESN (decimal), MDN, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifier" minOccurs="0"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN (decimal) or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AssignNonGeoMDN" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to assign a non-Geo MDN. If this flag is true; MdnZipCode is mandatory and NPA-NXX is optional. If this flag is false; Npa-nxx is mandatory and MdnZipCode is optional.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ZIP code from which the MDN will be derived. Specify the zip code of the location where the line of service will primarily be used. If you do not specify a zip code, the ThingSpace Platform will assign the zip code associated with the service plan for the device.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The NAP NXX from which the MDN will be derived. Specify the 6-digit NPA NXX of the location where the line of service will primarily be used. This ThingSpace Platform checks to see if a number starting with the NPA NXX is available. If not, it uses the MdnZipCode element, if specified, to assign a number in the area of the line of service.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally set the ServicePlan while changing 3G identifier.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | DeviceIdentifier | ||
properties |
|
||
children | Kind Identifier | ||
annotation |
|
||
source | <xs:element name="Device" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The device that you want to change, specified using the device's ESN (decimal), MDN, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | DeviceIdentifier | ||||||
properties |
|
||||||
children | Kind Identifier | ||||||
annotation |
|
||||||
source | <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifier" minOccurs="0"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN (decimal) or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:boolean | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="AssignNonGeoMDN" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Set to true to assign a non-Geo MDN. If this flag is true; MdnZipCode is mandatory and NPA-NXX is optional. If this flag is false; Npa-nxx is mandatory and MdnZipCode is optional.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ZIP code from which the MDN will be derived. Specify the zip code of the location where the line of service will primarily be used. If you do not specify a zip code, the ThingSpace Platform will assign the zip code associated with the service plan for the device.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The NAP NXX from which the MDN will be derived. Specify the 6-digit NPA NXX of the location where the line of service will primarily be used. This ThingSpace Platform checks to see if a number starting with the NPA NXX is available. If not, it uses the MdnZipCode element, if specified, to assign a number in the area of the line of service.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally set the ServicePlan while changing 3G identifier.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceIdentifierResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the ThingSpace Platform returns an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous result. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous result. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter ServicePlan FeatureCodesToAdd FeatureCodesToRemove TakeEffect | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceServicePlanRequest"> <xs:annotation> <xs:documentation>Changes the service plan for a list of one or more devices, or for all devices in a device group. You can sue GetServicePlanList to find a list of valid service plan codes for the account.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a current service plan to only change the service plan of those devices. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="ServicePlan" type="xs:string"> <xs:annotation> <xs:documentation>The service plan code that you want to assign to all specified devices. Set this parameter to one of the Code values returned by GetServicePlanList in the Account Service. Verizon Wireless provides service plan codes at the time of on-boarding and subsequently whenever there are any changes to the service plan.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="FeatureCodesToAdd" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A space-separated list of ThingSpace Platform feature codes to add to the specified devices. The Verizon Wholesale network supports ThingSpace Platform feature codes. Other networks do not support ThingSpace Platform feature codes. (The Verizon Retail network supports feature codes, but those feature codes are not operational with the ThingSpace Platform.)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="FeatureCodesToRemove" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A space-separated list of ThingSpace Platform feature codes to remove from the specified devices. The Verizon Wholesale network supports ThingSpace Platform feature codes. Other networks do not support ThingSpace Platform feature codes. (The Verizon Retail network supports feature codes, but those feature codes are not operational with the ThingSpace Platform.)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="TakeEffect" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The effective date of the service plan change Leave empty to make the service plan change effective today. The next bill will show a credit for a portion of the monthly charge for the old plan, calculated from today until the end of the billing cycle, plus next month's full charge on the new plan, if we bill you in advance. Set to "BackDate" (without the quotes) to make the service plan change effective at the beginning of the current billing cycle (or at the activation date for devices that were added after the current billing cycle start date). Recommended if you anticipate devices using more than the monthly allowance of the current plan and you are changing to a plan with a higher monthly allowance to avoid overage charges. Note that you cannot backdate to a service plan with a lower monthly allowance. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account if you want to change all devices in that account. This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a current service plan to only change the service plan of those devices. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="ServicePlan" type="xs:string"> <xs:annotation> <xs:documentation>The service plan code that you want to assign to all specified devices. Set this parameter to one of the Code values returned by GetServicePlanList in the Account Service. Verizon Wireless provides service plan codes at the time of on-boarding and subsequently whenever there are any changes to the service plan.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="FeatureCodesToAdd" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A space-separated list of ThingSpace Platform feature codes to add to the specified devices. The Verizon Wholesale network supports ThingSpace Platform feature codes. Other networks do not support ThingSpace Platform feature codes. (The Verizon Retail network supports feature codes, but those feature codes are not operational with the ThingSpace Platform.)</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="FeatureCodesToRemove" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A space-separated list of ThingSpace Platform feature codes to remove from the specified devices. The Verizon Wholesale network supports ThingSpace Platform feature codes. Other networks do not support ThingSpace Platform feature codes. (The Verizon Retail network supports feature codes, but those feature codes are not operational with the ThingSpace Platform.)</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="TakeEffect" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation> The effective date of the service plan change Leave empty to make the service plan change effective today. The next bill will show a credit for a portion of the monthly charge for the old plan, calculated from today until the end of the billing cycle, plus next month's full charge on the new plan, if we bill you in advance. Set to "BackDate" (without the quotes) to make the service plan change effective at the beginning of the current billing cycle (or at the activation date for devices that were added after the current billing cycle start date). Recommended if you anticipate devices using more than the monthly allowance of the current plan and you are changing to a plan with a higher monthly allowance to avoid overage charges. Note that you cannot backdate to a service plan with a lower monthly allowance. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceServicePlanResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API response returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the system generates an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList DeviceGroupName AccountName DeviceServicePlanFilter DeviceCustomFieldFilter Activate Deactivate Reconnect Restore Suspend | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceStateRequest"> <xs:annotation> <xs:documentation>Activates, deactivates, suspends, or restores the lines of service for one or more devices. This request must include exactly one of the state elements: Activate, Deactivate, Restore, or Suspend. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal). 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 if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account, which can serve one of three purposes: 1) Indicates that you want to change all devices in that account. Do not also pass DeviceList, DeviceGroupName, or any of the filters. 2) This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. 3) This pararmeter is required if this is a pre-provisioning request (the devices have not previously been added to the account). In this case, you must also include the DeviceList parameter to identify the devices.</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 to only change the device state for devices that have that service plan.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Activate" type="ActivateDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Activate the specified devices.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Deactivate" type="DeactivateDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Deactivate the specified devices.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Reconnect" type="ReconnectDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Reconnect the specified devices. Reconnect is only applicable to the Verizon Wholesale network.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Restore" type="RestoreDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Restore the specified devices from the suspend state.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Suspend" type="SuspendDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Suspend the specified devices. When suspended, a device continues to be billed in accordance with the service plan associated with that device. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal). Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a device group if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountName" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of an account, which can serve one of three purposes: 1) Indicates that you want to change all devices in that account. Do not also pass DeviceList, DeviceGroupName, or any of the filters. 2) This parameter is required if you are passing DeviceGroupName and you have access to multiple accounts, since a device group name can exist in multiple accounts. 3) This pararmeter is required if this is a pre-provisioning request (the devices have not previously been added to the account). In this case, you must also include the DeviceList parameter to identify the devices.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a service plan to only change the device state for devices that have that service plan.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | ActivateDeviceRequest | ||||||||
properties |
|
||||||||
children | CarrierName CarrierIpPoolName ServicePlan FeatureCodesToAdd FeatureCodesToRemove EffectiveDate MdnZipCode MdnNpaNxx CustomFields State DeviceGroupNames LeadId PublicIPRestriction PrimaryPlaceOfUse SkuNumber CostCenterCode | ||||||||
annotation |
|
||||||||
source | <xs:element name="Activate" type="ActivateDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Activate the specified devices.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeactivateDeviceRequest | ||||||||
properties |
|
||||||||
children | EffectiveDate ReasonCode EtfWaiver | ||||||||
annotation |
|
||||||||
source | <xs:element name="Deactivate" type="DeactivateDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Deactivate the specified devices.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | ReconnectDeviceRequest | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="Reconnect" type="ReconnectDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Reconnect the specified devices. Reconnect is only applicable to the Verizon Wholesale network.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | RestoreDeviceRequest | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="Restore" type="RestoreDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Restore the specified devices from the suspend state.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | SuspendDeviceRequest | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="Suspend" type="SuspendDeviceRequest" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Suspend the specified devices. When suspended, a device continues to be billed in accordance with the service plan associated with that device. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceStateResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API response returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the system generates an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback response.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback response.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | DeviceList DeviceGroupNameFilter AccountName AccountNameFilter DeviceServicePlanFilter DeviceCustomFieldFilter ServicePlan CarrierIpPoolName DeviceGroupName CustomFields | ||
annotation |
|
||
source | <xs:element name="MoveDeviceRequest"> <xs:annotation> <xs:documentation>Changes the cost center and/or primary place of use info for a list of one or more devices, or for all devices in a device group.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceGroupNameFilter" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a device group if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountName" type="xs:string"> <xs:annotation> <xs:documentation>The name of the account that you want to move the selected devices to.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="AccountNameFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of the account, if you want to move all devices in the selected account. This field is required when specifying DeviceServicePlanFilter or DeviceCustomFieldFilter.</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 only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally specify a new price plan when moving devices. New rate plan must map to the account to move the devices to.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="CarrierIpPoolName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The pool from which your device IP addresses will be derived. New carrier IP pool must map to the account to move the devices to.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Assigns the devices to the specified device group. Devices can only be assigned to one device group. The devices are only assigned to the device group if the move is successful.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values for up to 5 custom fields. The valid names for the custom fields are "CustomField1", "CustomField2", "CustomField3", "CustomField4", and "CustomField5".</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifierCollection | ||||||||
properties |
|
||||||||
children | DeviceIdentifiers | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceList" type="DeviceIdentifierCollection" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of one or more devices that you want to change. Do not pass DeviceGroupName, AccountName, or any of the filters if you use this parameter. Specify each device using the device's ESN (decimal), MDN, ICCID (up to 20 digits), IMEI (up to 15 digits), IMSI, MSISDN, or MEID (hexadecimal).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupNameFilter" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a device group if you want to change all devices in that group.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="AccountName" type="xs:string"> <xs:annotation> <xs:documentation>The name of the account that you want to move the selected devices to.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="AccountNameFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of the account, if you want to move all devices in the selected account. This field is required when specifying DeviceServicePlanFilter or DeviceCustomFieldFilter.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>The name of a service plan, if you only want to change devices in that service plan.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to change the device state for devices matching these custom fields.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="ServicePlan" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Optionally specify a new price plan when moving devices. New rate plan must map to the account to move the devices to.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="CarrierIpPoolName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The pool from which your device IP addresses will be derived. New carrier IP pool must map to the account to move the devices to.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Assigns the devices to the specified device group. Devices can only be assigned to one device group. The devices are only assigned to the device group if the move is successful.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values for up to 5 custom fields. The valid names for the custom fields are "CustomField1", "CustomField2", "CustomField3", "CustomField4", and "CustomField5".</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
properties |
|
||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="MoveDeviceResponse"> <xs:annotation> <xs:documentation>If the request is successfully sent to the carrier, this API response returns a Request ID that can be matched with the callback response. If the request is not successfully sent to the carrier, the system generates an exception which includes a message that indicates the reason for the failure.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="RequestId" type="xs:string"> <xs:annotation> <xs:documentation>A unique Request ID which associates the API request with the asynchronous callback result.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | CarrierName CarrierIpPoolName ServicePlan FeatureCodesToAdd FeatureCodesToRemove EffectiveDate MdnZipCode MdnNpaNxx CustomFields State DeviceGroupNames LeadId PublicIPRestriction PrimaryPlaceOfUse SkuNumber CostCenterCode | ||
used by |
|
||
source | <xs:complexType name="ActivateDeviceRequest"> <xs:sequence> <xs:element name="CarrierName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The carrier that will perform the activation. If you have only one carrier and are preprovisioning devices, you do not need to specify this element; your carrier will be used by default.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="CarrierIpPoolName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The pool from which your device IP addresses will be derived. If this element is not specified, the default pool will be used.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ServicePlan" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Sets the service plan code that will be assigned to all specified devices. You must specify a service plan when you activate devices. You can use GetServicePlanList in the Account Service to find a list of valid service plan codes. Verizon Wireless provides service plan codes at the time of on-boarding and subsequently whenever there are any changes to the service plan. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="FeatureCodesToAdd" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The features to add to the device, as well as the service plan features. Feature codes are only supported for devices on the Verizon Wholesale network. Customers of the Verizon Retail network may have feature codes available to them, but those feature codes are not operational with the ThingSpace Platform.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="FeatureCodesToRemove" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The feature codes to remove when a device is activated. Feature codes are only supported for devices on the Verizon Wholesale network. Customers of the Verizon Retail network may have feature codes available, but those feature codes are not operational with the ThingSpace Platform.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="EffectiveDate" type="xs:dateTime" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>This element is not used.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The zip code that will be used to derive the MDN. Specify the zip code of the location where the line of service will primarily be used. For devices on the Verizon network, you must specify a zip code. For devices on the Vodafone network, the zip code is optional, and if you do not specify a zip code, the system uses the zip code associated with the service plan specified by the ServicePlan element.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The 6-digit NPA NXX that will be used to derive the MDN. Only applicable to customers using the Verizon Wholesale network.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="5"> <xs:annotation> <xs:documentation>The names and values for up to 5 custom fields. The valid names for the custom fields are "CustomField1", "CustomField2", "CustomField3", "CustomField4", and "CustomField5".</xs:documentation> </xs:annotation> </xs:element> <xs:element name="State" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The activation state: “Active”, “Active.Ready”, or “Active.Test”. The default is “Active”. The states “Active.Ready” and “Active.Test” are only valid on the Vodafone network. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="DeviceGroupNames" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Assigns the devices to the specified device group. Devices can only be assigned to one device group. The devices are only assigned to the device group if the activation is successful.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="LeadId" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ID of a VPP customer lead, which is used with other values to determine MDN Assignment, taxation and compensation</xs:documentation> </xs:annotation> </xs:element> <xs:element name="PublicIPRestriction" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specifies whether the device has general access to the Internet. Valid values are “restricted” or “unrestricted”.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify PrimaryPlaceOfUse CustomerName, Address and Zip code for Taxation.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="SkuNumber" type="xs:string" nillable="true" minOccurs="0"> <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:element name="CostCenterCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify Cost Center Code.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="CarrierName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The carrier that will perform the activation. If you have only one carrier and are preprovisioning devices, you do not need to specify this element; your carrier will be used by default.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="CarrierIpPoolName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The pool from which your device IP addresses will be derived. If this element is not specified, the default pool will be used.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="ServicePlan" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Sets the service plan code that will be assigned to all specified devices. You must specify a service plan when you activate devices. You can use GetServicePlanList in the Account Service to find a list of valid service plan codes. Verizon Wireless provides service plan codes at the time of on-boarding and subsequently whenever there are any changes to the service plan. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="FeatureCodesToAdd" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The features to add to the device, as well as the service plan features. Feature codes are only supported for devices on the Verizon Wholesale network. Customers of the Verizon Retail network may have feature codes available to them, but those feature codes are not operational with the ThingSpace Platform.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="FeatureCodesToRemove" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The feature codes to remove when a device is activated. Feature codes are only supported for devices on the Verizon Wholesale network. Customers of the Verizon Retail network may have feature codes available, but those feature codes are not operational with the ThingSpace Platform.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:dateTime | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="EffectiveDate" type="xs:dateTime" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>This element is not used.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnZipCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The zip code that will be used to derive the MDN. Specify the zip code of the location where the line of service will primarily be used. For devices on the Verizon network, you must specify a zip code. For devices on the Vodafone network, the zip code is optional, and if you do not specify a zip code, the system uses the zip code associated with the service plan specified by the ServicePlan element.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="MdnNpaNxx" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The 6-digit NPA NXX that will be used to derive the MDN. Only applicable to customers using the Verizon Wholesale network.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | CustomField | ||||||||
properties |
|
||||||||
children | Name Value | ||||||||
annotation |
|
||||||||
source | <xs:element name="CustomFields" type="CustomField" nillable="true" minOccurs="0" maxOccurs="5"> <xs:annotation> <xs:documentation>The names and values for up to 5 custom fields. The valid names for the custom fields are "CustomField1", "CustomField2", "CustomField3", "CustomField4", and "CustomField5".</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="State" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The activation state: “Active”, “Active.Ready”, or “Active.Test”. The default is “Active”. The states “Active.Ready” and “Active.Test” are only valid on the Vodafone network. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="DeviceGroupNames" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Assigns the devices to the specified device group. Devices can only be assigned to one device group. The devices are only assigned to the device group if the activation is successful.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="LeadId" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The ID of a VPP customer lead, which is used with other values to determine MDN Assignment, taxation and compensation</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="PublicIPRestriction" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specifies whether the device has general access to the Internet. Valid values are “restricted” or “unrestricted”.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | PrimaryPlaceOfUse | ||||||||
properties |
|
||||||||
children | CustomerName Address | ||||||||
annotation |
|
||||||||
source | <xs:element name="PrimaryPlaceOfUse" type="PrimaryPlaceOfUse" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify PrimaryPlaceOfUse CustomerName, Address and Zip code for Taxation.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="SkuNumber" type="xs:string" nillable="true" minOccurs="0"> <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> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="CostCenterCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Specify Cost Center Code.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
children | Device ChangeDeviceIdentifierTo |
source | <xs:complexType name="ChangeDeviceIdentifierObj"> <xs:sequence> <xs:element name="Device" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The current identifier for the device, using the device's ESN or MEID.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN or MEID.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | DeviceIdentifier | ||
properties |
|
||
children | Kind Identifier | ||
annotation |
|
||
source | <xs:element name="Device" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The current identifier for the device, using the device's ESN or MEID.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | DeviceIdentifier | ||
properties |
|
||
children | Kind Identifier | ||
annotation |
|
||
source | <xs:element name="ChangeDeviceIdentifierTo" type="DeviceIdentifier"> <xs:annotation> <xs:documentation>The new identifier for the device. Specify the new identifier using the ESN or MEID.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
children | Name Value |
used by | |
source | <xs:complexType name="CustomField"> <xs:sequence> <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The custom field name.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Value" type="xs:string"> <xs:annotation> <xs:documentation>The value for the custom field. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The custom field name.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xs:element name="Value" type="xs:string"> <xs:annotation> <xs:documentation>The value for the custom field. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | EffectiveDate ReasonCode EtfWaiver | ||
used by |
|
||
source | <xs:complexType name="DeactivateDeviceRequest"> <xs:sequence> <xs:element name="EffectiveDate" type="xs:dateTime" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>This element is not operational.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ReasonCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>A reason code for the deactivation.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="EtfWaiver" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Waives the Early Termination Fee (ETF), if applicable. Any ETF that is specified in the contract with the carrier is applied when devices are deactivated, unless that ETF is waived. When EtfWaiver is set to true, the ETF will be waived. When EtfWaiver is set to false, the ETF will not be waived via this mechanism. If you use a business process where you deactivate devices and then apply ETF waivers through some other mechanism, you may continue to follow that process, and simply set EtfWaiver to false. This element is required when deactivating devices on the Verizon network.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:dateTime | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="EffectiveDate" type="xs:dateTime" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>This element is not operational.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="ReasonCode" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>A reason code for the deactivation.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:boolean | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xs:element name="EtfWaiver" type="xs:boolean" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Waives the Early Termination Fee (ETF), if applicable. Any ETF that is specified in the contract with the carrier is applied when devices are deactivated, unless that ETF is waived. When EtfWaiver is set to true, the ETF will be waived. When EtfWaiver is set to false, the ETF will not be waived via this mechanism. If you use a business process where you deactivate devices and then apply ETF waivers through some other mechanism, you may continue to follow that process, and simply set EtfWaiver to false. This element is required when deactivating devices on the Verizon network.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
used by |
|
||
source | <xs:complexType name="ReconnectDeviceRequest"> <xs:sequence/> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
used by |
|
||
source | <xs:complexType name="RestoreDeviceRequest"> <xs:sequence/> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
used by |
|
||
source | <xs:complexType name="SuspendDeviceRequest"> <xs:sequence/> </xs:complexType> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
children | Name Value |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
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> |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedByte | ||
properties |
|
||
source | <xs:element name="Month" type="xs:unsignedByte"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedByte | ||
properties |
|
||
source | <xs:element name="Day" type="xs:unsignedByte"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedShort | ||
properties |
|
||
source | <xs:element name="Year" type="xs:unsignedShort"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
children | Kind Identifier |
used by | |
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> |
diagram | |||||||||||||||||||||||||||||||||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||||||||||||||||||||||||||||||||
type | restriction of xs:string | ||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||
facets |
|
||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | DeviceIdentifiers | ||
used by | |||
annotation |
|
||
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> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | DeviceIdentifier | ||||||||
properties |
|
||||||||
children | Kind Identifier | ||||||||
source | <xs:element name="DeviceIdentifiers" type="DeviceIdentifier" nillable="true" minOccurs="1" maxOccurs="unbounded"/> |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
properties |
|
||
annotation |
|
||
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> |
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> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
annotation |
|
||||
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> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
annotation |
|
||||
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> |
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> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="Code" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="Description" type="xs:string" nillable="true"/> |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:dateTime | ||
properties |
|
||
annotation |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:dateTime | ||
properties |
|
||
annotation |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | CustomerName Address | ||
used by |
|
||
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> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | PrimaryPlaceOfUseCustomerName | ||||
properties |
|
||||
children | Title FirstName MiddleName LastName Suffix | ||||
source | <xs:element name="CustomerName" type="PrimaryPlaceOfUseCustomerName" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | PrimaryPlaceOfUseAddress | ||||
properties |
|
||||
children | AddressLine1 AddressLine2 City State ZipCode Country ZipCode4 CBRPhone CBRPhoneType EmailAddress | ||||
source | <xs:element name="Address" type="PrimaryPlaceOfUseAddress" nillable="true"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | AddressLine1 AddressLine2 City State ZipCode Country ZipCode4 CBRPhone CBRPhoneType EmailAddress | ||
used by |
|
||
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> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="AddressLine1" type="xs:string" nillable="true"/> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
source | <xs:element name="AddressLine2" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="City" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="State" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="ZipCode" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="Country" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="ZipCode4" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="CBRPhone" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="CBRPhoneType" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="EmailAddress" type="xs:string" nillable="true"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Title FirstName MiddleName LastName Suffix | ||
used by |
|
||
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> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
source | <xs:element name="Title" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="FirstName" type="xs:string" nillable="true"/> |
diagram | |||||||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||||||
type | xs:string | ||||||||
properties |
|
||||||||
source | <xs:element name="MiddleName" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="LastName" type="xs:string" nillable="true"/> |
diagram | |||||
namespace | http://nphase.com/unifiedwebservice/v2 | ||||
type | xs:string | ||||
properties |
|
||||
source | <xs:element name="Suffix" type="xs:string" nillable="true"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Hour Minute Second | ||
used by |
|
||
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedByte | ||
properties |
|
||
source | <xs:element name="Hour" type="xs:unsignedByte"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedByte | ||
properties |
|
||
source | <xs:element name="Minute" type="xs:unsignedByte"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:unsignedByte | ||
properties |
|
||
source | <xs:element name="Second" type="xs:unsignedByte"/> |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:dateTime | ||
properties |
|
||
source | <xs:element name="Start" type="xs:dateTime"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:dateTime | ||
properties |
|
||
source | <xs:element name="End" type="xs:dateTime"/> |
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> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | Time | ||
properties |
|
||
children | Hour Minute Second | ||
source | <xs:element name="Start" type="Time"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | Time | ||
properties |
|
||
children | Hour Minute Second | ||
source | <xs:element name="End" type="Time"/> |