D19536 NovAtel Partner E-Commerce Web Service API R0W

E-Commerce API Specification
NovAtel / Partner Web Service Interface
Proprietary Information - Copyright (c) 2014-2016 NovAtel Inc. - All Rights Reserved
NovAtel E-Commerce Web Services *** PRELIMINARY - SUBJECT TO CHANGE *** Partner Application Programmers Interface
Table of Contents
NovAtel E-Commerce Web Services......................................................................................................................................................................................... 1

Introduction Section...................................................................................................................................................................................................................2
Version History...................................................................................................................................................................................................................... 3
Legal......................................................................................................................................................................................................................................6
Intended Audience................................................................................................................................................................................................................ 7
Customer Service..................................................................................................................................................................................................................8
Initial Customer Setup........................................................................................................................................................................................................... 9
References............................................................................................................................................................................................................................ 10
Definitions, Acronyms and Abreviations................................................................................................................................................................................11
INovAtelPartnerM2Mservice......................................................................................................................................................................................................12
Methods.................................................................................................................................................................................................................................13
GetMetaData..................................................................................................................................................................................................................... 20
GetPaidModelNames........................................................................................................................................................................................................ 22
GetPromoStatus................................................................................................................................................................................................................23
GetPSNStatus................................................................................................................................................................................................................... 24
GetPSNStatusRevB.......................................................................................................................................................................................................... 26
GetTerraStarStatus........................................................................................................................................................................................................... 28
PurchaseTerraStarService................................................................................................................................................................................................ 29
PurchaseTerraStarServiceRevB....................................................................................................................................................................................... 34
RequestAuthcodeUpdate.................................................................................................................................................................................................. 41
RequestAuthcodeUpgrade................................................................................................................................................................................................ 43
RequestAuthcodeUpgradeRevB....................................................................................................................................................................................... 48
RequestAuthcodeUpgradeWithIndirectCustomer............................................................................................................................................................. 52
D19536 Rev: 0W *** PRELIMINARY - SUBJECT TO CHANGE ***

RequestPreviousAuthCode............................................................................................................................................................................................... 56
RequestTempAuthCode....................................................................................................................................................................................................58
RequestTerraStarResendActivation..................................................................................................................................................................................60
RequestTerraStarTestActivation....................................................................................................................................................................................... 62
ResetDevelopmentPSN.................................................................................................................................................................................................... 65
TestConnection................................................................................................................................................................................................................. 67
TransferTerraStarService..................................................................................................................................................................................................68
Complex Types..................................................................................................................................................................................................................... 70
ArrayofCardServiceCapabilities........................................................................................................................................................................................ 74
ArrayOfGPSCardDetail..................................................................................................................................................................................................... 75
ArrayOfGPSCardDetailRevB............................................................................................................................................................................................ 76
ArrayOfNovAtelTransactionTypes.....................................................................................................................................................................................77
ArrayOfPACStatusTypes...................................................................................................................................................................................................78
ArrayOfRequestTypes.......................................................................................................................................................................................................79
ArrayOfResponseCodes................................................................................................................................................................................................... 80
ArrayOfServiceStatusTypes.............................................................................................................................................................................................. 81
ArrayOfServiceTypes........................................................................................................................................................................................................ 82
ArrayOfString.....................................................................................................................................................................................................................83
ArrayOfTerraStarPartNumbers......................................................................................................................................................................................... 84
ArrayOfTerraStarUnitStatus.............................................................................................................................................................................................. 85
NeCSMetaData................................................................................................................................................................................................................. 86
NovAtelTransactionTypeDetail..........................................................................................................................................................................................87
PACStatusTypeDetail........................................................................................................................................................................................................88
RequestTypeDetail............................................................................................................................................................................................................89
Response.......................................................................................................................................................................................................................... 90
ResponseMetadata........................................................................................................................................................................................................... 91
ServiceStatusTypeDetail................................................................................................................................................................................................... 92

ServiceTypeDetail............................................................................................................................................................................................................. 93
TArrayOfCouponStatusDetail............................................................................................................................................................................................94
TArrayOfEligiblePartNumbers........................................................................................................................................................................................... 95
TCardServiceCapabilities..................................................................................................................................................................................................96
TCouponStatusDetail........................................................................................................................................................................................................ 97
TEligiblePartNumber......................................................................................................................................................................................................... 98
TEnclosureDetail............................................................................................................................................................................................................... 99
TGetMetaDataParams...................................................................................................................................................................................................... 100
TGetPaidModelNamesParams......................................................................................................................................................................................... 101
TGetPaidModelNamesReply.............................................................................................................................................................................................102
TGetPromoStatusParams................................................................................................................................................................................................. 103
TGetPromoStatusReply.................................................................................................................................................................................................... 104
TGetPSNStatusParams.................................................................................................................................................................................................... 105
TGetPSNStatusReply........................................................................................................................................................................................................106
TGetPSNStatusRevBParams........................................................................................................................................................................................... 107
TGetPSNStatusRevBReply...............................................................................................................................................................................................108
TGetTerraStarStatusParams............................................................................................................................................................................................ 109
TGetTerraStarStatusReply................................................................................................................................................................................................110
TGPSCardDetail................................................................................................................................................................................................................111
TGPSCardDetailRevB.......................................................................................................................................................................................................112
TPromoDetails...................................................................................................................................................................................................................113
TPurchaseTerraStarServiceParams................................................................................................................................................................................. 114
TPurchaseTerraStarServiceReply.................................................................................................................................................................................... 118
TPurchaseTerraStarServiceRevBParams........................................................................................................................................................................ 120
TPurchaseTerraStarServiceRevBReply............................................................................................................................................................................124
TRequestAuthCodeUpdateParams...................................................................................................................................................................................126
TRequestAuthCodeUpdateReply......................................................................................................................................................................................127

TRequestAuthcodeUpgradeParams................................................................................................................................................................................. 128
TRequestAuthcodeUpgradeParamsWithIndirectCustomer...............................................................................................................................................130
TRequestAuthcodeUpgradeReply.................................................................................................................................................................................... 133
TRequestAuthcodeUpgradeRevBParams........................................................................................................................................................................ 135
TRequestAuthcodeUpgradeRevBReply............................................................................................................................................................................138
TRequestPreviousAuthCodeParams................................................................................................................................................................................ 140
TRequestPreviousAuthCodeReply................................................................................................................................................................................... 141
TRequestTempAuthCodeParams..................................................................................................................................................................................... 142
TRequestTempAuthCodeReply........................................................................................................................................................................................ 144
TRequestTerraStarResendActivationParams................................................................................................................................................................... 145
TRequestTerraStarResendActivationReply...................................................................................................................................................................... 146
TRequestTerraStarTestActivationParams........................................................................................................................................................................ 147
TRequestTerraStarTestActivationReply............................................................................................................................................................................149
TResetDevelopmentPSNParams......................................................................................................................................................................................150
TResetDevelopmentPSNReply......................................................................................................................................................................................... 151
TTerraStarPartNumber......................................................................................................................................................................................................152
TTerraStarUnitStatus........................................................................................................................................................................................................ 153
TTransferTerraStarServiceParams................................................................................................................................................................................... 156
TTransferTerraStarServiceReply...................................................................................................................................................................................... 157
Simple Types.........................................................................................................................................................................................................................158
TCouponStatusType......................................................................................................................................................................................................... 159
TDevelopmentResetTypes................................................................................................................................................................................................160
TNovAtelTransactionType.................................................................................................................................................................................................161
TPACStatus.......................................................................................................................................................................................................................162
TRequestTypes................................................................................................................................................................................................................. 163
TServiceStatus.................................................................................................................................................................................................................. 164
TServiceType.................................................................................................................................................................................................................... 165

NovAtel E-Commerce Web Services

Description
NovAtel E-Commerce Web Services
Sources
Name Description
Introduction Section Introduction and Overview of NovAtel E-Commerce web services
INovAtelPartnerM2Mservice NovAtel / Partner E-Commerce Machine to Machine API
1
Introduction
The purpose of this document is to describe the interface specification to NovAtels E-Commerce Web Service.
The E-Commerce Web Service provides a mechanism for NovAtel's customers, dealers and business partners to communicate with NovAtel to:
Query information regarding a particular product
Request Authorization Codes for product
Purchase Paid Model Upgrades to add additional capabilities to a product already in the field
Purchase, renew or start a trial TerraStar Subscription
API development support functions
- Resetting a development PSN top a known model for testing purpose

- Connecting testing functions
Querying the status of any NovAtel Promotions that may be offerred
2
Version History
Rev Date Description Author

isio
n
0A 2014-07-25 Initial Revision Al Sisson
0B 2014-07-25 Added Introduction section and updated other sections Al Sisson
0C 2014-10-17 Changed orentation to landscape and updated as required Al Sisson
0D 2014-11-18 Updated to changes in interface. Removed Error codes for now, they are returned as part of the Al Sisson
metadata.
0E 2014-12-09 Updated parameter names with suggestions from Suren. Al Sisson
0F 2014-12-12 Cleaned up documentation and added additional types where necessary. Updated Auth Code routines Al Sisson
to use new calling format to keep them consistent with the TerraStar funnctions. Added new reset type
to the ResetDevelopmentPSN
0G 2014-12-15 Added TEnclosureDetail and TGPSCardDetail in order to return more information and use that Al Sisson
information to determine which card in an enclosure is TerraStar capable.
0H 2015-02-04 Removed InternalNote field. Al Sisson
0I 2015-02-22 Corrected country to ISO 3166-2 Al Sisson
0J 2015-02-24 Removed unneeded information from MetaData Al Sisson
0K 2015-03-01 Removed CustNumb in GetPSNStatus. Al Sisson
Removed PACMgmtType from TTerraStarStatus and MetaData
Removed extra ResponseStatus from TTerraStarUnitStatus
Updated Services Types to add SERVICE_TYPE_TERMED_MNGD
Updated NovAtelTransactionType to include TYPE_MGMD_PURCHASE
3

isio
n
0L 2015-06-04 Al Sisson
Added new TRequestType REQUEST_ORDER_NEW_OR_RENEW
Modified PurchaseTerraStarService to use new REQUEST_ORDER_NEW_OR_RENEW

RequestType to handle test to purchase and existing contract renewals.
Removed RenewTerraStarService as this functionality is now incorporated in the

PurchaseTerraStarService method.
Removed deprecated RequestTerraStarSalesTransactions
0M 2015-06-11 Al Sisson
clarified ScheduleActivationStartDate restrictions for PurchaseTerraStarService and
RequestTerraStarTestActivation
0N 2015-06-25 Added additional fields to TRequestAuthCodeUpdateReply Al Sisson

0O 2015-08-18 Corrected minor typo
0P 2015-10-05 Added RequestAuthcodeUpgradeWithIndirectCustomer Al Sisson
Added TYPE_MNGD_RENEWAL to TNovAtelTransactionType
0Q 2015-12-17 Added PurchaseTerraStarServiceRevB and RequestAuthCodeUpgradeRevB Al Sisson
0R 2016-02-23 Corrected maximum length of Purchase Order fields to 25 characters in RequestAuthCodeUpgrade and Al Sisson
PurchaseTerraStarService methods.
0S 2016-04-19 Updated documentation for PurchaseTerraStarServiceRevB Al Sisson
Added TransferTerraStarService and RequestTempAuthCode methods
0T 2016-04-25 Added additional fields to TransferTerraStarService response Al Sisson
Update PurchaseTerraStarServiceRevB for Phase 2 features
Added documentation for new GetPSNStatusRevB method.

Updated GetPSNStatus method to indicate that it is now deprecated.
Updated TPartNumber to add additional fields
4

isio
n
0U 2016-04-25 Flagged Deprecated methods in method listing Al Sisson
0V 2016-06-30 Updated to add support for GetPromoStatus Al Sisson
0W 2016-06-30 Updated with review notes Al Sisson
5
Legal
RESTRICTED PROPRIETARY INFORMATION
The information disclosed herein is the exclusive property of NovAtel Inc. and is not to be disclosed without the written consent of NovAtel
Inc. No part of this publication may be reproduced or transmitted in any form or by any means including electronic storage, reproduction,
execution or transmission without the prior written consent of NovAtel Inc. The recipient of this document, by its retention and use, agrees to
respect the security status of the information contained herein.
This document is intended for limited circulation.
The information contained in this document is subject to change without notice and should not be construed as a commitment by NovAtel
Inc. unless such commitment is expressly given in a covering document.
Copyright NovAtel Inc. (2014-2016)
DISCLAIMER
In no event will NovAtel Inc. be liable for damages of any kind, incidental or consequential, in regard to or arising out of the performance or
form of the material presented herein. No representation is made regarding the suitability of this product for any particular purpose.
6
Intended Audience
This guide us written for developers who are implementing e-commerce solutions with NovAtel Inc. using the SOAP API.
7
Customer Service
If you have any questions regarding the e-Commerce API, please contact NovAtel Customer Service using any one of the following methods:
Method Details
NovAtel GPS Hotline 1-800-NOVATEL (U.S. & Canada)
403-295-4900 (International)
Fax 403-295-4901
E-Mail NECSsupport@novatel.ca
Website www.novatel.com
Write NovAtel Inc. Customer Service Dept.
1120 68 Avenue NE
Calgary, Alberta, Canada
T2E 8S5
8
Initial Customer Setup

In order to setup new customer to use web services the following information is required:
Visitor ID (generated by NovAtel Technical Services)
NovAtel Customer Number (should correspond ERP Customer #)
IP address for customers web server that will access web transactions. This address will be added to test and live web servers in order to allow
access
Password used to access Web Services
A list of Product Serial Numbers (PSN) that will be registered as development PSNs
Signed agreements for use of these services. This will establish agreed limits on transaction amounts allowed.
9
References
10
Definitions, Acronyms and Abreviations

Acronym Description
API Application Programmers Interface
M2M Machine to Machine
NeCS NovAtel E-Commerce System
OSN Optional Subscription Number
PSN Product Serial Number
PAC Product Activation Code
UCM Unit Control Message
11
INovAtelPartnerM2Mservice Web Service

Name
INovAtelPartnerM2Mservice
Description
NovAtel / Partner E-Commerce Machine to Machine API
Remarks
This service is typically used by high volume customers that wish to automate and integrate their systems with NovAtel's E-Commerce System
See Also
Methods | Complex Types | Simple Types
12
Methods: INovAtelPartnerM2Mservice
Description
These methods provide a variety of functions used to check NovAtel and TerraStar information for a customer's GPS receiver.
Deprecated
The following methods have been deprecated and all customers should now use the new method. The old methods have been temporarily left to allow
customers to modify their code to use the new functions.
Deprecated Method New Method

GetPSNStatus GetPSNStatusRevB
PurchaseTerraStarService PurchaseTerraStarServiceRevB
RequestAuthCodeUpgrade RequestAuthCodeUpgradeRevB
RequestAuthCodeUpgradeWithIndirectCustomer RequestAuthCodeUpgradeRevB
13
Methods
Name Deprecated Description

GetMetaData No This method is used by the partner's business system to obtain a detailed
information required to use NovAtel's E-Commerce system.
GetPaidModelNames No This method is used to return any of the the models that are the current paid
model as well as any other previous paid model(s) for the specified PSN. This
can be used with the RequestPreviousAuthCode method to request a previously
generate auth code.
GetPromoStatus No This method can be used to request the promotional details and the associated
coupon status that are available for the customer.
GetPSNStatus YES IMPORTANT NOTE: This method has been deprecated and all customers
should now use GetPSNStatusRevB. This method has been temporarily left
enabled to allow customers to modify their code to use the updated function.
This method will request the status of the card specified. The response will
include information about the NovAtel GPS card.
GetPSNStatusRevB No This method will request the status of the card specified. The response will
include information about the NovAtel GPS card and it's service capabilities for
each of the available services.
GetTerraStarStatus No This method returns the details about the TerraStar contract for the specified
Product Serial Number.
14
Methods

PurchaseTerraStarService YES IMPORTANT NOTE: This method has been deprecated and all customers
should now use PurchaseTerraStarServiceRevB. This method has been
temporarily left enabled to allow customers to modify their code to use the
updated function.
This method allows the requestor to request a quote, purchase or renew a

TerraStar Service Subscription.
If the RequestType is set to REQUEST_QUOTE then the method will validate of

the requested parameters and, if valid, will return a price for the requested part
number.
If the RequestType is set to REQUEST_ORDER then the method validate all of

the parameters and, if valid, creates a NEW TerraStar Service if there is no
SERVICE_ACTIVE or SERVICE_PENDING TerraStar service associated with
the PSN.
If the RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then the

method will validate all of the parameters and, if valid it will:
create a NEW TerraStar Service contract if there is no
SERVICE_ACTIVE or SERVICE_PENDING TerraStar service
associated with the PSN or
renews an existing TerraStar Service contract (SERVICE_ACTIVE or

SERVICE_EXPIRING) by extending the current service end date by the
duration specified in the requested part number. This action will create
a new contract number with the new contract
ScheduledServiceStartDateTime date set to the ServiceEndDateTime
of the existing service.
PurchaseTerraStarServiceRevB No This method allows the requestor to request a quote, purchase or renew a
TerraStar Service Subscription.
15
Methods

This method supports the following scenarios:
Purchase of new TerraStar service contract,
Seamless purchase of TerraStar service contract during a pending or

active test service, or
Seamless extension of an active or expiring TerraStar service contract.

This method allows for a purchase of a termed standard TerraStar service
contract for the supporting card PSN. A contract cannot be cancelled or
refunded for unused period once created. A TerraStar contract can be
purchased for PSNs with FW and paid model that supports the specific
TerraStar service. It is recommended to check the card's TerraStar capability
using GetPSNStatusRevB request prior to purchasing TerraStar service for a
PSN.
NeCS supports the following the request types:
REQUEST_QUOTE,
REQUEST_ORDER, and
REQUEST_ORDER_NEW_OR_RENEW
If RequestType is set to REQUEST_QUOTE then the method will validate of the
requested parameters and, if valid, will return a NovAtel Unit price, NovAtel List
price and Discount Percentage (if applicable) for the requested part number.
If RequestType is set to REQUEST_ORDER then the method validate all of the
parameters and, if valid, creates a NEW TerraStar Service under the following
condition:
PSN has no associated TerraStar records or an active or pending
TerraStar service
16
Methods

If the RequestType is set to REQUEST_ORDER then Purchase of TerraStar
service contract is rejected under the following conditions:
PSN has an active or pending TerraStar test service, or
PSN has an active or pending TerraStar service contract

If RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then Purchase
of TerraStar service contract is allowed under the following conditions:
PSN has no associated TerraStar records or active TerraStar service,
or
PSN has an active or expiring standard TerraStar service contract

If the RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then
Purchase of TerraStar service contract is rejected under the following condition:
PSN has a pending standard TerraStar service contract
RequestAuthcodeUpdate No This method requests an update authorization code for the specified PSN. The
authorization code will be generated for the cards current paid model and the
specified software version.
17
Methods

RequestAuthcodeUpgrade YES IMPORTANT NOTE: This method has been deprecated and all customers
should now use RequestAuthCodeUpgradeRevB. This method has been
updated function.
This method is used to purchase or quote on authorization code upgrade. If a

quote is requested then the price to upgrade the paid model will be returned. If
an order is requested then paid model will be updated to add additional
functionality for the specified PSN.
RequestAuthcodeUpgradeRevB No This method is used to purchase or quote on authorization code upgrade. If a

quote is requested then the NovAtel Unit Price and NovAtel List Price to upgrade
the paid model will be returned. If an order is requested then paid model will be
updated to add additional functionality for the specified PSN.
The RequestAuthCodeUpgradeRevB method differs from the previous

RequestAuthCodeUpgrade as it accepts additional IndirectCustomerName and
IndirectCustomerReference.
The RequestAuthCodeUpgradeRevB method also differs from the previous

RequestAuthCodeUpgradeWithIndirectCustomer in the data that is returned
which now includes NovAtelUnitPrice (instead of Amount) and the new
NovAtelListPrice field.
RequestAuthcodeUpgradeWithIndi YES IMPORTANT NOTE: This method has been deprecated and all customers
rectCustomer should now use RequestAuthCodeUpgradeRevB. This method has been
updated function.
This method is used to purchase or quote on authorization code upgrade with

additional Indirect Customer information. If a quote is requested then the price
to upgrade the paid model will be returned. If an order is requested then paid
model will be updated to add additional functionality for the specified PSN.
18
Methods

RequestPreviousAuthCode No This method determines if the specified Model is in the Paid Model list for the
specified PSN. If it is in the list then an authorization code will be generated for
the specified PSN, version and model.
RequestTempAuthCode No This method generates a temporary authorization code that enables the
specified model to operate on the specified PSN for the specified duration.
RequestTerraStarResendActivatio No This method may be used to resend the TerraStar UCM to the specified PSN.
n
RequestTerraStarTestActivation No This method requests a TerraStar test activation for the specified receiver.
ResetDevelopmentPSN No This method is used to reset one of the requestor's development PSNs to a
particular paid model. This allows testing of the entire upgrade process. Any
transactions that are processed on a card registered as a development PSN will
not be invoiced but will be processed as a zero dollar transaction to test the
service including e-mail notifications.
TestConnection No This method provides a simple echo function that can be used to ensure that
communication is working to the NovAtel Web Services.
TransferTerraStarService No The TransferTerraStarService method transfers the TerraStar activation from the
SourcePSN to the Destination PSN.
19
Method: GetMetaData
Description
This method is used by the partner's business system to obtain a detailed information required to use NovAtel's E-Commerce system.
Parameters
Params
Type: TGetMetaDataParams
This type specifies the parameters required to request the MetaData for the system.
Name Type Size Description Nillable?

VisitorID int Customer unique identification number originating No
the request.
CustNumb string 7 Associated customer number in the NovAtel No
eCommerce System.
Password string 40 Customer unique password required to use the No
web service.
Nillable?: No
Returns
A value of type NeCSMetaData having the structure defined by the following table.
Name Type Description

NovAtelTransactionTypes ArrayOfNovAtelTransactionTypes An array of NovAtel Transaction Types
PACStatusTypes ArrayOfPACStatusTypes An array of PAC Status Types
TerraStarPartNumbers ArrayOfTerraStarPartNumbers A list of the various part numbers that can be used to order TerraStar
subscriptions.
ResponseCodes ArrayOfResponseCodes A list of the various response codes that can be returned by the system
20
Returns

RequestTypes ArrayOfRequestTypes An array of Request Types
ServiceStatusTypes ArrayOfServiceStatusTypes An array of Service Status Types
ServiceTypes ArrayOfServiceTypes An array of Service Types
ResponseStatus Response The response status for the GetMetaData request
21
Method: GetPaidModelNames
Description
This method is used to return any of the the models that are the current paid model as well as any other previous paid model(s) for the specified PSN.
This can be used with the RequestPreviousAuthCode method to request a previously generate auth code.
Parameters
Params_
Type: TGetPaidModelNamesParams

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number of card to request the paid No
model information for. The PSN is case sensitive.
Nillable?: No
Returns
A value of type TGetPaidModelNamesReply having the structure defined by the following table.

PaidModels ArrayOfString An array of Paid Models for the specified PSN
ResponseStatus Response The response status for the GetPaidModelNames request
22
Method: GetPromoStatus
Description
This method can be used to request the promotional details and the associated coupon status that are available for the customer.
Parameters
Params_
Type: TGetPromoStatusParams

the request.
eCommerce System.
web service.
PromoPartNumber string 30 Promotional Part Number No
Nillable?: No
Returns
A value of type TGetPromoStatusReply having the structure defined by the following table.

PromoDetails TPromoDetails Details regarding the NovAtel promotion
CouponStatus TArrayOfCouponStatusDetail An arracy of CouponStatusDetail records
CouponsGenerated int The total number of coupons generated
ResponseStatus Response The response status for the GetPromoStatus request
23
Method: GetPSNStatus (Deprecated)
Description
IMPORTANT NOTE: This method has been deprecated and all customers should now use GetPSNStatusRevB. This method has been
temporarily left enabled to allow customers to modify their code to use the updated function.
This method will request the status of the card specified. The response will include information about the NovAtel GPS card.
Parameters
Params_
Type: TGetPSNStatusParams
This type specifies the parameters required to request the status of the card specified by Product Serial Number.

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number of card to request the status No
information for. The PSN is case sensitive.
Nillable?: No
Returns
A value of type TGetPSNStatusReply having the structure defined by the following table.
24
Returns

EnclosureDetails TEnclosureDetail Detailed information regarding the product enclosure (if applicable)
GPSReceivers ArrayOfGPSCardDetail An array of GPS Receiver card details. For enclosure products there will
be one entry for each GPS Receiver within the enclosure
ResponseStatus Response The response status for the GetPSNStatus request
25
Method: GetPSNStatusRevB
Description
This method will request the status of the card specified. The response will include information about the NovAtel GPS card and it's service capabilities
for each of the available services.
Parameters
Params_
Type: TGetPSNStatusRevBParams

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number of card to request the status No
Nillable?: No
Returns
A value of type TGetPSNStatusRevBReply having the structure defined by the following table.

26
Returns

GPSReceivers ArrayOfGPSCardDetailRevB An array of GPS Receiver card details. For enclosure products there will
be one entry for each GPS Receiver within the enclosure. For each GPS
Receiver there will also be a seperate entry for each of the available
services that indicates the receiver's capability with the service.
ResponseStatus Response The response status for the GetPSNStatusRevB request.
27
Method: GetTerraStarStatus
Description
This method returns the details about the TerraStar contract for the specified Product Serial Number.
Parameters
Params_
Type: TGetTerraStarStatusParams
This type specifies the parameters required to request the status of the TerraStar Subscription associated with the card specified by Product
Serial Number.

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number to request the TerraStar No
Subscription Status. The PSN is case sensitive.
Nillable?: No
Returns
A value of type TGetTerraStarStatusReply having the structure defined by the following table.

UnitStatusRecords ArrayOfTerraStarUnitStatus An array of TerraStarUnitStatus records for the specified PSN
ResponseStatus Response The response status for the GetTerraStarStatus request
28
Method: PurchaseTerraStarService
Description
IMPORTANT NOTE: This method has been deprecated and all customers should now use PurchaseTerraStarServiceRevB. This method has
been temporarily left enabled to allow customers to modify their code to use the updated function.
This method allows the requestor to request a quote, purchase or renew a TerraStar Service Subscription.
If the RequestType is set to REQUEST_QUOTE then the method will validate of the requested parameters and, if valid, will return a price for the
requested part number.
If the RequestType is set to REQUEST_ORDER then the method validate all of the parameters and, if valid, creates a NEW TerraStar Service if there is
no SERVICE_ACTIVE or SERVICE_PENDING TerraStar service associated with the PSN.
If the RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then the method will validate all of the parameters and, if valid it will:
create a NEW TerraStar Service contract if there is no SERVICE_ACTIVE or SERVICE_PENDING TerraStar service associated with the PSN or
renews an existing TerraStar Service contract (SERVICE_ACTIVE or SERVICE_EXPIRING) by extending the current service end date by the
duration specified in the requested part number. This action will create a new contract number with the new contract
ScheduledServiceStartDateTime date set to the ServiceEndDateTime of the existing service.
Parameters
Params
Type: TPurchaseTerraStarServiceParams
This type defines the parameters necessary to purchase a TerraStar Service Subscription
29
Parameters

the request.
eCommerce System.
web service.
PSN string 15 NovAtel Product Serial Number (PSN) of the No
specific receiver card or enclosure for which the
service is purchased. The PSN is case sensitive.
PartNumber string 30 NovAtel part number that describes the purchased No
service (Name/Region/Application/Duration, i.e.
TSD-GL-AR-1YR). Should be a valid part number
that is supported by NovAtel and is provided as
part of Meta Data.
RequestType TRequestTypes Specifies the type of transaction to process (i.e. No
quote or order). See TRequestTypes for valid
enumerations and associated definition.
ServiceLocationLatitude decimal Specifies the nominal service location (center) in Yes
latitude (specified in WGS-84 standard). Latitude
shall be specified in degrees and fraction of
degrees and between 90 degrees (A plus sign (+)
denotes Northern hemisphere or the equator, and a
minus sign (-) denotes Southern hemisphere).
For Global part numbers, this parameter will be

ignored.
30
Parameters

ServiceLocationLongitude decimal Specifies the nominal service location (center) in Yes
longitude (specified in WGS-84 standard).
Longitude shall be specified in degrees and fraction
of degrees and between 180 degrees (A plus
sign (+) denotes east longitude or the prime
meridian, and a minus sign (-) denotes west
longitude or 180 meridian i.e. opposite of the
prime meridian).

ignored.
ImmediateActivation boolean Specifies the commencement of purchased No
service. Set to True if purchased service should
start immediately or False for scheduled service
start date and time.
If the RequestType is set to

REQUEST_ORDER_NEW_OR_RENEW and an
active service (SERVICE_ACTIVE or
SERVICE_EXPIRING) is found for the associated
PSN then this parameter will be ignored and the
new contract will be scheduled to start at the
ServiceEndDate of the exisiting contract.
31
Parameters

ScheduledServiceStartDateTime dateTime The date and time that the TerraStar service Yes
should be activated in UTC Z format (i.e.
2014-12-31T13:00:00Z). Required if
ImmediateActivation is set to False otherwise set
to Null.

The date/time must be a valid date/time and not

before the current UTC time plus 5 minutes and
within 90 days of the current UTC date/time. For
example, if the current UTC datetime is
2015-06-09T14:00:00 HRS then any date/time
before 2015-06-09T14:05:00 HRS and after
2015-09-07T14:00:00 HRS will be rejected. If you
are trying to schedule an activation within 5
minutes of the current UTC it is suggested that you
set ImmediateActivation to True to avoid this
rejection.
CustomerPurchaseOrderReference string 25 Customer purchase order reference or number No
associated with this purchase request.
IndirectCustomerName string 50 An optional field that can be used by NovAtel Yes
customer to record information about their
customer.
IndirectCustomerReference string 50 An optional field that can be used by the Partner to Yes
record information about their customer.
32
Parameters

CustomerNotes string 255 An optional field that can be used to record notes Yes
related to this transaction.
Nillable?: No
Returns
A value of type TPurchaseTerraStarServiceReply having the structure defined by the following table.

NovAtelTransactionID int The Transaction ID for this purchase transaction
PSN string The Product Serial Number of the NovAtel GPS card that the TerraStar
service will be applied to.
EnclosurePSN string The PSN of the enclosure (if applicable).
PartNumber string NovAtel part number that describes the purchased service
(Name/Region/Application/Duration, i.e. TSD-GL-AR-1YR). Should be a
valid part number that is supported by NovAtel and is provided as part of
Meta Data.
ContractNumber long A unique Contract Number for the resulting contract or, if the command
fails a Null
NovAtelUnitPrice double Customer unit price associated with the purchased service.
NovAtelPriceCurrency string The ISO 4217 currency code associated with the price or, if the command
fails, a Null.
RequestType TRequestTypes The Request type specified for this transaction to process (i.e. quote or
order). See TRequestTypes for valid enumerations and associated
definition.
ResponseStatus Response The response status for the PurchaseTerraStarService request
33
Method: PurchaseTerraStarServiceRevB
Description
This method allows the requestor to request a quote, purchase or renew a TerraStar Service Subscription.
This method supports the following scenarios:
Purchase of new TerraStar service contract,
Seamless purchase of TerraStar service contract during a pending or active test service, or
Seamless extension of an active or expiring TerraStar service contract.
This method allows for a purchase of a termed standard TerraStar service contract for the supporting card PSN. A contract cannot be cancelled or
refunded for unused period once created. A TerraStar contract can be purchased for PSNs with FW and paid model that supports the specific TerraStar
service. It is recommended to check the card's TerraStar capability using GetPSNStatusRevB request prior to purchasing TerraStar service for a PSN.
NeCS supports the following the request types:
REQUEST_QUOTE,
REQUEST_ORDER, and
REQUEST_ORDER_NEW_OR_RENEW
If RequestType is set to REQUEST_QUOTE then the method will validate of the requested parameters and, if valid, will return a NovAtel Unit price,
NovAtel List price and Discount Percentage (if applicable) for the requested part number.
If RequestType is set to REQUEST_ORDER then the method validate all of the parameters and, if valid, creates a NEW TerraStar Service under the
following condition:
PSN has no associated TerraStar records or an active or pending TerraStar service
If the RequestType is set to REQUEST_ORDER then Purchase of TerraStar service contract is rejected under the following conditions:
34
Description
PSN has an active or pending TerraStar service contract
If RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then Purchase of TerraStar service contract is allowed under the following conditions:
PSN has no associated TerraStar records or active TerraStar service, or
PSN has an active or expiring standard TerraStar service contract
If the RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then Purchase of TerraStar service contract is rejected under the following
condition:
PSN has a pending standard TerraStar service contract
Parameters
Params_
Type: TPurchaseTerraStarServiceRevBParams
This type defines the parameters necessary to purchase a TerraStar Service Subscription.

the request.
eCommerce System.
web service.
35
Parameters

service is purchased. The PSN is case sensitive.
PartNumber string 30 NovAtel part number that describes the purchased No
service (Name/Region/Application/Duration, i.e.
TSD-GL-AR-1YR). Should be a valid part number
that is supported by NovAtel and is provided as
part of Meta Data.
RequestType TRequestTypes Specifies the type of transaction to process (i.e. No
quote or order). See TRequestTypes for valid
enumerations and associated definition.
ServiceLocationLatitude decimal Specifies the nominal service location (center) in Yes
latitude (specified in WGS-84 standard). Latitude
shall be specified in degrees and fraction of
degrees and between 90 degrees (A plus sign (+)
denotes Northern hemisphere or the equator, and a
minus sign (-) denotes Southern hemisphere).

ignored.
ServiceLocationLongitude decimal Specifies the nominal service location (center) in Yes
longitude (specified in WGS-84 standard).
Longitude shall be specified in degrees and fraction
of degrees and between 180 degrees (A plus
sign (+) denotes east longitude or the prime
meridian, and a minus sign (-) denotes west
longitude or 180 meridian i.e. opposite of the
prime meridian).

ignored.
36
Parameters

37
Parameters

ScheduledServiceStartDateTime dateTime The date and time that the TerraStar service Yes
2014-12-31T13:00:00Z). Required if
to Null.
rejection.
customer.
38
Parameters

Nillable?: No
Returns
A value of type TPurchaseTerraStarServiceRevBReply having the structure defined by the following table.

PSN string The Product Serial Number of the NovAtel GPS card that the
TerraStar service will be applied to.
PartNumber string NovAtel part number that describes the purchased service
(Name/Region/Application/Duration, i.e. TSD-GL-AR-1YR). Should
be a valid part number that is supported by NovAtel and is
provided as part of Meta Data.
ContractNumber long A unique Contract Number for the resulting contract or, if the
command fails a Null
NovAtelPriceCurrency string The ISO 4217 currency code associated with the price or, if the
command fails, a Null.
NovAtelListPrice double NovAtel list price associated with the purchased service.
DiscountPercentage double Discount Percentage applied (if applicable)
39
Returns

RequestType TRequestTypes The Request type specified for this transaction to process (i.e.
quote or order). See TRequestTypes for valid enumerations and
associated definition.
ResponseStatus Response The response status for the PurchaseTerraStarServiceRevB request
40
Method: RequestAuthcodeUpdate
Description
This method requests an update authorization code for the specified PSN. The authorization code will be generated for the cards current paid model
and the specified software version.
Parameters
Params_
Type: TRequestAuthCodeUpdateParams

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number of card to request the No
authorization code update for. The PSN is case
sensitive.
OSN string 20 Product's Optional Subscription Number. This is a Yes
secondary validation field for the PSN and is only
required on cards that have an 11 character PSN.
SWVersion string 15 Software Version to generate authorization code No
for. For products that support signature
authorization codes you can "SIGNATURE" as the
software version.
Nillable?: No
41
Returns

AuthCode string A unique authorization code allowing the specified PSN to operate with the
specified model and software version.
ResponseStatus Response The response status for the RequestAuthCodeUpdate request
42
Method: RequestAuthcodeUpgrade
Description
IMPORTANT NOTE: This method has been deprecated and all customers should now use RequestAuthCodeUpgradeRevB. This method has
This method is used to purchase or quote on authorization code upgrade. If a quote is requested then the price to upgrade the paid model will be
returned. If an order is requested then paid model will be updated to add additional functionality for the specified PSN.
Parameters
Params_
Type: TRequestAuthcodeUpgradeParams

the request.
eCommerce System.
web service.
43
Parameters

sensitive.
If you specify the Product Serial Number of an

enclosure the service will attempt to locate the PSN
of the upgradeable GPS card within that enclosure.
In most cases this will be succesful, however in
some cases there may be more that one
upgradeable GPS card within the enclosure and in
those cases the request will be rejected. An error
code will be return suggesting that you call
GetPSNStatus to determine which of the
enclosure's GPS cards that you want to upgrade.
secondary validation field for the PSN and is
typically only suggested for use with GPS cards
that have an 11 character PSN. The 13 character
PSNs include a check digit so the OSN is not
required.
Caution: The service will only validate the OSN if

it is not null. If you choose to not use the optional
secondary validation for 11 character PSNs then
you will be responsible for any authorization codes
purchased.
PartNumber string 30 Marketing Name Part Number to upgrade to eg. No
OEM615-D2S-B0G-550
software version.
44
Parameters

RequestType TRequestTypes Specifies the type of transaction to process No
(REQUEST_QUOTE or REQUEST_ORDER).
Any other RequestType will be rejected.
See TRequestTypes for valid enumerations and
related to this transaction
Nillable?: No
Returns
A value of type TRequestAuthcodeUpgradeReply having the structure defined by the following table.

Amount double Customer unit price associated with the authorization code upgrade.
AuthCode string If successful, this field will contain a unique authorization code allowing the
specified PSN to operate with the specified model and software version.
Currency string The ISO 4217 currency code associated with the price or, if the command
fails, a Null.
FromModel string The original Paid Model of the GPS card.
ToModel string The Paid Model that the GPS card will be updated to if
REQUEST_QUOTE is specified or the Paid Model that the card has been
upgraded to if REQUEST_ORDER is specified
PSN string The Product Serial Number of the card that the authorization code will
upgrade.
45
Returns

EnclosurePSN string The Product Serial Number of the enclosure (if applicable).
ResponseStatus Response The response status for the RequestAuthCodeUpgrade request
Remarks
Development Restrictions
During initial testing your account may be restricted to work with only registered development PSNs. Once your development is complete contact
NovAtel to have that restriction removed.
Suggested Development Sequence
1. Call ResetDevelopmentPSN with RESET_PAID_MODEL and specify the model that you would like to set the Paid Model to for the PSN
specified. For example, G1S000000.
2. Call GetPSNStatus to query the status of the PSN specified. Verify that the Paid Model has been updated
3. Call RequestAuthCodeUpgrade with the RequestType set to REQUEST_QUOTE and the new part number that you want the card upgraded to.
For example, OEM628-D1L-F0G-TTR. This will validate the parameters and return the amount that the upgrade will cost. This does not
actually upgrade the card - it only indicates what the upgrade will cost and allows you to present a confirmation dialog to your users if needed.
4. Review the Amount return by the previous call and if the amount is okay then change the RequestType to REQUEST_ORDER on the
RequestAuthCodeUpgrade call and submit. This will perform the actual Paid Model upgrade.
5. Call GetPSNStatus again to query the status of the PSN specified and verify that the Paid Model has been updated, in this example D1LF0GTTR.
This sequence can be repeated as necessary for registered development PSNs because you can reset the Paid Model and get the card back to a
known state.
46
Remarks
Production Use
For production use you can eliminate step 1 and continue with the rest of the steps. Note that the only step that is required to actually upgrade the
receiver is a call to RequestAuthCodeUpgrade with a RequestType of REQUEST_ORDER. The other steps are optional however it is strongly
recommended that you use REQUEST_QUOTE before REQUEST_ORDER to ensure that the pricing is correct.
47
Method: RequestAuthcodeUpgradeRevB
Description
This method is used to purchase or quote on authorization code upgrade. If a quote is requested then the NovAtel Unit Price and NovAtel List Price to
upgrade the paid model will be returned. If an order is requested then paid model will be updated to add additional functionality for the specified PSN.
The RequestAuthCodeUpgradeRevB method differs from the previous RequestAuthCodeUpgrade as it accepts additional IndirectCustomerName and
IndirectCustomerReference.
The RequestAuthCodeUpgradeRevB method also differs from the previous RequestAuthCodeUpgradeWithIndirectCustomer in the data that is returned
which now includes NovAtelUnitPrice (instead of Amount) and the new NovAtelListPrice field.
Parameters
Params_
Type: TRequestAuthcodeUpgradeRevBParams

the request.
eCommerce System.
web service.
48
Parameters

sensitive.

required.
Caution: The service will only validate the OSN if

it is not null. If you choose to not use the optional
purchased.
OEM615-D2S-B0G-550
software version.
49
Parameters

(REQUEST_QUOTE or REQUEST_ORDER).
IndirectCustomerName string 50 An optional field that can be used by the Partner to Yes
Nillable?: No
Returns
A value of type TRequestAuthcodeUpgradeRevBReply having the structure defined by the following table.

NovAtelUnitPrice double Customer unit price associated with the authorization code upgrade.
NovAtelPriceCurrency string The ISO 4217 currency code associated with the price or, if the command
fails, a Null.
NovAtelListPrice double The NovAtel list price associated with the authorization code upgrade.
FromModel string The original paid model of the GPS card.
50
Returns

REQUEST_QUOTE is specified or the Paid Model that the card
has been upgraded to if REQUEST_ORDER is specified.
PSN string The Product Serial Number of the card that the authorization code
will upgrade.
ResponseStatus Response The response status for the RequestAuthCodeUpgradeRevB request
51
Method: RequestAuthcodeUpgradeWithIndirectCustomer
Description
IMPORTANT NOTE: This method has been deprecated and all customers should now use RequestAuthCodeUpgradeRevB. This method has
This method is used to purchase or quote on authorization code upgrade with additional Indirect Customer information. If a quote is requested then the
price to upgrade the paid model will be returned. If an order is requested then paid model will be updated to add additional functionality for the specified
PSN.
Parameters
Params_
Type: TRequestAuthcodeUpgradeParamsWithIndirectCustomer

the request.
eCommerce System.
web service.
52
Parameters

sensitive.
required.
Caution: The service will only validate the OSN if it

is not null. If you choose to not use the optional
purchased.
OEM615-D2S-B0G-550
software version.
53
Parameters

(REQUEST_QUOTE or REQUEST_ORDER). Any
other RequestType will be rejected.
associated definitions.
customer.
Nillable?: No
Returns
A value of type TRequestAuthcodeUpgradeReply having the structure defined by the following table.

Amount double Customer unit price associated with the authorization code upgrade.
Currency string The ISO 4217 currency code associated with the price or, if the command
fails, a Null.
FromModel string The original Paid Model of the GPS card.
54
Returns

REQUEST_QUOTE is specified or the Paid Model that the card has been
upgraded to if REQUEST_ORDER is specified
PSN string The Product Serial Number of the card that the authorization code will
upgrade.
55
Method: RequestPreviousAuthCode
Description
This method determines if the specified Model is in the Paid Model list for the specified PSN. If it is in the list then an authorization code will be
generated for the specified PSN, version and model.
Parameters
Params_
Type: TRequestPreviousAuthCodeParams

the request.
eCommerce System.
web service.
previous authorization code for. The PSN is case
sensitive.
for.
Model string 15 Previous Paid Model to request authorization code No
for.
Nillable?: No
Returns
56
Returns

AuthCode string A unique authorization code allowing the specified PSN to operate with the
specified model and software version.
ResponseStatus Response The response status for the RequestPreviousAuthCode request
Remarks
See GetPaidModelNames method to determine which paid models are associated with the card
57
Method: RequestTempAuthCode
Description
This method generates a temporary authorization code that enables the specified model to operate on the specified PSN for the specified duration.
Parameters
Params_
Type: TRequestTempAuthCodeParams

the request.
eCommerce System.
web service.
sensitive.
typically only
required on cards that have an 11 character PSN.
If this field is specified then the OSN is checked to
ensure that it matches the OSN of the PSN
specifed.
software version.
58
Parameters

Model string 20 The model to generate the temporary auth code No
for.
Duration int The number of days to request a temporary No
authorization code for
Nillable?: No
Returns
A value of type TRequestTempAuthCodeReply having the structure defined by the following table.

PSN string The Product Serial Number of the card that the temporary authorization
code
was generated for.
Model string The model that will be enabled by the AuthCode.
AuthCode string If successful, this field will contain a unique authorization code
allowing the specified PSN to operate with the specified model and
software version.
AuthCodeStartDate dateTime The Start Date of the temporary authorization code in UTC-Z format.
AuthCodeStopDate dateTime The Stop Date of the temporary authorization code in UTC-Z format
ResponseStatus Response The response status for the RequestTempAuthCode request.
59
Method: RequestTerraStarResendActivation
Description
This method may be used to resend the TerraStar UCM to the specified PSN.
Parameters
Params
Type: TRequestTerraStarResendActivationParams
This type defines the parameters necessary to request a TerraStar Resend Activation

the request.
eCommerce System.
web service.
specific receiver card or enclosure associated with
the service for which the activation resend is
requested. The PSN is case sensitive.
Nillable?: No
Returns
A value of type TRequestTerraStarResendActivationReply having the structure defined by the following table.

ResponseStatus Response The response status for the RequestTerraStarResendActivation request.
60
Remarks
61
Method: RequestTerraStarTestActivation
Description
This method requests a TerraStar test activation for the specified receiver.
Parameters
Params
Type: TRequestTerraStarTestActivationParams
This type defines the parameters necessary to request a TerraStar Test Activation

the request.
eCommerce System.
web service.
test service is requested. The PSN is case
sensitive.
PartNumber string 30 NovAtel part number that describes the requested No
test service (i.e. TSD-GL-TEST-3DY). Should be a
valid test part number that is supported by NovAtel
and is provided as part of Meta Data.
62
Parameters

ScheduledServiceStartDateTime dateTime Specifies the start time (year, month, day, and Yes
hour) at which the test service should start.
Required if ImmediateActivation is set to False
otherwise set to Null. Should be specified in UTC
Z format (i.e. 2014-12-31T13:00:00Z).

rejection.
CustomerNotes string 255 Optional field that can be used by NovAtel No
customer to record notes related to this transaction.
Nillable?: No
Returns
A value of type TRequestTerraStarTestActivationReply having the structure defined by the following table.

NovAtelTransactionID int The Transaction ID for this transaction
PSN string NovAtel Product Serial Number (PSN) of the specific receiver card or
enclosure corresponding to the purchased service.
63
Returns

PartNumber string NovAtel's TerraStar Part Number that uniquely describes the purchased
service.
ResponseStatus Response The response status for the RequestTerraStarTestActivation request
64
Method: ResetDevelopmentPSN
Description
This method is used to reset one of the requestor's development PSNs to a particular paid model. This allows testing of the entire upgrade process.
Any transactions that are processed on a card registered as a development PSN will not be invoiced but will be processed as a zero dollar transaction to
test the service including e-mail notifications.
Parameters
Params_
Type: TResetDevelopmentPSNParams

the request.
eCommerce System.
web service.
PSN string 15 Product Serial Number of card to reset the Paid No
Model for. This PSN MUST be registered with
NovAtel Technical Services as an E-commerce
development PSN. The PSN is case sensitive.
ResetType TDevelopmentResetTypes The type of Reset requested No
NewModel string 20 The model to set the Paid Model to for the Yes
specified PSN. This is only required when the
ResetType is set to RESET_PAID_MODEL.
Nillable?: No
65
Returns
A value of type TResetDevelopmentPSNReply having the structure defined by the following table.

ResponseStatus Response The response status for the ResetDevelopmentPSN request
66
Method: TestConnection
Description
This method provides a simple echo function that can be used to ensure that communication is working to the NovAtel Web Services.
Parameters
EchoMessage
Type: string
The String that you want to echo
Nillable?: No
Returns
A value of type string.
Example
If the EchoMessage is set to "Hello" then the reply will be similar to:
Echo: Hello. Connection Okay
67
Method: TransferTerraStarService
Description
The TransferTerraStarService method transfers the TerraStar activation from the SourcePSN to the Destination PSN.
Parameters
Params_
Type: TTransferTerraStarServiceParams

the request.
eCommerce System.
web service.
SourcePSN string 15 Product Serial Number of the card to transfer the No
subscription from
DestinationPSN string 15 Product Serial Number of the card to transfer the No
subscription to
Nillable?: No
Returns
A value of type TTransferTerraStarServiceReply having the structure defined by the following table.

NovAtelTransactionID int The Transaction ID associated with TerraStar service transfer
68
Returns

SourcePSN string NovAtel card level PSN from which the TerraStar service was transferred
from
DestinationPSN string NovAtel card level PSN from which the TerraStar service was transferred
to
PartNumber string NovAtel part number associated with the transferred TerraStar service
ResponseStatus Response The response status for the TransferTerraStarService request
69
Complex Types: INovAtelPartnerM2Mservice

Description
These Complex types specify the parameters and replies from the associated methods.
Complex Types
Name Description
ArrayofCardServiceCapabilities This array contains a list of TCardServiceCapabilites which provides details on available services
and the card's ability to use each of the services
ArrayOfGPSCardDetail A list of GPS Receiver cards. For enclosure products there will be one entry for each GPS
Receiver within the enclosure.
ArrayOfGPSCardDetailRevB A list of GPS Receiver cards. For enclosure products there will be one entry for each GPS
Receiver within the enclosure. For each GPS Receiver there is ServiceCapabilities array
containing detailed information on each of the available services and the GPS receiver's
capabilities with each of those services.
ArrayOfNovAtelTransactionTypes An array of NovAtel Transaction Types
ArrayOfPACStatusTypes An array of PAC Status Types
ArrayOfRequestTypes An array of Request Types
ArrayOfResponseCodes An array of Response Codes
ArrayOfServiceStatusTypes An array of Service Status Types
ArrayOfServiceTypes An array of Service Types
ArrayOfString An array of Strings
ArrayOfTerraStarPartNumbers A array of the part numbers that can be used to order TerraStar subscriptions.
ArrayOfTerraStarUnitStatus An array of TerraStar Unit Status records
NeCSMetaData This complex data type contains meta data information required for using the service.
NovAtelTransactionTypeDetail Detailed information on a NovAtel Transaction Type
PACStatusTypeDetail Detailed information on the various PAC status types
70
Complex Types
Name Description
RequestTypeDetail A complex data type that provides details on the types of requests.
Response A complex data type that will provide additional status information related to a request
ResponseMetadata A list of Response types that can be returned by the system.
ServiceStatusTypeDetail Detailed information on the various status types for the TerraStar Service
ServiceTypeDetail Detailed information on the various TerraStar Service Types
TArrayOfCouponStatusDetail An array of CouponStatusDetail
TArrayOfEligiblePartNumbers An array of eligible part numbers that is qualified for the promotion
TCardServiceCapabilities Detailed information on an available service and the card's capabilties for using the service.
TCouponStatusDetail Detailed information on the status of a coupon
TEligiblePartNumber An eligible part number
TEnclosureDetail Detailed information regarding the product enclosure (if applicable)
TGetMetaDataParams Parameters used for GetMetaData method
TGetPaidModelNamesParams Parameters for the GetPaidModelNames method
TGetPaidModelNamesReply Reply from the GetPaidModelNames method
TGetPromoStatusParams Parameters for the GetPromoStatus method
TGetPromoStatusReply Reply from the GetPromoStatus method
TGetPSNStatusParams Parameters used for GetPSNStatus method
TGetPSNStatusReply Reply from GetPSNStatus method
TGetPSNStatusRevBParams Parameters used for GetPSNStatusRevB method
TGetPSNStatusRevBReply Reply from GetTerraStarStatusRevB method
TGetTerraStarStatusParams Parameters for GetTerraStarStatus method
TGetTerraStarStatusReply Reply from GetTerraStarStatus method
71
Complex Types
Name Description
TGPSCardDetail Detailed information for a GPS Receiver card.
TGPSCardDetailRevB Detailed information for a GPS Receiver card and the capabilties with each of the available
services.
TPromoDetails Detailed information regarding a NovAtel promotion
TPurchaseTerraStarServiceParams Parameters used for PurchaseTerraStarService method
TPurchaseTerraStarServiceReply Reply from PurchaseTerraStarService method
TPurchaseTerraStarServiceRevBParams Parameters for the PurchaseTerraStarServiceRevB method
TPurchaseTerraStarServiceRevBReply Reply from the PurchaseTerraStarServiceRevB method
TRequestAuthCodeUpdateParams Parameters for the RequestAuthCodeUpdate method
TRequestAuthCodeUpdateReply Reply from the RequestAuthCodeUpdate method
TRequestAuthcodeUpgradeParams Parameters for the RequestAuthCodeUpgrade method
TRequestAuthcodeUpgradeParamsWithIndirectCus Parameters for the RequestAuthCodeUpgradeWithIndirectCustomer method
tomer
TRequestAuthcodeUpgradeReply Reply from the RequestAuthCodeUpgrade method
TRequestAuthcodeUpgradeRevBParams Parameters for the RequestAuthCodeUpgradeRevB method
TRequestAuthcodeUpgradeRevBReply Reply from the RequestAuthCodeUpgrade method
TRequestPreviousAuthCodeParams Parameters for RequestPreviousAuthCode
TRequestPreviousAuthCodeReply Reply from RequestPreviousAuthCode method
TRequestTempAuthCodeParams Parameters for the RequestTempAuthCode method
TRequestTempAuthCodeReply Reply from the RequestTempAuthCode method
TRequestTerraStarResendActivationParams Parameters for RequestTerraStarResendActivation method.
TRequestTerraStarResendActivationReply Reply from RequestTerraStarResendActivation method
TRequestTerraStarTestActivationParams Parameters for RequestTerraStarTestActivation method
72
Complex Types
Name Description
TRequestTerraStarTestActivationReply Reply from RequestTerraStarTestActivation method
TResetDevelopmentPSNParams Parameters for ResetDevelopmentPSN
TResetDevelopmentPSNReply Reply from ResetDevelopmentPSN method
TTerraStarPartNumber A complex type providing details on the individual elements related to a NovAtel Part Number for
TerraStar subscriptions
TTerraStarUnitStatus The TerraStar Status for a specific PSN
TTransferTerraStarServiceParams Parameters for the TransferTerraStarService method
TTransferTerraStarServiceReply Reply from the TransferTerraStarService method
73
Complex Type: ArrayofCardServiceCapabilities
Description
This array contains a list of TCardServiceCapabilites which provides details on available services and the card's ability to use each of the services
Derived By
Restricting Array
74
Complex Type: ArrayOfGPSCardDetail
Description
A list of GPS Receiver cards. For enclosure products there will be one entry for each GPS Receiver within the enclosure.
Derived By
Restricting Array
75
Complex Type: ArrayOfGPSCardDetailRevB
Description
A list of GPS Receiver cards. For enclosure products there will be one entry for each GPS Receiver within the enclosure. For each GPS Receiver
there is ServiceCapabilities array containing detailed information on each of the available services and the GPS receiver's capabilities with each of those
services.
Derived By
Restricting Array
76
Complex Type: ArrayOfNovAtelTransactionTypes
Description
An array of NovAtel Transaction Types
Derived By
Restricting Array
77
Complex Type: ArrayOfPACStatusTypes
Description
An array of PAC Status Types
Derived By
Restricting Array
78
Complex Type: ArrayOfRequestTypes
Description
An array of Request Types
Derived By
Restricting Array
79
Complex Type: ArrayOfResponseCodes
Description
An array of Response Codes
Derived By
Restricting Array
80
Complex Type: ArrayOfServiceStatusTypes
Description
An array of Service Status Types
Derived By
Restricting Array
81
Complex Type: ArrayOfServiceTypes
Description
An array of Service Types
Derived By
Restricting Array
82
Complex Type: ArrayOfString
Description
An array of Strings
Derived By
Restricting Array
83
Complex Type: ArrayOfTerraStarPartNumbers
Description
A array of the part numbers that can be used to order TerraStar subscriptions.
Derived By
Restricting Array
84
Complex Type: ArrayOfTerraStarUnitStatus
Description
An array of TerraStar Unit Status records
Derived By
Restricting Array
85
Complex Type: NeCSMetaData
Description
This complex data type contains meta data information required for using the service.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component Type Size Description

NovAtelTransactionTypes ArrayOfNovAtelTransactionTypes An array of NovAtel Transaction Types
PACStatusTypes ArrayOfPACStatusTypes An array of PAC Status Types
TerraStarPartNumbers ArrayOfTerraStarPartNumbers A list of the various part numbers that can be used to order
TerraStar subscriptions.
ResponseCodes ArrayOfResponseCodes A list of the various response codes that can be returned by the
system
RequestTypes ArrayOfRequestTypes An array of Request Types
ServiceStatusTypes ArrayOfServiceStatusTypes An array of Service Status Types
ServiceTypes ArrayOfServiceTypes An array of Service Types
ResponseStatus Response The response status for the GetMetaData request
Referenced By
Name Type
GetMetaData Method
86
Complex Type: NovAtelTransactionTypeDetail
Description
Detailed information on a NovAtel Transaction Type
Derived By
Restricting anyType
Content Model

NovAtelTransactionTypeValue int The integer value of the NovAtel Transaction Type
NovAtelTransactionTypeCode TNovAtelTransactionType The enumerated value of the NovAtel Transaction Type
Description string 255 The corresponding description of the NovAtel Transaction Type
87
Complex Type: PACStatusTypeDetail
Description
Detailed information on the various PAC status types
Derived By
Restricting anyType
Content Model

PACStatusTypeValue int The integer value of the PACStatus Type
PACStatusCode TPACStatus The enumerated value of the PACStatus Type
Description string 255 The corresponding description of the PACStatusCode
88
Complex Type: RequestTypeDetail
Description
A complex data type that provides details on the types of requests.
Derived By
Restricting anyType
Content Model

RequestTypeValue int The enumerated value of the RequestType
RequestTypeCode TRequestTypes The enumerated value of the RequestType
Description string 255 The corresponding description of the RequestType
89
Complex Type: Response
Description
A complex data type that will provide additional status information related to a request
Derived By
Restricting anyType
Content Model

RequestID int A unique Request ID assigned to each request received by the
system
ResponseCode int The ResponseCode indicates the status of the request.
Details string 255 The corresponding description of the status of the request
90
Complex Type: ResponseMetadata
Description
A list of Response types that can be returned by the system.
Derived By
Restricting anyType
Content Model

ResponseCode int The ResponseCode indicates the status of the request.
ShortDescription string 60 The short description of the ResponseCode
LongDescription string 255 The long description of the ResponseCode
91
Complex Type: ServiceStatusTypeDetail
Description
Detailed information on the various status types for the TerraStar Service
Derived By
Restricting anyType
Content Model

ServiceStatusTypeCodeValue int The integer value of the ServiceStatusType
ServiceStatusTypeCode TServiceStatus The enumerated value of the ServiceStatusTypeCode
Description string 255 The corresponding description of the ServiceStatusType
92
Complex Type: ServiceTypeDetail
Description
Detailed information on the various TerraStar Service Types
Derived By
Restricting anyType
Content Model

ServiceTypeCodeValue int The integer value of the ServiceTypeCode
ServiceTypeCode TServiceType The enumerated value of the ServiceTypeCode
Description string 255 The corresponding description of the ServiceTypeCode
93
Complex Type: TArrayOfCouponStatusDetail
Description
An array of CouponStatusDetail
Derived By
Restricting Array
94
Complex Type: TArrayOfEligiblePartNumbers
Description
An array of eligible part numbers that is qualified for the promotion
Derived By
Restricting Array
95
Complex Type: TCardServiceCapabilities
Description
Detailed information on an available service and the card's capabilties for using the service.
Derived By
Restricting anyType
Content Model

ServiceCode string 10 The ServiceCode for the Service
ServiceDescription string 60 The description of the Service
HWCapable boolean A boolean field indicating whether or not the card is capable for the
service
ModelCapable boolean A boolean field indicating whether or not the card's paid model is
capable for the service
ServiceCapable boolean A boolean field indicating whether or not the card and the paid
model are capable for the service
ServiceCapabilityDetails string 255 A string that describes the current service capabilities for the card
specified by PSN
96
Complex Type: TCouponStatusDetail
Description
Detailed information on the status of a coupon
Derived By
Restricting anyType
Content Model

CouponStatus TCouponStatusType
StatusDescription string
CouponCount int
97
Complex Type: TEligiblePartNumber
Description
An eligible part number
Derived By
Restricting anyType
Content Model

PartNumber string 30 An eligible part number
98
Complex Type: TEnclosureDetail
Description
Detailed information regarding the product enclosure (if applicable)
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of the Enclosure
Description string 40 A description of the enclosure
HWRevision string 10 The Hardware version for the enclosure
WarrantyExpiry dateTime The Warranty Expiration for the enclosure
99
Complex Type: TGetMetaDataParams
Description
Parameters used for GetMetaData method
Derived By
Restricting anyType
Content Model

VisitorID int Customer unique identification number originating the request.
CustNumb string 7 Associated customer number in the NovAtel eCommerce System.
Password string 40 Customer unique password required to use the web service.
Referenced By
Name Type
GetMetaData Method
100
Complex Type: TGetPaidModelNamesParams
Description
Parameters for the GetPaidModelNames method
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of card to request the paid model
Referenced By
Name Type
GetPaidModelNames Method
101
Complex Type: TGetPaidModelNamesReply
Description
Reply from the GetPaidModelNames method
Derived By
Restricting anyType
Content Model

PaidModels ArrayOfString An array of Paid Models for the specified PSN
ResponseStatus Response The response status for the GetPaidModelNames request
Referenced By
Name Type
GetPaidModelNames Method
102
Complex Type: TGetPromoStatusParams
Description
Parameters for the GetPromoStatus method
Derived By
Restricting anyType
Content Model

PromoPartNumber string 30 Promotional Part Number
Referenced By
Name Type
GetPromoStatus Method
103
Complex Type: TGetPromoStatusReply
Description
Reply from the GetPromoStatus method
Derived By
Restricting anyType
Content Model

PromoDetails TPromoDetails Details regarding the NovAtel promotion
CouponStatus TArrayOfCouponStatusDetail An arracy of CouponStatusDetail records
CouponsGenerated int The total number of coupons generated
ResponseStatus Response The response status for the GetPromoStatus request
Referenced By
Name Type
GetPromoStatus Method
104
Complex Type: TGetPSNStatusParams
Description
Parameters used for GetPSNStatus method
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of card to request the status information
for. The PSN is case sensitive.
Referenced By
Name Type
GetPSNStatus Method
105
Complex Type: TGetPSNStatusReply
Description
Reply from GetPSNStatus method
Derived By
Restricting anyType
Content Model

GPSReceivers ArrayOfGPSCardDetail An array of GPS Receiver card details. For enclosure products
there will be one entry for each GPS Receiver within the enclosure
ResponseStatus Response The response status for the GetPSNStatus request
Referenced By
Name Type
GetPSNStatus Method
106
Complex Type: TGetPSNStatusRevBParams
Description
Parameters used for GetPSNStatusRevB method
Derived By
Restricting anyType
Content Model

VisitorID int Customer unique identification number originating
the request.
PSN string 15 Product Serial Number of card to request the status information
for. The PSN is case sensitive.
Referenced By
Name Type
GetPSNStatusRevB Method
107
Complex Type: TGetPSNStatusRevBReply
Description
Reply from GetTerraStarStatusRevB method
Derived By
Restricting anyType
Content Model

GPSReceivers ArrayOfGPSCardDetailRevB An array of GPS Receiver card details. For enclosure products
there will be one entry for each GPS Receiver within the enclosure.
For each GPS Receiver there will also be a seperate entry for each
of the available services that indicates the receiver's capability with
the service.
ResponseStatus Response The response status for the GetPSNStatusRevB request.
Referenced By
Name Type
GetPSNStatusRevB Method
108
Complex Type: TGetTerraStarStatusParams
Description
Parameters for GetTerraStarStatus method
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number to request the TerraStar Subscription
Status. The PSN is case sensitive.
Referenced By
Name Type
GetTerraStarStatus Method
109
Complex Type: TGetTerraStarStatusReply
Description
Reply from GetTerraStarStatus method
Derived By
Restricting anyType
Content Model

UnitStatusRecords ArrayOfTerraStarUnitStatus An array of TerraStarUnitStatus records for the specified PSN
ResponseStatus Response The response status for the GetTerraStarStatus request
Referenced By
Name Type
GetTerraStarStatus Method
110
Complex Type: TGPSCardDetail
Description
Detailed information for a GPS Receiver card.
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of the GPS card
Description string 40 A description of the GPS card
PAC string 20 The TerraStar Product Activation Code for the card specified by
PSN
HWRevision string 10 The Hardware version for the card for the card specified by PSN
PaidModel string 20 The Paid Model for the card specified by PSN
TerraStarCapable boolean A boolean value indicating whether the card is TerraStar ready
TerraStarDetails string 255 A string that describes the current TerraStar capabilities for the
card specified by PSN
WarrantyExpiry dateTime The receiver's Warranty Expiration for the card specified by PSN
111
Complex Type: TGPSCardDetailRevB
Description
Detailed information for a GPS Receiver card and the capabilties with each of the available services.
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of the GPS card
Description string 40 A description of the GPS card
PAC string 20 The TerraStar Product Activation Code for the card specified by
PSN
HWRevision string 10 The Hardware version for the card for the card specified by PSN
PaidModel string 20 The Paid Model for the card specified by PSN
WarrantyExpiry dateTime The receiver's Warranty Expiration for the card specified by PSN
ServiceCapabilies ArrayofCardServiceCapabilities An array containing an entry for each of the available services
which provides detailed information for the capabilites of the card
and paid model with the service.
112
Complex Type: TPromoDetails
Description
Detailed information regarding a NovAtel promotion
Derived By
Restricting anyType
Content Model

PromoName string 60 Unique identifier of the promotion being offered.
PromoDescription string 60 Description of the promotion
PromoStartDate dateTime Date that the promotion starts
PromoEndDate dateTime Date that the promotion ends
PromoPartNumber string 30 Promotional Part Number that should be used to redeem
promotional coupons
CouponValidityPeriod int The number of days that the coupon is valid from the date of the
hardware shipment.
EligiblePartNumbers TArrayOfEligiblePartNumbers An array of eligible part numbers that is qualified for the promotion
113
Complex Type: TPurchaseTerraStarServiceParams
Description
Parameters used for PurchaseTerraStarService method
Derived By
Restricting anyType
Content Model

PSN string 15 NovAtel Product Serial Number (PSN) of the specific receiver card
or enclosure for which the service is purchased. The PSN is case
sensitive.
PartNumber string 30 NovAtel part number that describes the purchased service
RequestType TRequestTypes Specifies the type of transaction to process (i.e. quote or order).
See TRequestTypes for valid enumerations and associated
definition.
114
Content Model

ServiceLocationLatitude decimal Specifies the nominal service location (center) in latitude (specified
in WGS-84 standard). Latitude shall be specified in degrees and
fraction of degrees and between 90 degrees (A plus sign (+)
denotes Northern hemisphere or the equator, and a minus sign (-)
denotes Southern hemisphere).
For Global part numbers, this parameter will be ignored.

ServiceLocationLongitude decimal Specifies the nominal service location (center) in longitude
(specified in WGS-84 standard). Longitude shall be specified in
degrees and fraction of degrees and between 180 degrees (A
plus sign (+) denotes east longitude or the prime meridian, and a
minus sign (-) denotes west longitude or 180 meridian i.e.
opposite of the prime meridian).

ImmediateActivation boolean Specifies the commencement of purchased service. Set to True if
purchased service should start immediately or False for
scheduled service start date and time.

REQUEST_ORDER_NEW_OR_RENEW and an active service
(SERVICE_ACTIVE or SERVICE_EXPIRING) is found for the
associated PSN then this parameter will be ignored and the new
contract will be scheduled to start at the ServiceEndDate of the
exisiting contract.
115
Content Model

ScheduledServiceStartDateTime dateTime The date and time that the TerraStar service should be activated in
UTC Z format (i.e. 2014-12-31T13:00:00Z). Required if
ImmediateActivation is set to False otherwise set to Null.

REQUEST_ORDER_NEW_OR_RENEW and an active service
(SERVICE_ACTIVE or SERVICE_EXPIRING) is found for the
associated PSN then this parameter will be ignored and the new
contract will be scheduled to start at the ServiceEndDate of the
exisiting contract.
The date/time must be a valid date/time and not before the current
UTC time plus 5 minutes and within 90 days of the current UTC
date/time. For example, if the current UTC datetime is
2015-06-09T14:00:00 HRS then any date/time before
2015-06-09T14:05:00 HRS and after 2015-09-07T14:00:00 HRS
will be rejected. If you are trying to schedule an activation within 5
minutes of the current UTC it is suggested that you set
ImmediateActivation to True to avoid this rejection.
CustomerPurchaseOrderReferenc string 25 Customer purchase order reference or number associated with this
e purchase request.
IndirectCustomerName string 50 An optional field that can be used by NovAtel customer to record
information about their customer.
IndirectCustomerReference string 50 An optional field that can be used by the Partner to record
CustomerNotes string 255 An optional field that can be used to record notes related to this
transaction.
116
Referenced By
Name Type
PurchaseTerraStarService Method
117
Complex Type: TPurchaseTerraStarServiceReply
Description
Reply from PurchaseTerraStarService method
Derived By
Restricting anyType
Content Model

PSN string 15 The Product Serial Number of the NovAtel GPS card that the
EnclosurePSN string 15 The PSN of the enclosure (if applicable).
NovAtelPriceCurrency string 3 The ISO 4217 currency code associated with the price or, if the
ResponseStatus Response The response status for the PurchaseTerraStarService request
118
Referenced By
Name Type
PurchaseTerraStarService Method
119
Complex Type: TPurchaseTerraStarServiceRevBParams
Description
Parameters for the PurchaseTerraStarServiceRevB method
Derived By
Restricting anyType
Content Model

or enclosure for which the service is purchased. The PSN is case
sensitive.
RequestType TRequestTypes Specifies the type of transaction to process (i.e. quote or order).
definition.
120
Content Model

ServiceLocationLatitude decimal Specifies the nominal service location (center) in latitude (specified
in WGS-84 standard). Latitude shall be specified in degrees and

ServiceLocationLongitude decimal Specifies the nominal service location (center) in longitude
(specified in WGS-84 standard). Longitude shall be specified in
degrees and fraction of degrees and between 180 degrees (A
plus sign (+) denotes east longitude or the prime meridian, and a
minus sign (-) denotes west longitude or 180 meridian i.e.
opposite of the prime meridian).

ImmediateActivation boolean Specifies the commencement of purchased
121
Content Model

ScheduledServiceStartDateTime dateTime The date and time that the TerraStar service
2014-12-31T13:00:00Z). Required if
to Null.
rejection.
CustomerPurchaseOrderReferenc string 50 Customer purchase order reference or number
e associated with this purchase request.
IndirectCustomerName string 50 An optional field that can be used by NovAtel
customer.
IndirectCustomerReference string 50 An optional field that can be used by the Partner to
CustomerNotes string 255 An optional field that can be used to record notes
122
Referenced By
Name Type
PurchaseTerraStarServiceRevB Method
123
Complex Type: TPurchaseTerraStarServiceRevBReply
Description
Reply from the PurchaseTerraStarServiceRevB method
Derived By
Restricting anyType
Content Model

PSN string 15 The Product Serial Number of the NovAtel GPS card that the
NovAtelListPrice double NovAtel list price associated with the purchased service.
DiscountPercentage double Discount Percentage applied (if applicable)
124
Content Model

ResponseStatus Response The response status for the PurchaseTerraStarServiceRevB
request
Referenced By
Name Type
PurchaseTerraStarServiceRevB Method
125
Complex Type: TRequestAuthCodeUpdateParams
Description
Parameters for the RequestAuthCodeUpdate method
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of card to request the authorization code
update for. The PSN is case sensitive.
OSN string 20 Product's Optional Subscription Number. This is a secondary
validation field for the PSN and is only required on cards that have
an 11 character PSN.
SWVersion string 15 Software Version to generate authorization code for. For products
that support signature authorization codes you can "SIGNATURE"
as the software version.
Referenced By
Name Type
RequestAuthcodeUpdate Method
126
Complex Type: TRequestAuthCodeUpdateReply
Description
Reply from the RequestAuthCodeUpdate method
Derived By
Restricting anyType
Content Model

AuthCode string 80 A unique authorization code allowing the specified PSN to operate
with the specified model and software version.
ResponseStatus Response The response status for the RequestAuthCodeUpdate request
Referenced By
Name Type
RequestAuthcodeUpdate Method
127
Complex Type: TRequestAuthcodeUpgradeParams
Description
Parameters for the RequestAuthCodeUpgrade method
Derived By
Restricting anyType
Content Model

If you specify the Product Serial Number of an enclosure the

service will attempt to locate the PSN of the upgradeable GPS
card within that enclosure. In most cases this will be succesful,
however in some cases there may be more that one upgradeable
GPS card within the enclosure and in those cases the request will
be rejected. An error code will be return suggesting that you call
GetPSNStatus to determine which of the enclosure's GPS cards
that you want to upgrade.
128
Content Model

validation field for the PSN and is typically only suggested for use
with GPS cards that have an 11 character PSN. The 13 character
PSNs include a check digit so the OSN is not required.
Caution: The service will only validate the OSN if it is not null. If
you choose to not use the optional secondary validation for 11
character PSNs then you will be responsible for any authorization
codes purchased.
PartNumber string 30 Marketing Name Part Number to upgrade to eg.
OEM615-D2S-B0G-550
RequestType TRequestTypes Specifies the type of transaction to process (REQUEST_QUOTE
or REQUEST_ORDER).
definition.
CustomerPurchaseOrderReferenc string 25 Customer purchase order reference or number associated with this
e purchase request.
CustomerNotes string 255 An optional field that can be used to record notes related to this
transaction
Referenced By
Name Type
RequestAuthcodeUpgrade Method
129
Complex Type: TRequestAuthcodeUpgradeParamsWithIndirectCustomer
Description
Parameters for the RequestAuthCodeUpgradeWithIndirectCustomer method
Derived By
Restricting anyType
Content Model

however in some cases there may be more that one
upgradeable GPS card within the enclosure and in those cases the
request will be rejected. An error code will be return suggesting
that you call GetPSNStatus to determine which of the enclosure's
GPS cards that you want to upgrade.
130
Content Model

codes purchased.
OEM615-D2S-B0G-550
or REQUEST_ORDER). Any other RequestType will be rejected.
definitions.
IndirectCustomerName string 50 An optional field that can be used by NovAtel customer to record
131
Referenced By
Name Type
RequestAuthcodeUpgradeWithIndirectCustomer Method
132
Complex Type: TRequestAuthcodeUpgradeReply
Description
Reply from the RequestAuthCodeUpgrade method
Derived By
Restricting anyType
Content Model

Amount double Customer unit price associated with the authorization code
upgrade.
AuthCode string 80 If successful, this field will contain a unique authorization code
software version.
Currency string 3 The ISO 4217 currency code associated with the price or, if the
FromModel string 20 The original Paid Model of the GPS card.
ToModel string 20 The Paid Model that the GPS card will be updated to if
has been upgraded to if REQUEST_ORDER is specified
PSN string 15 The Product Serial Number of the card that the authorization code
will upgrade.
EnclosurePSN string 15 The Product Serial Number of the enclosure (if applicable).
133
Referenced By
Name Type
RequestAuthcodeUpgrade Method
RequestAuthcodeUpgradeWithIndirectCustomer Method
134
Complex Type: TRequestAuthcodeUpgradeRevBParams
Description
Parameters for the RequestAuthCodeUpgradeRevB method
Derived By
Restricting anyType
Content Model


however in some cases there may be more that one upgradeable
GPS card within the enclosure and in those cases the request will
be rejected. An error code will be return suggesting that you call
GetPSNStatus to determine which of the enclosure's GPS cards
that you want to upgrade.
135
Content Model

codes purchased.
OEM615-D2S-B0G-550
or REQUEST_ORDER).
definition.
IndirectCustomerName string 50 An optional field that can be used by the Partner to record
136
Referenced By
Name Type
RequestAuthcodeUpgradeRevB Method
137
Complex Type: TRequestAuthcodeUpgradeRevBReply
Description
Reply from the RequestAuthCodeUpgrade method
Derived By
Restricting anyType
Content Model

software version.
NovAtelUnitPrice double Customer unit price associated with the authorization code
upgrade.
NovAtelListPrice double The NovAtel list price associated with the authorization code
upgrade.
FromModel string 20 The original paid model of the GPS card.
ToModel string 20 The Paid Model that the GPS card will be updated to if
has been upgraded to if REQUEST_ORDER is specified.
PSN string 15 The Product Serial Number of the card that the authorization code
will upgrade.
ResponseStatus Response The response status for the RequestAuthCodeUpgradeRevB
request
138
Referenced By
Name Type
RequestAuthcodeUpgradeRevB Method
139
Complex Type: TRequestPreviousAuthCodeParams
Description
Parameters for RequestPreviousAuthCode
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of card to request the previous
authorization code for. The PSN is case sensitive.
SWVersion string 15 Software Version to generate authorization code for.
Model string 15 Previous Paid Model to request authorization code for.
Referenced By
Name Type
RequestPreviousAuthCode Method
140
Complex Type: TRequestPreviousAuthCodeReply
Description
Reply from RequestPreviousAuthCode method
Derived By
Restricting anyType
Content Model

AuthCode string 80 A unique authorization code allowing the specified PSN to operate
with the specified model and software version.
ResponseStatus Response The response status for the RequestPreviousAuthCode request
Referenced By
Name Type
RequestPreviousAuthCode Method
141
Complex Type: TRequestTempAuthCodeParams
Description
Parameters for the RequestTempAuthCode method
Derived By
Restricting anyType
Content Model

the request.
CustNumb string 7 Associated customer number in the NovAtel
eCommerce System.
Password string 40 Customer unique password required to use the
web service.
PSN string 15 Product Serial Number of card to request the
sensitive.
OSN string 20 Product's Optional Subscription Number. This is a
secondary validation field for the PSN and is typically only
required on cards that have an 11 character PSN. If this field is
specified then the OSN is checked to ensure that it matches the
OSN of the PSN specifed.
SWVersion string 15 Software Version to generate authorization code
software version.
Model string 20 The model to generate the temporary auth code for.
142
Content Model

Duration int The number of days to request a temporary authorization code for
Referenced By
Name Type
RequestTempAuthCode Method
143
Complex Type: TRequestTempAuthCodeReply
Description
Reply from the RequestTempAuthCode method
Derived By
Restricting anyType
Content Model

PSN string 15 The Product Serial Number of the card that the temporary
authorization code
was generated for.
Model string 20 The model that will be enabled by the AuthCode.
software version.
AuthCodeStartDate dateTime The Start Date of the temporary authorization code in UTC-Z
format.
AuthCodeStopDate dateTime The Stop Date of the temporary authorization code in UTC-Z
format
ResponseStatus Response The response status for the RequestTempAuthCode request.
Referenced By
Name Type
RequestTempAuthCode Method
144
Complex Type: TRequestTerraStarResendActivationParams
Description
Parameters for RequestTerraStarResendActivation method.
Derived By
Restricting anyType
Content Model

or enclosure associated with the service for which the activation
resend is requested. The PSN is case sensitive.
Referenced By
Name Type
RequestTerraStarResendActivation Method
145
Complex Type: TRequestTerraStarResendActivationReply
Description
Reply from RequestTerraStarResendActivation method
Derived By
Restricting anyType
Content Model

ResponseStatus Response The response status for the RequestTerraStarResendActivation
request.
Referenced By
Name Type
RequestTerraStarResendActivation Method
146
Complex Type: TRequestTerraStarTestActivationParams
Description
Parameters for RequestTerraStarTestActivation method
Derived By
Restricting anyType
Content Model

or enclosure for which the test service is requested. The PSN is
case sensitive.
PartNumber string 30 NovAtel part number that describes the requested test service (i.e.
TSD-GL-TEST-3DY). Should be a valid test part number that is
supported by NovAtel and is provided as part of Meta Data.
ImmediateActivation boolean Specifies the commencement of purchased service. Set to True if
purchased service should start immediately or False for
scheduled service start date and time.
147
Content Model

ScheduledServiceStartDateTime dateTime Specifies the start time (year, month, day, and hour) at which the
test service should start. Required if ImmediateActivation is set to
False otherwise set to Null. Should be specified in UTC Z
format (i.e. 2014-12-31T13:00:00Z).
The date/time must be a valid date/time and not before the current
UTC time plus 5 minutes and within 90 days of the current UTC
date/time. For example, if the current UTC datetime is
2015-06-09T14:00:00 HRS then any date/time before
2015-06-09T14:05:00 HRS and after 2015-09-07T14:00:00 HRS
will be rejected. If you are trying to schedule an activation within 5
minutes of the current UTC it is suggested that you set
ImmediateActivation to True to avoid this rejection.
CustomerNotes string 255 Optional field that can be used by NovAtel customer to record
notes related to this transaction.
Referenced By
Name Type
RequestTerraStarTestActivation Method
148
Complex Type: TRequestTerraStarTestActivationReply
Description
Reply from RequestTerraStarTestActivation method
Derived By
Restricting anyType
Content Model

NovAtelTransactionID int The Transaction ID for this transaction
or enclosure corresponding to the purchased service.
PartNumber string 30 NovAtel's TerraStar Part Number that uniquely describes the
purchased service.
ResponseStatus Response The response status for the RequestTerraStarTestActivation
request
Referenced By
Name Type
RequestTerraStarTestActivation Method
149
Complex Type: TResetDevelopmentPSNParams
Description
Parameters for ResetDevelopmentPSN
Derived By
Restricting anyType
Content Model

PSN string 15 Product Serial Number of card to reset the Paid Model for. This
PSN MUST be registered with NovAtel Technical Services as an
E-commerce development PSN. The PSN is case sensitive.
ResetType TDevelopmentResetTypes The type of Reset requested
NewModel string 20 The model to set the Paid Model to for the specified PSN. This is
only required when the ResetType is set to
RESET_PAID_MODEL.
Referenced By
Name Type
ResetDevelopmentPSN Method
150
Complex Type: TResetDevelopmentPSNReply
Description
Reply from ResetDevelopmentPSN method
Derived By
Restricting anyType
Content Model

ResponseStatus Response The response status for the ResetDevelopmentPSN request
Referenced By
Name Type
ResetDevelopmentPSN Method
151
Complex Type: TTerraStarPartNumber
Description
A complex type providing details on the individual elements related to a NovAtel Part Number for TerraStar subscriptions
Derived By
Restricting anyType
Content Model

PartNumber string 30 NovAtel part number that can be used to order TerraStar
subscriptions
ServiceName string 60 TerraStar service name (or level) associated with the part number
(i.e. TerraStarC, TerraStarL)
ServiceRegion string 60 TerraStar service coverage associated with the part number (i.e.
regional, global)
ServiceApplication string 30 End user application associated with the part number (i.e.
agriculture, land, airborne, test service).
ServiceDuration string 30 TerraStar service duration associated with the part number (i.e.
5DY, 1MO, 1YR).
152
Complex Type: TTerraStarUnitStatus
Description
The TerraStar Status for a specific PSN
Derived By
Restricting anyType
Content Model

whose TerraStar Status is requested.
EnclosurePSN string 15 NovAtel Product Serial Number (PSN) of the specific enclosure
whose TerraStar Status is requested.
PAC string 20 TerraStar Product Activation Code (PAC) of the specific receiver
card or enclosure whose TerraStar Status is requested.
PACStatus TPACStatus TerraStar PAC status of the receiver card or enclosure at the time
of the request.
ServiceStatus TServiceStatus TerraStar service status of the receiver card or enclosure at the
time of the request. Will be Null for test service.
ServiceType TServiceType 60 TerraStar service type associated with the service at the time of
the request.
PartNumber string 30 NovAtel part number associated with the service at the time of the
request (Name/Region/Application/Duration, i.e.
TSD-GL-AR-1YR).
ContractNumber long TerraStar contract number associated with the purchased service
at the time of the request. Will be Null for test service.
ServiceDuration string 30 Duration corresponding to the associated service.
153
Content Model

ServiceStartDateTime dateTime Start date and time corresponding to the associated service
specified in UTC Z format (i.e. 2014-12-26T13:00:00Z).
ServiceEndDateTime dateTime End date and time corresponding to the associated service
specified in UTC Z format (i.e. 2014-12-30T13:00:00Z).
ServiceName string 60 TerraStar service name (i.e. TerraStarD, TerraStarC)
ServiceCoverage string 60 Geographic coverage associated with the service at the time of the
request.
ServiceBeams ArrayOfString TerraStar satellite beams (name) associated with service.
ServiceApplication string 30 End use application (market) associated with service.
ServiceLocationLatitude decimal Latitude of the nominal service location provided at the time of
service request. Specified in WGS-84 standard in degrees and
ServiceLocationLongitude decimal Longitude of the nominal service location provided at the time of
service request. Specified in WGS-84 standard in degrees and
denotes east longitude or the prime meridian, and a minus sign (-)
denotes west longitude or 180 meridian i.e. opposite of the prime
meridian).
NovAtelTransactionDate dateTime NovAtel date and time of transaction corresponding to the
associated service request specified in UTC Z format (i.e.
2014-11-30T13:00:00Z).
NovAtelTransactionType TNovAtelTransactionType Transaction type associated with the service at the time of this
request (i.e. purchase, renew, test)
NovAtelUnitPrice double Customer unit price associated with the purchased service. Will be
Null for test service.
154
Content Model

NovAtelPriceCurrency string 3 Customer price currency (code) associated with the purchased
service. Will be Null for test service.
CustomerPurchaseOrderReferenc string 50 Customer purchase order reference or number associated with the
e purchased service. Will be Null for test service.
IndirectCustomerName string 50 Customer supplied indirect customer name associated with the
purchased service. Will be Null for test service.
IndirectCustomerReference string 50 Customer supplied indirect customer reference or number
associated with the purchased service. Will be Null for test
service.
CustomerNotes string 255 Customer supplied notes at the time of service request.
155
Complex Type: TTransferTerraStarServiceParams
Description
Parameters for the TransferTerraStarService method
Derived By
Restricting anyType
Content Model

the request.
CustNumb string 7 Associated customer number in the NovAtel
eCommerce System.
Password string 40 Customer unique password required to use the
web service.
SourcePSN string 15 Product Serial Number of the card to transfer the subscription from
DestinationPSN string 15 Product Serial Number of the card to transfer the subscription to
Referenced By
Name Type
TransferTerraStarService Method
156
Complex Type: TTransferTerraStarServiceReply
Description
Reply from the TransferTerraStarService method
Derived By
Restricting anyType
Content Model

NovAtelTransactionID int The Transaction ID associated with TerraStar service transfer
SourcePSN string 15 NovAtel card level PSN from which the TerraStar service was
transferred from
DestinationPSN string 15 NovAtel card level PSN from which the TerraStar service was
transferred to
PartNumber string 30 NovAtel part number associated with the transferred TerraStar
service
ResponseStatus Response The response status for the TransferTerraStarService request
Referenced By
Name Type
TransferTerraStarService Method
157
Simple Types: INovAtelPartnerM2Mservice

Description
Simple enumerated types that define various types used in the system
Simple Types
Name Description
TCouponStatusType This type is used to indicate the Coupon Status
TDevelopmentResetTypes This type is used to specify the type of development reset
TNovAtelTransactionType This type defines the NovAtel Transaction Type
TPACStatus This type is used to indicate the status of the PAC
TRequestTypes This type is used to specify the type of transaction to process.
TServiceStatus This type is used to specify the TerraStar Service Status
TServiceType This type is used to specify the TerraStar Service Type
158
Simple Type: TCouponStatusType
Description
This type is used to indicate the Coupon Status
Derived By
Restricting string
Enumeration
DEFINE Value Description

COUPON_UNKNOWN 0 Coupon Status is unknown
COUPON_ACTIVE 1 Coupon is available for redemption
COUPON_EXPIRING 2 Coupon is available for redemption but will be expiring soon
COUPON_EXPIRED 3 Coupon has expired
COUPON_REDEEMED 4 Coupon has been redeemed
COUPON_CANCELLED 5 Coupon has been cancelled
159
Simple Type: TDevelopmentResetTypes
Description
This type is used to specify the type of development reset
Derived By
Restricting string
Enumeration

RESET_PAID_MODEL 0 Requests that the Paid Model for the specified receiver is set to the specified
new model
RESET_TERRASTAR_CONTRACTS 1 Requests that the reset of the TerraStar contracts associated with the
specified PSN be reset to a known state.
160
Simple Type: TNovAtelTransactionType
Description
This type defines the NovAtel Transaction Type
Derived By
Restricting string
Enumeration

TYPE_TEST_ACTIVATION 0 Transaction is for test service
TYPE_STD_PURCHASE 1 Transaction is for standard contract purchase
TYPE_STD_RENEWAL 2 Transaction is for standard contract renewal
TYPE_STD_UPGRADE 3 Transaction is for standard contract upgrade
TYPE_MNGD_PURCHASE 4 Transaction is for Managed PAC purchase
TYPE_MNGD_RENEWAL 5 Transaction is for Managed PAC renewal
161
Simple Type: TPACStatus
Description
This type is used to indicate the status of the PAC
Derived By
Restricting string
Enumeration

PAC_ACTIVATED 0 TerraStar Service is enabled for the unit identified by the PAC
PAC_DEACTIVATED 1 TerraStar Service is disabled for the unit identified by the PAC
PAC_ARCHIVED 2 The unit identified by the PAC is archived to stop TerraStar Service
162
Simple Type: TRequestTypes
Description
This type is used to specify the type of transaction to process.
Derived By
Restricting string
Enumeration

REQUEST_QUOTE 0 Requests a quotation price after validating all request parameters
REQUEST_ORDER 1 Validates all parameters and then places an order for the specifed request for
a NEW service.
REQUEST_ORDER_NEW_OR_RENEW 2 Validates all parameters and then places an order for a NEW service or
RENEWAL of existing service. See PurchaseTerraStarService for more
information.
163
Simple Type: TServiceStatus
Description
This type is used to specify the TerraStar Service Status
Derived By
Restricting string
Enumeration

SERVICE_PENDING 0 Service is pending (for scheduled service start date)
SERVICE_ACTIVE 1 Service Status is active
SERVICE_EXPIRING 2 Service will be expiring soon and can now be renewed
SERVICE_EXPIRED 3 Service expired
SERVICE_UNKNOWN 4 Service Status is unknown
SERVICE_CANCELLED 5 Service has been cancelled
164
Simple Type: TServiceType
Description
This type is used to specify the TerraStar Service Type
Derived By
Restricting string
Enumeration

SERVICE_TYPE_UNKNOWN 0 An unknown service An unknown service was returned from TerraStar
SERVICE_TYPE_TEST 1 Test Service
SERVICE_TYPE_TERMED_STD 2 Standard Service with termed duration
SERVICE_TYPE_TERMED_PAYG 3 PAYG Service with termed duration
SERVICE_TYPE_TERMED_MNGD 4 Termed Duration with a Managed PAC
165
Index
Definitions, Acronyms and Abreviations 11

A
ArrayofCardServiceCapabilities 74 G
ArrayOfGPSCardDetail 75 GetMetaData 20
ArrayOfGPSCardDetailRevB 76 GetPaidModelNames 22
ArrayOfNovAtelTransactionTypes 77 GetPromoStatus 23
ArrayOfPACStatusTypes 78 GetPSNStatus 24
ArrayOfRequestTypes 79 GetPSNStatusRevB 26
ArrayOfResponseCodes 80 GetTerraStarStatus 28
ArrayOfServiceStatusTypes 81
ArrayOfServiceTypes 82 I
ArrayOfString 83 Initial Customer Setup 9
ArrayOfTerraStarPartNumbers 84 INovAtelPartnerM2Mservice 12
ArrayOfTerraStarUnitStatus 85 Intended Audience 7
Introduction Section 2
C
Complex Types 70 L
Customer Service 8 Legal 6
D M
Methods 13
166
Response 90
N ResponseMetadata 91
NeCSMetaData 86
NovAtel E-Commerce Web Services 1 S

NovAtelTransactionTypeDetail 87 ServiceStatusTypeDetail 92
ServiceTypeDetail 93
P Simple Types 158
PACStatusTypeDetail 88
PurchaseTerraStarService 29 T
PurchaseTerraStarServiceRevB 34 TArrayOfCouponStatusDetail 94
TArrayOfEligiblePartNumbers 95
R TCardServiceCapabilities 96
References 10 TCouponStatusDetail 97
RequestAuthcodeUpdate 41 TCouponStatusType 159
RequestAuthcodeUpgrade 43 TDevelopmentResetTypes 160
RequestAuthcodeUpgradeRevB 48 TEligiblePartNumber 98
RequestAuthcodeUpgradeWithIndirectCusto 52 TEnclosureDetail 99
mer
TestConnection 67
RequestPreviousAuthCode 56
TGetMetaDataParams 100
RequestTempAuthCode 58
TGetPaidModelNamesParams 101
RequestTerraStarResendActivation 60
TGetPaidModelNamesReply 102
RequestTerraStarTestActivation 62
TGetPromoStatusParams 103
RequestTypeDetail 89
TGetPromoStatusReply 104
ResetDevelopmentPSN 65
TGetPSNStatusParams 105
167
TGetPSNStatusReply 106 TRequestAuthcodeUpgradeRevBReply 138
TGetPSNStatusRevBParams 107 TRequestPreviousAuthCodeParams 140
TGetPSNStatusRevBReply 108 TRequestPreviousAuthCodeReply 141
TGetTerraStarStatusParams 109 TRequestTempAuthCodeParams 142
TGetTerraStarStatusReply 110 TRequestTempAuthCodeReply 144
TGPSCardDetail 111 TRequestTerraStarResendActivationParams 145
TGPSCardDetailRevB 112 TRequestTerraStarResendActivationReply 146
TNovAtelTransactionType 161 TRequestTerraStarTestActivationParams 147
TPACStatus 162 TRequestTerraStarTestActivationReply 149
TPromoDetails 113 TRequestTypes 163
TPurchaseTerraStarServiceParams 114 TResetDevelopmentPSNParams 150
TPurchaseTerraStarServiceReply 118 TResetDevelopmentPSNReply 151
TPurchaseTerraStarServiceRevBParams 120 TServiceStatus 164
TPurchaseTerraStarServiceRevBReply 124 TServiceType 165
TransferTerraStarService 68 TTerraStarPartNumber 152
TRequestAuthCodeUpdateParams 126 TTerraStarUnitStatus 153
TRequestAuthCodeUpdateReply 127 TTransferTerraStarServiceParams 156
TRequestAuthcodeUpgradeParams 128 TTransferTerraStarServiceReply 157
TRequestAuthcodeUpgradeParamsWithIndir 130
ectCustomer
V
TRequestAuthcodeUpgradeReply 133
Version History 3
TRequestAuthcodeUpgradeRevBParams 135
168

D19536 NovAtel Partner E-Commerce Web Service API R0W

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

D19536 NovAtel Partner E-Commerce Web Service API R0W

Uploaded by

Copyright:

Available Formats

E-Commerce API Specification

NovAtel / Partner Web Service Interface

NovAtel E-Commerce Web Services......................................................................................................................................................................................... 1

D19536 Rev: 0W *** PRELIMINARY - SUBJECT TO CHANGE ***

D19536 Rev: 0W *** PRELIMINARY - SUBJECT TO CHANGE ***

D19536 Rev: 0W *** PRELIMINARY - SUBJECT TO CHANGE ***

D19536 Rev: 0W *** PRELIMINARY - SUBJECT TO CHANGE ***

NovAtel E-Commerce Web Services

NovAtel E-Commerce Web Services

Query information regarding a particular product

Request Authorization Codes for product

Purchase, renew or start a trial TerraStar Subscription

API development support functions

- Resetting a development PSN top a known model for testing purpose

Querying the status of any NovAtel Promotions that may be offerred

Rev Date Description Author

Rev Date Description Author

Modified PurchaseTerraStarService to use new REQUEST_ORDER_NEW_OR_RENEW

Removed RenewTerraStarService as this functionality is now incorporated in the

Removed deprecated RequestTerraStarSalesTransactions

0N 2015-06-25 Added additional fields to TRequestAuthCodeUpdateReply Al Sisson

Added documentation for new GetPSNStatusRevB method.

Rev Date Description Author

This document is intended for limited circulation.

Copyright NovAtel Inc. (2014-2016)

Initial Customer Setup

Visitor ID (generated by NovAtel Technical Services)

NovAtel Customer Number (should correspond ERP Customer #)

Password used to access Web Services

Definitions, Acronyms and Abreviations

INovAtelPartnerM2Mservice Web Service

NovAtel / Partner E-Commerce Machine to Machine API

Methods | Complex Types | Simple Types

Deprecated Method New Method

Name Deprecated Description

Name Deprecated Description

This method allows the requestor to request a quote, purchase or renew a

If the RequestType is set to REQUEST_QUOTE then the method will validate of

If the RequestType is set to REQUEST_ORDER then the method validate all of

If the RequestType is set to REQUEST_ORDER_NEW_OR_RENEW then the

renews an existing TerraStar Service contract (SERVICE_ACTIVE or

Name Deprecated Description

Seamless purchase of TerraStar service contract during a pending or

Seamless extension of an active or expiring TerraStar service contract.

Name Deprecated Description

PSN has an active or pending TerraStar service contract

PSN has an active or pending TerraStar test service, or

PSN has an active or expiring standard TerraStar service contract

Name Deprecated Description

This method is used to purchase or quote on authorization code upgrade. If a

RequestAuthcodeUpgradeRevB No This method is used to purchase or quote on authorization code upgrade. If a

The RequestAuthCodeUpgradeRevB method differs from the previous

The RequestAuthCodeUpgradeRevB method also differs from the previous

This method is used to purchase or quote on authorization code upgrade with

Name Deprecated Description

Name Type Size Description Nillable?

Name Type Description

Name Type Description

Name Type Size Description Nillable?

Name Type Description

Name Type Size Description Nillable?

Name Type Description

Method: GetPSNStatus (Deprecated)

D19536 Rev: 0W * PRELIMINARY - SUBJECT TO CHANGE *

D19536 Rev: 0W * PRELIMINARY - SUBJECT TO CHANGE *

D19536 Rev: 0W * PRELIMINARY - SUBJECT TO CHANGE *

D19536 Rev: 0W * PRELIMINARY - SUBJECT TO CHANGE *