A360 - ARISWebService - Version 1.73 - (Release 7.6.01.25 - CL)

ARISWebService
SOAP APIs
Version 1.73
Matthew S. Young
Advantage 360 Software, LLC
Last Updated 04/28/2017
ARISWebService
Contents
About ARISWebService ................................................................................................................ 5

About ................................................................................................................................................................. 5
Authentication .................................................................................................................................................... 5
Logging .............................................................................................................................................................. 5
ARISWebServce.ARISWebUtilities.asmx .................................................................................... 7
GetIDs ............................................................................................................................................................... 7
LockID ............................................................................................................................................................... 9
UnlockID .......................................................................................................................................................... 11
PreAuthCreditCard........................................................................................................................................... 13
ValidateAddress ............................................................................................................................................... 17
GetCreditClass - Custom ................................................................................................................................. 19
GetCreditScore ................................................................................................................................................ 21
CalculateTax .................................................................................................................................................... 23
GetSecretQuestion .......................................................................................................................................... 25
GetAvailFreeUseRefreshSKUs ........................................................................................................................ 27
IDInventoryStatusChange ................................................................................................................................ 31
BIDImageAttachement ..................................................................................................................................... 33
EmployeeLogin ................................................................................................................................................ 35
SubscriberRegistrationDetail ............................................................................................................................ 37
ARISWebService.ARISWebAccount.asmx ................................................................................ 39
ApplyCCPayment............................................................................................................................................. 39
GetRatePlans .................................................................................................................................................. 43
GetPaymentHistory .......................................................................................................................................... 49
GetBID ............................................................................................................................................................. 51
CreateAccountCustom ..................................................................................................................................... 57
GetAccount ...................................................................................................................................................... 63
AddCreditCard ................................................................................................................................................. 67
GetCreditCard .................................................................................................................................................. 69
EditCreditCard ................................................................................................................................................. 71
RemoveCreditCard .......................................................................................................................................... 73
AutoPayOption................................................................................................................................................. 75
GetAvailableTermsCodes ................................................................................................................................ 79
CreateAffinity ................................................................................................................................................... 81
GetAffinity ........................................................................................................................................................ 83
UpdateAffinity .................................................................................................................................................. 85
GetAffinityBalance ........................................................................................................................................... 87
AddNumberInventory ....................................................................................................................................... 89
GetOrderStatus ................................................................................................................................................ 91
CreateSalesOrder ............................................................................................................................................ 93
GetReasonCodes ............................................................................................................................................ 97
ExchangeID ..................................................................................................................................................... 99
EditAddress ................................................................................................................................................... 101
EditPhones .................................................................................................................................................... 103
GetBillDetails ................................................................................................................................................. 105
GetBillCharges ............................................................................................................................................... 107
GetCallDetail.................................................................................................................................................. 109
GetRecentUsage ........................................................................................................................................... 111
AddUsageRecord........................................................................................................................................... 113
GetBalanceSummary ..................................................................................................................................... 115
GetTreatmentGroupBalances ........................................................................................................................ 117
GetCustomerPersonalData ............................................................................................................................ 119
RegisterAccount............................................................................................................................................. 121
AccountLogin ................................................................................................................................................. 123
EditRatePlan .................................................................................................................................................. 125
AddBankDebit ................................................................................................................................................ 127
EditBankDebit ................................................................................................................................................ 129
GetBankDebit ................................................................................................................................................ 131
GetContract ................................................................................................................................................... 133
-2-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
InvoiceDeliveryMethod ................................................................................................................................... 135

DeactivateUnit ............................................................................................................................................... 137
CalcPlanEditChrg........................................................................................................................................... 139
CalcBIDRestoreChrg...................................................................................................................................... 141
CreateInvoice................................................................................................................................................. 143
GetRecentUsageSummary ............................................................................................................................ 147
TransferBID ................................................................................................................................................... 151
RestoreBID .................................................................................................................................................... 153
CloseTroubleTicket ........................................................................................................................................ 155
GetBalanceSummaryByBID ........................................................................................................................... 157
AddBillAddOnItems ........................................................................................................................................ 159
AddRentalContract......................................................................................................................................... 161
GetRatePackage............................................................................................................................................ 163
AddRatePackage ........................................................................................................................................... 165
CreateAccount ............................................................................................................................................... 167
ActivateBID .................................................................................................................................................... 169
ARISWebService.ARISAccessAccount ................................................................................... 173

MakePayment ................................................................................................................................................ 173
GetAccountStatus .......................................................................................................................................... 177
GetUnitIDDepositBalance .............................................................................................................................. 181
InquireInComm .............................................................................................................................................. 183
PreAuthorization ............................................................................................................................................ 185
GetInvoiceDetails ........................................................................................................................................... 187
MakePaymentByInvoice................................................................................................................................. 189
MakePrepayPostpayPayment ........................................................................................................................ 191
A360FacilitiesManagement.asmx ............................................................................................ 193

EditServiceAddress........................................................................................................................................ 193
EscalateWorkflow .......................................................................................................................................... 195
EditBID .......................................................................................................................................................... 197
LinkCircuit ...................................................................................................................................................... 199
AvailableSKUs ............................................................................................................................................... 201
CommitServiceOrder...................................................................................................................................... 203
CreateInvoice................................................................................................................................................. 205
GetSalesOrders ............................................................................................................................................. 209
EditServiceAddressGPS ................................................................................................................................ 211
Appendix A – ARISWebService Error Codes .......................................................................... 213
Appendix B – ARISAccessAccount Error Codes ................................................................... 221
Revision History ........................................................................................................................ 223
-3-
ARISWebService
-4-
ARISWebService
About ARISWebService
About
The ARISWebService provides numerous API calls to access OSS360 information.
Each WebMethod will return a Result (<[WebMethod]Result>) which indicates whether the method is working properly. If
the connection to the database is invalid, the stored procedures are missing, or if invalid parameters are passed to the
stored procedures then “false” will be returned.
Authentication
The Web Services support authentication for internal and 3rd party use.
Authentication can be turned on by setting the AuthorizedAccessOnly value in the web.config from “No” to “Yes”.
<add key="AuthorizedAccessOnly" value="No" />
When authentication is turned on, an OSS360 Employee Code and Password are required for each API call. In addition
the Employee’s Permission settings for the Web Service Category can determine which APIs the Employee has access.
This is important to control when hosting the Web Service API for the use by a 3rd party.
The SOAP header of each API call will require an EmpCode and EmpPassword that must be submitted for each API call.
Logging
The ARISWebService allows for logging of Requests and Responses.

To turn on the logging set the LogLevel value to any of the values listed below.
<add key="LogLevel" value="0"/>
0 - No logging
1 - Error logging only
2 - Warning logging only
3 - Debug
4 - Log Everything
Logged entries are inserted into a table named wiServiceAccessLog.
-5-
ARISWebService
-6-
ARISWebService
ARISWebServce.ARISWebUtilities.asmx
GetIDs
Description:
This WebMethod is used to return 100 IDs from Number Inventory based on a pattern search.
Use:
This would be used to display a pool of 100 numbers to a subscriber based on the input Area Code.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
POST /ARISWebService/ARISWebutilities.asmx HTTP/1.1

Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetIDs"
<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetIDs xmlns="http://tempuri.org/">
<NPA>string</NPA>
</GetIDs>
</soap:Body>
</soap:Envelope>
-7-
ARISWebService
HTTP/1.1 200 OK

<soap:Body>
<GetIDsResponse xmlns="http://tempuri.org/">
<GetIDsResult>boolean</GetIDsResult>
<IDInventorySet>
<ARISIDInventory>
<UnitID1>string</UnitID1>
<IDInventoryKey>int</IDInventoryKey>
</ARISIDInventory>
<ARISIDInventory>
</ARISIDInventory>
</IDInventorySet>
</GetIDsResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
NPA String 3 Required
Output:
Field Data Type Max Length Description
UnitID1 String 16 MSISDN, MDN, etc.
UnitID2 String 16 MIN, etc.
IDInventoryKey Integer 2,147,483,647 Primary Key of the Number Inventory row.
Note:
The IDInventoryKey output needs to be retained for use with other WebMethod calls such as LockID and UnlockID.
-8-
ARISWebService
LockID
Description:
This WebMethod is used to lock a single ID from Number Inventory based on the IDInventorKey passed.
Use:
This would be used after the GetIDs to reserve an ID based on one a subscriber has selected.
actual values
POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/LockID"

<soap:Body>
<LockID xmlns="http://tempuri.org/">
<ReservationDays>int</ReservationDays>
</LockID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<LockIDResponse xmlns="http://tempuri.org/">
<LockIDResult>boolean</LockIDResult>
<ReturnValue>int</ReturnValue>
</LockIDResponse>
</soap:Body>
</soap:Envelope>
Input:
IDInventoryKey Integer 2,147,483,647 Required
ReservationDays Integer 2,147,483,647 Required: Pass 0 for the default reservation period of 72
hours or pass a number of days to define a custom
reservation period.
Output:
ReturnValue String 1 1 – Success
2 - Already Reserved
-9-
ARISWebService
3 - Invalid Key passed
- 10 -
ARISWebService
UnlockID
Description:
This WebMethod is used to unlock a single ID from Number Inventory based on the IDInventorKey passed.
Use:
This would be used after the LockIDs to release a reserved ID based on one a subscriber has deselected.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/UnlockID"

<soap:Body>
<UnlockID xmlns="http://tempuri.org/">
</UnlockID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<UnlockIDResponse xmlns="http://tempuri.org/">
<UnlockIDResult>boolean</UnlockIDResult>
</UnlockIDResponse>
</soap:Body>
</soap:Envelope>
Input:
IDInventoryKey Integer 2,147,483,647 Required
Output:
2 - Not Reserved
3 - Invalid Key passed
- 11 -
ARISWebService
- 12 -
ARISWebService
PreAuthCreditCard
Description:
This WebMethod is used to preauthorize a credit card for $1.00 to verify it is valid and capable of being charged. This will
reduce the subscribers ability to charge for the amount of the preauth until this expires with the bank usually 7 – 10 days.
Use:
This would be used to verify that a credit card entered on the web is valid and is capable of being charged.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/PreAuthCreditCard"

<soap:Body>
<PreAuthCreditCard xmlns="http://tempuri.org/">
<XML_CreditCardData>string</XML_CreditCardData>
</PreAuthCreditCard>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<PreAuthCreditCardResponse xmlns="http://tempuri.org/">
<PreAuthCreditCardResult>boolean</PreAuthCreditCardResult>
<AuthorizationNumber>string</AuthorizationNumber>
<Result>string</Result>
<CCReference>string</CCReference>
</PreAuthCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_CreditCardData String 8,000 Required: See Below
- 13 -
ARISWebService
XML_CreditCardData Fields:
Field Data Type Max Length Requirement Description

CardNumberKey Integer 2,147,483,647 Optional Used for EditCreditCard
CardNumber String 20 Required Credit Card Number
CID String 5 Optional Card Identification Number also referred to
as CVV2, CVC2
PostalCode String 10 Optional Postal Code 5 or 9 digit Postal (dash is
optional)
Format 99999, 99999-9999, 999999999
ExpirationDate String 8 Required Format MMYY, MM/YY, MM-YY, YYMM,
YY/MM, YY-MM
ExpDateFormat String 4 Optional MMYY (Default format if not passed)
or YYMM
CardHolder String 120 Required Name of Card Holder
ContractKey Integer Undefined Optional Reserved for future use.
ApplicationType String Undefined Optional Reserved for future use.
SaveCreditCard String 1 Required Save Credit Card on file with Account
AmountToCharge Decimal 999999999.99 Optional Amount to charge to Account
Example:
<![CDATA[
<CreditCardData>
<CardData CardNumber ="4012000033330026" ExpirationDate ="1109" ExpDateFormat="MMYY" CardHolder=
"Web Test Customer 1" CID="" PostalCode="" SaveCreditCard ="0"/>
</CreditCardData>
]]>
Note: Any XML fields that are passed to a web method must be wrapped with <![CDATA[XML Fields]]> so they are
treated as strings.
Output:
0 – Unsuccessful
AuthorizationNumber String 40 For approved transactions:
Returns authorization code from the issuing bank.
For declined transactions:

Returns the reason why the transaction was declined (if the
issuing bank provides one) or why the transaction was
rejected.
Result String 40 Returns the result, which indicates the transaction’s status
upon completion.
PCCharge Good Results:

'CAPTURED',
PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',
'RETURN RECOVERED'
PCCharge Bad Results:

'NOT CAPTURED',
'NOT APPROVED',
'SALE NOT FOUND',
'ERROR'
CCReference String 40 Returns the reference number associated with the
transaction. The reference number is by the card
associations. The Reference number is used to help
identify the transaction and is useful for cardholder and
merchant when doing research. This value is not returned
- 14 -
ARISWebService
with all transactions
- 15 -
ARISWebService
- 16 -
ARISWebService
ValidateAddress
Description:
This WebMethod is used to validate an address to make sure it conforms to the USPS standards.
Use:
This would be used to verify that an address exists and if so then the USPS formatted address is returned.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/ValidateAddress"

<soap:Body>
<ValidateAddress xmlns="http://tempuri.org/">
<Address1>string</Address1>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
</ValidateAddress>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<ValidateAddressResponse xmlns="http://tempuri.org/">
<ValidateAddressResult>boolean</ValidateAddressResult>
<USPSAddress1>string</USPSAddress1>
<USPSAddress2>string</USPSAddress2>
<USPSCity>string</USPSCity>
<USPSState>string</USPSState>
<USPSPostalCode>string</USPSPostalCode>
</ValidateAddressResponse>
</soap:Body>
</soap:Envelope>
Input:
- 17 -
ARISWebService
Address1 String 40 Required

Address2 String 40 Optional
City String 40 Required
State String 20 Required
PostalCode String 10 Required
Output:
ReturnValue String 1 1 - Address Confirmed
0 - Address Invalid
USPSAddress1 String 40 USPS conformed Address1
USPSAddress2 String 40 USPS conformed Address2
USPSCity String 40 USPS conformed City
USPSState String 20 USPS conformed State
UPSPPostalCode String 10 USPS conformed PostalCode
- 18 -
ARISWebService
GetCreditClass - Custom
Description:
This WebMethod is used to return a Credit Class value (A – E)(Defined in Data Titles) based on a credit score.
Use:
This would be used to return Credit Class letter values for manual filtering of Rate Plans, etc. on the web.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetCreditClass"

<soap:Body>
<GetCreditClass xmlns="http://tempuri.org/">
<FirstName>string</FirstName>
<LastName>string</LastName>
<Street>string</Street>
<City>string</City>
<Zip>string</Zip>
<SSN>string</SSN>
</GetCreditClass>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetCreditClassResponse xmlns="http://tempuri.org/">
<GetCreditClassResult>boolean</GetCreditClassResult>
<CreditClass>string</CreditClass>
</GetCreditClassResponse>
</soap:Body>
</soap:Envelope>
Input:
FirstName String 40 Required
LastName String 40 Required
Address String 40 Required
- 19 -
ARISWebService

Zip String 10 Required
SSN String 9 Required
Output:
CreditClass String 1 Returns Credit Class as defined by setup or false.
- 20 -
ARISWebService
GetCreditScore
Description:
This WebMethod is used to return a Credit Score for a subscriber.
Use:
This would be used to return Credit Score to preset defaults for services.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetCreditScore"

<soap:Body>
<GetCreditScore xmlns="http://tempuri.org/">
<Street>string</Street>
<City>string</City>
<Zip>string</Zip>
<SSN>string</SSN>
</GetCreditScore>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetCreditScoreResponse xmlns="http://tempuri.org/">
<GetCreditScoreResult>boolean</GetCreditScoreResult>
<Score>string</Score>
<Report>string</Report>
</GetCreditScoreResponse>
</soap:Body>
</soap:Envelope>
Input:
FirstName String 40 Required
LastName String 40 Required
- 21 -
ARISWebService
Address String 40 Required

Zip String 10 Required
Output:
CreditScore String 3 Returns the subscribers Credit Score or false
Report String 4,096 Returns the actual credit report as text.
- 22 -
ARISWebService
CalculateTax
Description:
This WebMethod is used to calculate tax on any SKU / Item Number passed by either ARIS internal taxation or by CCH
taxation.
Use:
This would be used to calculate or recalculate shopping cart item taxes.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/CalculateTax"

<soap:Body>
<CalculateTax xmlns="http://tempuri.org/">
<XML_LineItems>string</XML_LineItems>
</CalculateTax>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CalculateTaxResponse xmlns="http://tempuri.org/">
<CalculateTaxResult>boolean</CalculateTaxResult>
<SubTotal>decimal</SubTotal>
<TotalTax>decimal</TotalTax>
<Total>decimal</Total>
</CalculateTaxResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_LineItems String 8,000 Required: See below
- 23 -
ARISWebService
XML_LineItems Fields:

Item String 24 Required Existing OSS360 Items/SKU must be
passed and assumed to be for Item
Category “New”. Will not work for Used,
Loaner or Rental Items.
Description String 40 Optional A user defined description can be passed.
If “NULL” or “(NULL)” is passed then we
will use the Items internal description.
Quantity Integer 999999 Optional Quantity not passed in XML or if Quantity
is 0 then we translate to Quantity = 1. If a
negative Quantity is passed then this is a
discount.
UnitPrice Decimal 999999999.99 Required If the UnitPrice is passed as a positive
value then it is used. If a negative value is
passed then we will use the Price Book
price using the Accounts assigned Price
Book.
<CartItems>
<LineItem Item = "X9000" Description = "NULL" Quantity = "1" UnitPrice = "199.95"/>
<LineItem Item = "P9000" Description = "(NULL)" Quantity = "1" UnitPrice = "19.95"/>
<LineItem Item = "L9000" UnitPrice = "-1.00"/>
<LineItem Item = "SHIPPING" Description = "UPS - Blue" Quantity = "1" UnitPrice = "10.00"/>
</CartItems>
Output:
ReturnValue Integer 2,147,483,647 Return code (See Appendix C)
SubTotal Decimal 999999999.99 SubTotal of cart items
TotalTax Decimal 999999999.99 Total tax calculated on cart items
Total Decimal 999999999.99 SubTotal plus TotalTax
- 24 -
ARISWebService
GetSecretQuestion
Description:
This WebMethod is used to query the defined Secret Questions from Data Titles / Personal Data Types.
Use:
This would be used to return the Secret Questions and Key values used for storing along with the answer to the Accounts.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetSecretQuestion"

<soap:Body>
<GetSecretQuestion xmlns="http://tempuri.org/" />
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetSecretQuestionResponse xmlns="http://tempuri.org/">
<GetSecretQuestionResult>boolean</GetSecretQuestionResult>
<SecretQuestionSet>
<ARISSecretQuestion>
<Description>string</Description>
<PersonalDataTypeKey>int</PersonalDataTypeKey>
</ARISSecretQuestion>
<ARISSecretQuestion>
<PersonalDataTypeKey>int</PersonalDataTypeKey>
</ARISSecretQuestion>
</SecretQuestionSet>
</GetSecretQuestionResponse>
</soap:Body>
</soap:Envelope>
Input:
No Input
- 25 -
ARISWebService
Output:
Description String 40 Secret Question
PersonalDataTypeKey Integer 2,147,483,647 IdentityKey of Secret Question record
- 26 -
ARISWebService
GetAvailFreeUseRefreshSKUs
Description:
This WebMethod is used to return the available Free Use Refresh SKUs that are available to be sold.
Use:
This would be used to return a list of SKUs to allow the subscriber to choose from for purchasing Free Usage.
actual values
POST /ariswebservice/ARISWebUtilities.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/GetAvailFreeUseRefreshSKUs"

<soap:Body>
<GetAvailFreeUseRefreshSKUs xmlns="http://tempuri.org/">
<RateType>string</RateType>
</GetAvailFreeUseRefreshSKUs>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAvailFreeUseRefreshSKUsResponse xmlns="http://tempuri.org/">
<GetAvailFreeUseRefreshSKUsResult>boolean</GetAvailFreeUseRefreshSKUsRe
sult>
<AvailFreeUseRefreshSKUsSet>
<ARISAvailFreeUseRefreshSKUs>
<Item>string</Item>
<AllocationPeriod>string</AllocationPeriod>
<Quantity1>int</Quantity1>
<Price1>decimal</Price1>
<Quantity2>string</Quantity2>
<Price3>string</Price3>
<Quantity4>decimal</Quantity4>
- 27 -
ARISWebService
</ARISAvailFreeUseRefreshSKUs>
<ARISAvailFreeUseRefreshSKUs>
<Item>string</Item>
<AllocationPeriod>string</AllocationPeriod>
<RateIncrement>string</RateIncrement>
<Quantity1>int</Quantity1>
<Price3>string</Price3>
</ARISAvailFreeUseRefreshSKUs>
</AvailFreeUseRefreshSKUsSet>
</GetAvailFreeUseRefreshSKUsResponse>
</soap:Body>
</soap:Envelope>
Input:
RateType String 2 Optional:
TA – Airtime
TR – Roaming
TT – Toll Charges
TM – SMS
MS – MMS
GD – GPRS Data
TD – Data
TN – Content
Output:
Item String 23 Item SKU
Description String 40 Description of Item
AllocationPeriod String 1 Rate Period of Free Usage:
A – Anytime
U – Unlimited
1 – Period 1
2 – Period 2
3 – Period 3
4 – Period 4
5 – Period 5
6 – Period 6
RateType String 2 TA – Airtime
TR – Roaming
TT – Toll Charges
- 28 -
ARISWebService
TM – SMS
MS – MMS
GD – GPRS Data
TD – Data
TN – Content
RateIncrement String 20 2 - Minute(s) Squared
3 - Megabyte(s)
4 - Gigabyte(s)
5 - Terabyte(s)
6 - Petabyte(s)
7 - Exabyte(s)
A - Page(s)
B - Byte(s)
C - Character(s)
D - Day(s)
E - Packet(s)
G - Message(s)
H - Hour(s)
I - PIP(s)
K - Kilobyte(s)
M - Minute(s)
N - Count
O - Month(s)
P - Kilopacket(s)
S - Second(s)
U - Unit(s)
V - Sales Volume
X - Download(s)
Quantity1 Integer 9999 Quantity 2 Tier
Price1 Decimal 999999999.99 Price 1 Amount
- 29 -
ARISWebService
- 30 -
ARISWebService
IDInventoryStatusChange
Description:
This WebMethod is used to update the status of an ID in Number Inventory.
Use:
This would be used to change the status of an ID from Quarantine or Ported Deleted to Available for reuse.
actual values
POST /WebServices/Version%201.0.0.19/ariswebutilities.asmx HTTP/1.1

Host: devsvr1
SOAPAction: "http://tempuri.org/IDInventoryStatusChange"

<soap:Body>
<IDInventoryStatusChange xmlns="http://tempuri.org/">
<SystemID>string</SystemID>
<ID>string</ID>
<Status>string</Status>
</IDInventoryStatusChange>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<IDInventoryStatusChangeResponse xmlns="http://tempuri.org/">
<IDInventoryStatusChangeResult>boolean</IDInventoryStatusChangeResult>
</IDInventoryStatusChangeResponse>
</soap:Body>
</soap:Envelope>
Input:
SystemID String 5 Required: ID of the System which the number resides
ID String 24 Required: ID that is used as the BID
Status String 1 Required: A - Available
- 31 -
ARISWebService
Output:
ReturnValue String 1 1 - Successful
0 - Unsuccessful
- 32 -
ARISWebService
BIDImageAttachement
Description:
This WebMethod is used to update the status of an ID in Number Inventory.
Use:
This would be used to change the status of an ID from Quarantine or Ported Deleted to Available for reuse.
actual values
POST /ariswebservice/Ariswebutilities.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/BIDImageAttachement"

<soap:Body>
<BIDImageAttachement xmlns="http://tempuri.org/">
<BID>string</BID>
<fileDescription>string</fileDescription>
<filename>string</filename>
<fileContent>base64Binary</fileContent>
</BIDImageAttachement>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<BIDImageAttachementResponse xmlns="http://tempuri.org/">
<BIDImageAttachementResult>boolean</BIDImageAttachementResult>
</BIDImageAttachementResponse>
</soap:Body>
</soap:Envelope>
Input:
BID String 16 Required: Billable ID which the images are related.
fileDescription String 24 Required: Description of the image
filename String 40 Required: Name of the image.
fileContent String Base64Binary Required: Image
- 33 -
ARISWebService
Output:
BIDImageAttachementResult String 5 true - Successful
false - Unsuccessful
- 34 -
ARISWebService
EmployeeLogin
Description:
This WebMethod is used for validating Employee Code and Password for login.
Use:
This would be used to allow 3rd parties to use OS360 Employee Codes and Passwords for authentication.
actual values
POST /A360WebService/ARISWebUtilities.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/EmployeeLogin"

<soap:Body>
<EmployeeLogin xmlns="http://tempuri.org/">
<EmployeeCode>string</EmployeeCode>
<Password>string</Password>
</EmployeeLogin>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EmployeeLoginResponse xmlns="http://tempuri.org/">
<EmployeeLoginResult>int</EmployeeLoginResult>
<EmployeeKey>int</EmployeeKey>
</EmployeeLoginResponse>
</soap:Body>
</soap:Envelope>
Input:
EmployeeCode String 3 Required – Alphanumeric Employee Code
Password String 40 Required – MD5 Hashed Employee Password
Output:
ReturnValue Integer 1 1 = Valid
0 = Invalid
EmployeeKey Integer 2,147,483,647 Identity Key of Employee
- 35 -
ARISWebService
Please Note:
The Password being passed into the API must be MD5 Hashed. (http://www.md5hashgenerator.com/)
- 36 -
ARISWebService
SubscriberRegistrationDetail
Description:
This WebMethod is used for obtaining the registration detail for registration purposes on the subscriber portal.
Use:
This would be used to allow 3rd parties to query to receive the subscriber portal registration details for a subscriber.
actual values
POST /A360WebService/ARISWebUtilities.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/SubscriberRegistrationDetail"

<soap:Body>
<SubscriberRegistrationDetail xmlns="http://tempuri.org/">
<SalesOrderNo>string</SalesOrderNo>
</SubscriberRegistrationDetail>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<SubscriberRegistrationDetailResponse xmlns="http://tempuri.org/">
<SubscriberRegistrationDetailResult>int</SubscriberRegistrationDetailRe
sult>
<AccountNumber>string</AccountNumber>
<BillableID>string</BillableID>
<InvoiceNo>string</InvoiceNo>
</SubscriberRegistrationDetailResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitID1 String 16 Required – UnitID1, UnitID3, or SalesOrderNo is required
UnitID3 String 23 Required – UnitID1, UnitID3, or SalesOrderNo is required
SalesOrderNo String 9 Required – UnitID1, UnitID3, or SalesOrderNo is required
- 37 -
ARISWebService
Output:
ReturnValue Integer 1 1 = Successful
0 = Unsuccessful
AccountNumber String 11 Subscriber’s Account Number
BillableID String 16 Subscriber’s BillableID
InvoiceNo String 9 Subscriber’s last invoice number
- 38 -
ARISWebService
ARISWebService.ARISWebAccount.asmx
ApplyCCPayment
Description:
This WebMethod is used to apply credit card payments to Customer Invoices or as Credits.
Use:
This would be used to charge credit cards for Payments on Customer Accounts.
actual values
POST /ariswebservice/ariswebaccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/ApplyCCPayment"

<soap:Body>
<ApplyCCPayment xmlns="http://tempuri.org/">
<CustomerNo>string</CustomerNo>
<Target>string</Target>
<TotalAmountPaid>decimal</TotalAmountPaid>
<XML_ContractData>string</XML_ContractData>
<PaymentPriority>int</PaymentPriority>
</ApplyCCPayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<ApplyCCPaymentResponse xmlns="http://tempuri.org/">
<ApplyCCPaymentResult>boolean</ApplyCCPaymentResult>
<PaymentKey>int</PaymentKey>
</ApplyCCPaymentResponse>
</soap:Body>
- 39 -
ARISWebService
</soap:Envelope>
Input:
CustomerNo String 11 Required
Target String 9 Optional:
Blank – Pay invoices oldest to newest
InvoiceNo – Pay passed 9 digit InvoiceNo.Overage will go to
bucket defined by “Default Unapplied Payment” preference.
ACCDEP – See XML_ContractData field
TotalAmountPaid Decimal 999999999.99 Required
XML_CreditCardData String 8,000 Required:
See PreAuthCreditCard
XML_ContractData String 8,000 Required only when Target field = ACCDEP
PaymentPriority Integer 1 Required: 0- 9 – Payment Priorities 1 though 9 or 0 if not
used.
XML_ContractData Fields:

ContractKey Integer 2,147,483,647 Required Specifies Contract to apply Credit
AmountPaid Decimal 999999999.99 Required Credit amount paid
UnitID1 String 16 Optional Required when posting payment for IN
Prepay solution.
Example:
<![CDATA[
<CustContracts>
<ContractData ContractKey = “12345” AmountPaid = “25.00”/>
</CustContracts>
]]>
treated as strings.
Output:
PaymentKey Integer 2,147,483,647 IdentityKey for Payment. Can be used to create a receipt in
the Web Interface. Negative values are errors.

rejected.
upon completion.
PCCharge Good Results:

'CAPTURED',
PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',
'RETURN RECOVERED'

'NOT CAPTURED',
'NOT APPROVED',
'SALE NOT FOUND',
'ERROR'
- 40 -
ARISWebService
Please Note:
This API is supported by a setting named “AllowAllTermsForINPayments” in table wiDefaultValues (defaulted to 0) that
determines whether Payments using the Target ACCDEP will be transferred to IN Platforms regardless of the BID’s
related Contract Terms.
 When “AllowAllTermsForINPayments” = 0 then Payments will only be transferred for Prepay Terms.
 When “AllowAllTermsForINPayments” = 1 then Payments will be transferred for any Terms.
- 41 -
ARISWebService
- 42 -
ARISWebService
GetRatePlans
Description:
This WebMethod is used to return all the available options / features within all Rate Plans.
Use:
This would be used to display any MRC, Airtime, Features, Free Use, etc. values on a web page.
actual values
POST /ARISWebService/ARISWebAccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/GetRatePlans"

<soap:Body>
<GetRatePlans xmlns="http://tempuri.org/">
<AccessContractCodeKey>int</AccessContractCodeKey>
<Type>string</Type>
</GetRatePlans>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetRatePlansResponse xmlns="http://tempuri.org/">
<GetRatePlansResult>boolean</GetRatePlansResult>
<RatePlanSet>
<ARISRatePlan>
<RatePlan>string</RatePlan>
<RatePlanDescription>string</RatePlanDescription>
<RateCode>string</RateCode>
<RateCodeDescription>string</RateCodeDescription>
<MasterRatePackage>string</MasterRatePackage>
<MasterRatePackageDescription>string</MasterRatePackageDescription>
<MemberCount>short</MemberCount>
<RatePackage>string</RatePackage>
<PackageDescription>string</PackageDescription>
<FeatureCode>string</FeatureCode>
<FeatureCodeDescription>string</FeatureCodeDescription>
- 43 -
ARISWebService
<FeatureType>string</FeatureType>
<FeatureTypeDescription>string</FeatureTypeDescription>
<Rate1>decimal</Rate1>
<AllocationType>string</AllocationType>
<FreeAmount1>int</FreeAmount1>
<Promote>boolean</Promote>
<MasterPackageKey>int</MasterPackageKey>
<RatePackageKey>int</RatePackageKey>
<RateCodeKey>int</RateCodeKey>
<TreeNode>string</TreeNode>
<RatePlanKey>int</RatePlanKey>
</ARISRatePlan>
<ARISRatePlan>
<MasterRatePackage>string</MasterRatePackage>
<MasterRatePackageDescription>string</MasterRatePackageDescription>
<MemberCount>short</MemberCount>
<PackageDescription>string</PackageDescription>
<MasterPackageKey>int</MasterPackageKey>
<RatePackageKey>int</RatePackageKey>
<RateCodeKey>int</RateCodeKey>
<TreeNode>string</TreeNode>
</ARISRatePlan>
</RatePlanSet>
</GetRatePlansResponse>
</soap:Body>
</soap:Envelope>
Input:
AccessContractCodeKey Integer 2,147,483,647 Required
Type String 1 Required:
B - Non-Sharing Plans
C - Sharing Plans
SystemKey Integer 2,147,483,647 Optional
Output:
RatePlan String 4 Code from Rate Plan
- 44 -
ARISWebService
RatePlanDescription String 40 Rate Plan Description

RateCode String 4 Code from Rate Code
RateCodeDescription String 40 Rate Code Description
MasterRatePackage String 40 Parent Rate Package (Preference, Mandatory,
Conditional, etc.)
MasterRatePackageDescription String 40 Description of Master Rate Package
MemberCount String 40 Maximum count of Master Rate Package Members
RatePackage String 40 Child Rate Package (Standard Packages)
RatePackageDescription String 40 Rate Package Description
RateType String 2 FF – Fixed In Advance
FA – Fixed in Arrears
TA – Airtime
TM – SMS
TT – Toll Charges
GD – Data
TN – Content
TV – Voice Mail
CV – Voice Mail Count
TR – Roaming
FeatureCode String 2 CF - Call Forwarding
CT - Content
DT - Data
DT - Roaming Data
FD - FAX Deposit
FD - FAX Deposit
FN - Frequent Number
FR - FAX Retrieval
FR - FAX Retrieval
FV - FAX Delivery
FV - FAX Delivery
GA - Roaming GPRS Airtime
GD - Roaming GPRS Data
ID - IDD Delivery
IN - Incoming
IN - Incoming
IT - International Toll
LD - Local Delivery
LT - Local / Special Toll
MD - Message Deposit
MI - Home Mobile-to-Home Mobile Incoming
MI - Mobile-to-Mobile Incoming
MM - Mobile-to-Mobile
MM - Home Mobile-to-Home Mobile
MR - Message Retrieval
MV - Message Delivery
NC - Contract
ND - NDD Delivery
NP - Rate Plan
NT - National Toll
OC - Roaming OCCs
OU - Outgoing
RF - Roaming Call Forwarding
RI - Roaming SMS Incoming
RO - Roaming SMS Outgoing
TG - Talk Group
TI - Roaming IDD Toll
TL - Roaming Local Toll
TO - Roaming Toll
VM - Voice Mail Maintenance
WU - Wake-Up Call
FeatureCodeDescription String 40 See FeatureCode
FeatureType String 2 ^ - Per Primary Limit
0 - DS1DSO
- 45 -
ARISWebService
1 - Bonus Usage 1
2 - Bonus Usage 2
3 - Bonus Usage 3
4 - Bonus Usage 4
5 - Bonus Usage 5
6 - Bonus Usage 6
7 - Bonus Usage 7
8 - Bonus Usage 8
9 - Bonus Usage 9
A - Access Fee
AC - Accounting Codes
BK - Phone Books
C - Contract Commitment
D - DSL
DB - DID Block Size
DC - PRI D Channel
E - Support Level
F - Frequently Called Number
G - Mileage
H - Hosted Storage
I - Invoice Detail
IO - PRI In/Out
J - Channels
K - Data Archive
L - Per Contract Limit
M - E-Mail
MD - MADN
N - None
NA - NARS
NM - Inter Mobile
O - Origination Detail
P - Personal Directory
PD - PRI Data
PI - PRI In
PO - PRI Out
PR - PRI
PV - PRI Voice
Q - Equipment Protection
R - Conditional Access Fee
S - Shadow Rate
SU - Share Usage
T - Talk Group
TF - Toll Free
TK - Trunk
U - E-Mail Address Count
V - Voice Mail
W - Connections
X - Fax
Y - Channel Mileage
Z - License Fee
FeatureTypeDescription String 40 User Defined System Feature Type Description
Rate1 Decimal 999999999.99 When Rate Type = “FA” or ”FF” this is the MRC Rate.
When RateType = “TA” or “TM” then the Period 1 Rate.
Rate2 Decimal 999999999.99 When RateType = “TA” or “TM” then the Period 2 Rate.
AllocationType String 1 Free Use Allocation Type:
B = Per BID, G = Per Group, A = All BIDs, C =
Conditional, P = Priority Group
FreeAmount1 Integer 999999999.99 Amount of Period 1 Free Use (Typically Peak)
Promote Integer 1 Indicates whether a Rate Plan / Package Member is
the default
MasterRatePackageKey Integer 2,147,483,647 Required for Create Account: Members with the same
key value are part of the same package
RatePackageKey Integer 2,147,483,647 Required for Create Account: Members with the same
key value are part of the same package
RateCodeKey Integer 2,147,483,647 Required for Create Account: IdentityKey from Rate
Code
TreeNode String 4 Required for Create Account:
- 46 -
ARISWebService
Used for identifying tree node level

RatePlanKey Integer 2,147,483,647 Required for Create Account:
IdentityKey from Rate Plan
- 47 -
ARISWebService
- 48 -
ARISWebService
GetPaymentHistory
Description:
This WebMethod is used to return the history of the last 12 payments made on an Account.
Use:
This would be used to display the last 12 payments and their related information made on an Account.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetPaymentHistory"

<soap:Body>
<GetPaymentHistory xmlns="http://tempuri.org/">
</GetPaymentHistory>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetPaymentHistoryResponse xmlns="http://tempuri.org/">
<GetPaymentHistoryResult>
<ARISPaymentHistory>
<DatePaid>string</DatePaid>
<Reference>string</Reference>
<PaymentTypeDesc>string</PaymentTypeDesc>
<PaymentID>string</PaymentID>
<CustomerKey>int</CustomerKey>
</ARISPaymentHistory>
<ARISPaymentHistory>
<DatePaid>string</DatePaid>
<PaymentTypeDesc>string</PaymentTypeDesc>
</ARISPaymentHistory>
- 49 -
ARISWebService
</GetPaymentHistoryResult>
</GetPaymentHistoryResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
DatePaid String 20 Date of Payment
TotalAmountPaid Decimal 999999999.99 Amount
Reference String 40 Comment used for Check Payments
PaymentTypeDesc String 20 Description of Payment Type
PaymentID String 24 Payment Identification, Incomm unique identifier
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
- 50 -
ARISWebService
GetBID
Description:
This WebMethod is used to return the Contact, BID and Rate Plan details.
Use:
This would be used to display a BID and all related Rate Codes in the subscribers Rate Plan including the associated
Contact.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetBID"

<soap:Body>
<GetBID xmlns="http://tempuri.org/">
<DateTime>string</DateTime>
</GetBID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBIDResponse xmlns="http://tempuri.org/">
<GetBIDResult>boolean</GetBIDResult>
<BIDEntitySet>
<ARISBIDEntity>
<MiddleName>string</MiddleName>
<EID>string</EID>
- 51 -
ARISWebService
<Commitment>string</Commitment>
<UnitSystemKey>int</UnitSystemKey>
<AccountStatus>string</AccountStatus>
<AccountStatusDescription>string</AccountStatusDescription>
<UnitIDStatus>string</UnitIDStatus>
<UnitIDStatusDescription>string</UnitIDStatusDescription>
</ARISBIDEntity>
<ARISBIDEntity>
<EID>string</EID>
<Commitment>string</Commitment>
</ARISBIDEntity>
</BIDEntitySet>
</GetBIDResponse>
</soap:Body>
</soap:Envelope>
- 52 -
ARISWebService
Input:
UnitID1 String 16 Required
DateTime String 23 Optional
Output:
CustomerNo String 11 Customer Number
FirstName String 40 First name of Customer / Contact
MiddleName String 40 Middle name of Customer / Contact
LastName String 40 Last name of Customer / Contact
UnitID1 String 16 Primary ID (MSISDN, MDN, etc.)
UnitID2 String 16 (IMSI, MIN, etc.)
UnitID3 String 24 (ESN, ICCID, etc.)
EID String 24 Equipment Serial Number
RatePlan String 4 Code from Rate Plan
RatePlanDescription String 40 Rate Plan Description
RateCode String 4 Code from Rate Code
RateCodeDescription String 40 Rate Code Description
RateType String 2 FF – Fixed In Advance
FA – Fixed in Arrears
TA – Airtime
TM – SMS
TT – Toll Charges
GD – Data
TN – Content
TV – Voice Mail
CV – Voice Mail Count
TR – Roaming
CT - Content
DT - Data
DT - Roaming Data
FD - FAX Deposit
FD - FAX Deposit
FR - FAX Retrieval
FR - FAX Retrieval
FV - FAX Delivery
FV - FAX Delivery
ID - IDD Delivery
IN - Incoming
IN - Incoming
LD - Local Delivery
NC - Contract
ND - NDD Delivery
NP - Rate Plan
NT - National Toll
OC - Roaming OCCs
OU - Outgoing
- 53 -
ARISWebService

TG - Talk Group
TO - Roaming Toll
WU - Wake-Up Call
FeatureCodeDescription String 40 See FeatureCode
FeatureType String 2 ^ - Per Primary Limit
0 - DS1DSO
1 - Bonus Usage 1
2 - Bonus Usage 2
3 - Bonus Usage 3
4 - Bonus Usage 4
5 - Bonus Usage 5
6 - Bonus Usage 6
7 - Bonus Usage 7
8 - Bonus Usage 8
9 - Bonus Usage 9
A - Access Fee
AC - Accounting Codes
BK - Phone Books
C - Contract Commitment
D - DSL
DB - DID Block Size
DC - PRI D Channel
E - Support Level
F - Frequently Called Number
G - Mileage
H - Hosted Storage
I - Invoice Detail
IO - PRI In/Out
J - Channels
K - Data Archive
L - Per Contract Limit
M - E-Mail
MD - MADN
N - None
NA - NARS
NM - Inter Mobile
O - Origination Detail
P - Personal Directory
PD - PRI Data
PI - PRI In
PO - PRI Out
PR - PRI
PV - PRI Voice
Q - Equipment Protection
R - Conditional Access Fee
S - Shadow Rate
SU - Share Usage
T - Talk Group
TF - Toll Free
TK - Trunk
U - E-Mail Address Count
V - Voice Mail
W - Connections
X - Fax
Y - Channel Mileage
Z - License Fee
FeatureTypeDescription String 40 User Defined System Feature Type Description
Rate1 Decimal 999999999.99 When Rate Type = “FA” or ”FF” this is the MRC Rate. When
RateType = “TA” or “TM” then the Period 1 Rate.
Rate2 Decimal 999999999.99 When RateType = “TA” or “TM” then the Period 2 Rate.
AllocationType String 1 Free Use Allocation Type:
B = Per BID, G = Per Group, A = All BIDs, C = Conditional,
- 54 -
ARISWebService
P = Priority Group
FreeAmount1 Decimal 999999999.99 Amount of Period 1 Free Use (Typically Peak)
Promote String 1 Indicates whether a Rate Plan / Package Member is the
default
Commitment String 23 Date when commitment expires
SystemID String 5 System ID which service resides
UnitSystemKey Integer 2,147,483,647 IdentityKey of BID
AccountStatus String 1 A=Active,
I=Inactive,
C=Conditional hold,
U=Unconditional hold,
P=Partial barring,
F=Full barring,
L=Collections,
D=Deleted,
R=Restricted,
W=Write off,
AccountStatusDescription String 20 Text Description of account status
UnitIDStatus String 1 A=Active, P=Pending, H=Hold, B=Bar, U=Unbar, I=Inactive
UnitIDStatusDescription String 100 Text Description of unit status
- 55 -
ARISWebService
- 56 -
ARISWebService
CreateAccountCustom
Description:
This WebMethod is used to query Create Accounts, Contracts, Activate BIDs on Hold, Create Sales Order, apply Order
Deposit Credit Card Payments towards Sales Order, and generate New Breed Order Import output file.
Use:
This would be used for the complete sign up process.
actual values
Host: local host
SOAPAction: "http://tempuri.org/CreateAccount"

<soap:Body>
<CreateAccount xmlns="http://tempuri.org/">
<AccessContractCodeKey>int</AccessContractCodeKey>
<AgentID>string</AgentID>
<XML_CustomerData>string</XML_CustomerData>
<XML_UnitIDDoc>string</XML_UnitIDDoc>
<XML_UnitRatesDoc>string</XML_UnitRatesDoc>
</CreateAccount>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CreateAccountResponse xmlns="http://tempuri.org/">
<CreateAccountResult>boolean</CreateAccountResult>
<WebOutputDataSet>
<ARISWebOutputData>
- 57 -
ARISWebService
</ARISWebOutputData>
<ARISWebOutputData>
</WebOutputDataSet>
</CreateAccountResponse>
</soap:Body>
</soap:Envelope>
Input:
AccessContractCodeKey Integer 2,147,483,647 Required – can be zero if AgentID is provided
AgentID String 6 Required – only if AccessContractCodeKey = 0
XML_CustomerData String 8,000 Required
XML_UnitIDDoc String 8,000 Required
XML_UnitRatesDoc String 8,000 Required
XML_CreditCardData String 8,000 Required
XML_LineItems String 8,000 Required
XML_CustomerData:

FirstName String 40 Required First name of Customer / Contact
MiddleName String 40 Optional Middle name of Customer / Contact
LastName String 40 Required Last name of Customer / Contact
BirthDate String 20 Required Birthdate of customer
BillingAddress1 String 40 Required Billing address line 1
BillingAddress2 String 40 Required Billing address line 2
BillingCity String 40 Required Billing address city
BillingState String 20 Required Billing address state
BillingPostalCode String 10 Required Billing address postal code
BillingCountry String 40 Required Billing address country
ShippingAddress1 String 40 Optional Shipping address line 1
ShippingAddress2 String 40 Optional Shipping address line2
ShippingCity String 40 Optional Shipping address city
ShippingState String 20 Optional Shipping address state
ShippingPostalCode String 10 Optional Shipping address postal code
ShippingCountry String 40 Optional Shipping address country
DaytimePhone String 80 Required Daytime phone number
DaytimePhoneExt String 8 Optional Daytime phone extension
HomePhone String 80 Required Home phone number
EmailAddress String 80 Required Email address
PassPhrase String 20 Required Customers chosen password
SecretQuestionKey Integer 2,147,483,647 Required Description of secret question
SecretAnswer String 40 Required Answer to secret question
- 58 -
ARISWebService
SSN String 40 Required Social Security Number
<CustomerData>
<tblxmlCustomerData FirstName="Mary" MiddleName="" LastName="Jones" BirthDate="02/02/1980"
BillingAddress1="2001 Main Street" BillingAddress2="" BillingCity="Riverside" BillingState="CA"
BillingPostalCode="92509" BillingCountry="USA" ShippingAddress1="10681 Foothill Blvd" ShippingAddress2="Suite
100" ShippingCity="Rancho Cucamonga" ShippingState="CA" ShippingPostalCode="91730-2032"
ShippingCountry="USA" DaytimePhone="909 980 1035" HomePhone="909 980 1034"
EmailAddress="maryj@hotmail.com" Password="password" SecretQuestionKey="8" SecretAnswer="answer"
SSN="111223333" />
</CustomerData>
XML_UnitIDDoc:

UnitKey Integer 2,147,483,647 Required UnitKey is the identityKey (increment
negatively for each ID being activated)
IDInventoryKey Integer 2,147,483,647 Required IDInventoryKey is the Key returned from
the GetIDs API
RatePlanKey Integer 2,147,483,647 Required
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="983" RatePlanKey="1"/>
<tblxmlID UnitKey="-2" IDInventoryKey="982" RatePlanKey="1"/>
</IDData>
XML_UnitRatesDoc:

UnitKey Integer 2,147,483,647 Required
MasterKey Integer 2,147,483,647 Required GetRatePlans.MasterPackageKey
PackKey Integer 2,147,483,647 Required GetRatePlans.RatePackageKey
RateKey Integer 2,147,483,647 Required GetRatePlans.RateCodeKey
TreeNode String 4 Required GetRatePlans.TreeNode
<RatesData>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="1" TreeNode="IR"/>
</RatesData>
XML_CreditCardData:

CID String 5 Optional Card Identification Number also refered to
as CVV2, CVC2
PostalCode String 10 Optional Reserved for future use. Used for Mode 2
and Mode 3 only.
Postal Code 5 or 9 digit Postal (dash is
optional)
Format 99999, 99999-9999, 999999999
ExpirationDate String 8 Required Card Expiration Date
Format MMYY, MM/YY, MM-YY, YYMM,
YY/MM, YY-MM
ExpDateFormat String 4 Optional for (MMYY or YYMM) (Default
Mode 2 only ExprirationDateFormat MMYY)
(See below)
- 59 -
ARISWebService

CardNumberKey Integer 2,147,483,647 Optional (See Credit Card Number Key
below)
CardTypeCode String 3 Optional for Credit Card Type – OSS360 defined credit
Mode 2 only card types. g. VSA-Visa, AX2-American
(See below) Express, AX1- American Express, DSC-
Discover, MST-MasterCard
SaveCreditCard String 1 Required Save Credit Card on file with Customer
Account
See PreAuthCreditCard Schemas
XML_LineItems:

discount.
Book.
<CartItems>
</CartItems>
Output:
XML_WebOutputData:

CustomerNo String 11 Customer Number for Account added
CustomerKey Integer 2,147,483,647 CustomerKey for Account added
SalesOrderNo String 8 Sales Order Number for SO added
PaymentKey Integer 2,147,483,647 PaymentKey for CreditCard Payment

rejected.
upon completion.
PCCharge Good Results: 'CAPTURED',
- 60 -
ARISWebService
PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',
'RETURN RECOVERED' .

'NOT CAPTURED',
'NOT APPROVED',
'SALE NOT FOUND',
'ERROR'
ReturnValue Integer 1 1 – Success
0 - Unsuccessful
- 61 -
ARISWebService
- 62 -
ARISWebService
GetAccount
Description:
This WebMethod is used to return the Customers Name, Billing Address, Shipping Address, and Credit Card information.
Use:
This would be used to display the Customers entity and credit card related information.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetAccount"

<soap:Body>
<GetAccount xmlns="http://tempuri.org/">
</GetAccount>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAccountResponse xmlns="http://tempuri.org/">
<GetAccountResult>boolean</GetAccountResult>
<AccountEntitySet>
<ARISAccountEntity>
<Company>string</Company>
<BillingAddress1>string</BillingAddress1>
<BillingCity>string</BillingCity>
<BillingState>string</BillingState>
<BillingPostalCode>string</BillingPostalCode>
<BillingCountry>string</BillingCountry>
<ShippingAddress1>string</ShippingAddress1>
- 63 -
ARISWebService
<ShippingCity>string</ShippingCity>
<ShippingState>string</ShippingState>
<ShippingPostalCode>string</ShippingPostalCode>
<ShippingCountry>string</ShippingCountry>
<DaytimePhone>string</DaytimePhone>
<DaytimePhoneExt>string</DaytimePhoneExt>
<HomePhone>string</HomePhone>
<Email>string</Email>
<SSN>string</SSN>
<BirthDate>string</BirthDate>
<SecretQuestion>string</SecretQuestion>
<SecretAnswer>string</SecretAnswer>
<CardType>string</CardType>
<CardExpiration>string</CardExpiration>
<CardExpirationFormat>string</CardExpirationFormat>
<CardHolder>string</CardHolder>
<AutoPay>boolean</AutoPay>
<CurrentBalance>decimal</CurrentBalance>
<CardNumberKey>int</CardNumberKey>
<ContractKey>int</ContractKey>
<IsMasterContract>boolean</IsMasterContract>
<BankName>string</BankName>
<RoutingNumber>string</RoutingNumber>
</ARISAccountEntity>
<ARISAccountEntity>
<ShippingCity>string</ShippingCity>
<ShippingState>string</ShippingState>
<ShippingPostalCode>string</ShippingPostalCode>
<ShippingCountry>string</ShippingCountry>
<SSN>string</SSN>
<BirthDate>string</BirthDate>
<SecretQuestion>string</SecretQuestion>
<CardType>string</CardType>
<CardExpiration>string</CardExpiration>
- 64 -
ARISWebService
<CardExpirationFormat>string</CardExpirationFormat>
<AutoPay>boolean</AutoPay>
<CurrentBalance>decimal</CurrentBalance>
<IsMasterContract>boolean</IsMasterContract>
</ARISAccountEntity>
</AccountEntitySet>
</GetAccountResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
FirstName String 40 First name of Customer / Contact
MiddleName String 40 Middle name of Customer / Contact
LastName String 40 Last name of Customer / Contact
Company String 40 Name of Company
BillingAddress1 String 40 Billing address line 1
BillingAddress2 String 40 Billing address line 2
BillingCity String 40 Billing address city
BillingState String 20 Billing address state
BillingPostalCode String 10 Billing address postal code
BillingCountry String 40 Billing address country
ShippingAddress1 String 40 Shipping address line 1
ShippingAddress2 String 40 Shipping address line2
ShippingCity String 40 Shipping address city
ShippingState String 20 Shipping address state
ShippingPostalCode String 10 Shipping address postal code
ShippingCountry String 40 Shipping address country
DaytimePhone String 80 Daytime phone number
DaytimePhoneExt String 8 Daytime phone extension
HomePhone String 80 Home phone number
Email String 80 Email address
SSN String 40 Social Security Number
BirthDate String 20 Birthdate of customer
Password String 20 Customers chosen password
SecretQuestion String 40 Description of secret question
SecretAnswer String 40 Answer to secret question
CardType String 3 Type of credit card
CardExpiration String 4 Expiration date of credit card
CardExpirationFormat String 4 Expiration date format
CardHolder String 120 Name of credit card owner
AutoPay Boolean 1 Defines if Customer is AutoPaying
CurrentBalance Decimal 999999999.99 Current account balance
CardNumberKey Integer 2,147,483,647 IdentityKey for the Credit Card used for AutoPay Credit
Card
ContractKey Integer 2,147,483,647 IdentityKey for the Contract
IsMasterContract Boolean 1 Define if the contract is the master contract on the account
BankName String 40 The Bank Account used for Autopay Bank Debit
RoutingNumber String 9 The Routing Number for the Bank Account used for Autopay
Bank Debit
- 65 -
ARISWebService
AccountNumber String 17 The AccounNumber for the Bank Account used for Autopay
Bank Debit
- 66 -
ARISWebService
AddCreditCard
Description:
This WebMethod is used to add a Credit Card to a subscriber’s Account.
Use:
This would be used to add new Credit Cards to a subscribers Account.
actual values
POST /ARISWebService1.0.0.3/ARISWebAccount.asmx HTTP/1.1

Host: sapphire
SOAPAction: "http://tempuri.org/AddCreditCard"

<soap:Body>
<AddCreditCard xmlns="http://tempuri.org/">
</AddCreditCard>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddCreditCardResponse xmlns="http://tempuri.org/">
<AddCreditCardResult>boolean</AddCreditCardResult>
</AddCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
ContractKey Integer 2,147,483,647 Required
- 67 -
ARISWebService
Example:
<CreditCardData>
<CardData CardNumber ="4012000033330026" ExpirationDate ="1108" CardHolder= "Web Test Customer 1"
CID="" PostalCode="" PostalCode=”” SaveCreditCard ="1"/>
</CreditCardData>
Output:
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 68 -
ARISWebService
GetCreditCard
Description:
This WebMethod is used to return the Credit Cards on file with the Account.
Use:
This would be used to display to a customer their Credit Cards they have on file on their Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetCreditCard"

<soap:Body>
<GetCreditCard xmlns="http://tempuri.org/">
</GetCreditCard>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetCreditCardResponse xmlns="http://tempuri.org/">
<GetCreditCardResult>boolean</GetCreditCardResult>
<CreditCardSet>
<ARISCreditCard>
<CardNumber>string</CardNumber>
<CardTypeCode>string</CardTypeCode>
<ExpirationDate>string</ExpirationDate>
<ExpDateFormat>string</ExpDateFormat>
<ApplicationType>string</ApplicationType>
</ARISCreditCard>
<ARISCreditCard>
- 69 -
ARISWebService
<CardTypeCode>string</CardTypeCode>
<ExpirationDate>string</ExpirationDate>
<ExpDateFormat>string</ExpDateFormat>
<ApplicationType>string</ApplicationType>
</ARISCreditCard>
</CreditCardSet>
</GetCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
CardNumber String 20 Credit Card Number
CardTypeCode String 3 Credit Card Type – OSS360 defined credit card types. g.
VSA-Visa, AX2-American Express, AX1- American Express,
DSC-Discover, MST-MasterCard
ExpirationDate String 8 Card Expiration Date
Format MMYY, MM/YY, MM-YY, YYMM, YY/MM, YY-MM
ExpDateFormat String 4 (MMYY or YYMM) (Default ExprirationDateFormat MMYY)
PostalCode String 10 Reserved for future use. Used for Mode 2 and Mode 3 only.
Postal Code 5 or 9 digit Postal (dash is optional)
Format 99999, 99999-9999, 999999999
CardHolder String 120 Name of Card Holder
CardNumberKey Integer 2,147,483,647 Credit Card Number Key
ContractKey Integer Undefined Reserved for future use.
ApplicationType String Undefined Reserved for future use.
- 70 -
ARISWebService
EditCreditCard
Description:
This WebMethod is used to edit a Credit Card on a subscriber’s Account.
Use:
This would be used to edit an existing Credit Cards on a subscriber’s Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/EditCreditCard"

<soap:Body>
<EditCreditCard xmlns="http://tempuri.org/">
</EditCreditCard>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditCreditCardResponse xmlns="http://tempuri.org/">
<EditCreditCardResult>boolean</EditCreditCardResult>
</EditCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
- 71 -
ARISWebService
Example:
<CreditCardData>
<CardData CardNumberKey=”1234” CardNumber ="4012000033330026" ExpirationDate ="1108" CardHolder=
"Web Test Customer 1" SaveCreditCard ="1"/>
</CreditCardData>
Output:
0 - Unsuccessful
- 72 -
ARISWebService
RemoveCreditCard
Description:
This WebMethod is used to remove a Credit Card from subscriber’s Account.
Use:
This would be used to remove a Credit Card from a subscriber’s Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/RemoveCreditCard"

<soap:Body>
<RemoveCreditCard xmlns="http://tempuri.org/">
</RemoveCreditCard>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<RemoveCreditCardResponse xmlns="http://tempuri.org/">
<RemoveCreditCardResult>boolean</RemoveCreditCardResult>
</RemoveCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
CardNumberKey Integer 2,147,483,647 Required
Output:
0 - Unsuccessful
- 73 -
ARISWebService
- 74 -
ARISWebService
AutoPayOption
Description:
This WebMethod is used to change the AutoPay option.
Use:
This would be used to change a Customer’s Contract Terms between Net, Credit Card, and Direct Debit.
actual values

Host: citrine
SOAPAction: "http://tempuri.org/AutoPayOption"

<soap:Header>
<A360Login xmlns="http://tempuri.org/">
<EmpCode>string</EmpCode>
<EmpPassword>string</EmpPassword>
</A360Login>
</soap:Header>
<soap:Body>
<AutoPayOption xmlns="http://tempuri.org/">
<AlternateTermKey>int</AlternateTermKey>
<XML_DirectDebitData>string</XML_DirectDebitData>
<AllContracts>int</AllContracts>
</AutoPayOption>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AutoPayOptionResponse xmlns="http://tempuri.org/">
<AutoPayOptionResult>boolean</AutoPayOptionResult>
</AutoPayOptionResponse>
</soap:Body>
- 75 -
ARISWebService
</soap:Envelope>
Input:
ContractKey Integer 2,147,483,647 Required if AllContracts =0
AlternateTermKey Integer 2,147,483,647 Required: Note use the GetAvailableTermsCodes method to
get the Alternate Terms key
CardNumberKey Integer 2,147,483,647 Required: See Please Note below
XML_CreditCardData String 8,000 Optional: See Please Note below
XML_DirectDebitData String 8,000 Optional: See Please Note below
AllContracts Integer 1 Required: 0 – Specific Contract, 1 – All Contracts
Output:
0 – Unsuccessful
Please Note:
1. The CardNumberKey is always required. When unnecessary pass a 0.
2. The CardNumberKey will be evaluated, if greater than 0 then CardNumberKey will be used otherwise
XML_CardCardData or XML_DirectDebitData will be used.
3. If the AlternateTermKey references a Credit Card Type Terms Code then the XML_CardCardData is required.
4. If the AlternateTermsKey references Direct Debit Type Terms Code then the XML_DirectDebitData is required.
XML_CreditCardData Fields:

CID String 5 Optional Card Identification Number also referred to
as CVV2, CVC2
PostalCode String 10 Optional Postal Code 5 or 9 digit Postal (dash is
optional)
Format 99999, 99999-9999, 999999999
ExpirationDate String 8 Required Format MMYY, MM/YY, MM-YY, YYMM,
YY/MM, YY-MM
ExpDateFormat String 4 Optional MMYY (Default format if not passed)
or YYMM
SaveCreditCard String 1 Required Save Credit Card on file with Account
Example:
<![CDATA[
<CreditCardData>
<CardData CardNumber ="4012000033330026" ExpirationDate ="1109" ExpDateFormat="MMYY" CardHolder=
"Web Test Customer 1" CID="" PostalCode="" SaveCreditCard ="0"/>
</CreditCardData>
]]>
treated as strings.
- 76 -
ARISWebService
XML_DirectDebitData Fields:

BankName String 40 Required Name of the Bank
AccountType String 1 Required C = Checking, S = Savings
RoutingNumber String 9 Required 9 Digit Routing Number
AccountNumber String 17 Required Account Number
Example:
<![CDATA[
<DirectDebitData>
<DebitData>BankName ="Wells Fargo" AccountType = “C” RoutingNumber = “122000247” AccountNumber =
“1000000000000”/>
</DirectDebitData>
]]>
treated as strings.
- 77 -
ARISWebService
- 78 -
ARISWebService
GetAvailableTermsCodes
Description:
This WebMethod is used to return the Avaliable Terms Codes for the Customer and the first Contract they have.
Use:
This would be used to display to a customer their available Access Billing Contract Terms to choose from.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetAvailableTermsCodes"

<soap:Body>
<GetAvailableTermsCodes xmlns="http://tempuri.org/">
</GetAvailableTermsCodes>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAvailableTermsCodesResponse xmlns="http://tempuri.org/">
<GetAvailableTermsCodesResult>boolean</GetAvailableTermsCodesResult>
<TermsCodesSet>
<ARISTermsCodes>
<TermsCode>string</TermsCode>
<TermsCodeDescription>string</TermsCodeDescription>
<TermsKey>int</TermsKey>
<IsCurrentTerms>boolean</IsCurrentTerms>
</ARISTermsCodes>
<ARISTermsCodes>
<TermsCode>string</TermsCode>
<IsCurrentTerms>boolean</IsCurrentTerms>
- 79 -
ARISWebService
</ARISTermsCodes>
</TermsCodesSet>
</GetAvailableTermsCodesResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
TermsCode String 3 Unique identifier for Terms Code
TermsCodeDescription String 40 Description of Terms Code
TermsKey Integer 2,147,483,647 IdentityKey for the Terms Code
IsCurrentTerms Integer 1 1 – Yes
0 - No
- 80 -
ARISWebService
CreateAffinity
Description:
This WebMethod is used to create affinities. This includes AgentIDs, Agent Bill To Account, Agreement Code, Communitiy
of Interest, Talk Group, Agent SLM, and assigning of commissioning structure.
Use:
This would be used to create an Affinity Group.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetAffinity"

<soap:Body>
<GetAffinity xmlns="http://tempuri.org/">
</GetAffinity>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAffinityResponse xmlns="http://tempuri.org/">
<GetAffinityResult>boolean</GetAffinityResult>
<AffinityEntitySet>
<ARISAffinityEntity>
<AffinityID>string</AffinityID>
<AffinityName>string</AffinityName>
<AffinityContact>string</AffinityContact>
<AffinityAddress1>string</AffinityAddress1>
<AffinityCity>string</AffinityCity>
<AffinityState>string</AffinityState>
<AffinityPostalCode>string</AffinityPostalCode>
<AffinityPhone>string</AffinityPhone>
<AffinityEmail>string</AffinityEmail>
<LogoPathFileName>string</LogoPathFileName>
</ARISAffinityEntity>
- 81 -
ARISWebService
<LogoPathFileName>string</LogoPathFileName>
</AffinityEntitySet>
</GetAffinityResponse>
</soap:Body>
</soap:Envelope>
Input:
Logo String 255 Optional
Name String 40 Required
ContactName String 80 Required
Phone String 80 Required- when blank we delete the number
EmailAddress String 80 Required- when blank we delete the number
Output:
AgentID String 6 Agent Number
0 - Unsuccessful
- 82 -
ARISWebService
GetAffinity
Description:
This WebMethod is used to return the affinities entity information.
Use:
This would be used to display the Affinities Contact Name, Address, Phone, and E-mail information.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetAffinity"

<soap:Body>
<GetAffinity xmlns="http://tempuri.org/">
</GetAffinity>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAffinityResponse xmlns="http://tempuri.org/">
<GetAffinityResult>boolean</GetAffinityResult>
<AffinityEntitySet>
<Logo>string</Logo>
- 83 -
ARISWebService
<Logo>string</Logo>
</AffinityEntitySet>
</GetAffinityResponse>
</soap:Body>
</soap:Envelope>
Input:
AgentID String 6 Required
Output:
AffinityID String 11 AffinityID which customer is defined
AffinityName String 40 Name of Affinity which is customer defined
AffinityContact String 40 Name of Customer / Contact
AffinityAddress1 String 40 Address line 1
AffinityAddress2 String 40 Address line 2
AffinityCity String 40 City
AffinityState String 20 State
AffinityPostalCode String 10 Postal code
AffinityPhone String 80 Phone number
AffinityEmail String 80 Email address
LogoPathFileName String 255 Location path of logo
- 84 -
ARISWebService
UpdateAffinity
Description:
This WebMethod is used to update the Affinities contact information.
Use:
This would be used to update an Affinities name, contact, address, phone, e-mail, or logo information.
actual values
POST /ArisWebService/ARISWebAccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/UpdateAffinity"

<soap:Body>
<UpdateAffinity xmlns="http://tempuri.org/">
<City>string</City>
<Phone>string</Phone>
<eMail>string</eMail>
<Logo>string</Logo>
</UpdateAffinity>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<UpdateAffinityResponse xmlns="http://tempuri.org/">
<UpdateAffinityResult>boolean</UpdateAffinityResult>
</UpdateAffinityResponse>
</soap:Body>
</soap:Envelope>
- 85 -
ARISWebService
Input:
AffinityName String 40 Optional
AffinityContact String 40 Optional
City String 40 Optional
State String 20 Optional
PostalCode String 10 Optional
Phone String 80 Required, when blank we delete the number
eMail String 80 Required, when blank we delete the address
Logo String 255 Optional
Output:
-[value] – Unsuccessful
Note:
1. To update an AffinityName or Address you must pass the AffinityName, Address1, Address2, City, State, and
PostalCode data.
- 86 -
ARISWebService
GetAffinityBalance
Description:
This WebMethod is used to
Use:
This would be used to display
actual values

Host: local host
SOAPAction: "http://tempuri.org/GetAffinityBalance"

<soap:Body>
<GetAffinityBalance xmlns="http://tempuri.org/">
</GetAffinityBalance>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAffinityBalanceResponse xmlns="http://tempuri.org/">
<GetAffinityBalanceResult>boolean</GetAffinityBalanceResult>
<AffinityBalanceSet>
<ARISAffinityBalance>
<PreviousBalance>decimal</PreviousBalance>
<CommEarned>decimal</CommEarned>
<EarnedDate>dateTime</EarnedDate>
<CommRedeemed>decimal</CommRedeemed>
<RedeemedDate>dateTime</RedeemedDate>
<CommAdjustments>decimal</CommAdjustments>
<AdjustmentDate>dateTime</AdjustmentDate>
<VendorKey>int</VendorKey>
</ARISAffinityBalance>
<ARISAffinityBalance>
- 87 -
ARISWebService
<PreviousBalance>decimal</PreviousBalance>
<CommEarned>decimal</CommEarned>
<EarnedDate>dateTime</EarnedDate>
<CommRedeemed>decimal</CommRedeemed>
<RedeemedDate>dateTime</RedeemedDate>
<CommAdjustments>decimal</CommAdjustments>
<AdjustmentDate>dateTime</AdjustmentDate>
<VendorKey>int</VendorKey>
</ARISAffinityBalance>
</AffinityBalanceSet>
</GetAffinityBalanceResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
PreviousBalance Decimal 999999999.99 Previous Balance on account
CommEarned Decimal 999999999.99 commission earned by the employee
EarnedDate String 20 Date earned
CommRedeemed Decimal 999999999.99 Commission redeemed by the employee
RedeemedDate String 20 Date redeemed
CommAdjustments Decimal 999999999.99 Commissions adjusted by the employee
AdjustmentDate String 20 Date adjusted
AgentID String 6 Agent Number
VendorKey Integer 2,147,483,647 VendoryKey for Vendor added
CustomerNo String 11 Customer number for account added
- 88 -
ARISWebService
AddNumberInventory
Description:
This WebMethod is used to Add a LNP number to Number Inventory.
Use:
This would be used to add the LNP number to Number Inventory so it can be activated.
actual values
POST /ARISWebService/ariswebaccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/AddNumberInventory"

<soap:Body>
<AddNumberInventory xmlns="http://tempuri.org/">
<ID>string</ID>
<PortingType>string</PortingType>
<SystemKey>int</SystemKey>
<Price>decimal</Price>
</AddNumberInventory>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddNumberInventoryResponse xmlns="http://tempuri.org/">
<AddNumberInventoryResult>boolean</AddNumberInventoryResult>
</AddNumberInventoryResponse>
</soap:Body>
</soap:Envelope>
Input:
ID String 10 Required
PortingType String 1 Required: Pass I for Porting In
Output:
IDInventoryKey Integer 1 1 – Successful
0 - Unsuccessful
- 89 -
ARISWebService
- 90 -
ARISWebService
GetOrderStatus
Description:
This WebMethod is used to return the shipping status for line items within a Sales Order.
Use:
This would be used to display the status of items ordered on a website including the tracking numbers.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetOrderStaus"

<soap:Body>
<GetOrderStaus xmlns="http://tempuri.org/">
</GetOrderStaus>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetOrderStausResponse xmlns="http://tempuri.org/">
<GetOrderStausResult>boolean</GetOrderStausResult>
<OrderStatusSet>
<ARISOrderStatus>
<Item>string</Item>
<TrackingNumber>string</TrackingNumber>
</ARISOrderStatus>
<ARISOrderStatus>
<Item>string</Item>
- 91 -
ARISWebService
<TrackingNumber>string</TrackingNumber>
</ARISOrderStatus>
</OrderStatusSet>
</GetOrderStausResponse>
</soap:Body>
</soap:Envelope>
Input:
SalesOrderNo String 8 Required
Output:
Item String 23 SKU / Item Number
Description String 40 Description of Item
UnitID2 String 16 IMSI, MIN, etc.
UnitID3 String 23 ICCID, ESN, etc.
Status String 12 “Not Invoiced” or “Invoiced”
TrackingNumber String 30 Tracking Number for line item when Invoiced
- 92 -
ARISWebService
CreateSalesOrder
Description:
This WebMethod is used for creating Sales Orders for items being purchased.
Use:
This would be used to generate a Sales Order for accessories, handset purchases, new lines of service including
activations, etc.
actual values
POST /ArisWebService/ARISWebAccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/CreateSalesOrder"

<soap:Body>
<CreateSalesOrder xmlns="http://tempuri.org/">
</CreateSalesOrder>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CreateSalesOrderResponse xmlns="http://tempuri.org/">
<CreateSalesOrderResult>boolean</CreateSalesOrderResult>
<WebOutputDataSet>
<ARISWebOutputData>
- 93 -
ARISWebService
<ARISWebOutputData>
</WebOutputDataSet>
</CreateSalesOrderResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_UnitIDDoc String 8,000 Optional (Refer to CreateAccount for structure of XML doc)
XML_UnitRatesDoc String 8,000 Optional (Refer to CreateAccount for structure of XML doc)
XML_CreditCardData String 8,000 Optional (Refer to CreateAccount for structure of XML doc)
XML_LineItems String 8,000 Required (Refer to CreateAccount for structure of XML doc)
Output:
CustomerNo String 11 Customer Number for the Account
CustomerKey Integer 2,147,483,647 Primary Key of the Customer
SalesOrderNo String 8 Sales Order Number for SO added

rejected.
upon completion.

PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',

'NOT CAPTURED',
'NOT APPROVED',
'SALE NOT FOUND',
- 94 -
ARISWebService
'ERROR'
ReturnValue Integer 2,147,483,647 1 – Success
0 – Unsuccessful
Notes on when to populate the parameters:
1. Sale for Accessory with no Credit Card on file

a. Need to populate CustomerNo, XML_LineItems, and XML_CredtCardData.
2. Sale for Accessory with Credit Card on file

a. Need to populate CustomerNo and XML_LineItems.
3. Sale for Handset with no Credit Card on file (upgrade)

4. Sale for Handset with Credit Card on file (upgrade)

5. Sale for Handset with new Activation with no Credit Card on file (Add a line)
a. Need to populate CustomerNo, XML_UnitIDDoc, XML_UnitRatesDoc, XML_CredtCardData, and
XML_LineItems.
6. Sale for Handset with new Activation with Credit Card on file (Add a line)
a. Need to populate CustomerNo, XML_UnitIDDoc, XML_UnitRatesDoc, and XML_LineItems
- 95 -
ARISWebService
- 96 -
ARISWebService
GetReasonCodes
Description:
This WebMethod is used to return different Reason Codes for Temp Deacts, Perm Deacts, Exchange of ESNs.
Use:
This would be used to display the list choices of reasons why a customer is making a change.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetReasonCodes"

<soap:Body>
<GetReasonCodes xmlns="http://tempuri.org/">
<ServiceChangeType>string</ServiceChangeType>
</GetReasonCodes>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetReasonCodesResponse xmlns="http://tempuri.org/">
<GetReasonCodesResult>boolean</GetReasonCodesResult>
<ReasonCodesSet>
<ARISReasonCodes>
<ReasonCodeKey>int</ReasonCodeKey>
</ARISReasonCodes>
<ARISReasonCodes>
</ARISReasonCodes>
</ReasonCodesSet>
</GetReasonCodesResponse>
</soap:Body>
</soap:Envelope>
- 97 -
ARISWebService
Input:
ServiceChangeType String 2 Required
Output:
Description String 40 Description for Reason Code
ReasonCodeKey Integer 2,147,483,647 Primary Key for Reason Code
Note:
Pass “AX” to return Reason Codes for ExchangeID.
- 98 -
ARISWebService
ExchangeID
Description:
This WebMethod is used to exchange the ESN for a Handset.
Use:
This would be used to exchange an ESN on an Activated BID for a new handset or existing handset.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/ExchangeID"

<soap:Body>
<ExchangeID xmlns="http://tempuri.org/">
<EID>string</EID>
<Make>string</Make>
<Model>string</Model>
<SystemKey>int</SystemKey>
</ExchangeID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<ExchangeIDResponse xmlns="http://tempuri.org/">
<ExchangeIDResult>boolean</ExchangeIDResult>
</ExchangeIDResponse>
</soap:Body>
</soap:Envelope>
Input:
- 99 -
ARISWebService

EID String 24 Required
Make String 15 Optional
Model String 15 Optional
ReasonCodeKey Integer 2,147,483,647 Optional
SystemKey Integer 2,147,483,647 Optional
Output:
2 – Could not AppLock Unit or is already AppLocked
3 -- BID is not currently Active
4 -- EID UnitType is invalid
5 -- No Exchange Service Change Code Deact or React
6 -- Different SystemInterfaceKey tied to the ID change
7 -- Exchange ID failed
- 100 -
ARISWebService
EditAddress
Description:
This WebMethod is used to update or add an Address of a specific Type for an Account. If the address Type being
passed does not exist then the address will be added. If the address Type already exists then we’ll perform an Edit that
will result in a new add for the date / time as we retain history of address changes.
Use:
This would be used to update / add any type of Address for an Account.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/EditAddress"

<soap:Body>
<EditAddress xmlns="http://tempuri.org/">
<AddressType>string</AddressType>
<City>string</City>
</EditAddress>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditAddressResponse xmlns="http://tempuri.org/">
<EditAddressResult>boolean</EditAddressResult>
<AddressIDKey>int</AddressIDKey>
</EditAddressResponse>
</soap:Body>
</soap:Envelope>
- 101 -
ARISWebService
Input:
B -Business Main
I -Bill To
S -Ship To
N -Notice
P -Promotion
O -Other
Output:
0 - Unsuccessful
AddressIDKey Integer 2,147,483,647 Identity Key of newly added Address row
- 102 -
ARISWebService
EditPhones
Description:
This WebMethod is used to edit phone numbers on an Account. Edit results in a new add for the date/time as we retain
history of phone number changes.
Use:
This would be used to update any phone number on an Account
actual values

Host: localhost
SOAPAction: "http://tempuri.org/EditPhones"

<soap:Body>
<EditPhones xmlns="http://tempuri.org/">
<PhoneType>string</PhoneType>
<PhoneNumber>string</PhoneNumber>
<PhoneExt>string</PhoneExt>
</EditPhones>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditPhonesResponse xmlns="http://tempuri.org/">
<EditPhonesResult>boolean</EditPhonesResult>
<PhoneIDKey>int</PhoneIDKey>
</EditPhonesResponse>
</soap:Body>
</soap:Envelope>
Input:
PhoneType String 1 Required:
BM -Business Main
H -Home Phone
E -E-mail Address
- 103 -
ARISWebService
PhoneNumber String 40 Required

PhoneExt String 40 Required
Output:
0 - Unsuccessful
PhoneIDKey Integer 2,147,483,647 Identity Key of newly added Phone row
- 104 -
ARISWebService
GetBillDetails
Description:
This WebMethod is used to return the Invoice summary details for last Access Invoice for the Customer.
Use:
This would be used to display the last invoice summary information for a Customer.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetBillDetails"

<soap:Body>
<GetBillDetails xmlns="http://tempuri.org/">
</GetBillDetails>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBillDetailsResponse xmlns="http://tempuri.org/">
<GetBillDetailsResult>boolean</GetBillDetailsResult>
<BillDetailsSet>
<ARISBillDetails>
<Date>string</Date>
<DueDate>string</DueDate>
<CustomerName>string</CustomerName>
<BillingPeriod>string</BillingPeriod>
<BeginBalance>decimal</BeginBalance>
<Payments>decimal</Payments>
<TotalOtherCredits>decimal</TotalOtherCredits>
<BalanceForward>decimal</BalanceForward>
<RecurringCharges>decimal</RecurringCharges>
<UsageCharges>decimal</UsageCharges>
<NonRecurringCharges>decimal</NonRecurringCharges>
- 105 -
ARISWebService
<TotalCurrentTaxes>decimal</TotalCurrentTaxes>
<TotalCurrentCharges>decimal</TotalCurrentCharges>
<TotalAmountDue>decimal</TotalAmountDue>
</ARISBillDetails>
<ARISBillDetails>
<Date>string</Date>
<DueDate>string</DueDate>
<BillingPeriod>string</BillingPeriod>
<BeginBalance>decimal</BeginBalance>
<Payments>decimal</Payments>
<TotalOtherCredits>decimal</TotalOtherCredits>
<BalanceForward>decimal</BalanceForward>
<RecurringCharges>decimal</RecurringCharges>
<UsageCharges>decimal</UsageCharges>
<NonRecurringCharges>decimal</NonRecurringCharges>
<TotalCurrentTaxes>decimal</TotalCurrentTaxes>
<TotalCurrentCharges>decimal</TotalCurrentCharges>
</ARISBillDetails>
</BillDetailsSet>
</GetBillDetailsResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
CustomerNo String 11 Customer Number of Account
InvoiceNo String 9 Invoice Number for Access Invoice
Date String 10 Date used for start of terms or Invoice Date
DueDate String 10 Date Access Invoice is due
CustomerName String 80 Name of Customer
BillingPeriod String 23 Billing Period for Access Invoice
BeginBalance Decimal 999999999.99 Beginning Balance
Payments Decimal 999999999.99 Payments as reflected on Invoice
TotalOtherCredits Decimal 999999999.99 Credits as reflected on Invoice
BalanceForward Decimal 999999999.99 Balance Forward as reflected on Invoice
RecurringCharges Decimal 999999999.99 Recurring Charges as reflected on Invoice
UsageCharges Decimal 999999999.99 Usage Charges as reflected on Invoice
NonRecurringCharges Decimal 999999999.99 Non Recurring Charges as reflected on Invoice
TotalCurrentTaxes Decimal 999999999.99 Total of Current Taxes as reflected on Invoice
TotalCurrentCharges Decimal 999999999.99 Total of Current Charges as reflected on Invoice
TotalAmountDue Decimal 999999999.99 Total Amount Due as reflected on Invoice
ContractNo String 3 String representation of the Contract Number
ContractKey Integer 2,147,483,647 IdentityKey from Contract
IsMasterContract Boolean 1 Designator for the Master Contract
- 106 -
ARISWebService
GetBillCharges
Description:
This WebMethod is used to return the line items charges and taxes for the last Access Invoice for the Customer.
Use:
This would be used to display an Invoice in an html view in a web page.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetBillCharges"

<soap:Body>
<GetBillCharges xmlns="http://tempuri.org/">
</GetBillCharges>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBillChargesResponse xmlns="http://tempuri.org/">
<GetBillChargesResult>boolean</GetBillChargesResult>
<BillChargesSet>
<ARISBillCharges>
<BilledDates>string</BilledDates>
<RecordCount>int</RecordCount>
<VolumeUsed>decimal</VolumeUsed>
<VolumeFree>decimal</VolumeFree>
<ChargeTotal>decimal</ChargeTotal>
<BIDTotal>decimal</BIDTotal>
<ChargeType>string</ChargeType>
<RecID>int</RecID>
<TaxTotalPerBID>decimal</TaxTotalPerBID>
- 107 -
ARISWebService
<LineItemTotalPerBID>decimal</LineItemTotalPerBID>
<SortOrder>string</SortOrder>
</ARISBillCharges>
<ARISBillCharges>
<BilledDates>string</BilledDates>
<RecordCount>int</RecordCount>
<VolumeUsed>decimal</VolumeUsed>
<VolumeFree>decimal</VolumeFree>
<ChargeTotal>decimal</ChargeTotal>
<BIDTotal>decimal</BIDTotal>
<ChargeType>string</ChargeType>
<RecID>int</RecID>
<TaxTotalPerBID>decimal</TaxTotalPerBID>
<LineItemTotalPerBID>decimal</LineItemTotalPerBID>
<SortOrder>string</SortOrder>
</ARISBillCharges>
</BillChargesSet>
</GetBillChargesResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
InvoiceNo String 9 InvoiceNo for Access Invoice
Description String 40 Invoice line Description. Rate Code, Add-On Item, Taxes,
etc.
BilledDates String 23 Billing Period for Access Invoice
RecordCount Integer 999999999.99 Number of records billed.
VolumeUsed Decimal 999999999.99 Quantity of cdrs
VolumeFree Decimal 999999999.99 Quantity of free cdrs
ChargeTotal Decimal 999999999.99 Total charge for particular line
BIDTotal Decimal 999999999.99 Total charge per BID for particular line
ChargeType String 3 CHG = Charge, TAX = Tax
UnitSystemKey Integer 2,147,483,647 IdentityKey from BID
RecID Integer 2,147,483,647 IdentityKey from Invoice line
TaxTotalPerBID Decimal 999999999.99 Tax Total BID
LineItemTotalPerBID Decimal 999999999.99 Tax Total BID
ContractNo String 3 String representation of the Contract Number
ContractKey Integer 2,147,483,647 IdentityKey from Contract
IsMasterContract Boolean 1 Designator for the Master Contract
SortOrder String Order of line item display
- 108 -
ARISWebService
GetCallDetail
Description:
This WebMethod is used to return the call detail of the last Access Invoice for the Customer.
Use:
This would be used to display
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetCallDetail"

<soap:Body>
<GetCallDetail xmlns="http://tempuri.org/">
</GetCallDetail>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetCallDetailResponse xmlns="http://tempuri.org/">
<GetCallDetailResult>boolean</GetCallDetailResult>
<CallDetailsSet>
<ARISCallDetails>
<DateOfCall>string</DateOfCall>
<TimeOfCall>string</TimeOfCall>
<Destination>string</Destination>
<NumberCalled>string</NumberCalled>
<Period>string</Period>
<Duration>decimal</Duration>
<AirtimeCharges>decimal</AirtimeCharges>
<TollCharges>decimal</TollCharges>
<UsageType>string</UsageType>
</ARISCallDetails>
- 109 -
ARISWebService
<ARISCallDetails>
</ARISCallDetails>
</CallDetailsSet>
</GetCallDetailResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
DateOfCall String 10 Date of cdr
TimeOfCall String 8 Time of cdr
Destination String 20 Destination City, State, Etc. called
NumberCalled String 16 Number called
Period String 9 Rate Period which the call was rated
Duration Decimal 999999999 Rounded duration of cdr
AirtimeCharges Decimal 999999999.99 Airtime charge
TollCharges Decimal 999999999.99 Toll charge
Total Decimal 999999999.99 Sum of Airtime and Toll Charges
UsageType String 1 V = Voice, M = Messages, D = Data, C = Content,
R = Roaming
- 110 -
ARISWebService
GetRecentUsage
Description:
This WebMethod is used to return the recent unbilled usage for the current bill cycle for the Customer.
Use:
This would be used to display the current bill cycle unbilled cdrs.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetRecentUsage"

<soap:Body>
<GetRecentUsage xmlns="http://tempuri.org/">
</GetRecentUsage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetRecentUsageResponse xmlns="http://tempuri.org/">
<GetRecentUsageResult>boolean</GetRecentUsageResult>
<CurrentUsageSet>
<ARISCurrentUsage>
</ARISCurrentUsage>
<ARISCurrentUsage>
- 111 -
ARISWebService
</ARISCurrentUsage>
</CurrentUsageSet>
</GetRecentUsageResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
DateOfCall String 10 Date of cdr
TimeOfCall String 8 Time of cdr
Destination String 20 Destination City, State, Etc. called
NumberCalled String 16 Number called
Period String 9 Rate Period which the call was rated
Duration Decimal 999999999 Rounded duration of cdr
AirtimeCharges Decimal 999999999.99 Airtime charge
TollCharges Decimal 999999999.99 Toll charge
Total Decimal 999999999.99 Sum of Airtime and Toll Charges
UsageType String 1 V = Voice, M = Messages, D = Data, R = Roaming, C =
Content
- 112 -
ARISWebService
AddUsageRecord
Description:
This WebMethod is used to add usage.
Use:
This would be used to manually add usage to the tables.
actual values

Host: local host
SOAPAction: "http://tempuri.org/AddUsageRecord"

<soap:Body>
<AddUsageRecord xmlns="http://tempuri.org/">
<Type>string</Type>
<StartDateTime>string</StartDateTime>
<OrigPartyID1>string</OrigPartyID1>
<OrigPartyID2>string</OrigPartyID2>
<TermPartyID1>string</TermPartyID1>
<TermPartyID2>string</TermPartyID2>
<Duration>int</Duration>
</AddUsageRecord>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddUsageRecordResponse xmlns="http://tempuri.org/">
<AddUsageRecordResult>boolean</AddUsageRecordResult>
<RawUsageKey>int</RawUsageKey>
</AddUsageRecordResponse>
</soap:Body>
</soap:Envelope>
- 113 -
ARISWebService
Input:
S – SMS
M - MMS
StartDateTime String 23 Required
OrigPartyID1 String 16 Required
OrigPartyID2 String 16 Optional
TermPartyID1 String 16 Required
TermPartyID2 String 16 Optional
Price Decimal 999999999.99 Required
Duration Int 4 Required:
Duration is per event. (1 = 1 Message)
Output:
RawUsageKey Integer 2,147,483,647 Primary Key of the Raw Usage row.
- 114 -
ARISWebService
GetBalanceSummary
Description:
This WebMethod is used for returning the Balance Summary, Last Payment and Last Access Invoice.
Use:
This would be used to display balances, last payment, and past due amounts for an account.
actual values

Host: local host
SOAPAction: "http://tempuri.org/GetBalanceSummary"

<soap:Body>
<GetBalanceSummary xmlns="http://tempuri.org/">
</GetBalanceSummary>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBalanceSummaryResponse xmlns="http://tempuri.org/">
<GetBalanceSummaryResult>boolean</GetBalanceSummaryResult>
<BalanceSummarySet>
<ARISBalanceSummary>
<LastPayment>decimal</LastPayment>
<LastPaymentDate>string</LastPaymentDate>
<PastDueBalance>decimal</PastDueBalance>
<PaymentDueDate>string</PaymentDueDate>
<PaymentType>string</PaymentType>
</ARISBalanceSummary>
- 115 -
ARISWebService
</BalanceSummarySet>
</GetBalanceSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
CustomerNo String 11 Optional – CustomerNo or UnitID1 is required
UnitID1 String 16 Optional – CustomerNo or UnitID1 is required
Output:
LastPayment Decimal 999999999.99 Last payment posted to account
Reference String 40 Reference of last payment posted
LastPaymentDate String 10 Date of last payment posted
PastDueBalance Decimal 999999999.99 Past due balance on account
TotalAmountDue Decimal 999999999.99 Total amount due on account
PaymentDueDate DateTime 10 Due date of payment for last access invoice generated
PaymentType String 20 Payment type of last payment posted
InvoiceNo String 9 Invoice number of last access invoice generated
PaymentKey Integer 2,147,483,647 IdentityKey from Payment
- 116 -
ARISWebService
GetTreatmentGroupBalances
Description:
This WebMethod is used for returning the balances for the different Treatment Group buckets 1-9.
Use:
This would be used to display balances based from the Treatment Groups setup. (i.e. Mobile, Landline, ISP, etc.)
actual values
Request Placeholder
Response Placeholder
Input:
TreatmentGroup String 1 Required
Output:
Group1Balance Decimal 999999999.99 Treatment Group 1 balance
AccountBalance Decimal 999999999.99 Account balance
PastDueBalance Decimal 999999999.99 Past due Account balance
- 117 -
ARISWebService
- 118 -
ARISWebService
GetCustomerPersonalData
Description:
This WebMethod is used to get the customer's personal data, needed to login in to the system. If the Customer forgets
their password, provide the secret question. If the secret answer matches the one in the system, email the password to
the customer.
Use:
This would be used to display personal information for the customer to retrieve their password.
actual values

Host: local host
SOAPAction: "http://tempuri.org/GetCustomerPersonalData"

<soap:Body>
<GetCustomerPersonalData xmlns="http://tempuri.org/">
</GetCustomerPersonalData>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetCustomerPersonalDataResponse xmlns="http://tempuri.org/">
<GetCustomerPersonalDataResult>boolean</GetCustomerPersonalDataResult>
<Question>string</Question>
<QuestionKey>int</QuestionKey>
<Answer>string</Answer>
</GetCustomerPersonalDataResponse>
</soap:Body>
</soap:Envelope>
- 119 -
ARISWebService
Input:
Output:
Question String 40 Description of secret question
QuestionKey Integer 2,147,483,647 IdentityKey from secret question
Answer String 48 Answer to secret question
Email String 80 Customer’s email address
Password String 20 Customer’s password on account
CustomerKey Integer 2,147,483,647 IdentityKey from customer
- 120 -
ARISWebService
RegisterAccount
Description:
This WebMethod is used to update Secret Question, Secret Answer, Email Address, and Password once the user has
been authenticated by providing their BID and either SSN or drivers license.
Use:
This would be used to register a customer’s account.
actual values

Host: local host
SOAPAction: "http://tempuri.org/RegisterAccount"

<soap:Body>
<RegisterAccount xmlns="http://tempuri.org/">
<SSN>string</SSN>
<DriversLicense>string</DriversLicense>
<SecretQuestionKey>int</SecretQuestionKey>
<EmailAddress>string</EmailAddress>
<PassPhrase>string</PassPhrase>
</RegisterAccount>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<RegisterAccountResponse xmlns="http://tempuri.org/">
<RegisterAccountResult>boolean</RegisterAccountResult>
</RegisterAccountResponse>
</soap:Body>
</soap:Envelope>
- 121 -
ARISWebService
Input:
DriversLicense String 20 Required
SecretQuestionKey Integer 2,147,483,647 IdentityKey from secret question
SecretAnswer String 48 Answer to secret question
EmailAddress String 80 Customer’s email address
PassPhrase String 20 Customer’s password on account
Output:
CustomerNo String 11 Customer’s account number
CustomerName String 80 Name of customer
ReturnValue String 1 1 - Successful
2 - Mobile Number Not Found
3 - SSN Not Found
4 - SSN Does Not Match
5 - DL Not Found
6 - DL Does Not Match
- 122 -
ARISWebService
AccountLogin
Description:
This WebMethod is used verify the user. Accepts a users BID and Password as parameters and compares the password
to the one on file for the BID.
Use:
This would be used to display the login page to access the customer’s information.
actual values

Host: local host
SOAPAction: "http://tempuri.org/AccountLogin"

<soap:Body>
<AccountLogin xmlns="http://tempuri.org/">
<PassPhrase>string</PassPhrase>
</AccountLogin>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AccountLoginResponse xmlns="http://tempuri.org/">
<AccountLoginResult>boolean</AccountLoginResult>
</AccountLoginResponse>
</soap:Body>
</soap:Envelope>
Input:
PassPhrase String 20 Customer’s password on account
Output:
CustomerNo String 80 Name of customer
- 123 -
ARISWebService

0 - Unsuccessful
- 124 -
ARISWebService
EditRatePlan
Description:
This WebMethod is used to change the customer’s rate plan.
Use:
This would be used to edit a customer’s rate plan.
actual values

Host: local host
SOAPAction: "http://tempuri.org/EditRatePlan"

<soap:Body>
<EditRatePlan xmlns="http://tempuri.org/">
<XMLUnitRatesDoc>string</XMLUnitRatesDoc>
<PlanChangeStart>string</PlanChangeStart>
</EditRatePlan>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditRatePlanResponse xmlns="http://tempuri.org/">
<EditRatePlanResult>boolean</EditRatePlanResult>
</EditRatePlanResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_UnitRatesDoc String 8,000 Required
RatePlanKey Integer 2,147,483,647 IdentityKey from Rate Plan
PlanChangeStart String 1 Optional:
I = Immediate (default)
- 125 -
ARISWebService
C = Cycle Start
Output:
0 - Unsuccessful
InvoiceNo String 9 Invoice Number returned if Invoice was created
TotalAmountDue Decimal 999999999.99 Positive value indicates debit, negative number indicates
credit.
XML_UnitRatesDoc:

UnitKey Integer 2,147,483,647 Required IdentityKey for acUnits
<![CDATA[<RatesData>
<xmlRates UnitKey="-1" MasterKey="5" PackKey="5" RateKey="3" TreeNode="MRP"/>
<xmlRates UnitKey="-1" MasterKey="25" PackKey="25" RateKey="47" TreeNode="IRP"/>
</RatesData>]]>
- 126 -
ARISWebService
AddBankDebit
Description:
This WebMethod is used to add a bank account to a subscriber’s Account.
Use:
This would be used to add new bank account to a subscribers Account for the bank draft process.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/AddBankDebit"

<soap:Body>
<AddBankDebit xmlns="http://tempuri.org/">
<AccountType>string</AccountType>
</AddBankDebit>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddBankDebitResponse xmlns="http://tempuri.org/">
<AddBankDebitResult>boolean</AddBankDebitResult>
</AddBankDebitResponse>
</soap:Body>
</soap:Envelope>
- 127 -
ARISWebService
Input:
BankName String 40 Required
AccountType String 1 Required : C = Checking, S = Savings
RoutingNumber String 9 Required
AccountNumber String 17 Required
Output:
0 - Unsuccessful
- 128 -
ARISWebService
EditBankDebit
Description:
This WebMethod is used to Edit bank account information on a subscriber’s Account.
Use:
This would be used to edit bank account information on a subscribers Account for the purpose of Direct Debit.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/EditBankDebit"

<soap:Body>
<EditBankDebit xmlns="http://tempuri.org/">
<BankDebitDataKey>int</BankDebitDataKey>
</EditBankDebit>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditBankDebitResponse xmlns="http://tempuri.org/">
<EditBankDebitResult>boolean</EditBankDebitResult>
</EditBankDebitResponse>
</soap:Body>
</soap:Envelope>
- 129 -
ARISWebService
Input:
BankDebitDataKey Integer 2,147,483,647 Required
BankName String 40 Required
AccountType String 1 Required : C = Checking, S = Savings
RoutingNumber String 9 Required
AccountNumber String 17 Required
Output:
0 - Unsuccessful
- 130 -
ARISWebService
GetBankDebit
Description:
This WebMethod is used to return the bank account setup on a subscriber’s Account.
Use:
This would be used to display to a customer their bank account information they have on file on their Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetBankDebit"

<soap:Body>
<GetBankDebit xmlns="http://tempuri.org/">
</GetBankDebit>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBankDebitResponse xmlns="http://tempuri.org/">
<GetBankDebitResult>boolean</GetBankDebitResult>
<BankDebitSet>
<ARISBankDebit>
</ARISBankDebit>
<ARISBankDebit>
- 131 -
ARISWebService
</ARISBankDebit>
</BankDebitSet>
</GetBankDebitResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
BankName String 40 Name of Bank Account
AccountType String 1 Type of Account: C = Checking, S = Savings
RoutingNumber String 9 Routing Number of bank account
AccountNumber String 17 Bank Account number
BankDebitDataKey Integer 2,147,483,647 Identity Column for the Bank Debit Data. Needed for the
Edit Bank Data
- 132 -
ARISWebService
GetContract
Description:
This WebMethod is used to return the Contracts for a subscriber’s Account.
Use:
This would be used to display to a customer their Contracts they have on their Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetContract"

<soap:Body>
<GetContract xmlns="http://tempuri.org/">
</GetContract>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetContractResponse xmlns="http://tempuri.org/">
<GetContractResult>boolean</GetContractResult>
<ContractSet>
<ARISContract>
<Terms>string</Terms>
<BillCycle>string</BillCycle>
<DeliveryMethod>string</DeliveryMethod>
<TermsDescription>string</TermsDescription>
</ARISContract>
<ARISContract>
- 133 -
ARISWebService
</ARISContract>
</ContractSet>
</GetContractResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
ContractKey Integer 2,147,483,647 Primary Key of Contracts row
Terms String 1 N = Net, C = Credit Card, D = Direct Debit
BillCycle String 2 Bill Cycle of Contract
Delivery Method String 1 P = Print, F = Fax, E = Email
Destination String 89 Email Address or Fax Number
TermsKey Integer 2,147,483,647 Identity for the Contract Terms
TermsDescription String 40 Terms Description
- 134 -
ARISWebService
InvoiceDeliveryMethod
Description:
This WebMethod is used to update a Contracts delivery method used for Invoice Distribution.
Use:
This would be used to change how a subscriber receives their Access Invoices eacy Bill Cycle.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/GetContract"

<soap:Body>
<GetContract xmlns="http://tempuri.org/">
</GetContract>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetContractResponse xmlns="http://tempuri.org/">
<GetContractResult>boolean</GetContractResult>
<ContractSet>
<ARISContract>
</ARISContract>
<ARISContract>
- 135 -
ARISWebService
</ARISContract>
</ContractSet>
</GetContractResponse>
</soap:Body>
</soap:Envelope>
Input:
DeliveryMethod String 1 Required: P = Print, E = Email
DeliveryAddress String 80 Required: Blank for P, Pre-validated email address for E
AllContracts Integer 1 Optional: 0 – Specific Contract, 1 – All Contracts
Output:
0 – Unsuccessful
- 136 -
ARISWebService
DeactivateUnit
Description:
This WebMethod is used to perform a temporary or permanent deactivation, a reactivation, or a temporary restriction on a
BID.
Use:
This would be used to change the status of a BID on the subscriber’s Account.
actual values

Host: sapphire
SOAPAction: "http://tempuri.org/DeactivateUnit"

<soap:Body>
<DeactivateUnit xmlns="http://tempuri.org/">
< UnitSystemKey>int</ UnitSystemKey>
< ServiceChangeKey>int</ ServiceChangeKey>
<ServiceChange>string</ServiceChange>
</ DeactivateUnit>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<DeactivateUnitResponse xmlns="http://tempuri.org/">
<DeactivateUnitResult>boolean</DeactivateUnitResult>
</ DeactivateUnitResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitSystemKey Integer 2,147,483,647 Required - IdentityKey from BID
ServiceChangeKey Integer 2,147,483,647 Conditional
ServiceChangeKey for Temporary Deactivation, Permanent
Deactivation, Reactivation, or Temporary Restriction Service
Change
ServiceChange String 1 Conditional
D = Temporary Deactivation
- 137 -
ARISWebService
P = Permanent Deactivation
A = Reactivation
E = Temporary Restriction
Output:
-[value] = Unsuccessful
-1 = No Web Employee defined
-2 = UnitSystemKey not found
-3 = Either ServiceChangeKey or ServiceChange but not
both
-4 = Invalid ServiceChangeKey
-5 = Invalid ServiceChange
-7 = Temp Deact and BID status not active
-8 = Perm Deact and BID already Perm Deact
-9 = React and BID already deactivated
-10 = Restrict and BID status not active
-11 = Deactivate failed
-12 = Reactivate failed
-13 = Restriction failed
-14 = Unable to lock BID
-15 = Unable to unlock BID
- 138 -
ARISWebService
CalcPlanEditChrg
Description:
This WebMethod is used to perform a pre-calculation of a Rate Plan Edit charges / credits before an actual edit occurs.
Use:
This would be used to pre-calculate the charges / credits for a BID Rate Plan Edit and used to let the subscriber know the
results before moving forward with the Rate Plan edit.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/CalcPlanEditChrg"

<soap:Body>
<CalcPlanEditChrg xmlns="http://tempuri.org/">
</CalcPlanEditChrg>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CalcPlanEditChrgResponse xmlns="http://tempuri.org/">
<CalcPlanEditChrgResult>boolean</CalcPlanEditChrgResult>
<RateChangeCost>decimal</RateChangeCost>
<RateChangeCostTaxes>decimal</RateChangeCostTaxes>
<RateChangeFees>decimal</RateChangeFees>
</CalcPlanEditChrgResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_UnitRatesDoc String 8,000 XML string of the new rates: MasterKey, PackKey,
RateKey,TreeNode
- 139 -
ARISWebService
RatePlanKey Integer 2,147,483,647 Primary key of the selected Rate Plan
Output:
ReturnValue Integer 4 0 = Unsuccessful
1 = Successful
RateChangeCost Decimal 999999999.99 Rate Code charges for the Rate Plan Change
RateChangeCostTaxes Decimal 999999999.99 Rate Code Taxes for the Rate Plan Change
RateChangeFees Decimal 999999999.99 Fees associated with Rate Change from Service Statuses,
etc.
- 140 -
ARISWebService
CalcBIDRestoreChrg
Description:
This WebMethod is used to perform a pre-calculation of a BID Restore before an actual Restore occurs.
Use:
This would be used to pre-calculate the charges / credits for a BID Restore and used to let the subscriber know the results
before moving forward with the Restore.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/CalcBIDRestoreChrg"

<soap:Body>
<CalcBIDRestoreChrg xmlns="http://tempuri.org/">
</CalcBIDRestoreChrg>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CalcBIDRestoreChrgResponse xmlns="http://tempuri.org/">
<CalcBIDRestoreChrgResult>boolean</CalcBIDRestoreChrgResult>
<RestoreCost>decimal</RestoreCost>
<RestoreTaxes>decimal</RestoreTaxes>
<RestoreServiceChangeFees>decimal</RestoreServiceChangeFees>
</CalcBIDRestoreChrgResponse>
</soap:Body>
Input:
Output:
RestoreCost Decimal 999999999.99 Charges for restore of service
- 141 -
ARISWebService
RestoreTaxes Decimal 999999999.99 Taxes on charges for restore of service

RestoreServiceChangeFees Decimal 999999999.99 Fees associated with restore of service
- 142 -
ARISWebService
CreateInvoice
Description:
This WebMethod is used for creating an Invoice for items being purchased. (Note: API only works for non-serialized
inventory at this time)
Use:
This would be used to create an Invoice for SKUs being sold on a subscriber account.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/CreateInvoice"

<soap:Body>
<CreateInvoice xmlns="http://tempuri.org/">
</CreateInvoice>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CreateInvoiceResponse xmlns="http://tempuri.org/">
<CreateInvoiceResult>boolean</CreateInvoiceResult>
<WebOutputDataSet>
<ARISInvoicePayment>
- 143 -
ARISWebService
</ARISInvoicePayment>
<ARISInvoicePayment>
</ARISInvoicePayment>
</WebOutputDataSet>
</CreateInvoiceResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_CreditCardData String 8,000 Optional (Refer to CreateAccount for structure of XML doc)
XML_LineItems String 8,000 Required (Refer to CreateAccount for structure of XML doc)
EmployeeCode String 3 Optional: If passed we will validate and use the
EmployeeCode to indicate who created the Account. If not
passed the the default configuration will be used.
Output:
CustomerNo String 11 Customer Number for the Account
CustomerKey Integer 2,147,483,647 Primary Key of the Customer

rejected.
upon completion.

PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',

'NOT CAPTURED',
'NOT APPROVED',
'SALE NOT FOUND',
'ERROR'
- 144 -
ARISWebService

ReturnValue Integer 2,147,483,647 1 – Success
0 – Unsuccessful
Notes on when to populate the parameters:
1. Sale for Accessory with no Credit Card on file

2. Sale for Accessory with Credit Card on file

3. Sale for Handset with no Credit Card on file (upgrade)

4. Sale for Handset with Credit Card on file (upgrade)

5. Sale for Handset with new Activation with no Credit Card on file (Add a line)
a. Need to populate CustomerNo, XML_UnitIDDoc, XML_UnitRatesDoc, XML_CredtCardData, and
XML_LineItems.
6. Sale for Handset with new Activation with Credit Card on file (Add a line)
a. Need to populate CustomerNo, XML_UnitIDDoc, XML_UnitRatesDoc, and XML_LineItems
- 145 -
ARISWebService
- 146 -
ARISWebService
GetRecentUsageSummary
Description:
This WebMethod is used to return the recent unbilled usage including Free Usage for the current bill cycle for the
Customer.
Use:
This would be used to display the current bill cycle unbilled cdrs and related Free Use details.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetRecentUsageSummary"

<soap:Body>
<GetRecentUsageSummary xmlns="http://tempuri.org/">
</GetRecentUsageSummary>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetRecentUsageSummaryResponse xmlns="http://tempuri.org/">
<GetRecentUsageSummaryResult>boolean</GetRecentUsageSummaryResult>
<WebRecentUsageSummarySet>
<ARISRecentUsageSummary>
<Available>decimal</Available>
<Used>decimal</Used>
<Remaining>decimal</Remaining>
</ARISRecentUsageSummary>
<ARISRecentUsageSummary>
- 147 -
ARISWebService
<Available>decimal</Available>
<Used>decimal</Used>
<Remaining>decimal</Remaining>
</ARISRecentUsageSummary>
</WebRecentUsageSummarySet>
</GetRecentUsageSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
RateType String 2 TA – Airtime
TR – Roaming
TT – Toll Charges
TM – SMS
MS – MMS
GD – GPRS Data
TD – Data
TN – Content
CT - Content
DT - Data
DT - Roaming Data
FD - FAX Deposit
FD - FAX Deposit
FR - FAX Retrieval
FR - FAX Retrieval
FV - FAX Delivery
FV - FAX Delivery
ID - IDD Delivery
IN - Incoming
IN - Incoming
LD - Local Delivery
NC - Contract
ND - NDD Delivery
NP - Rate Plan
NT - National Toll
OC - Roaming OCCs
OU - Outgoing
TG - Talk Group
- 148 -
ARISWebService

TO - Roaming Toll
WU - Wake-Up Call
RateIncrement String 20 Second(s), Minute(s), Message(s), KB, MB, GB, TB,
etc.
Available Integer 9223372036854775807 Volume of Free Usage Available
Used Integer 9223372036854775807 Volume of Free Usage Used
Remaining Integer 9223372036854775807 Difference between Available and Remaining
- 149 -
ARISWebService
- 150 -
ARISWebService
TransferBID
Description:
This WebMethod is used to transfer the BID from one Account / Contract to another Contract or Account / Contract.
Use:
This would be used to transfer BIDs between Contract or Acccounts and Contracts.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/TransferBID"

<soap:Body>
<TransferBID xmlns="http://tempuri.org/">
<ToAccountNumber>string</ToAccountNumber>
<ToContractNumber>string</ToContractNumber>
</TransferBID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<TransferBIDResponse xmlns="http://tempuri.org/">
<TransferBIDResult>boolean</TransferBIDResult>
</TransferBIDResponse>
</soap:Body>
</soap:Envelope>
Input:
ToAccountNumber String 11 Required
ToContractNumber String 999 Required
Output:
- 151 -
ARISWebService
0 = Unsuccessful
- 152 -
ARISWebService
RestoreBID
Description:
This WebMethod is used to restore a BID back to service from being deleted or permantely deactivated.
Use:
This would be used to restore a deleted BID back to service and follow the system rules of whether to invoice the Add-On
Item charges immediately or not.
actual values
POST /WebServices/Version%201.0.0.19/ariswebaccount.asmx HTTP/1.1

Host: devsvr1
SOAPAction: "http://tempuri.org/RestoreBID"

<soap:Body>
<RestoreBID xmlns="http://tempuri.org/">
</RestoreBID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<RestoreBIDResponse xmlns="http://tempuri.org/">
<RestoreBIDResult>boolean</RestoreBIDResult>
</RestoreBIDResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
ReturnValue Integer 2,147,483,647 Return code (See Appendix A)
InvoiceNo String 9 Invoice Number returned if Invoice was created
TotalAmountDue Decimal 999999999.99 Amount due on the invoice
- 153 -
ARISWebService
- 154 -
ARISWebService
CloseTroubleTicket
Description:
This WebMethod is used to close a trouble ticket from a 3rd party system.
Use:
This would be used to close an open trouble ticket from an external system.
actual values
PLACEHOLDER
PLACEHOLDER
Input:
TagNumber String 10 Required
ToAccountNumber String 11 Required
ToContractNumber String 999 Required
Output:
0 = Unsuccessful
- 155 -
ARISWebService
- 156 -
ARISWebService
GetBalanceSummaryByBID
Description:
This WebMethod is used for returning the Balance Summary, Last Payment and Last Access Invoice with BID as the
input.
Use:
This would be used to display balances, last payment, and past due amounts for an account with BID as the input.
actual values

Host: local host
SOAPAction: "http://tempuri.org/GetBalanceSummary"

<soap:Body>
<GetBalanceSummary xmlns="http://tempuri.org/">
</GetBalanceSummary>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetBalanceSummaryResponse xmlns="http://tempuri.org/">
<GetBalanceSummaryResult>boolean</GetBalanceSummaryResult>
<BalanceSummarySet>
- 157 -
ARISWebService
</BalanceSummarySet>
</GetBalanceSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitID1 String 16 Required UnitID1 or BID
Output:
LastPayment Decimal 999999999.99 Last payment posted to account
Reference String 40 Reference of last payment posted
LastPaymentDate String 10 Date of last payment posted
PastDueBalance Decimal 999999999.99 Past due balance on account
TotalAmountDue Decimal 999999999.99 Total amount due on account
PaymentDueDate DateTime 10 Due date of payment for last access invoice generated
PaymentType String 20 Payment type of last payment posted
InvoiceNo String 9 Invoice number of last access invoice generated
PaymentKey Integer 2,147,483,647 IdentityKey from Payment
- 158 -
ARISWebService
AddBillAddOnItems
Description:
This WebMethod is used inserting Add On Items to be billed on the subscribers next bill cycle
Use:
This would be used to allow 3rd parties to insert Add On Items using OSS360 Items to be billed on the subscribers next
billing.
actual values
POST /A360WebService/ARISWebAccount.asmx HTTP/1.1

Host: 10.253.12.2
SOAPAction: "http://tempuri.org/AddBillAddOnItems"

<soap:Body>
<AddBillAddOnItems xmlns="http://tempuri.org/">
<Item>string</Item>
<EffectiveDate>string</EffectiveDate>
</AddBillAddOnItems>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddBillAddOnItemsResponse xmlns="http://tempuri.org/">
<AddBillAddOnItemsResult>int</AddBillAddOnItemsResult>
</AddBillAddOnItemsResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitID1 String 16 Required - UnitID1 or BID
Item String 23 Required - OSS360 Item / SKU
EffectiveDate String 20 Required – Date of Charge (i.e. 2015-01-15 09:15:12)
Description String 40 Required – Description of Item
Price Decimal 999999999.99 Amount to be billed. (Quantity of one)
- 159 -
ARISWebService
Output:
0 = Unsuccessful
- 160 -
ARISWebService
AddRentalContract
Description:
This WebMethod is used to create Rental Contracts that are to be billed on Access Contracts.
Use:
This would be used to allow 3rd parties to create new Rental Contracts if a Rental Contract does not exist one will be
created and tied to the same Contract as the referenced BID and allocate the Inventory passed as the input parameter.
actual values
POST /A360WebService/ARISWebAccount.asmx HTTP/1.1

Host: 10.253.12.2
SOAPAction: "http://tempuri.org/AddRentalContract"

<soap:Body>
<AddRentalContract xmlns="http://tempuri.org/">
<SerialNo>string</SerialNo>
</AddRentalContract>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddRentalContractResponse xmlns="http://tempuri.org/">
<AddRentalContractResult>int</AddRentalContractResult>
</AddRentalContractResponse>
</soap:Body>
</soap:Envelope>
Input:
EmployeeKey Integer 2,147,483,647 Required – Logged In EmployeeKey
UnitSystemKey Integer 2,147,483,647 Required – Identity key of BID
SerialNumber String 24 Required – Serial Number of Rental Item
Output:
-1 = UnitSystemKey does not exist or has been deleted
-2 = Serial Number does not exist in the System
- 161 -
ARISWebService
-3 = Serial Number does not exist in Employees Inventory

-4 = Serial Number is already allocated
- 162 -
ARISWebService
GetRatePackage
Description:
This WebMethod is used by USSD to query a BID to see if a Rate Package has already been added.
Use:
This would be used to allow a USSD platform to find out if a Rate Package is already assigned to a BID and the state of
the members.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetRatePackage"

<soap:Header>
</A360Login>
</soap:Header>
<soap:Body>
<GetRatePackage xmlns="http://tempuri.org/">
</GetRatePackage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetRatePackageResponse xmlns="http://tempuri.org/">
<GetRatePackageResult>boolean</GetRatePackageResult>
<IsAssigned>int</IsAssigned>
<IsPromo>int</IsPromo>
<StopDate>string</StopDate>
</GetRatePackageResponse>
</soap:Body>
</soap:Envelope>
- 163 -
ARISWebService
Input:
BID Integer 2,147,483,647 Required – Billable ID
RatePackage String 4 Required – Rate Package
Output:
IsAssigned Integer 1 0 = Not Assigned, 1 = Assigned
IsPromo Integer 1 0 = No Promo Rates Exist, 1 = Promo Rates Exist
StopDate String 10 Earliest StopDate of Promo Rate in effect
Please Note:
Assigned - If the Package is assigned 1 else 0.
IsPromo - If any of the Rate Codes are IsPromotional then 1 else 0.
StopDate - If any of the Rate Codes are IsPromotional then earliest StopDate else NULL.
- 164 -
ARISWebService
AddRatePackage
Description:
This WebMethod is used by USSD to add or re-add a Rate Package to a BID.
Use:
This would be used to allow a USSD platform to trigger an activation or reactivation of a Rate Package on a BID.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/AddRatePackage"

<soap:Header>
</A360Login>
</soap:Header>
<soap:Body>
<AddRatePackage xmlns="http://tempuri.org/">
</AddRatePackage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AddRatePackageResponse xmlns="http://tempuri.org/">
<AddRatePackageResult>boolean</AddRatePackageResult>
</AddRatePackageResponse>
</soap:Body>
</soap:Envelope>
Input:
BID Integer 2,147,483,647 Required – Billable ID
RatePackage Integer 4 Required – Rate Package
ForceChange Integer 1 Required – When 0 existing Rate Package will be reviewed
- 165 -
ARISWebService
to see if new package can be added. When 1 new Package

will be added unconditionally.
Output:
0 - Unsuccessful
- 166 -
ARISWebService
CreateAccount
Description:
This WebMethod is used to create new Accounts only.
Use:
This would be used for the for creating new individual or company accounts.
actual values
Host: local host
SOAPAction: "http://tempuri.org/CreateAccount"

<soap:Body>
<CreateAccount xmlns="http://tempuri.org/">
<XML_CustomerData>string</XML_CustomerData>
</CreateAccount>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CreateAccountResponse xmlns="http://tempuri.org/">
<CreateAccountResult>boolean</CreateAccountResult>
</CreateAccountResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_CustomerData String 8,000 Required
XML_CustomerData:

FirstName String 40 Required First name of Customer / Contact
MiddleName String 40 Optional Middle name of Customer / Contact
LastName String 40 Required Last name of Customer / Contact
BirthDate String 20 Required Birthdate of customer
- 167 -
ARISWebService
MainAddress1 String 40 Required Main address line 1

MainAddress2 String 40 Required Main address line 2
MainCity String 40 Required Main address city
MainState String 20 Required Main address state
MainPostalCode String 10 Required Main address postal code
MainCountry String 40 Required Main address country
BillingAddress1 String 40 Optional Billing address line 1
BillingAddress2 String 40 Optional Billing address line 2
BillingCity String 40 Optional Billing address city
BillingState String 20 Optional Billing address state
BillingPostalCode String 10 Optional Billing address postal code
BillingCountry String 40 Optional Billing address country
ShippingAddress1 String 40 Optional Shipping address line 1
ShippingAddress2 String 40 Optional Shipping address line2
ShippingCity String 40 Optional Shipping address city
ShippingState String 20 Optional Shipping address state
ShippingPostalCode String 10 Optional Shipping address postal code
ShippingCountry String 40 Optional Shipping address country
DaytimePhone String 80 Required Daytime phone number
DaytimePhoneExt String 8 Optional Daytime phone extension
HomePhone String 80 Required Home phone number
SSN String 40 Required Social Security Number
AccountTypeKey Integer 2,147,483,647 Optional Override AccountTypeKey. If not passed
then the default Account Type assigned to
the web configured Employee is used.
EmployeeCode String 3 Optional If passed we will validate and use the
EmployeeCode to indicate who created
the Account. If not passed the the default
configuration will be used.
<CustomerData>
<tblxmlCustomerData FirstName="Mary" MiddleName="" LastName="Jones" BirthDate="02/02/1980"
MainAddress1="2001 Main Street" MainAddress2="" MainCity="Riverside" MainState="CA" MainPostalCode="92509"
MainCountry="USA" BillingAddress1="2001 Main Street" BillingAddress2="" BillingCity="Riverside" BillingState="CA"
BillingPostalCode="92509" BillingCountry="USA" ShippingAddress1="10681 Foothill Blvd" ShippingAddress2="Suite
100" ShippingCity="Rancho Cucamonga" ShippingState="CA" ShippingPostalCode="91730-2032"
ShippingCountry="USA" DaytimePhone="909 980 1035" HomePhone="909 980 1034" AccountTypeKey=””
EmployeeCode=”” />
</CustomerData>
Output:

CustomerNo String 11 Customer Number for Account added
0 - Unsuccessful
- 168 -
ARISWebService
ActivateBID
Description:
This WebMethod is used to activate a BID in OSS360.
Use:
This would be used to activate a BID on an existing OSS360 Account.
actual values

Host: citrine
SOAPAction: "http://tempuri.org/ActivateBID"

<soap:Header>
</A360Login>
</soap:Header>
<soap:Body>
<ActivateBID xmlns="http://tempuri.org/">
</ActivateBID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<ActivateBIDResponse xmlns="http://tempuri.org/">
<ActivateBIDResult>boolean</ActivateBIDResult>
<BIDStatuses>
<ARISBIDStatus>
<UNITID1>string</UNITID1>
</ARISBIDStatus>
<ARISBIDStatus>
<UNITID1>string</UNITID1>
- 169 -
ARISWebService
</ARISBIDStatus>
</BIDStatuses>
</ActivateBIDResponse>
</soap:Body>
</soap:Envelope>
XML_UnitIDDoc:

UnitKey Integer 2,147,483,647 Required UnitKey is the identityKey (increment
negatively for each ID being activated)
IDInventoryKey Integer 2,147,483,647 Required IDInventoryKey is the Key returned from
the GetIDs API, pass 0 if not using
Number Inventory.
BID String 16 Optional If not using Number Inventory pass BID for
activation without formatting.
RatePlanKey Integer 2,147,483,647 Required Identity key of the Rate Plan
CustomerKey Integer 2,147,483,647 Required Identity key of the account
AccessContractCodeKey Integer 2,147,483,647 Optional Identity key of the Agreement Code
ServiceChangeKey Integer 2,147,483,647 Optional If empty, Activation will be used otherwise
specified Service Status Code identity key
ContractKey Integer 2,147,483,647 Optional If provided will attempt to use existing
Contract otherwise a new one will be
created
UnitID3 Integer 2,147,483,647 Optional ESN/MEID/ICC
EmployeeCode String 3 Optional If passed we will validate and use the
EmployeeCode to indicate who created
the Account. If not passed the the default
configuration will be used.
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="26952" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""/>
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""
UnitID3="" EmployeeCode=""/>
</IDData>
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="0" BID="00A0C914C829" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""/>
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""
UnitID3="" EmployeeCode=""/>
</IDData>
XML_UnitRatesDoc:

UnitKey Integer 2,147,483,647 Required
- 170 -
ARISWebService
<RatesData>
</RatesData>
Output:
UnitID1 String 16 Billable ID that was activated
Status String 1 Status of Activated BID. (A – Active, I – Inactive, H – Hold)

0 - Unsuccessful
- 171 -
ARISWebService
- 172 -
ARISWebService
ARISWebService.ARISAccessAccount
MakePayment
Description:
Value insertion transaction that enables the insertion of an amount onto a Consumer Account.
Use:
This would be used to make a payment onto customer accounts.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values.
POST /ARISWebService/ARISAccessAccount.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/MakePayment"

<soap:Body>
<MakePayment xmlns="http://tempuri.org/">
<PaymentDate>string</PaymentDate>
<Amount>decimal</Amount>
</MakePayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<MakePaymentResponse xmlns="http://tempuri.org/">
<MakePaymentResult>boolean</MakePaymentResult>
<ResponseCode>int</ResponseCode>
</MakePaymentResponse>
</soap:Body>
</soap:Envelope>
- 173 -
ARISWebService
Input:
UnitID1 String 16 Required: BID (Billable ID: Phone Number)
PaymentDate String 23 Required
PaymentID String 24 Required
Reference String 40 Required
Amount Decimal 16,2 Required
Output:
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
Note:
This API is supported by an override rule which is allows one to update the wiDefaultValue Item
(MakePaymentTargetOverride) and when the CharValue = PAYOLDEST will allow the MakePayment API to post
payments in the oldest to newest invoice order overriding the default state of applying payments to Access Deposits.
When the wiDefaultValue.CharValue is blank or anything other than PAYOLDEST then payments are posted to Access
Deposits. When wiDefaultValue.CharValue equals PAYOLDEST, then invoices are paid oldest to newest.
- 174 -
ARISWebService
ReversePayment
Description:
Reversal transaction, where the original transaction is identified in the reversal transaction.
Use:
This would be used reverse a payment on a customer’s account.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with
actual values.

Host: localhost
SOAPAction: "http://tempuri.org/ReversePayment"

<soap:Body>
<ReversePayment xmlns="http://tempuri.org/">
</ReversePayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<ReversePaymentResponse xmlns="http://tempuri.org/">
<ReversePaymentResult>boolean</ReversePaymentResult>
</ReversePaymentResponse>
</soap:Body>
</soap:Envelope>
Input:
PaymentKey Integer 2,147,483,647 Optional if provided all subsequent fields are not required.
UnitID1 String 16 Optional – Required if PaymentKey is not available. BID
- 175 -
ARISWebService
(Billable ID: Phone Number)

PaymentDate String 23 Optional – Required if PaymentKey is not available
PaymentID String 24 Optional – Required if PaymentKey is not available
Reference String 40 Optional – Required if PaymentKey is not available
Amount Decimal 16,2 Optional – Required if PaymentKey is not available
Output:
ReturnValue Integer 1 ReturnValue >= 1 Success; Return Value <= 0 Errors
- 176 -
ARISWebService
GetAccountStatus
Description:
Vendor status inquiry transaction, which provides the status of the Consumer Account at the Vendor.
Use:
This would be used to display a customer’s account information.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with
actual values.

Host: localhost
SOAPAction: "http://tempuri.org/GetAccountStatus"

<soap:Body>
<GetAccountStatus xmlns="http://tempuri.org/">
</GetAccountStatus>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetAccountStatusResponse xmlns="http://tempuri.org/">
<GetAccountStatusResult>boolean</GetAccountStatusResult>
<AccountUnitIDEntitySet>
<ARISAccountUnitIDEntity>
- 177 -
ARISWebService
<SystemType>string</SystemType>
</ARISAccountUnitIDEntity>
<ARISAccountUnitIDEntity>
<SystemType>string</SystemType>
</ARISAccountUnitIDEntity>
</AccountUnitIDEntitySet>
</GetAccountStatusResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
ARISAccountUnitIDEntity
CustomerName String 80 Name of Customer
DaytimePhone String 80 Customer’s daytime phone number
DayTimePhoneExt String 8 Customer’s daytime phone extension.
HomePhone String 80 Customer’s home phone number
BillingAddress1 String 40 Customer’s Billing address line 1
BillingCity String 40 Billing address city
BillingState String 20 Billing address state
BillingPostalCode String 10 Billing address postal code
BillingCountry String 40 Billing address country
AccountStatus String 1 A=Active, P=Pending, H=Hold, B=Bar, U=Unbar,
I=Inactive
AccountStatusDescription String 20 Active, Pending, Hold, Bar, Unbar, Inactive
- 178 -
ARISWebService
UnitIDStatus String 1 A=Active, P=Pending, H=Hold, B=Bar, U=Unbar,

I=Inactive
UnitIDStatusDescription String 20 Active, Pending, Hold, Bar, Unbar, Inactive
SystemType String 40 Aris System Type SysKey
UnitID1 String 16 BID (Billable ID: Phone Number)
- 179 -
ARISWebService
- 180 -
ARISWebService
GetUnitIDDepositBalance
Description:
Vendor balance inquiry transaction which provides the current balance on the Consumer Account at the Vendor.
Use:
This would be used to display a customer’s access deposit balance.
SOAP: The following is a sample SOAP1.1 request and response. The placeholders shown need to be replaced with
actual values

Host: localhost
SOAPAction: "http://tempuri.org/GetUnitIDDepositBalance"

<soap:Body>
<GetUnitIDDepositBalance xmlns="http://tempuri.org/">
</GetUnitIDDepositBalance>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetUnitIDDepositBalanceResponse xmlns="http://tempuri.org/">
<GetUnitIDDepositBalanceResult>boolean</GetUnitIDDepositBalanceResult>
<UnitIDBalance>decimal</UnitIDBalance>
</GetUnitIDDepositBalanceResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitID1 String 16 Required: BID (Billable ID: Phone Number)
Output:
UnitID1Balance Decimal 16,2 Access deposit balance
- 181 -
ARISWebService
- 182 -
ARISWebService
InquireInComm
Description:
Vendor provides capability to support, store and respond with the unique InComm transaction identifier on all transactions
that they share with InComm.
Use:
This would be used to display a customer’s access deposit balance.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/InquireInComm"

<soap:Body>
<InquireInComm xmlns="http://tempuri.org/">
</InquireInComm>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<InquireInCommResponse xmlns="http://tempuri.org/">
<InquireInCommResult>boolean</InquireInCommResult>
<PaymentReceiptSet>
<ARISPaymentReceipt>
<DatePaid>dateTime</DatePaid>
<AmountPaid>decimal</AmountPaid>
<ContractNo>string</ContractNo>
</ARISPaymentReceipt>
<ARISPaymentReceipt>
<DatePaid>dateTime</DatePaid>
- 183 -
ARISWebService
<AmountPaid>decimal</AmountPaid>
<ContractNo>string</ContractNo>
</ARISPaymentReceipt>
</PaymentReceiptSet>
</InquireInCommResponse>
</soap:Body>
</soap:Envelope>
Input:
PaymentID String 24 Required (InComm Unique Identifier)
Output:
ARISPaymentReceipt
PaymentDate String 10 Date of last payment posted
DatePaid String 23 Date and time of payment
PaymentID String 24 Payment Identification, Incomm unique identifier
Reference String 40 Reference of payment
AmountPaid Decimal 999999999.99 Amount
ContractNo String 3 Customer’s Contract number
UnitID1 String 16 BID (Billable ID: Phone Number)
PaymentKey Integer 2,147,483,647 IdentityKey from Payments
- 184 -
ARISWebService
PreAuthorization
Description:
Vendor provides the capability to support a vendor pre-authorization transaction that determines that a transaction will
occur successfully.
Use:
This would be used to display a customer’s BID information.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/PreAuthorization"

<soap:Body>
<PreAuthorization xmlns="http://tempuri.org/">
</PreAuthorization>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<PreAuthorizationResponse xmlns="http://tempuri.org/">
<PreAuthorizationResult>boolean</PreAuthorizationResult>
<ReturnValue>boolean</ReturnValue>
</PreAuthorizationResponse>
</soap:Body>
</soap:Envelope>
Input:
Output:
ReturnValue String 1 ReturnValue = 1 Success; Return Value <= 0 Errors
UnitIDStatus String 1 A=Active, P=Pending, H=Hold, B=Bar, U=Unbar, I=Inactive
- 185 -
ARISWebService
UnitIDStatusDescription String 20 Active, Pending, Hold, Bar, Unbar, Inactive
- 186 -
ARISWebService
GetInvoiceDetails
Description:
This API is intended to return basic details relating to an invoice.
Use:
This would be used to return the Account Number, Account Name, and Invoice Amount for an Input Invoice Number.

Host: localhost

<soap:Body>
</MakePayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
</soap:Body>
</soap:Envelope>
Input:
InvoiceNo String 9 Required
Output:
Account Number String 11 Account Number
Account Name String 60 Individual Account Name or Company Name
- 187 -
ARISWebService
Invoice Balance Decimal 999999999.99 Outstanding Invoice Balance
- 188 -
ARISWebService
MakePaymentByInvoice
Description:
This API allows payments to be posted from a specific vendor into OSS360 where the payment was actually posted
through a 3rd party by Invoice Number.
Use:
This would be used to post payments to Invoices that were actually collected from a 3rd party.

Host: localhost

<soap:Body>
</MakePayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
</soap:Body>
</soap:Envelope>
Input:
InvoiceNo String 9 Required
PaymentDate String 23 Optional
PaymentID String 24 Optional
- 189 -
ARISWebService
Amount Decimal 999999999.99 Required
Output:
- 190 -
ARISWebService
MakePrepayPostpayPayment
Description:
This API allows payments to be posted for both prepay and post-pay subscribers where the monies are collected by third
parties.
Use:
This would be used to post payments to Invoices that were actually collected from a 3rd party.

Host: localhost

<soap:Body>
<MakePrepayPostpayPayment xmlns="http://tempuri.org/">
<BID>string</BID>
<Target>string</Target>
<PaymentType>string>/PaymentType>
<PaymentDate>dateTime</PaymentDate>
</MakePrepayPostpayPayment>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<MakePrepayPostpayPaymentResponse xmlns="http://tempuri.org/">
<MakePrepayPostpayPaymentResult>boolean</MakePrepayPostpayPaymentResult>
<PaymentKey>long</PaymentKey>
</MakePrepayPostpayPaymentResponse>
</soap:Body>
</soap:Envelope>
Input:
BID String 16 Optional for Post-pay, Required for Prepay
Target String 10 Required:
PAYOLDEST = Invoice Payment
- 191 -
ARISWebService
ACCDEP = Access Deposits for Prepay

PaymentType String 40 Optional, if not provided Employee, Vendor, Payment Type
lookup will be performed.
Reference String 40 Optional
PaymentID String 24 Optional
PaymentDate String 23 Required
Amount Decimal 999999999.99 Required
Output:
- 192 -
ARISWebService
A360FacilitiesManagement.asmx
EditServiceAddress
Description:
This WebMethod is used to edit or update an existing Service Address assigned to a BID.
Use:
This would be used by facility providers to communicate back to OSS360 on address changes made on their end that
need to be propagated back to OSS360.
actual values
POST /ariswebservice/A360FacilitiesManagement.asmx HTTP/1.1

Host: ttpro.advantage360.com
SOAPAction: "http://tempuri.org/EditServiceAddress"

<soap:Body>
<EditServiceAddress xmlns="http://tempuri.org/">
<City>string</City>
</EditServiceAddress>
</soap:Body>
</soap:Envelope>

<soap:Body>
<EditServiceAddressResponse xmlns="http://tempuri.org/">
<EditServiceAddressResult>boolean</EditServiceAddressResult>
</EditServiceAddressResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitSystemKey Integer 2,147,483,647 Primary Key of the BID
Address1 String 40 Service Address Address Line 1
City String 40 Service Address City
State String 20 Service Address State
PostalCode String 10 Service Address Postal Code
- 193 -
ARISWebService
Output:
0 - Unsuccessful
- 194 -
ARISWebService
EscalateWorkflow
Description:
This WebMethod is used to escalate SO Workflow orders to different Stages.
Use:
This would be used by a facility provider to communicate to OSS360 the next status of the order in their workflow system.
This allows us to keep OSS360 SO Workflow updated on the state of an order.
actual values

SOAPAction: "http://tempuri.org/EscalateWorkflow"

<soap:Body>
<EscalateWorkflow xmlns="http://tempuri.org/">
<StatusCode>string</StatusCode>
</EscalateWorkflow>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EscalateWorkflowResponse xmlns="http://tempuri.org/">
<EscalateWorkflowResult>boolean</EscalateWorkflowResult>
</EscalateWorkflowResponse>
</soap:Body>
</soap:Envelope>
Input:
SalesOrderNo String 9 Sales Order Number
StatusCode String 3 OSS360 Status Code
Output:
0 - Unsuccessful
- 195 -
ARISWebService
- 196 -
ARISWebService
EditBID
Description:
This WebMethod is used to change the BID in OSS360 when Number Inventory is being managed by the Facility
Provider.
Use:
This would be used for the facility provider to send OSS360 a number change request so the BID is changed in the billing
system.
actual values

SOAPAction: "http://tempuri.org/EditBID"

<soap:Body>
<EditBID xmlns="http://tempuri.org/">
<OldID>string</OldID>
<NewID>string</NewID>
</EditBID>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditBIDResponse xmlns="http://tempuri.org/">
<EditBIDResult>boolean</EditBIDResult>
</EditBIDResponse>
</soap:Body>
</soap:Envelope>
Input:
OldID String 16 Old BID for ID being changed
NewID String 16 New BID for ID being changed
Output:
0 - Unsuccessful
- 197 -
ARISWebService
- 198 -
ARISWebService
LinkCircuit
Description:
This WebMethod is used by a facility provider to reference OSS360 to the selected Circuit for a BID.
Use:
This would be used for the facility provider to send OSS360 the Circuit reference to a BID once assigned in the facility
system.
actual values
POST /A360FacilitiesManagement.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/LinkCircuit"

<soap:Body>
<LinkCircuit xmlns="http://tempuri.org/">
<CircuitID>int</CircuitID>
</LinkCircuit>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<LinkCircuitResponse xmlns="http://tempuri.org/">
<LinkCircuitResult>boolean</LinkCircuitResult>
</LinkCircuitResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitSystemKey Integer 2,147,483,647 Required - Primary Key of the BID
SalesOrderNo String 9 Required – Sales Order originally sent in
CreateWorkOrder
CircuitID String 9,223,372,036,854,775,807 Required – CircuitID to link to BID in OSS360
Output:
ReturnValue Integer 2,147,483,647 Return Codes – See below
ReturnValue Codes:
- 199 -
ARISWebService
- 200 -
ARISWebService
AvailableSKUs
Description:
This WebMethod is used to return a list of SKUs, Descriptions for use with a third party system.
Use:
This would be used for the facility provider to retrieve a list of valid SKUs they can pass back to A360 for the
CommitWorkOrder and CreateInvoice API calls.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/AvailableSKUs"

<soap:Body>
<AvailableSKUs xmlns="http://tempuri.org/" />
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<AvailableSKUsResponse xmlns="http://tempuri.org/">
<AvailableSKUsResult>boolean</AvailableSKUsResult>
<AvailableSKUsSet>
<ARISAvailableSKUs>
<ItemSKU>string</ItemSKU>
</ARISAvailableSKUs>
<ARISAvailableSKUs>
<ItemSKU>string</ItemSKU>
</ARISAvailableSKUs>
</AvailableSKUsSet>
</AvailableSKUsResponse>
</soap:Body>
</soap:Envelope>
Input:
ClassCode String 8,000 Optional – Comma delimited list of Item
Class Codes for filtering results
Output:
SKU String 23 SKU of the Item
Description String 40 Description of the Item
- 201 -
ARISWebService
- 202 -
ARISWebService
CommitServiceOrder
Description:
This WebMethod is used to return work order details to OSS360.
Use:
This would be used by a facility provider to communicate to OSS360 the
actual values

Host: localhost
SOAPAction: "http://tempuri.org/CommitServiceOrder"

<soap:Body>
<CommitServiceOrder xmlns="http://tempuri.org/">
<StatusCode>string</StatusCode>
<Memo>string</Memo>
</CommitServiceOrder>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CommitServiceOrderResponse xmlns="http://tempuri.org/">
<CommitServiceOrderResult>boolean</CommitServiceOrderResult>
</CommitServiceOrderResponse>
</soap:Body>
</soap:Envelope>
Input:
SalesOrderNo String 9 Required - Sales Order Number
StatusCode String 3 Required – Mapping code indicating closure
Memo String 8,000 Optional – Facilities entered memos
XML_LineItems String 8,000 Optional – Additional Sales Order Line Item
XML_LineItems:

- 203 -
ARISWebService

discount.
Book.
<![CDATA[
<CartItems>
</CartItems>
]]>
treated as strings.
Output:
This API is supported by a special override Employee Code that can be used to record the transaction separately from all
other SOAP APIs. This requires an Employee to be created in OSS360 and A360 Support to update the configuration in
wiDefaultValues.
SELECT *
FROM wiDefaultValues
WHERE DefaultItem = 'EmployeeKey'
AND DefaultGroup = 'FacilitiesManagement'
- 204 -
ARISWebService
CreateInvoice
Description:
This WebMethod is used create a POS Invoice on an Account with the items passed to the API.
Use:
This would be used by a facility provider to pass items, quantities, and pricing to create POS Invoices in OSS360.

Host: localhost
SOAPAction: "http://tempuri.org/CreateInvoice"

<soap:Body>
<CreateInvoice xmlns="http://tempuri.org/">
</CreateInvoice>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<CreateInvoiceResponse xmlns="http://tempuri.org/">
<CreateInvoiceResult>boolean</CreateInvoiceResult>
</CreateInvoiceResponse>
</soap:Body>
</soap:Envelope>
Input:
XML_LineItems String 8,000 Optional – Additional Sales Order Line Item
XML_LineItems:

discount.
- 205 -
ARISWebService

Book.
<![CDATA[
<CartItems>
</CartItems>
]]>
treated as strings.
- 206 -
ARISWebService
Output:
InvoiceNo String 9 Invoice number generated
- 207 -
ARISWebService
- 208 -
ARISWebService
GetSalesOrders
Description:
This WebMethod is used query Sales Orders by Employee.
Use:
This would be used to allow 3rd parties to query open & closed Sales Orders by Employee or installers.
actual values
POST /A360WebService/A360FacilitiesManagement.asmx HTTP/1.1

Host: localhost
SOAPAction: "http://tempuri.org/GetSalesOrders"

<soap:Body>
<GetSalesOrders xmlns="http://tempuri.org/">
<OrderDate>string</OrderDate>
</GetSalesOrders>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<GetSalesOrdersResponse xmlns="http://tempuri.org/">
<GetSalesOrdersResult>int</GetSalesOrdersResult>
<SalesOrders>
<ARISSalesOrders>
<AccountName>string</AccountName>
<AppointmentDate>string</AppointmentDate>
<ContactName>string</ContactName>
<City>string</City>
<PlanDescription>string</PlanDescription>
<UnitSystemKey>string</UnitSystemKey>
</ARISSalesOrders>
<ARISSalesOrders>
<AccountName>string</AccountName>
<AppointmentDate>string</AppointmentDate>
<ContactName>string</ContactName>
- 209 -
ARISWebService
<City>string</City>
<PlanDescription>string</PlanDescription>
<Comment>string</Comment>
<UnitSystemKey>string</UnitSystemKey>
</ARISSalesOrders>
</SalesOrders>
</GetSalesOrdersResponse>
</soap:Body>
</soap:Envelope>
Input:
EmployeeKey Integer 2,147,483,647 Required - EmployeeKey
Status String 1 Required – O – Open, C - Closed
OrderDate String 10 Optional – Filter for orders greater than or equal to the
defined date (i.e. 2015-01-15) If not passed we will return
orders 30 days old.
Output:
0 = Unsuccessful
AccountName String 100 Company or Individual Name
ContactName String 100 BID’s associated Contact Name
CustomerNo String 11 Subscribes Account Number
SalesOrderNo String 9 Sales Order Number
WorkflowStatus String 40 Current Workflow Status
AppointmentDate String 20 Install Date & Time
AddressLine1 String 40 Service Address Line 1
AddressLine2 String 40 Service Address Line 2
City String 40 Service Address City
State String 20 Service Address State / Province
PostalCode String 10 Service Address Postal Code
UnitID1 String 16 Billable ID
PlanDescription String 40 Rate Plan Description
BillCycle String 2 Bill Cycle of BID
Comment String 8,000 SO Comment
UnitSystemKey Integer 2,147,483,647 Unique identifier of BID
UnitKey Integer 2,147,483,647 Static Identifier of BID
FirstName String 40
LastName String 40
PhoneNumber String 80
Email String 80
Latitude String 20
Longitude String 20
- 210 -
ARISWebService
EditServiceAddressGPS
Description:
This WebMethod is used to edit or update an existing Service Address GPS coordinates assigned to a BID.
Use:
This would be used by facility providers to communicate back to OSS360 on GPS coordinate changes made on their end
that need to be propagated back to OSS360.
actual values

Host: localhost
SOAPAction: "http://tempuri.org/EditServiceAddressGPS"

<soap:Body>
<EditServiceAddressGPS xmlns="http://tempuri.org/">
<Latitude>string</Latitude>
<Longitude>string</Longitude>
</EditServiceAddressGPS>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK

<soap:Body>
<EditServiceAddressGPSResponse xmlns="http://tempuri.org/">
<EditServiceAddressGPSResult>boolean</EditServiceAddressGPSResult>
</EditServiceAddressGPSResponse>
</soap:Body>
</soap:Envelope>
Input:
UnitID1 String 16 Billable ID
Latitude String 20 GPS Latitude Coordinate
Longitude String 20 GPS Longitude Coordinate
Output:
0 - Unsuccessful
- 211 -
ARISWebService
- 212 -
ARISWebService
Appendix A – ARISWebService Error Codes
Customer Add Errors
-503 -- Access Contract Code missing or invalid

-504 -- XML Document Customer Data missing or invalid
-505 -- XML Document Unit ID Data missing or invalid
-506 -- XML Document Unit Rate Data missing or invalid
-507 -- XML Document Credit Card Data missing or invalid
-508 -- XML Document Line Items missing or invalid
-509 -- Customer Number missing or invalid
-510 -- Total Amount Paid missing or invalid
-511 -- Postal Code missing or invalid
-512 -- GeoCodeKey missing or invalid
-1000 -- Customer Add Errors

-102 -- SQL Error inserting into syCustomers
-103 -- SQL Error inserting into syCustDepartments
-104 -- SQL Error inserting into syCustAddresses for Billing Address
-105 -- SQL Error inserting into syCustAddresses for Shipping Address
-106 -- SQL Error inserting into syCustContacts
-107 -- SQL Error inserting into syCustPhones for department Business Main Phone
-108 -- SQL Error inserting into syCustPhones for department Home Phone
-109 -- SQL Error inserting into syCustPhones for contact Business Main Phone
-110 -- SQL Error inserting into syCustPhones for contact Home Phone
-111 -- SQL Error inserting into syCustPhones for Email Address
-112 -- SQL Error inserting into syCustContactPersDataVals for SSN
-113 -- SQL Error inserting into syCustContactPersDataVals for Secret Question & Answer
-114 -- SQL Error inserting into syCustAccountTerms
-201 -- XML parameter list missing First Name

-202 -- XML parameter list missing Middle Name
-203 -- XML parameter list missing Last Name
-204 -- XML parameter list missing Birth Date
-205 -- XML parameter list missing Billing Address1
-206 -- XML parameter list missing Billing City
-207 -- XML parameter list missing Billing State
-208 -- XML parameter list missing Billing Postal Code
-209 -- XML parameter list missing Billing Country
-215 -- XML parameter list missing Business Main Phone
-216 -- XML parameter list missing Home Phone
-217 -- XML parameter list missing Email Address
-218 -- XML parameter list missing PassPhrase
-219 -- XML parameter list missing Personal Data Type Key for the Secret Question
-220 -- XML parameter list missing Secret Answer
-221 -- XML parameter list missing SSN
-301 -- Invalid derived value for BillingGeoCodeKey

-302 -- Invalid derived value for ShippingGeoCodeKey
-303 -- Invalid derived value for DefAccountTypeKey
-304 -- Invalid derived value for DefCurrencyCodeKey
-305 -- Invalid derived value for DefAccountStatusCodeKey
-306 -- Invalid derived value for DeptStaticKey
-307 -- Invalid derived value for DeptTypeKey
-308 -- Invalid derived value for DefCountryDivisionTypeKey
-309 -- Invalid derived value for BillingAddressStaticKey
-310 -- Invalid derived value for ShippingAddressStaticKey
-311 -- Invalid derived value for DefBillingAddressTypeKey
-312 -- Invalid derived value for DefShippingAddressTypeKey
-313 -- Invalid derived value for Phone1TypeKey
-316 -- Invalid derived value for ContactStaticKey
- 213 -
ARISWebService
-317 -- Invalid derived value for PersonalData1TypeKey

-318 -- Invalid derived value for CountryCodeKey
-319 -- Invalid derived value for CountryDialCode
-320 -- Invalid derived value for ConPhone1StaticKey
-321 -- Invalid derived value for DeptPhone1StaticKey
-326 -- Invalid derived value for POSPriceBookKey
-327 -- Invalid derived value for POSTermsKey
-328 -- Invalid derived value for POSCreditLimit
-329 -- Invalid derived value for POSTaxCodeKey
-330 -- Invalid derived value for POSShippingMethodKey
Contract / Credit Card Errors
-2000 -- Contract Creation Errors
-3000 -- Credit Card Errors

-3100 -- Save Credit Card Errors
-3200 -- Update Credit Card Errors
-1 -- Inactive Card Number on File

-2 -- Bad Card Number: Check Sum error
-3 -- Bad Card Number: Card number not set up to be used in OSS360. Add the Card Type to OSS360 Database or
Validate the Card Number
-4 -- Bad Expiration Date: ExpirationDate passed does not match any of the available formats. 'MMYY', 'YYMM',
'MM/YY', 'MM-YY', 'YY/MM', 'YY-MM'
-5 -- Bad Expiration Date: Expired Card
-6 -- PCChargeIPAdress missing from the web configuration table
-7 -- PCCPortNumber missing from the web configuration table
-8 -- PCChargeUser missing from the web configuration table
-9 -- WebSalesLocationKey missing from the configurations table
-10 -- Database not set up to perform credit card processing.
-11 -- PCCharge bad result returned from attempt to charge.
-12 -- Invalid Authorize Type
-13 -- Authorize Type and Charge amount does not correspond
-14 -- Address Validation Required and Postal Code missing or is Invlaid
-15 -- Charge was not successful cannot save the order deposit payment.
-16 -- Sales Order does not exist so the Order deposit cannot be Saved.
-17 -- Charge amounts must be greater than 0.
-18 -- Sales Order does not exist so the Order deposit cannot be Saved
-19 -- Charge amounts must be greater than 0
-20 -- Charge amounts must be less than 0
-21 -- Invoice does not exist so the Payment cannot be saved
-22 -- TransactionType And Target mismach
-23 -- XMLDoc required for Access deposit.
-24 -- CreditCardTypeKey and PaymentTypeKey missing.
-25 -- Contract not created
-26 -- Missing AccessContractCodeKey
-27 -- Default HomeSystemKey missing from the configurations table
-28 -- Error Creating and inserting into the GlobalAppVars Table
-29 -- Default Language missing from the Language table
-30 -- Default LanguageKey missing from the syConfigurations table
-31 -- Default CurrencyKey missing from the syConfigurations table
-32 -- Error getting the next ReceiptNum
-33 -- EmployeeKey missing from the web configuration file
-34 -- PaymentID missing from the web configuration file
-35 -- Error Aquiring CashReceiptsLock
-36 -- Error inserting row in arPayments
-37 -- Error inserting row in arCRBankCardNumbers
-38 -- Pre-Auth to verify customers credit worthy-ness must be $1.00
-39 -- Error inserting invoice payment row in arCashReceiptTransaction
-40 -- Error inserting Order Deposit row in arCashReceiptTransaction
-41 -- Error inserting rows in arCashReceiptTransaction to pay oldest invoice
- 214 -
ARISWebService
-42 -- Error inserting rows in arCashReceiptTransaction to pay access deposit

-43 -- Error updating CRTransPostFlag in arPayments
-44 -- Error updating IsPosted AND CommitFlag in arCashReceiptTransactions
-45 -- Error commiting Cash Receipt payments to arPaymentApplication tables
-46 -- Error inserting rows in arCashReceiptTransaction to pay oldest invoice
-47 -- Error inserting open credit row in arCashReceiptTransaction
-48 -- Missing CustomerKey
-49 -- Invalid ApplicationTypes
-50 -- ContractKey required for applicationtypes 'C'or 'M'
-51 -- InvoiceNo and SalesOrderNo required to apply the Order Deposit
-52 -- Order Deposit must be greater than 0
-53 -- Cannot cash receipt lock the customer record
-54 -- Customer locked by someone else
-55 -- Global AppVars Missing
-56 -- Order Deposit Drag Drop Error
-57 -- Order Deposit Update Error
-58 -- Commiting Payment Failed.
-59 -- CustomerNo Missing or Invalid
-60 -- Credit Card Data missing or Invalid
-61 -- Customer CashReceiptLock by another user
-62 -- Card Number and or Expiration Date missing or Invalid
-63 -- Alternate Terms or Contract missing
-64 -- Credit Card Terms Require the Credit Card Information.
-65 -- Credit Card Not Saved to File for future use
-66 -- Error Updating Contract Terms and/or CardNumberKey
-67 -- Contract missing
-68 -- Credit Card Information missing.
-69 -- Credit Card Number not stored on the system
-70 -- Error removing credit card on file.
-71 -- Account Terms are locked on the Access Agrreement Codes
-72 -- Duplicate Credit Card
-73 -- Direct Debit Terms Requires the Customer Bank Information.
-74 -- Error Updating Contract Terms to Direct Debit and/or CardNumberKey
-75 -- Error Updating Contract Terms to Net Terms and/or CardNumberKey
-76 -- Autopay to Credit Card Error
-77 -- Autopay to Direct Debit Error
-78 -- Autopay to Net Terms Error
-79 -- ContractKey does not match the Application Type ContractKey
-80 -- PCCharge Response is NULL
-81 -- Credit Class Code Key missing or invalid
-82 -- Error updating CreditClassCodeKey
-83 -- CardNumberKey missing or invalid
-84 -- CardNumberKey not assigned to the passed customer
-85 -- Error inserting into arCRSmallProcessQueue
-86 -- Error updating arCRSmallProcessQueue
-87 -- Error Voiding Charge (Note: Pay special attention to this reponse. This means the Credit Card was successfully
charged but the payment failed to post in OSS360. The Credit Cared must be manually voided in the Gateway)
Bank Debit Errors
-3400 –Bank Debit Errors
-1 -- Bank Name missing.

-2 -- Account Type missing.
-3 -- Routing Number missing.
-4 -- Routing Number Invalid
-5 -- Account Number missing.
-6 -- Error Insering Bank Debit Record.
-7 -- Duplicate Bank Debit Record
-8 -- Encryption Failed
-9 -- Error Updating Bank Debit Record
-500 -- Required parameter missing or invalid

-501 -- Error updating the CardNumberKey on the contract.
-502 -- ContactStaticKey Missing or Invalid
-4000 -- BID Creation Errors

0 --BID Activation failed
- 215 -
ARISWebService
1 --If all passed BIDs were added

2 --Missing or invalid passed data
3 --IDInventoryKey is already used
Sales Order Errors
-5000 -- Sales Order Errors

-1 -- Invalid CustomerKey.
-2 -- Missing address info.
-3 -- Missing TaxCodeKey.
-4 -- SQL Error inserting main SO row.
-5 -- Replication occurred inserting main SO row.
-6 -- Insert of main SO row failed.
-7 -- SQL Error in lookup of current tax-code date/time row.
-8 -- SQL Error inserting into soTempSalesOrderTaxes.
-9 -- Blank/NULL line-item XML parameter.
-10 -- SQL Error in sp_xml_preparedocument for @XML_LineItems.
-11 -- SQL Error declaring cursor on @XML_LineItems
-12 -- SQL Error opening @XML_LineItems cursor.
-13 -- SQL Error inserting soTempSalesOrderLineItems row.
-14 -- Item not found in inventory.
-15 -- Item-replication occurred.
-16 -- No line-items added from XML data.
-17 -- SQL Error calculating taxes.
-18 -- SQL Error inserting OD into soTempSalesOrderLineItems.
-19 -- OD ItemKey not found in inventory.
-20 -- Item-replication occurred when inserting OD line-item.
-21 -- SQL Error occurred querying TotalTax.
-22 -- TotalTax is NULL, not 0.
-23 -- SQL Error querying the SO Total.
-24 -- The SO Total is NULL, not 0.
-25 -- SQL error in the EXEC of wiSalesOrderInitAP.
-26 -- SQL error in the EXEC of wiPCChargeChargeCardAP.
-27 -- wiPCChargeChargeCardAP returned non-zero/NULL value.
-28 -- SQL error in the EXEC of soSalesOrdersCommitAP.
-29 -- Apparently soSalesOrdersCommitAP did a ROLLBACK TRAN after trapping a SQL Error.
-30 -- SQL error in the EXEC of wiSaveOrderDepositAP.
-31 -- The returned PaymentKey for the Order Deposit is NULL/Zero.
-32 -- SQL Error occurred while looking-up inventory-item data.
-33 -- No BID is associated with the IDInventoryKey of an XML line-item.
-34 -- No BID is associated with an equipment (S/N) XML line-item.
-35 -- Apparently wiSaveOrderDepositAP did a ROLLBACK TRAN after trapping a SQL Error.
-36 -- SQL Error occurred while looking-up package-item data.
-37 -- SQL error in the EXEC of ivPackagePricesSelectAP.
-38 -- SQL Error declaring PackageItems_CS cursor.
-39 -- SQL Error declaring PackageItems_CS cursor.
-50 -- Error Inserting SMS Message in the syNotificationsMessageQueue table.
Vendor Add Errors
-6000 -- Vendor Add Errors

-102 -- SQL Error inserting into syVendors
-103 -- SQL Error inserting into syVendDepartments
-104 -- SQL Error inserting into syVendAddresses
-105 -- SQL Error inserting into syVendContacts
-107 -- SQL Error inserting into syVendPhones for department Business Main phone
-108 -- SQL Error inserting into syVendPhones for department Email Address
-109 -- SQL Error inserting into syVendPhones for contact Business Main phone
-110 -- SQL Error inserting into syVendPhones for contact Email Address
-111 -- SQL Error updating syVendors (BillToAccount and WarrantyAccount)
-201 -- XML parameter list missing Affinity Name

-202 -- XML parameter list missing Contact Name
-203 -- XML parameter list missing Address1
-204 -- XML parameter list missing City
- 216 -
ARISWebService
-205 -- XML parameter list missing State

-206 -- XML parameter list missing Postal Code
-207 -- XML parameter list missing Business Main Phone
-208 -- XML parameter list missing Email Address
-301 -- Invalid derived value for VendorNo

-302 -- Invalid derived value for VendorTaxCodeKey
-303 -- Invalid derived value for DefCurrencyCodeKey
-304 -- Invalid derived value for DeptTypeKey
-305 -- Invalid derived value for DeptStaticKey
-306 -- Invalid derived value for DefCountryDivisionTypeKey
-307 -- Invalid derived value for BillingAddressStaticKey
-308 -- Invalid derived value for DefBillingAddressTypeKey
-309 -- Invalid derived value for DefCountry
-310 -- Invalid derived value for DefCountryCodeKey
-311 -- Invalid derived value for DefCountryDialCode
-318 -- Invalid derived value for VendContactStaticKey
Community of Interest Add Errors
-7000 -- Community Of Interest Add Errors

-1 -- You have reached the maximum number of CINumbers for this Account Number
-2 -- Parameter Errors, either the COINumber, CustomerNo or Department IS NULL
-3 -- Error Inserting the COI Code row.
-4 -- Error Inserting the COI Code LD rows.
Talk Group Add Errors
-7010 -- Talk Group Add Errors

-1 -- Parameter Errors, either the TalkGroup or Description is an empty string
-2 -- Error Inserting the Talk Groups Code.
-3 -- Error Inserting the Talk Groups LD rows.
Agreement Codes Add Errors
-7020 -- Agreement Code Add Errors

-1 -- Parameter Errors, either the derived AccessContractCode, Description or File name is an empty string
-2 -- Default Access Contract Code missing.
-3 -- Error Inserting the Access Contract Code.
-4 -- Error Inserting the Access Contract Code LD rows.
-5 -- Error Inserting the Optional Terms for Access Contract Code.
-6 -- Error Inserting the Preference for Access Contract Code.
Agent SLM Add Errors
-7040 -- Agent SLM Add Errors

-1 -- Vendor Contact, Address and Phone data missing
-2 -- Error Inserting Employee rows
-3 -- Missing DepartmentStaticKey
-4 -- Error Inserting Employee Contact/Personal Data Information
-5 -- Missing AddressTypeKey For Employee Business Main, Contact Address Type
-6 -- Error Inserting Employee Contact Address Information
-7 -- Error Inserting Employee Contact Business Phone
-8 -- Error Inserting Employee Contact Email Address
-9 -- Error Commission Groups has to be set up, Employee will not get commissions
-10 -- Missing Default AccessCommisionKey
-11 -- Error Inserting acCommissionGroupMembers
- 217 -
ARISWebService
Customer Address Edit Errors
-8000 -- Customer Address Edit Errors

-1 -- Error inserting into syCustAddresses
-2 -- All address parameters are NULL or empty
-3 -- Invalid derived value for EmployeeKey
-4 -- Invalid derived value for CustomerKey
-5 -- Invalid derived value for AddressTypeKey
-6 -- Invalid derived value for GeoCodeKey
-7 -- Invalid derived value for AddressIDKey
Customer Phone Edit Errors
-8100 -- Customers Phone Edit Errors

-11 -- Error inserting department phone into syCustPhones
-12 -- Error inserting contact phone into syCustPhones
-2 -- PhoneNumber parameter not passed
-4 -- Invalid derived value for CustomerKey
-5 -- Invalid PhoneType passed
-6 -- Invalid derived value for PhoneTypeKey
Update Vendor Errors
-8200 -- Vendor Update Errors

-1 -- Error executing wiUpdateVendorAP
-2 -- Error updating Logo
-3 -- Error executing wiEditCustomerPhonesAP
-4 -- CustomerNo Missing or Invalid
Update Vendor Contact Errors
-8300 -- Vendor Contact Edit Errors

-2 -- Invalid derived value for BillToAccount
-3 -- Invalid derived value for VendContStaticKey
-4 -- Invalid derived value for CustContStaticKey
-5 -- SQL Error inserting into syVendContacts
-6 -- SQL Error insertint into syCustContacts
Update Vendor Phone Errors
-8400 -- Vendor Phone Edit Errors

-1 -- SQL Error deleting (updating Status) from syVendPhones
-3 -- Invalid PhoneType passed
-5 -- Invalid derived value for DeptPhoneIDKey
-6 -- Invalid derived value for ConPhoneIDKey
-7 -- Invalid derived value for CustomerNo
-8 -- SQL Error inserting into syVendPhones for department Business Main phone
-9 -- SQL Error inserting into syVendPhones for department Email Address
-10 -- SQL Error inserting into syVendPhones for contact Business Main phone
-11 -- SQL Error inserting into syVendPhones for contact Email Address
-13 -- Invalid derived value for Dept StaticKey
-14 -- Invalid derived value for Con StaticKey
-15 -- WebSalesLocationKey missing from the configurations table
-16 -- Invalid derived value for DefCountry
-17 -- Invalie derived value for DefCountryDialCode
Register Account Errors
-9000 -- Register Account Errors

- 218 -
ARISWebService
-1 -- SSN and DL are both NULL or empty

-2 -- Invalid derived value for SSN PersonalDataTypeKey
-3 -- Invalid derived value for DL PersonalDataTypeKey
-7 -- Invalid derived value for DeptPhoneStaticKey
-8 -- Invalid derived value for AddressTypeKey
-9 -- Invalid derived value for Billing AddressStaticKey
-10 -- Error executing syCustPhonesInsAP (Department)
-11 -- Invalid derived value for ConPhoneStaticKey
-12 -- Error executing syCustPhonesInsAP (Contact)
-13 -- Error executing syCustPersonalDataGenAP (Secret Question and Secret Answer)
-14 -- Error updating syCustContacts with new password
Number Porting Add & Exchange ID Errors
-10000 -- Number Porting Add & Exchange ID Errors

-1 -- Error Inserting the number to be ported into the IDInventory table
-2 -- Error failed to AppLock Unit(acUnits) row is already applocked by another user
-3 -- Error BID is not currently Active
-4 -- Error EID UnitTYpe is invalid
-5 -- Error no exchange service change code Deact or React
-6 -- Error different SystemInterfaceKey tied to the ID change
-7 -- Error Exchange ID failed
-11000 -- Error occurred downstream in one of the triggered functions to cause the rate change to fail
0 -- Rate Change was committed and successful
-1 -- Error failed to AppLock Unit(acUnits) row is already applocked by another user
-2 -- Error missing required values
-3 -- UnitSystemKey / BID is not Active
-4 -- Error no rate change service change code Deact or React
-5 -- Error one or more required rate code is missing or invalid
Restore BID Errors
-17000 -- Restore BID Errors

1 -- Restored ID successful
-1 -- Passed BID(UnitID1) is currently active
-2 -- Error missing required values
-3 -- Error no restore service change code
-4 -- Error no original ProrateCodeKey on BID to be used for the restore
-5 -- Error ID is in an invalid Status to be restored Used or Deleted
-6 -- Error Creating and inserting into the GlobalAppVars Table
-7 -- Default Language missing from the Language table
-8 -- Default LanguageKey missing from the syConfigurations table
-9 -- Default LocationKey missing from the syConfigurations table
-10 -- Default EmployeeKey missing from the syConfigurations table
-11 -- System Type is wireline and cannot be restored
-12 -- Error calling wiInvoiceInitAddOnAP
-13 -- Error with Commit of the invoice: EXEC arInvoicesCommitAP
-14 -- Error with Commit Rollback Transaction
-15 -- Error with CusotmerKey information
-16 -- No Address found in tables
-17 -- No valid Tax Code Key found
-18 -- Error Sales Order insert failed
-19 -- Error Sales Order got replicated
-20 -- Error Sales Order did not get inserted
-21 -- Error Could Not Find Current Tax Code
-22 -- Error with Isert into Invoice Taxes
-23 -- Error with Restore Cursor Query
-24 -- Error with Restore Cursor Open
-25 -- Error Invalid ContractKey
-26 -- Error ItemKey does not equal SecurityDepositItemKey settings
-27 -- Error with quering the Item
- 219 -
ARISWebService
-28 -- Error with Insert of the SO LineItem

-29 -- Error No Line Items Added
-30 -- Error Calling Tax Calculation
-31 -- Error Query for arTempInvoices SO Total
-32 -- Error SO Total Is Null
-33 -- Error Query for Sum TotalTax from arTempInvoiceTaxes
-34 -- Error SO Total Tax Is Null
-35 -- No Active Session Key created
-36 -- BID has no Rate Codes to Restore
- 220 -
ARISWebService
Appendix B – ARISAccessAccount Error Codes
-680 -- 1Required parameter missing or invalid

-681 -- Error Payment has been previously reversed
-682 -- Invalid Record Type
-683 -- Error cancelling Arbitrage Invoice
-684 -- PaymentID not distinct
-686 -- Missing Payment ID
-687 -- Missing Reference
-688 -- Missing Amount
-689 -- No Customer Information Associated with this BID
-690 -- No Customer Information Associated with this PaymentKey
-691 -- No Customer Information Associated with the PaymentID
-692 -- No Customer Information Associated with the UnitID, Payment Date, Reference and Amount Paid
A360 Internal Errors (Setup Errors on the system)

-609 -- Default Location missing or is invalid from the Configurations table
-629 -- Default Language missing or is invalid from the Language table
-630 -- Default LanguageKey missing or is invalid from the Configurations table
-631 -- Default CurrencyKey missing or is invalid from the Configurations table
-632 -- Error getting the next Receipt Number
-633 -- EmployeeKey missing or is invalid from configuration table
-635 -- Error Acquiring Lock on record
-636 -- Error inserting Payment row
-639 -- Error inserting Transaction row
-642 -- Error inserting Access Deposit Transaction rows
-643 -- Error updating Posting Flag
-644 -- Error updating Commit Flag
-645 -- Error committing payments
-685 -- Administration Error: Missing Payment Vendor Type
-693 -- Error deriving Client ID
1
All Web Service Methods will return this error message if any or all the required parameters are missing.
- 221 -
ARISWebService
- 222 -
ARISWebService
Revision History
Date Change User Version

03/18/2007 Created Matt Young 1.0
03/24/2007 Added CreateAffinity, UpdateAffinity, GetAffinity, GetAffinityBalance Matt Young 1.1
WebMethods
04/04/2007 Updated documentation so that ValidateAddress has Address2 as Optional Matt Young 1.2
04/04/2007 Updated documentation to add valid type values for GetRatePlans Matt Young 1.2
04/04/2007 Updated documentation for GetBID to include new Request / Response value Matt Young 1.2
names
04/13/2007 Changed XML_CustomerData: and renamed E-mail to Email Matt Young 1.3
04/13/2007 Changed XML_CustomerData: and renamed Password to PassPhrase Matt Young 1.3
04/19/2007 Updated CreateAccount sample XML for XML_CustomerData Matt Young 1.3
04/19/2007 Added several new APIs AddNumberInventory, CreateSalesOrder, Matt Young 1.3
GetReasonCodes, ExchangeID, EditAddress, EditPhones, and GetBillDetails.
Also added place holders for new forthcoming APIs. UpdateAffinity,
GetOrderStatus, GetBillCharges, GetBillDetails, GetRecentUsage, and
AddUsageRecord
04/19/2007 Added additional Error Codes Matt Young 1.3
04/19/2007 Document formatting changes Matt Young 1.3
5/14/2007 Added GetBillCharges, GetCallDetail, GetRecentUsage, GetOrderStatus Matt Young 1.4
5/23/2007 Added Date Output parameter to GetBillDetails method Matt Young 1.5
5/23/2007 Updated DueDate Max Length from 23 to 10 in GetBillDetails method Matt Young 1.5
5/24/2007 Updated EditAddress to add valid Type values Matt Young 1.6
5/24/2007 Updated EditPhones to add valid PhoneType values Matt Young 1.6
5/24/2007 Updated GetRatePlans to have valid Type values Matt Young 1.6
5/24/2007 Adjusted page formatting Matt Young 1.7
5/24/2007 Added GetBalanceSummary, GetCustomerPersonalData, RegisterAccount, Christina Meyers 1.8
and AccountLogin
5/29/2007 Updated various formatting issues only Matt Young 1.9
6/5/2007 Added ArisAccessAccount Christina Meyers 1.10
6/7/2007 Removed ArisAccessAccount Christina Meyers 1.11
6/29/2007 Update format for GetAffinity and UpdateAffinity as they were changed Christina Meyers 1.12
8/13/2007 Added CreateSalesOrder, UpdateAffinity, and updated Error Codes Matt Young 1.13
8/28/2007 Added Customer Add Error Codes 503 – 512 Matt Young 1.14
8/28/2007 Added User column to this Revision History table. Matt Young 1.14
10/30/2007 Updated CreateAffinity, GetAffinity, GetAffinityBalance. Added EditRatePlan Christina Meyers 1.15
and AddUsageRecord
11/01/2007 Updated GetCallDetail API to include Content in Description for the Matt Young 1.16
UsageType.
11/14/2007 Updated the Type and Duration Input for the AddUsageRecord API to have Matt Young 1.17
meaningful values.
11/26/2007 Updated various to use UnitID1 instead of UnitSystemKey Keith Mutrux 1.18
12/04/2007 Updated GetRecentUsage API to include Content in Description for the Matt Young 1.19
UsageType.
01/24/2008 Updated basic document formatting in footers Matt Young 1.20
01/30/2008 Updated GetBID to include account and unit statuses Keith Muturx 1.21
07/08/2008 Updated input parameters and sample for PreAuthCreditCard Keith Mutrux 1.22
7/30/2008 Added AddBankDebit, EditBankDebit, RemoveBankDebit, and GetBankDebit Matt Young 1.23
APIs. Changed AutoPayOption API to allow for Net, Credit Card and Direct
Debit options.
7/30/2008 Updated AddCreditCard, EditCreditCard, RemoveCreditCard and Matt Young 1.23
GetCreditCard APIs to pass in the ContractKey.
7/30/2008 Updated AutoPayOption API to pass in a Type for changing between Net, Matt Young 1.23
Credit Card and Direct Debit Terms Types.
7/30/2008 Added GetContract API to return Contract details. Matt Young 1.23
2/13/2009 Updated GetAvailableTermsCodes and AutoPay option fields with correct Christina Meyers 1.23
values for contract keys.
04/08/2009 Update GetBillDetail, added BeginBalance and TotalOtherCredits Keith Mutrux 1.23
04/15/2009 Updated document formatting Matt Young 1.24
6/11/2009 Modified PreAuthCreditCard and ApplyCCPayment to further defining field Matt Young 1.25
- 223 -
ARISWebService
descriptions; Added XML_ContractData example

6/12/2009 Updated formatting of entire document Matt Young 1.25
02/01/2012 Updated the RemoveCreditCard API to use CardNumberKey rather than Matt Young 1.26
CreditCardNo and removed ContractKey input parameter.
02/01/2012 Added invoiceDeliveryMethod API Matt Young 1.26
02/27/2012 Modified the GetAccount API to include the Company name. Matt Young 1.27
08/28/2012 Modified the EditAddress API to allow an address Type to be added if it does Matt Young 1.28
not exist already otherwise an update.
01/25/2013 Added DeactivateUnit API Keith Mutrux 1.29
03/15/2013 Updated the ApplyCCPayment API to include the Payment Priority values 1-9 Matt Young 1.30
using the Target parameter.
03/15/2013 Updated ApplyCCPayment API to include UnitID1 parameter Matt Young 1.30
03/19/2013 Added GetTreatmentGroupBalances API Matt Young 1.30
03/22/2013 In ApplyCCPayment removed PaymentPriority from Target and added as own Matt Young 1.31
field to support both Target and PaymentPriority features at the same time.
04/12/2013 Updated ApplyCCPayment to remove UnitID1 parameter and sync’d up the Matt Young 1.32
web service definition.
05/10/2013 Added new CalcPlanEditChrg and CalcBIDRestoreChrg APIs Matt Young 1.33
05/14/2013 Added new GetAvailFreeUseRefreshSKUs API Matt Young 1.34
05/15/2013 Added new CreateInvoice API Matt Young 1.35
05/17/2013 Added new TransferBID API Matt Young 1.36
05/20/2013 Modified the AutoPayOption and InvoiceDeliveryMethod APIs to include Matt Young 1.37
AllContracts and allow ContractKey to be optional.
06/18/2013 Modified ApplyCCPayment API to allow Payment Priority input parameter to Matt Young 1.38
allow for 0.
07/15/2013 Sync’d up the soap definitions with the actual web service defnintions for Matt Young 1.39
GetAvailFreeUseRefreshSKUs, CalcPlanEditChrg, CalcBIDRestoreChrg,
CreateInvoice, GetRecentUsageSummary, and TransferBID
08/06/2013 Added new IDInventoryStatusChange API Matt Young 1.40
09/05/2013 Added Credit Card Charging Error Codes -80 through -87. Matt Young 1.41
09/24/2013 Modified AutoPayOption API to include CardNumberKey and Matt Young 1.42
XML_CreditCardData
09/25/2013 Updated typo in XML_DirectDebitData xml example Matt Young 1.43
10/03/2013 Updated the IDInventoryStatusChange with actual SOAP request / response Matt Young 1.44
11/13/2013 Updated the cover page Matt Young 1.45
12/18/2013 Added new Restore BID API Matt Young 1.46
01/20/2014 Added Appendix section for BIDRestore Error Codes Matt Young 1.47
02/27/2014 Updated document for AutoPayOption to make AllContracts parameter Matt Young 1.48
required.
02/27/2014 Updated Please Note section for AutoPayOption to make text more clear. Matt Young 1.48
03/28/2014 Updated EditRatePlan API to include detail for creating credit / debit. Matt Young 1.49
11/04/2014 Added new API ARISWebUtilities/BIDImageAttachement Matt Young 1.50
12/08/2014 Added new API ARISWebAccount/CloseTroubleTicket Matt Young 1.51
12/19/2014 Added new API GetBalanceSummaryByBID Matt Young 1.52
01/19/2015 Added new API AddBillAddOnItems Matt Young 1.53
01/22/2015 Added new API EmployeeLogin Matt Young 1.54
01/22/2015 Added new API SubscriberRegistrationDetail Matt Young 1.54
01/28/2015 Added new API AddRentalContract Matt Young 1.55
06/11/2015 Added new API GetRatePackage Matt Young 1.56
06/11/2015 Added new API AddRatePackage Matt Young 1.56
06/11/2015 Modified EditRatePlan API for new input parameter “PlanCycleStart” Matt Young 1.57
07/31/2015 Added Authentication and Logging detail in the About section Matt Young 1.58
08/26/2015 Added additional return columns for GetRatePlans. (MasterRatePackage, Matt Young 1.58
MasterRatePackageDescription, MemberCount, RatePackage,
RatePackageDescription)
10/19/2015 Renamed CreateAccount API to CreateAccountCustom Matt Young 1.59
10/19/2015 Added new API CreateAccount Matt Young 1.59
10/19/2015 Added new API ActivateBID Matt Young 1.59
10/21/2015 Combined the ARISWebService and A360FacilitiesManangement documents Matt Young 1.60
10/26/2015 Combined ARISWebService and ARISAccessAccount documents Matt Young 1.61
10/26/2015 Restructed document moving Revision History to the bottom. Matt Young 1.61
10/30/2015 Updated the SOAP request & response samples for AutoPayOption Matt Young 1.62
01/22/2016 Modified CreateAccount API to include Business Main Address fields Matt Young 1.63
03/25/2016 Modified CreateAccount API to include AccountTypeKey. Matt Young 1.64
04/04/2016 Modified ActivateBID API to include UnitID3. Matt Young 1.65
- 224 -
ARISWebService
04/13/2016 Modified CreateAccount API to include an optional parameter EmployeeCode Matt Young 1.66
in the XML_CustomerData.
06/03/2016 Modified ActivateBID API to include an optional parameter EmployeeCode in Matt Young 1.67
the XML_UnitIDDoc
06/03/2016 Corrected spelling mistake serialzied to serialized. Matt Young 1.67
06/08/2016 Modified LockID API to add the ReservationDays input parameter. Matt Young 1.68
08/09/2016 Modified CreateInvoice to add optional EmployeeCode parameter that can be Matt Young 1.69
used to record who created the transaction using the Employee’s default
Location.
02/08/2017 Added new API ARISAccessAccount / MakePrepayPostpayPayment Matt Young 1.70
02/08/2017 Changed all Envision references to OSS360 Matt Young 1.70
02/08/2017 Modified AddRatePackage API to include the ForceChange flag. Matt Young 1.70
02/16/2017 Added the note regarding AllowAllTermsForINPayments at the bottom of the Matt Young 1.70
ApplyCCPayment API.
02/24/2017 Modified Activate BIDs API to include the BID parameter. Matt Young 1.71
04/21/2017 Changed language relating to the Logging functionality. Matt Young 1.72
04/28/2017 Modified MakePrepayPostpayPayment to allow for optional PaymentType Matt Young 1.73
parameter.
- 225 -

A360 - ARISWebService - Version 1.73 - (Release 7.6.01.25 - CL)

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

A360 - ARISWebService - Version 1.73 - (Release 7.6.01.25 - CL)

Uploaded by

Copyright:

Available Formats

ARISWebService

About ARISWebService ................................................................................................................ 5

InvoiceDeliveryMethod ................................................................................................................................... 135

ARISWebService.ARISAccessAccount ................................................................................... 173

A360FacilitiesManagement.asmx ............................................................................................ 193

Appendix A – ARISWebService Error Codes .......................................................................... 213

Appendix B – ARISAccessAccount Error Codes ................................................................... 221

Revision History ........................................................................................................................ 223

The ARISWebService provides numerous API calls to access OSS360 information.

The ARISWebService allows for logging of Requests and Responses.

Logged entries are inserted into a table named wiServiceAccessLog.

POST /ARISWebService/ARISWebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

3 - Invalid Key passed

POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /ARISWebService/ARISWebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

Field Data Type Max Length Requirement Description

For declined transactions:

PCCharge Good Results:

PCCharge Bad Results:

with all transactions

POST /ARISWebService/ARISWebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

Address1 String 40 Required

POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

City String 40 Required

POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

Address String 40 Required

POST /ARISWebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

Field Data Type Max Length Requirement Description

POST /ARISWebService/ARISWebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /ariswebservice/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /WebServices/Version%201.0.0.19/ariswebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /ariswebservice/Ariswebutilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /A360WebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

POST /A360WebService/ARISWebUtilities.asmx HTTP/1.1

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>