Escolar Documentos
Profissional Documentos
Cultura Documentos
SOAP APIs
Version 1.73
Matthew S. Young
Advantage 360 Software, LLC
Last Updated 04/28/2017
ARISWebService
Contents
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
-3-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
-4-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
About ARISWebService
About
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
0 - No logging
1 - Error logging only
2 - Warning logging only
3 - Debug
4 - Log Everything
-5-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
-6-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
-7-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
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-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
ReturnValue String 1 1 – Success
2 - Already Reserved
-9-
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 10 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
IDInventoryKey Integer 2,147,483,647 Required
Output:
Field Data Type Max Length Description
ReturnValue String 1 1 – Success
2 - Not Reserved
3 - Invalid Key passed
- 11 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 12 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
XML_CreditCardData String 8,000 Required: See Below
- 13 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
XML_CreditCardData Fields:
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:
Field Data Type Max Length Description
ReturnValue String 1 1 – Success
0 – Unsuccessful
AuthorizationNumber String 40 For approved transactions:
Returns authorization code from the issuing bank.
- 14 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 15 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 16 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
- 17 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
FirstName String 40 Required
LastName String 40 Required
Address String 40 Required
- 19 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
CreditClass String 1 Returns Credit Class as defined by setup or false.
- 20 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
FirstName String 40 Required
LastName String 40 Required
- 21 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
CreditScore String 3 Returns the subscribers Credit Score or false
Report String 4,096 Returns the actual credit report as text.
- 22 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
PostalCode String 9 Required
XML_LineItems String 8,000 Required: See below
- 23 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
XML_LineItems Fields:
<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:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
No Input
- 25 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
Description String 40 Secret Question
PersonalDataTypeKey Integer 2,147,483,647 IdentityKey of Secret Question record
- 26 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<GetAvailFreeUseRefreshSKUsResult>boolean</GetAvailFreeUseRefreshSKUsRe
sult>
<AvailFreeUseRefreshSKUsSet>
<ARISAvailFreeUseRefreshSKUs>
<Item>string</Item>
<Description>string</Description>
<AllocationPeriod>string</AllocationPeriod>
<Quantity1>int</Quantity1>
<Price1>decimal</Price1>
<Quantity2>string</Quantity2>
<Price2>decimal</Price2>
<Quantity3>string</Quantity3>
<Price3>string</Price3>
<Quantity4>decimal</Quantity4>
<Price4>decimal</Price4>
- 27 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Quantity5>decimal</Quantity5>
<Price5>decimal</Price5>
<Quantity6>decimal</Quantity6>
<Price6>decimal</Price6>
</ARISAvailFreeUseRefreshSKUs>
<ARISAvailFreeUseRefreshSKUs>
<Item>string</Item>
<Description>string</Description>
<AllocationPeriod>string</AllocationPeriod>
<RateType>string</RateType>
<RateIncrement>string</RateIncrement>
<Quantity1>int</Quantity1>
<Price1>decimal</Price1>
<Quantity2>string</Quantity2>
<Price2>decimal</Price2>
<Quantity3>string</Quantity3>
<Price3>string</Price3>
<Quantity4>decimal</Quantity4>
<Price4>decimal</Price4>
<Quantity5>decimal</Quantity5>
<Price5>decimal</Price5>
<Quantity6>decimal</Quantity6>
<Price6>decimal</Price6>
</ARISAvailFreeUseRefreshSKUs>
</AvailFreeUseRefreshSKUsSet>
</GetAvailFreeUseRefreshSKUsResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
RateType String 2 Optional:
TA – Airtime
TR – Roaming
TT – Toll Charges
TM – SMS
MS – MMS
GD – GPRS Data
TD – Data
TN – Content
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
Quantity2 Integer 9999 Quantity 2 Tier
Price2 Decimal 999999999.99 Price 2 Amount
Quantity3 Integer 9999 Quantity 3 Tier
Price3 Decimal 999999999.99 Price 3 Amount
Quantity4 Integer 9999 Quantity 4 Tier
Price4 Decimal 999999999.99 Price 4 Amount
Quantity5 Integer 9999 Quantity 5 Tier
Price5 Decimal 999999999.99 Price 5 Amount
Quantity6 Integer 9999 Quantity 6 Tier
Price6 Decimal 999999999.99 Price 6 Amount
- 29 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 30 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<IDInventoryStatusChangeResult>boolean</IDInventoryStatusChangeResult>
<ReturnValue>int</ReturnValue>
</IDInventoryStatusChangeResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue String 1 1 - Successful
0 - Unsuccessful
- 32 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
BIDImageAttachementResult String 5 true - Successful
false - Unsuccessful
- 34 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
EmployeeCode String 3 Required – Alphanumeric Employee Code
Password String 40 Required – MD5 Hashed Employee Password
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Valid
0 = Invalid
EmployeeKey Integer 2,147,483,647 Identity Key of Employee
- 35 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Please Note:
The Password being passed into the API must be MD5 Hashed. (http://www.md5hashgenerator.com/)
- 36 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<SubscriberRegistrationDetailResult>int</SubscriberRegistrationDetailRe
sult>
<AccountNumber>string</AccountNumber>
<BillableID>string</BillableID>
<InvoiceNo>string</InvoiceNo>
</SubscriberRegistrationDetailResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 39 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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:
Example:
<![CDATA[
<CustContracts>
<ContractData ContractKey = “12345” AmountPaid = “25.00”/>
</CustContracts>
]]>
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:
Field Data Type Max Length Description
PaymentKey Integer 2,147,483,647 IdentityKey for Payment. Can be used to create a receipt in
the Web Interface. Negative values are errors.
AuthorizationNumber String 100 For approved transactions:
Returns authorization code from the issuing bank.
- 40 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
CCReference String 100 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
with all transactions
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 42 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 43 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<FeatureType>string</FeatureType>
<FeatureTypeDescription>string</FeatureTypeDescription>
<Rate1>decimal</Rate1>
<Rate2>decimal</Rate2>
<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>
<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>
<RateType>string</RateType>
<FeatureCode>string</FeatureCode>
<FeatureCodeDescription>string</FeatureCodeDescription>
<FeatureType>string</FeatureType>
<FeatureTypeDescription>string</FeatureTypeDescription>
<Rate1>decimal</Rate1>
<Rate2>decimal</Rate2>
<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>
</RatePlanSet>
</GetRatePlansResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
RatePlan String 4 Code from Rate Plan
- 44 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 45 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 47 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 48 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 49 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</GetPaymentHistoryResult>
</GetPaymentHistoryResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 51 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<RateCodeDescription>string</RateCodeDescription>
<RateType>string</RateType>
<FeatureCode>string</FeatureCode>
<FeatureCodeDescription>string</FeatureCodeDescription>
<FeatureType>string</FeatureType>
<FeatureTypeDescription>string</FeatureTypeDescription>
<Rate1>decimal</Rate1>
<Rate2>decimal</Rate2>
<AllocationType>string</AllocationType>
<FreeAmount1>int</FreeAmount1>
<Promote>boolean</Promote>
<Commitment>string</Commitment>
<SystemID>string</SystemID>
<UnitSystemKey>int</UnitSystemKey>
<AccountStatus>string</AccountStatus>
<AccountStatusDescription>string</AccountStatusDescription>
<UnitIDStatus>string</UnitIDStatus>
<UnitIDStatusDescription>string</UnitIDStatusDescription>
</ARISBIDEntity>
<ARISBIDEntity>
<CustomerNo>string</CustomerNo>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<UnitID1>string</UnitID1>
<UnitID2>string</UnitID2>
<UnitID3>string</UnitID3>
<EID>string</EID>
<RatePlan>string</RatePlan>
<RatePlanDescription>string</RatePlanDescription>
<RateCode>string</RateCode>
<RateCodeDescription>string</RateCodeDescription>
<RateType>string</RateType>
<FeatureCode>string</FeatureCode>
<FeatureCodeDescription>string</FeatureCodeDescription>
<FeatureType>string</FeatureType>
<FeatureTypeDescription>string</FeatureTypeDescription>
<Rate1>decimal</Rate1>
<Rate2>decimal</Rate2>
<AllocationType>string</AllocationType>
<FreeAmount1>int</FreeAmount1>
<Promote>boolean</Promote>
<Commitment>string</Commitment>
<SystemID>string</SystemID>
<UnitSystemKey>int</UnitSystemKey>
<AccountStatus>string</AccountStatus>
<AccountStatusDescription>string</AccountStatusDescription>
<UnitIDStatus>string</UnitIDStatus>
<UnitIDStatusDescription>string</UnitIDStatusDescription>
</ARISBIDEntity>
</BIDEntitySet>
</GetBIDResponse>
</soap:Body>
</soap:Envelope>
- 52 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
DateTime String 23 Optional
Output:
Field Data Type Max Length Description
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
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
MD - Message Deposit
MI - Home Mobile-to-Home Mobile Incoming
MI - Mobile-to-Mobile Incoming
MM - Mobile-to-Mobile
MM - Mobile-to-Mobile
MM - Home Mobile-to-Home Mobile
MR - Message Retrieval
MR - Message Retrieval
MV - Message Delivery
MV - Message Delivery
NC - Contract
ND - NDD Delivery
NP - Rate Plan
NT - National Toll
OC - Roaming OCCs
OU - Outgoing
RF - Roaming Call Forwarding
- 53 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 54 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 56 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
POST /ARISWebService/ARISWebAccount.asmx HTTP/1.1
Host: local host
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateAccount"
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<AuthorizationNumber>string</AuthorizationNumber>
<Result>string</Result>
<CCReference>string</CCReference>
<ReturnValue>int</ReturnValue>
</ARISWebOutputData>
<ARISWebOutputData>
<CustomerNo>string</CustomerNo>
<CustomerKey>int</CustomerKey>
<SalesOrderNo>string</SalesOrderNo>
<SubTotal>decimal</SubTotal>
<TotalTax>decimal</TotalTax>
<Total>decimal</Total>
<PaymentKey>int</PaymentKey>
<AuthorizationNumber>string</AuthorizationNumber>
<Result>string</Result>
<CCReference>string</CCReference>
<ReturnValue>int</ReturnValue>
</ARISWebOutputData>
</WebOutputDataSet>
</CreateAccountResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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:
- 58 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<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:
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="983" RatePlanKey="1"/>
<tblxmlID UnitKey="-2" IDInventoryKey="982" RatePlanKey="1"/>
</IDData>
XML_UnitRatesDoc:
<RatesData>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="1" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="3" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="4" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="1" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="3" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="4" TreeNode="IR"/>
</RatesData>
XML_CreditCardData:
- 59 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
XML_LineItems:
<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:
XML_WebOutputData:
- 60 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
PROCESSED',
'APPROVED',
'CANCELLED',
'VOIDED',
'SALE RECOVERED',
'RETURN RECOVERED' .
- 61 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 62 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 63 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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>
<Password>string</Password>
<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>
<AccountNumber>string</AccountNumber>
</ARISAccountEntity>
<ARISAccountEntity>
<CustomerKey>int</CustomerKey>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<BillingAddress1>string</BillingAddress1>
<BillingAddress2>string</BillingAddress2>
<BillingCity>string</BillingCity>
<BillingState>string</BillingState>
<BillingPostalCode>string</BillingPostalCode>
<BillingCountry>string</BillingCountry>
<ShippingAddress1>string</ShippingAddress1>
<ShippingAddress2>string</ShippingAddress2>
<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>
<Password>string</Password>
<SecretQuestion>string</SecretQuestion>
<SecretAnswer>string</SecretAnswer>
<CardType>string</CardType>
<CardExpiration>string</CardExpiration>
- 64 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<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>
<AccountNumber>string</AccountNumber>
</ARISAccountEntity>
</AccountEntitySet>
</GetAccountResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
AccountNumber String 17 The AccounNumber for the Bank Account used for Autopay
Bank Debit
- 66 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
XML_CreditCardData String 8,000 Required:
See PreAuthCreditCard
- 67 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Example:
<CreditCardData>
<CardData CardNumber ="4012000033330026" ExpirationDate ="1108" CardHolder= "Web Test Customer 1"
CID="" PostalCode="" PostalCode=”” SaveCreditCard ="1"/>
</CreditCardData>
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 68 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 69 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<CardTypeCode>string</CardTypeCode>
<ExpirationDate>string</ExpirationDate>
<ExpDateFormat>string</ExpDateFormat>
<PostalCode>string</PostalCode>
<CardHolder>string</CardHolder>
<CardNumberKey>int</CardNumberKey>
<ContractKey>int</ContractKey>
<ApplicationType>string</ApplicationType>
</ARISCreditCard>
</CreditCardSet>
</GetCreditCardResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
XML_CreditCardData String 8,000 Required:
See PreAuthCreditCard
- 71 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Example:
<CreditCardData>
<CardData CardNumberKey=”1234” CardNumber ="4012000033330026" ExpirationDate ="1108" CardHolder=
"Web Test Customer 1" SaveCreditCard ="1"/>
</CreditCardData>
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 72 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
CardNumberKey Integer 2,147,483,647 Required
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 73 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 74 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 75 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
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:
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.
- 76 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
XML_DirectDebitData Fields:
Example:
<![CDATA[
<DirectDebitData>
<DebitData>BankName ="Wells Fargo" AccountType = “C” RoutingNumber = “122000247” AccountNumber =
“1000000000000”/>
</DirectDebitData>
]]>
Note: Any XML fields that are passed to a web method must be wrapped with <![CDATA[XML Fields]]> so they are
treated as strings.
- 77 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 78 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<GetAvailableTermsCodesResult>boolean</GetAvailableTermsCodesResult>
<TermsCodesSet>
<ARISTermsCodes>
<TermsCode>string</TermsCode>
<TermsCodeDescription>string</TermsCodeDescription>
<ContractKey>int</ContractKey>
<TermsKey>int</TermsKey>
<IsCurrentTerms>boolean</IsCurrentTerms>
</ARISTermsCodes>
<ARISTermsCodes>
<TermsCode>string</TermsCode>
<TermsCodeDescription>string</TermsCodeDescription>
<ContractKey>int</ContractKey>
<TermsKey>int</TermsKey>
<IsCurrentTerms>boolean</IsCurrentTerms>
- 79 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</ARISTermsCodes>
</TermsCodesSet>
</GetAvailableTermsCodesResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 IdentityKey for the Contract
Output:
Field Data Type Max Length Description
TermsCode String 3 Unique identifier for Terms Code
TermsCodeDescription String 40 Description of Terms Code
ContractKey Integer 2,147,483,647 IdentityKey for the Contract
TermsKey Integer 2,147,483,647 IdentityKey for the Terms Code
IsCurrentTerms Integer 1 1 – Yes
0 - No
- 80 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 81 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<ARISAffinityEntity>
<AffinityID>string</AffinityID>
<AffinityName>string</AffinityName>
<AffinityContact>string</AffinityContact>
<AffinityAddress1>string</AffinityAddress1>
<AffinityAddress2>string</AffinityAddress2>
<AffinityCity>string</AffinityCity>
<AffinityState>string</AffinityState>
<AffinityPostalCode>string</AffinityPostalCode>
<AffinityPhone>string</AffinityPhone>
<AffinityEmail>string</AffinityEmail>
<LogoPathFileName>string</LogoPathFileName>
</ARISAffinityEntity>
</AffinityEntitySet>
</GetAffinityResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
Logo String 255 Optional
Name String 40 Required
ContactName String 80 Required
Address1 String 40 Required
Address2 String 40 Optional
City String 40 Required
State String 20 Required
PostalCode String 10 Required
Phone String 80 Required- when blank we delete the number
EmailAddress String 80 Required- when blank we delete the number
Output:
Field Data Type Max Length Description
AgentID String 6 Agent Number
CustomerNo String 11 Customer Number
ReturnValue Integer 1 1 – Success
0 - Unsuccessful
- 82 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 83 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<AffinityID>string</AffinityID>
<AffinityName>string</AffinityName>
<AffinityContact>string</AffinityContact>
<AffinityAddress1>string</AffinityAddress1>
<AffinityAddress2>string</AffinityAddress2>
<AffinityCity>string</AffinityCity>
<AffinityState>string</AffinityState>
<AffinityPostalCode>string</AffinityPostalCode>
<AffinityPhone>string</AffinityPhone>
<AffinityEmail>string</AffinityEmail>
<Logo>string</Logo>
</ARISAffinityEntity>
</AffinityEntitySet>
</GetAffinityResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
AgentID String 6 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 85 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
AgentID String 6 Required
AffinityName String 40 Optional
AffinityContact String 40 Optional
Address1 String 40 Optional
Address2 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:
Field Data Type Max Length Description
ReturnValue Integer 4 1 – Successful
-[value] – Unsuccessful
Note:
1. To update an AffinityName or Address you must pass the AffinityName, Address1, Address2, City, State, and
PostalCode data.
- 86 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
GetAffinityBalance
Description:
This WebMethod is used to
Use:
This would be used to display
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 87 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<PreviousBalance>decimal</PreviousBalance>
<CommEarned>decimal</CommEarned>
<EarnedDate>dateTime</EarnedDate>
<CommRedeemed>decimal</CommRedeemed>
<RedeemedDate>dateTime</RedeemedDate>
<CommAdjustments>decimal</CommAdjustments>
<AdjustmentDate>dateTime</AdjustmentDate>
<AgentID>string</AgentID>
<VendorKey>int</VendorKey>
<CustomerKey>int</CustomerKey>
<CustomerNo>string</CustomerNo>
</ARISAffinityBalance>
</AffinityBalanceSet>
</GetAffinityBalanceResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
AgentID String 6 Required
Output:
Field Data Type Max Length Description
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
CustomerKey Integer 2,147,483,647 CustomerKey for Account added
CustomerNo String 11 Customer number for account added
- 88 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
ID String 10 Required
PortingType String 1 Required: Pass I for Porting In
Output:
Field Data Type Max Length Description
IDInventoryKey Integer 1 1 – Successful
0 - Unsuccessful
- 89 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 90 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 91 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<UnitID2>string</UnitID2>
<UnitID3>string</UnitID3>
<UnitSystemKey>int</UnitSystemKey>
<Status>string</Status>
<TrackingNumber>string</TrackingNumber>
</ARISOrderStatus>
</OrderStatusSet>
</GetOrderStausResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
SalesOrderNo String 8 Required
Output:
Field Data Type Max Length Description
Item String 23 SKU / Item Number
Description String 40 Description of Item
UnitID1 String 16 MSISDN, MDN, etc.
UnitID2 String 16 IMSI, MIN, etc.
UnitID3 String 23 ICCID, ESN, etc.
UnitSystemKey Integer 2,147,483,647 IdentityKey of BID
Status String 12 “Not Invoiced” or “Invoiced”
TrackingNumber String 30 Tracking Number for line item when Invoiced
- 92 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 93 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Result>string</Result>
<CCReference>string</CCReference>
<ReturnValue>int</ReturnValue>
</ARISWebOutputData>
<ARISWebOutputData>
<CustomerNo>string</CustomerNo>
<CustomerKey>int</CustomerKey>
<SalesOrderNo>string</SalesOrderNo>
<SubTotal>decimal</SubTotal>
<TotalTax>decimal</TotalTax>
<Total>decimal</Total>
<PaymentKey>int</PaymentKey>
<AuthorizationNumber>string</AuthorizationNumber>
<Result>string</Result>
<CCReference>string</CCReference>
<ReturnValue>int</ReturnValue>
</ARISWebOutputData>
</WebOutputDataSet>
</CreateSalesOrderResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
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:
Field Data Type Max Length Description
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
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
PaymentKey Integer 2,147,483,647 PaymentKey for CreditCard Payment
AuthorizationNumber String 100 For approved transactions:
Returns authorization code from the issuing bank.
- 94 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
'ERROR'
CCReference String 100 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
with all transactions
ReturnValue Integer 2,147,483,647 1 – Success
0 – Unsuccessful
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 96 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 97 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
ServiceChangeType String 2 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
UnitID2 String 16 Required
- 99 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 101 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Type String 1 Required:
B -Business Main
I -Bill To
S -Ship To
N -Notice
P -Promotion
O -Other
Address1 String 40 Required
Address2 String 40 Required
City String 40 Required
State String 20 Required
PostalCode String 10 Required
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
AddressIDKey Integer 2,147,483,647 Identity Key of newly added Address row
- 102 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
PhoneType String 1 Required:
BM -Business Main
H -Home Phone
E -E-mail Address
- 103 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
PhoneIDKey Integer 2,147,483,647 Identity Key of newly added Phone row
- 104 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 105 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<TotalCurrentTaxes>decimal</TotalCurrentTaxes>
<TotalCurrentCharges>decimal</TotalCurrentCharges>
<TotalAmountDue>decimal</TotalAmountDue>
</ARISBillDetails>
<ARISBillDetails>
<CustomerNo>string</CustomerNo>
<InvoiceNo>string</InvoiceNo>
<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>
<TotalCurrentTaxes>decimal</TotalCurrentTaxes>
<TotalCurrentCharges>decimal</TotalCurrentCharges>
<TotalAmountDue>decimal</TotalAmountDue>
</ARISBillDetails>
</BillDetailsSet>
</GetBillDetailsResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
- 107 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<LineItemTotalPerBID>decimal</LineItemTotalPerBID>
<SortOrder>string</SortOrder>
</ARISBillCharges>
<ARISBillCharges>
<InvoiceNo>string</InvoiceNo>
<UnitID1>string</UnitID1>
<Description>string</Description>
<BilledDates>string</BilledDates>
<RecordCount>int</RecordCount>
<VolumeUsed>decimal</VolumeUsed>
<VolumeFree>decimal</VolumeFree>
<ChargeTotal>decimal</ChargeTotal>
<BIDTotal>decimal</BIDTotal>
<ChargeType>string</ChargeType>
<CustomerKey>int</CustomerKey>
<UnitSystemKey>int</UnitSystemKey>
<RecID>int</RecID>
<TaxTotalPerBID>decimal</TaxTotalPerBID>
<LineItemTotalPerBID>decimal</LineItemTotalPerBID>
<SortOrder>string</SortOrder>
</ARISBillCharges>
</BillChargesSet>
</GetBillChargesResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
Output:
Field Data Type Max Length Description
InvoiceNo String 9 InvoiceNo for Access Invoice
UnitID1 String 16 MSISDN, MDN, etc.
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
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 109 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<ARISCallDetails>
<UnitID1>string</UnitID1>
<InvoiceNo>string</InvoiceNo>
<DateOfCall>string</DateOfCall>
<TimeOfCall>string</TimeOfCall>
<Destination>string</Destination>
<NumberCalled>string</NumberCalled>
<Period>string</Period>
<Duration>decimal</Duration>
<AirtimeCharges>decimal</AirtimeCharges>
<TollCharges>decimal</TollCharges>
<Total>decimal</Total>
<UsageType>string</UsageType>
</ARISCallDetails>
</CallDetailsSet>
</GetCallDetailResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
UnitID1 String 16 MSISDN, MDN, etc.
InvoiceNo String 9 InvoiceNo for Access Invoice
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 111 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<UnitID1>string</UnitID1>
<DateOfCall>string</DateOfCall>
<TimeOfCall>string</TimeOfCall>
<Destination>string</Destination>
<NumberCalled>string</NumberCalled>
<Period>string</Period>
<Duration>decimal</Duration>
<AirtimeCharges>decimal</AirtimeCharges>
<TollCharges>decimal</TollCharges>
<Total>decimal</Total>
<UsageType>string</UsageType>
</ARISCurrentUsage>
</CurrentUsageSet>
</GetRecentUsageResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
UnitID1 String 16 MSISDN, MDN, etc.
InvoiceNo String 9 InvoiceNo for Access Invoice
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
AddUsageRecord
Description:
This WebMethod is used to add usage.
Use:
This would be used to manually add usage to the tables.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 113 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
Type String 1 Required:
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:
Output:
Field Data Type Max Length Description
RawUsageKey Integer 2,147,483,647 Primary Key of the Raw Usage row.
- 114 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 115 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<LastPayment>decimal</LastPayment>
<Reference>string</Reference>
<LastPaymentDate>string</LastPaymentDate>
<PastDueBalance>decimal</PastDueBalance>
<TotalAmountDue>decimal</TotalAmountDue>
<PaymentDueDate>string</PaymentDueDate>
<PaymentType>string</PaymentType>
<InvoiceNo>string</InvoiceNo>
<CustomerKey>int</CustomerKey>
<PaymentKey>int</PaymentKey>
</ARISBalanceSummary>
</BalanceSummarySet>
</GetBalanceSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Optional – CustomerNo or UnitID1 is required
UnitID1 String 16 Optional – CustomerNo or UnitID1 is required
Output:
Field Data Type Max Length Description
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
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
PaymentKey Integer 2,147,483,647 IdentityKey from Payment
- 116 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.)
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
Request Placeholder
Response Placeholder
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
TreatmentGroup String 1 Required
Output:
Field Data Type Max Length Description
Group1Balance Decimal 999999999.99 Treatment Group 1 balance
Group2Balance Decimal 999999999.99 Treatment Group 2 balance
Group3Balance Decimal 999999999.99 Treatment Group 3 balance
Group4Balance Decimal 999999999.99 Treatment Group 4 balance
Group5Balance Decimal 999999999.99 Treatment Group 5 balance
Group6Balance Decimal 999999999.99 Treatment Group 6 balance
Group7Balance Decimal 999999999.99 Treatment Group 7 balance
Group8Balance Decimal 999999999.99 Treatment Group 8 balance
Group9Balance Decimal 999999999.99 Treatment Group 9 balance
AccountBalance Decimal 999999999.99 Account balance
PastDueBalance Decimal 999999999.99 Past due Account balance
- 117 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 118 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<GetCustomerPersonalDataResult>boolean</GetCustomerPersonalDataResult>
<Question>string</Question>
<QuestionKey>int</QuestionKey>
<Answer>string</Answer>
<Email>string</Email>
<Password>string</Password>
<CustomerKey>int</CustomerKey>
</GetCustomerPersonalDataResponse>
</soap:Body>
</soap:Envelope>
- 119 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 MSISDN, MDN, etc.
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 121 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 MSISDN, MDN, etc.
SSN String 9 Required
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:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 MSISDN, MDN, etc.
PassPhrase String 20 Customer’s password on account
Output:
Field Data Type Max Length Description
CustomerNo String 80 Name of customer
- 123 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 124 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
XML_UnitRatesDoc String 8,000 Required
UnitID1 String 16 MSISDN, MDN, etc.
RatePlanKey Integer 2,147,483,647 IdentityKey from Rate Plan
PlanChangeStart String 1 Optional:
I = Immediate (default)
- 125 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
C = Cycle Start
Output:
Field Data Type Max Length Description
ReturnValue String 1 1 – Success
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:
<![CDATA[<RatesData>
<xmlRates UnitKey="-1" MasterKey="5" PackKey="5" RateKey="3" TreeNode="MRP"/>
<xmlRates UnitKey="-1" MasterKey="25" PackKey="25" RateKey="47" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="44" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="46" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="24" PackKey="24" RateKey="5" TreeNode="MRP"/>
<xmlRates UnitKey="-1" MasterKey="25" PackKey="25" RateKey="49" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="25" PackKey="25" RateKey="49" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="25" PackKey="25" RateKey="48" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="40" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="26" PackKey="26" RateKey="51" TreeNode="MRP"/>
<xmlRates UnitKey="-1" MasterKey="27" PackKey="27" RateKey="54" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="27" PackKey="27" RateKey="52" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="26" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="27" PackKey="27" RateKey="53" TreeNode="IRP"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="25" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="26" TreeNode="IR"/>
</RatesData>]]>
- 126 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 127 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey 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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 128 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 129 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 130 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 131 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</ARISBankDebit>
</BankDebitSet>
</GetBankDebitResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
ContractKey Integer 2,147,483,647 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 133 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Destination>string</Destination>
<TermsKey>int</TermsKey>
<TermsDescription>string</TermsDescription>
</ARISContract>
</ContractSet>
</GetContractResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 135 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Destination>string</Destination>
<TermsKey>int</TermsKey>
<TermsDescription>string</TermsDescription>
</ARISContract>
</ContractSet>
</GetContractResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
ContractKey Integer 2,147,483,647 Required
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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 – Unsuccessful
- 136 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
P = Permanent Deactivation
A = Reactivation
E = Temporary Restriction
Output:
Field Data Type Max Length Description
ReturnValue Integer 4 1 = Successful
-[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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
XML_UnitRatesDoc String 8,000 XML string of the new rates: MasterKey, PackKey,
RateKey,TreeNode
UnitID1 String 16 Required
- 139 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
Output:
Field Data Type Max Length Description
ReturnValue Integer 4 1 = Successful
RestoreCost Decimal 999999999.99 Charges for restore of service
- 141 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 142 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 143 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<ReturnValue>int</ReturnValue>
</ARISInvoicePayment>
<ARISInvoicePayment>
<CustomerNo>string</CustomerNo>
<CustomerKey>int</CustomerKey>
<InvoiceNo>string</InvoiceNo>
<SubTotal>decimal</SubTotal>
<TotalTax>decimal</TotalTax>
<Total>decimal</Total>
<PaymentKey>int</PaymentKey>
<AuthorizationNumber>string</AuthorizationNumber>
<Result>string</Result>
<CCReference>string</CCReference>
<ReturnValue>int</ReturnValue>
</ARISInvoicePayment>
</WebOutputDataSet>
</CreateInvoiceResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
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:
Field Data Type Max Length Description
CustomerNo String 11 Customer Number for the Account
CustomerKey Integer 2,147,483,647 Primary Key of the Customer
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
PaymentKey Integer 2,147,483,647 PaymentKey for CreditCard Payment
AuthorizationNumber String 100 For approved transactions:
Returns authorization code from the issuing bank.
- 144 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 146 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<GetRecentUsageSummaryResult>boolean</GetRecentUsageSummaryResult>
<WebRecentUsageSummarySet>
<ARISRecentUsageSummary>
<RateType>string</RateType>
<FeatureCode>string</FeatureCode>
<RateIncrement>string</RateIncrement>
<Available>decimal</Available>
<Used>decimal</Used>
<Remaining>decimal</Remaining>
</ARISRecentUsageSummary>
<ARISRecentUsageSummary>
<RateType>string</RateType>
<FeatureCode>string</FeatureCode>
<RateIncrement>string</RateIncrement>
- 147 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Available>decimal</Available>
<Used>decimal</Used>
<Remaining>decimal</Remaining>
</ARISRecentUsageSummary>
</WebRecentUsageSummarySet>
</GetRecentUsageSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
Output:
Field Data Type Max Length Description
RateType String 2 TA – Airtime
TR – Roaming
TT – Toll Charges
TM – SMS
MS – MMS
GD – GPRS Data
TD – Data
TN – Content
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
MD - Message Deposit
MI - Home Mobile-to-Home Mobile Incoming
MI - Mobile-to-Mobile Incoming
MM - Mobile-to-Mobile
MM - Mobile-to-Mobile
MM - Home Mobile-to-Home Mobile
MR - Message Retrieval
MR - Message Retrieval
MV - Message Delivery
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
- 148 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 149 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 150 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
ToAccountNumber String 11 Required
ToContractNumber String 999 Required
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
- 151 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
0 = Unsuccessful
- 152 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 154 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
PLACEHOLDER
PLACEHOLDER
Input:
Field Data Type Max Length Requirement
TagNumber String 10 Required
ToAccountNumber String 11 Required
ToContractNumber String 999 Required
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
0 = Unsuccessful
- 155 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 156 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<Reference>string</Reference>
<LastPaymentDate>string</LastPaymentDate>
<PastDueBalance>decimal</PastDueBalance>
<TotalAmountDue>decimal</TotalAmountDue>
<PaymentDueDate>string</PaymentDueDate>
<PaymentType>string</PaymentType>
<InvoiceNo>string</InvoiceNo>
<CustomerKey>int</CustomerKey>
<PaymentKey>int</PaymentKey>
</ARISBalanceSummary>
</BalanceSummarySet>
</GetBalanceSummaryResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required UnitID1 or BID
Output:
Field Data Type Max Length Description
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
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
PaymentKey Integer 2,147,483,647 IdentityKey from Payment
- 158 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
0 = Unsuccessful
- 160 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
-1 = UnitSystemKey does not exist or has been deleted
-2 = Serial Number does not exist in the System
- 161 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 162 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 163 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
BID Integer 2,147,483,647 Required – Billable ID
RatePackage String 4 Required – Rate Package
Output:
Field Data Type Max Length Description
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
0 - Unsuccessful
- 166 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
POST /ARISWebService/ARISWebAccount.asmx HTTP/1.1
Host: local host
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateAccount"
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
XML_CustomerData String 8,000 Required
XML_CustomerData:
<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:
- 168 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 169 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
</ARISBIDStatus>
</BIDStatuses>
</ActivateBIDResponse>
</soap:Body>
</soap:Envelope>
XML_UnitIDDoc:
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="26952" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""/>
<tblxmlID UnitKey="-2" IDInventoryKey="21538" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""
UnitID3="" EmployeeCode=""/>
</IDData>
<IDData>
<tblxmlID UnitKey="-1" IDInventoryKey="0" BID="00A0C914C829" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""/>
<tblxmlID UnitKey="-2" IDInventoryKey="21538" RatePlanKey="1634"
CustomerKey="1410" AccessContractCodeKey="" ServiceChangeKey="" ContractKey=""
UnitID3="" EmployeeCode=""/>
</IDData>
XML_UnitRatesDoc:
- 170 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<RatesData>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="1" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="3" TreeNode="IR"/>
<xmlRates UnitKey="-1" MasterKey="0" PackKey="0" RateKey="4" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="1" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="3" TreeNode="IR"/>
<xmlRates UnitKey="-2" MasterKey="0" PackKey="0" RateKey="4" TreeNode="IR"/>
</RatesData>
Output:
Field Data Type Max Length Description
UnitID1 String 16 Billable ID that was activated
- 171 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 172 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 173 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
PaymentKey Integer 2,147,483,647 IdentityKey for Payment. Can be used to create a receipt in
the Web Interface. Negative values are 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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
ReturnValue Integer 1 ReturnValue >= 1 Success; Return Value <= 0 Errors
- 176 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<AccountStatusDescription>string</AccountStatusDescription>
<UnitIDStatus>string</UnitIDStatus>
<UnitIDStatusDescription>string</UnitIDStatusDescription>
<SystemType>string</SystemType>
<UnitID1>string</UnitID1>
<CustomerKey>int</CustomerKey>
<UnitSystemKey>int</UnitSystemKey>
</ARISAccountUnitIDEntity>
<ARISAccountUnitIDEntity>
<CustomerNo>string</CustomerNo>
<CustomerName>string</CustomerName>
<DaytimePhone>string</DaytimePhone>
<DaytimePhoneExt>string</DaytimePhoneExt>
<HomePhone>string</HomePhone>
<BillingAddress1>string</BillingAddress1>
<BillingAddress2>string</BillingAddress2>
<BillingAddress3>string</BillingAddress3>
<BillingCity>string</BillingCity>
<BillingState>string</BillingState>
<BillingPostalCode>string</BillingPostalCode>
<BillingCountry>string</BillingCountry>
<AccountStatus>string</AccountStatus>
<AccountStatusDescription>string</AccountStatusDescription>
<UnitIDStatus>string</UnitIDStatus>
<UnitIDStatusDescription>string</UnitIDStatusDescription>
<SystemType>string</SystemType>
<UnitID1>string</UnitID1>
<CustomerKey>int</CustomerKey>
<UnitSystemKey>int</UnitSystemKey>
</ARISAccountUnitIDEntity>
</AccountUnitIDEntitySet>
</GetAccountStatusResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
ARISAccountUnitIDEntity
CustomerNo String 11 Customer Number
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
BillingAddress2 String 40 Customer’s Billing address line 2
BillingAddress3 String 40 Customer’s Billing address line 3
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 179 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 180 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<GetUnitIDDepositBalanceResult>boolean</GetUnitIDDepositBalanceResult>
<ResponseCode>int</ResponseCode>
<UnitIDBalance>decimal</UnitIDBalance>
</GetUnitIDDepositBalanceResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required: BID (Billable ID: Phone Number)
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
UnitID1Balance Decimal 16,2 Access deposit balance
- 181 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 182 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP1.1 request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<PaymentID>string</PaymentID>
<Reference>string</Reference>
<AmountPaid>decimal</AmountPaid>
<CustomerNo>string</CustomerNo>
<ContractNo>string</ContractNo>
<UnitID1>string</UnitID1>
<CustomerKey>int</CustomerKey>
<ContractKey>int</ContractKey>
<PaymentKey>int</PaymentKey>
</ARISPaymentReceipt>
</PaymentReceiptSet>
</InquireInCommResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
PaymentID String 24 Required (InComm Unique Identifier)
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
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
CustomerNo String 11 Customer’s account number
ContractNo String 3 Customer’s Contract number
UnitID1 String 16 BID (Billable ID: Phone Number)
CustomerNo String 11 Customer’s account number
CustomerKey Integer 2,147,483,647 IdentityKey from Customer
PaymentKey Integer 2,147,483,647 IdentityKey from Payments
- 184 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP1.1 request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Required
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 186 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values.
Input:
Field Data Type Max Length Requirement
InvoiceNo String 9 Required
Output:
Field Data Type Max Length Description
Account Number String 11 Account Number
Account Name String 60 Individual Account Name or Company Name
- 187 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 188 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
InvoiceNo String 9 Required
PaymentDate String 23 Optional
PaymentID String 24 Optional
- 189 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
PaymentKey Integer 2,147,483,647 IdentityKey for Payment. Can be used to create a receipt in
the Web Interface. Negative values are errors.
- 190 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP 1.1 request and response. The placeholders shown need to be
replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
CustomerNo String 11 Required
BID String 16 Optional for Post-pay, Required for Prepay
Target String 10 Required:
PAYOLDEST = Invoice Payment
- 191 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ResponseCode Integer 2,147,483,647 0 = Success: > 0 = Errors
PaymentKey Integer 2,147,483,647 IdentityKey for Payment. Can be used to create a receipt in
the Web Interface. Negative values are errors.
- 192 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
Input:
Field Data Type Max Length Requirement
UnitSystemKey Integer 2,147,483,647 Primary Key of the BID
Address1 String 40 Service Address Address Line 1
Address2 String 40 Service Address Address Line 2
Address3 String 40 Service Address Address Line 3
City String 40 Service Address City
State String 20 Service Address State
PostalCode String 10 Service Address Postal Code
- 193 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 194 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
Input:
Field Data Type Max Length Requirement
UnitSystemKey Integer 2,147,483,647 Primary Key of the BID
SalesOrderNo String 9 Sales Order Number
StatusCode String 3 OSS360 Status Code
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 195 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 196 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
Input:
Field Data Type Max Length Requirement
UnitSystemKey Integer 2,147,483,647 Primary Key of the BID
OldID String 16 Old BID for ID being changed
NewID String 16 New BID for ID being changed
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 197 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 198 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
ReturnValue Integer 2,147,483,647 Return Codes – See below
ReturnValue Codes:
- 199 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 200 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
ClassCode String 8,000 Optional – Comma delimited list of Item
Class Codes for filtering results
Output:
Field Data Type Max Length Description
SKU String 23 SKU of the Item
Description String 40 Description of the Item
- 201 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 202 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitSystemKey Integer 2,147,483,647 Required - Primary Key of the BID
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<![CDATA[
<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>
]]>
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:
Field Data Type Max Length Description
ReturnValue Integer 2,147,483,647 Return Codes – See below
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitSystemKey Integer 2,147,483,647 Required - Primary Key of the BID
XML_LineItems String 8,000 Optional – Additional Sales Order Line Item
XML_LineItems:
- 205 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<![CDATA[
<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>
]]>
Note: Any XML fields that are passed to a web method must be wrapped with <![CDATA[XML Fields]]> so they are
treated as strings.
- 206 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Output:
Field Data Type Max Length Description
InvoiceNo String 9 Invoice number generated
ReturnValue Integer 2,147,483,647 Return Codes – See below
- 207 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 208 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
- 209 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<State>string</State>
<PostalCode>string</PostalCode>
<UnitID1>string</UnitID1>
<PlanDescription>string</PlanDescription>
<BillCycle>string</BillCycle>
<Comment>string</Comment>
<UnitSystemKey>string</UnitSystemKey>
</ARISSalesOrders>
</SalesOrders>
</GetSalesOrdersResponse>
</soap:Body>
</soap:Envelope>
Input:
Field Data Type Max Length Requirement
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:
Field Data Type Max Length Description
ReturnValue Integer 1 1 = Successful
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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.
SOAP: The following is a sample SOAP request and response. The placeholders shown need to be replaced with
actual values
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
Input:
Field Data Type Max Length Requirement
UnitID1 String 16 Billable ID
Latitude String 20 GPS Latitude Coordinate
Longitude String 20 GPS Longitude Coordinate
Output:
Field Data Type Max Length Description
ReturnValue Integer 1 1 – Successful
0 - Unsuccessful
- 211 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 212 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 213 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
-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
- 220 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
1
All Web Service Methods will return this error message if any or all the required parameters are missing.
- 221 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 222 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
Revision History
- 223 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
ARISWebService
- 224 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017
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 -
Confidential and Proprietary
Copyright © 2014 Advantage 360 Software, LLC
Last Revision Date: 04/28/2017