schema location: | C:\Working\SVN\m2mmc\branches\4.4.6\win\unified-web-service\APIs\v2\Schema\StateService.xsd |
targetNamespace: | http://nphase.com/unifiedwebservice/v2 |
Elements |
GetStateAndServicesListRequest |
GetStateAndServicesListResponse |
GoToStateRequest |
GoToStateResponse |
schema location: | C:\Working\SVN\m2mmc\branches\4.4.6\win\unified-web-service\APIs\v2\Schema\Types/StateServiceTypes.xsd |
targetNamespace: | http://nphase.com/unifiedwebservice/v2 |
Complex types |
EngagementInfo |
RatingGroupInfo |
ServiceInfo |
StateInfo |
schema location: | C:\Working\SVN\m2mmc\branches\4.4.6\win\unified-web-service\APIs\v2\Schema\Types/Common/CommonTypes.xsd |
targetNamespace: | http://nphase.com/unifiedwebservice/v2 |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Account | ||
annotation |
|
||
source | <xs:element name="GetStateAndServicesListRequest"> <xs:annotation> <xs:documentation>Retrieves a list of the States and Services associated with the specified account.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="Account" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of the account for which a list of Stage States is requested.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Account" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The name of the account for which a list of Stage States is requested.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Engagement | ||
annotation |
|
||
source | <xs:element name="GetStateAndServicesListResponse"> <xs:annotation> <xs:documentation>Returns a list of the Stage States associated with the specified account.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="Engagement" type="EngagementInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The list of Engagements associaed with the account.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | EngagementInfo | ||
children | Id ChargingGroup Services | ||
annotation |
|
||
source | <xs:element name="Engagement" type="EngagementInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The list of Engagements associaed with the account.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | DeviceList AccountNameFilter DeviceGroupNameFilter DeviceServicePlanFilter DeviceCustomFieldFilter ServiceName StateName ServicePlan CarrierIpPoolName MdnZipCode CustomFields DeviceGroupNames PublicIPRestriction SkuNumber | ||
annotation |
|
||
source | <xs:element name="GoToStateRequest"> <xs:annotation> <xs:documentation>Pushes a list of one or more devices to a specified state.</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="AccountNameFilter" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Indicates that you want to change all devices in that account. Do not also pass DeviceList, DeviceGroupName, or any of the other filters.</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="DeviceServicePlanFilter" type="xs:string" nillable="true" 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="CustomFieldFilterObj" 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="ServiceName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The service to push the device to.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="StateName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The stage state to push the device to.</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="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="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="CustomFields" type="CustomFieldFilterObj" 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="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 GoToState is successful.</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="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:sequence> </xs:complexType> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | DeviceIdentifierCollection | ||
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 | ||
annotation |
|
||
source | <xs:element name="AccountNameFilter" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>Indicates that you want to change all devices in that account. Do not also pass DeviceList, DeviceGroupName, or any of the other filters.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
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 | ||
annotation |
|
||
source | <xs:element name="DeviceServicePlanFilter" type="xs:string" nillable="true" 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 | CustomFieldFilterObj | ||
children | Name Value | ||
annotation |
|
||
source | <xs:element name="DeviceCustomFieldFilter" type="CustomFieldFilterObj" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The names and values of custom fields, if you only want to 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 | ||
annotation |
|
||
source | <xs:element name="ServiceName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The service to push the device to.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="StateName" type="xs:string" nillable="true" minOccurs="0"> <xs:annotation> <xs:documentation>The stage state to push the device to.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
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 | ||
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 | ||
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 | CustomFieldFilterObj | ||
children | Name Value | ||
annotation |
|
||
source | <xs:element name="CustomFields" type="CustomFieldFilterObj" 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 | ||
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 GoToState is successful.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
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 | xs:string | ||
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 | ||
children | RequestId | ||
annotation |
|
||
source | <xs:element name="GoToStateResponse"> <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 | ||
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 | ||
children | Id ChargingGroup Services | ||
used by |
|
||
source | <xs:complexType name="EngagementInfo"> <xs:sequence> <xs:element name="Id" type="xs:string"> <xs:annotation> <xs:documentation>The Engagement Id</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ChargingGroup" type="xs:string"> <xs:annotation> <xs:documentation>The Charging Group Name. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="Services" type="ServiceInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The list of Stage States associated with the account.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Id" type="xs:string"> <xs:annotation> <xs:documentation>The Engagement Id</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="ChargingGroup" type="xs:string"> <xs:annotation> <xs:documentation>The Charging Group Name. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | ServiceInfo | ||
children | Name Description States RatingGroup ExtendedAttributes | ||
annotation |
|
||
source | <xs:element name="Services" type="ServiceInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The list of Stage States associated with the account.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Code RatingGroupMinValue RatingGroupMaxValue | ||
used by |
|
||
source | <xs:complexType name="RatingGroupInfo"> <xs:sequence> <xs:element name="Code" type="xs:string"> <xs:annotation> <xs:documentation>The rating group code</xs:documentation> </xs:annotation> </xs:element> <xs:element name="RatingGroupMinValue" type="xs:string"> <xs:annotation> <xs:documentation>The min value of Rating Group </xs:documentation> </xs:annotation> </xs:element> <xs:element name="RatingGroupMaxValue" type="xs:string"> <xs:annotation> <xs:documentation>The max value of Rating Group </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Code" type="xs:string"> <xs:annotation> <xs:documentation>The rating group code</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="RatingGroupMinValue" type="xs:string"> <xs:annotation> <xs:documentation>The min value of Rating Group </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="RatingGroupMaxValue" type="xs:string"> <xs:annotation> <xs:documentation>The max value of Rating Group </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Name Description States RatingGroup ExtendedAttributes | ||
used by |
|
||
source | <xs:complexType name="ServiceInfo"> <xs:sequence> <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The Name of Service</xs:documentation> </xs:annotation> </xs:element> <xs:element name="Description" type="xs:string"> <xs:annotation> <xs:documentation>The Description of Service</xs:documentation> </xs:annotation> </xs:element> <xs:element name="States" type="StateInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of States for the specific Service </xs:documentation> </xs:annotation> </xs:element> <xs:element name="RatingGroup" type="RatingGroupInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of rating groups for the specific Service </xs:documentation> </xs:annotation> </xs:element> <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The extended attributes that describe the connection event.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The Name of Service</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Description" type="xs:string"> <xs:annotation> <xs:documentation>The Description of Service</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | StateInfo | ||
children | Name WorkflowSequenceNumber ServicePlan ExtendedAttributes | ||
annotation |
|
||
source | <xs:element name="States" type="StateInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of States for the specific Service </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | RatingGroupInfo | ||
children | Code RatingGroupMinValue RatingGroupMaxValue | ||
annotation |
|
||
source | <xs:element name="RatingGroup" type="RatingGroupInfo" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of rating groups for the specific Service </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | ExtendedAttributesObj | ||
children | Key Value | ||
annotation |
|
||
source | <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The extended attributes that describe the connection event.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Name WorkflowSequenceNumber ServicePlan ExtendedAttributes | ||
used by |
|
||
source | <xs:complexType name="StateInfo"> <xs:sequence> <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The Name of State</xs:documentation> </xs:annotation> </xs:element> <xs:element name="WorkflowSequenceNumber" type="xs:int"> <xs:annotation> <xs:documentation>The Charging Group Name. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="ServicePlan" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of serviceplan for specific State.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The extended attributes that describe the connection event.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="Name" type="xs:string"> <xs:annotation> <xs:documentation>The Name of State</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:int | ||
annotation |
|
||
source | <xs:element name="WorkflowSequenceNumber" type="xs:int"> <xs:annotation> <xs:documentation>The Charging Group Name. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | xs:string | ||
annotation |
|
||
source | <xs:element name="ServicePlan" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The List of serviceplan for specific State.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
type | ExtendedAttributesObj | ||
children | Key Value | ||
annotation |
|
||
source | <xs:element name="ExtendedAttributes" type="ExtendedAttributesObj" nillable="true" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The extended attributes that describe the connection event.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Name Value | ||
used by |
|
||
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 | ||
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 | ||
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 |
source | <xs:element name="Month" type="xs:unsignedByte"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:unsignedByte |
source | <xs:element name="Day" type="xs:unsignedByte"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:unsignedShort |
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 | ||||||||||||||
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 | ||
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" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | DeviceIdentifier |
children | Kind Identifier |
source | <xs:element name="DeviceIdentifiers" type="DeviceIdentifier" nillable="true" 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 | ||
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 | ||
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 | ||
used by |
|
||
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 | ||
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 | ||
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 |
source | <xs:element name="Code" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
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 | ||
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 | ||
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 |
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 |
children | Title FirstName MiddleName LastName |
source | <xs:element name="CustomerName" type="PrimaryPlaceOfUseCustomerName" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | PrimaryPlaceOfUseAddress |
children | AddressLine1 AddressLine2 City State ZipCode Country |
source | <xs:element name="Address" type="PrimaryPlaceOfUseAddress" nillable="true"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | AddressLine1 AddressLine2 City State ZipCode Country | ||
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:sequence> </xs:complexType> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="AddressLine1" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="AddressLine2" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="City" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="State" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="ZipCode" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="Country" type="xs:string" nillable="true"/> |
diagram | |||
namespace | http://nphase.com/unifiedwebservice/v2 | ||
children | Title FirstName MiddleName LastName | ||
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:sequence> </xs:complexType> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="Title" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="FirstName" type="xs:string" nillable="true"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="MiddleName" type="xs:string" nillable="true" minOccurs="0"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:string |
source | <xs:element name="LastName" 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 |
source | <xs:element name="Hour" type="xs:unsignedByte"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:unsignedByte |
source | <xs:element name="Minute" type="xs:unsignedByte"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:unsignedByte |
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 |
source | <xs:element name="Start" type="xs:dateTime"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | xs:dateTime |
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 |
children | Hour Minute Second |
source | <xs:element name="Start" type="Time"/> |
diagram | |
namespace | http://nphase.com/unifiedwebservice/v2 |
type | Time |
children | Hour Minute Second |
source | <xs:element name="End" type="Time"/> |