Corporate Info | News | Solutions | Products | Partners | Services | Events | Download | How To Buy
eLink Adapter for Portal Infranet Doc Home | eLink Adapter for Portal Infranet User Guide | Previous Topic | Next Topic | Contents |

Portal Infranet Service Interfaces

This section denotes the FML fields expected for each service and the fields that may be returned by the service's response.

The CREATE ACCOUNT Service

In the Configuration File, this service has input fields and the configuration parameters that the service may require. When you create this account, you may be required to set many different fields. There are over 100 fields in the Account object which may be sent in the input buffer. Some of these fields are mandatory, and some are optional. Each of the fields of the account object needs to be in the configuration file.

Table A-1 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
> M | STR |
>     NAME
O M M M M | ARRAY STR STR STR STR | SERVICES DEAL_NAME SERVICE_TYPE LOGIN PASSWD_CLEAR
O O O O O O O O | ARRAY STR(60) STR(60) ENUM UINT UINT STR(30) STR(30) | BILLINFO MERCHANT BILL_MODE BILL_TYPE CURRENCY BILL_WHEN ACCESS_CODE1 ACCESS_CODE2
O O O | ARRAY UINT UINT | ACTGINFO ACTG_FUTURE_DOM ACTG_TYPE
O O M M M M M M M M O M M O O O O O O O O O O | ARRAY STR STR ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR ENUM STR(255) ENUM STR(1023) ENUM ENUM NUM NUM TSTAMP TSTAMP STR(255) STR(255) | PAYINFO NAME OBJ_TYPE INV_INFO NAME ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR DELIVERY_PREFER DELIVERY_DESCR INV_TERMS INV_INSTR PO_TYPE PO_OPTIONS PO_AMOUNT PO_BAL_THRESHOLD PO_EXP PO_EXP_THRESHOLD PO_ORDER_NO PO_TERMS
M M M M M M M M M | ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(30) STR(30) | CC_INFO NAME ADDRESS CITY STATE ZIP COUNTRY DEBIT_NUM DEBIT_EXP
O M O O O O O O O O O O O O O O M M | ARRAY UINT STR(255) STR(25) STR(60) STR(30) STR(30) STR(60) STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(1023) ARRAY ENUM STR(25) | NAMEINFO ELEMENTID CONTACT_TYPE SALUTATION LAST_NAME FIRST_NAME MIDDLE_NAME TITLE COMPANY ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR PHONES TYPE PHONE
M O O | ARRAY ENUM NUM | EXEMPTIONS TYPE PERCENT
O M | ARRAY STR(255) | LOCALES LOCALE

Table A-2 OUTPUT Service Request

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
M | STR | ACCOUNT_NO
O M O | ARRAY STR STR | SERVICES LOGIN PASSWD_CLEAR
O O O O O O O O O O | ARRAY STR(60) STR(60) ENUM UINT UINT STR(30) STR(30) TSTAMP TSTAMP | BILLINFO MERCHANT BILL_MODE BILL_TYPE CURRENCY BILL_WHEN ACCESS_CODE1 ACCESS_CODE2 LAST_BILL_T NEXT_BILL_T
> O O O | ARRAY UINT UINT | ACTGINFO ACTG_FUTURE_DOM ACTG_TYPE
O O M M M M M M M M O M M O O O O O | ARRAY STR STR ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR ENUM STR(255) ENUM STR(1023) ENUM ENUM NUM | PAYINFO NAME OBJ_TYPE INV_INFO NAME ADDRESS CITY STATE ZIP COUNTRY EMIAL_ADDR DELIVERY_PREFER DELIVERY_DESCR INV_TERMS INV_INSTR PO_TYPE PO_OPTIONS PO_AMOUNT
O O O O O M M M M M M M M M | NUM TSTAMP TSTAMP STR(255) STR(255) ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(30) STR(30) | PO_BAL_THRESHOLD PO_EXP PO_EXP_THRESHOLD PO_ORDER_NO PO_TERMS CCINFO NAME ADDRESS CITY STATE ZIP COUNTRY DEBIT_NUM DEBIT_EXP
O O O O O O O O O O O O O O O O O | ARRAY STR(255) STR(25) STR(60) STR(30) STR(30) STR(60) STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(1023) ARRAY ENUM STR(25) | NAMEINFO CONTACT_TYPE SALUTATION LAST_NAME FIRST_NAME MIDDLE_NAME TITLE COMPANY ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR PHONES TYPE PHONES
O M O | ARRAY ENUM NUM | EXAMPTIONS TYPE PERCENT
O M | ARRAY STR(255) | LOCALES LOCALE

The DEL_PROD Service

The DELETE service deletes a business object from the Portal Infranet database. The information required for this operation is fetched from the configuration file. This process cancels the product indicated in that account. Use the tables A3 and A4 to help you delete products in an account.

Table A-3 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | PROD_NAME
O | NUM | QUANTITY

Table A-4 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M O | UINT STR | OPS_ERROR DESCRO

The DEL_CUST Service

The DEL_CUST (Delete Customer) service deletes a customer's account from Portal Infranet. The customer's account number (ACCOUNT_NO) must be specified as input. OPS_ERROR and DESCR fields indicate the success or failure of the DEL_CUST service. Use Tables A5 and A6 to help you delete a customer's account.

Table A-5 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | PASSWD_CLEAR

The MODIFY PAYMENT Service

The MODIFY service options modify the business object in the Portal Infranet database. These services include Account Modification services, and they modify an account information entry in the database and perform modifications in account information involving credit, billing, contact, payment, etc. In the configuration file, this service includes input fields and the configuration parameters that the service may require. The Account Modification services include:

- Modify Payment Information Service

- Modify Billing Information Service

- Modify Credit Balance Element

- Modify Accounting Information Servicen

- Modify Locale Information Service

- Modify Contact Information Service

- Adding New Contacts Service

- Modify Account Status Service

Table A-6 through Table A-20 show the various fields which arrive as input and are listed here per specific service requirement.

Modify Payment Information Service

Table A-6 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
> M O M M M M M M M M O M M O O O O O O O O O O | ARRAY STR STR ARRAY STR (60) STR(255) STR(30) STR(30) STR(12) STR(60) STR ENUM STR(255) ENUM STR(1023) ENUM ENUM NUM NUM TSTAMP TSTAMP STR(255) STR(255) | PAYINFO NAME OBJ_TYPE INV_INFO NAME ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR DELIVERY_PREFER DELIVERY_DESCR INV_TERMS INV_INSTR PO_TYPE PO_OPTIONS PO_AMOUNT PO_BAL_THRESHOLD PO_EXP PO_EXP_THRESHOLD PO_ORDER_NO PO_TERMS
O M M M M M M M M | ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(30) STR(30) | CC_INFO NAME ADDRESS CITY STATE ZIP COUNTRY DEBIT_NUM DEBIT_EXP

Modify Billing Information Service

Table A-7 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M O O O O O | ARRAY ENUM UINT UINT STR(30) STR(30) | BILLINFO BILL_TYPE CURRENCY BILL_WHEN ACCESS_CODE1 ACCESS_CODE2

Table A-8 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Credit Balance Element

Table A-9 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M M O O | ARRAY NUM NUM UINT | LIMIT CREDIT_LIMIT CREDIT_FLOOR CREDIT_THRESHOLDS

Table A-10 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Accounting Information Service

Table A-11 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O M O | ARRAY UINT UINT | ACTGINFO ACTG_FUTURE_DOM ACTG_TYPE

Table A-12 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Locale Information Service

Table A-13 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O M | ARRAY STR(255) | LOCALES LOCALE

Table A-14 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Contact Information Service

Table A-15 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O M O O O O O O O O O O O O O O M O | ARRAY UINT STR(255) STR(25) STR(60) STR(30) STR(30) STR(60) STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(1023) ARRAY ENUM STR | NAMEINFO ELEMENT_ID CONTACT TYPE SALUTATION LAST NAME FIRST NAME MIDDLE NAME TITLE COMPANY ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR PHONES TYPE PHONE

Table A-16 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Adding New Contacts Service

Table A-17 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O M O O O O O O O O O O O O O O M O | ARRAY UINT STR(255) STR(25) STR(60) STR(30) STR(30) STR(60) STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(1023) ARRAY ENUM STR | NAMEINFO ELEMENT_ID CONTACT TYPE SALUTATION LAST NAME FIRST NAME MIDDLE NAME TITLE COMPANY ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR PHONES TYPE PHONE

Table A-18 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Account Status Service

Table A-19 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O | STR | FLD_DESCR
M | ENUM | STATUS
M | UINT | STATUS_FLAGS
| TSTAMP | CLOSE_WHEN_T

Table A-20 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

The ORDER HANDLING Service

These services come under the category of Order Handling services, and they modify account information for an order-related entry in the database. With these services you perform modifications in account information in Portal Infranet about Deal, Plan, Service, and other services to the account.

In the configuration file, this service has input fields and configuration parameters that the service may require. The various fields required to modify different aspects of the order varies according to the service. At the time of account modification, you are required to set the fields in the input buffer. It is mandatory to set some of these fields, while others are optional. Each of the object order fields can be sent as part of the input buffer and should be included in the configuration file. The Order Handling services include:

- Add Deal to Account Service

- Modify Products In Account Service

- Add Service to Account Service

- Modify Product Status Service

Table A-6 through Table A-20 show the various fields which arrive as input and are listed here per specific service requirement.

Add Deal to Account Service

Table A-21 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | DEAL_NAME

Table A-22 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Products In Account Service

Table A-23 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O | NUM | PURCHASE_DISCOUNT
O | NUM | USAGE_DISCOUNT
O | TSTAMP | PURCHASE_START_T
O | TSTAMP | PURCHASE_END_T
O | TSTAMP | USAGE_START_T
O | TSTAMP | USAGE_END_T
M | STR | PROD_NAME

Table A-24 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Add Service to Account Service

Table A-25 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | PLAN_NAME
M M M M M | ARRAY STR STR STR STR | SERVICES DEAL_NAME SERVICE_TYPE FLD_LOGIN PASSWD_CLEAR

Table A-26 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify Product Status Service

Table A-27 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | ENUM | STATUS
M | STR | STATUS_FLAGS
M | STR | PROD_NAME

Table A-28 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

The Modification Service Handling Service

The Modification Service Handling services are account maintenance services that modify account information for service related entry in the database. These services perform modifications in account information in Portal Infranet about user password, login ID, and status of the services. Modification Service Handling functionality includes user login, password, and service status. The Modification Service Handling services include:

- Modify (Service) Login Information Service

- Modify (Service) Password Service

- Modify (Service) Status Service

Modify (Service) Login Information Service

Table A-29 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | NAME

Table A-30 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify (Service) Password Service

Table A-31 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
O | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | PASSWD_CLEAR

Table A-32 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

Modify (Service) Status Service

Table A-33 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | SERVICE_TYPE
M | STR | LOGIN
| STR | DESCR
M | ENUM | STATUS
M | UINT | STATUS_FLAGS
O | TSTAMP | CLOSE_WHEN_T

Table A-34 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

The Get Service

The Get services are billing services that get billing information from the database in order to perform modifications in account information in Portal Infranet for get bills, line items, and invoice image service instances to the account. In the configuration file, this service includes input fields and configuration parameters that the service requires.

The fields that you must modify for various aspects of billing are different for each service. At the time of account modification, you are required to set the fields in the input buffer. It is mandatory to set some of these fields, while others are optional. Each of the object order fields can be sent as part of the input buffer and should be included in the configuration file. The Get services include:

- Get List of Bills for an Account Service

- Get the Line Items for a Bill Service

- Get Invoice Image for a Bill Service

- GET_ACCOUNT_NO Service

Get List of Bills for an Account Service

Table A-35 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO

Table A-36 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
M | STR | ACCOUNT_NO
O O O O O O O | ARRAY STR TSTAMP TSTAMP NUM NUM UINT | BILLS BILL_NO START_T END_T TOTAL_DUE CURRENT_TOTAL CURRENCY

Get the Line Items for a Bill Service

Table A-37 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M M O O O | ARRAY STR TSTAMP TSTAMP ENUM | BILLS BILL_NO START_T END_T STATUS

Table A-38 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
M | STR | ACCOUNT_NO
O O O O O O O O O O O O | ARRAY STR TSTAMP TSTAMP NUM NUM UINT ARRAY STR STR NUM UINT | BILLS BILL_NO START_T END_T TOTAL_DUE CURRENT_TOTAL CURRENCY ITEMS ITEM_NO NAME ITEM_TOTAL CURRENCY

Get Invoice Image for a Bill Service

Table A-39 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M M | ARRAY STR | BILLS BILL_NO

Table A-40 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
M | STR | ACCOUNT_NO
O O O | ARRAY STR BUF | BILLS BILL_NO BUFFER

GET_ACCOUNT_NO Service

Table A-41 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE
M | STR | LOGIN

Table A-42 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | OPS_ERROR
O | STR | DESCR

The Querying Services

The Querying services query account information in Portal Infranet about the account and product, and they rate the related entry in the database. A query might be a single operation from the Portal Infranet point of view or a collection of read operations.

The fields that you must modify for various aspects of querying are different for each service. At the time of account querying, you are required to set the fields in the input buffer. It is mandatory to set some of these fields, while others are optional. Each of the object order fields can be sent as part of the input buffer and should be included in the configuration file. The Query services include:

- Get Account Information Service

- Get Product Information Service

- Get Rate Information Service

Get Account Information Service

Table A-43 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO

Table A-44 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
M | STR | ACCOUNT_NO
O M M O O M O | ARRAY STR TSTAMP UINT ENUM STR STR | SERVICES LASTSTAT_CMNT LAST_STATUS_T STATUS_FLAGS STATUS LOGIN PASSWORD
O O O O O O O O O O | ARRAY STR(60) STR(60) ENUM UINT UINT STR(30) STR(30) TSTAMP TSTAMP | BILLINFO MERCHANT BILL_MODE BILL_TYPE CURRENCY BILL_WHEN ACCESS_CODE1 ACCESS_CODE2 LAST_BILL_T NEXT_BILL_T
O M O | ARRAY UINT UINT | ACTGINFO ACTG_FUTURE_DOM ACTG_TYPE
O O M M M M M M M M O M M O O O O O O O O O O | ARRAY STR STR ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR ENUM STR(255) ENUM STR(1023) ENUM ENUM NUM NUM TSTAMP TSTAMP STR(255) STR(255) | PAYINFO NAME OBJ_TYPE INV_INFO NAME ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR DELIVERY_PREFER DELIVERY_DESCR INV_TERMS INV_INSTR PO_TYPE PO_OPTIONS PO_AMOUNT PO_BAL_THRESHOLD PO_EXP PO_EXP_THRHESHOLD PO_ORDER_NO PO_TERMS
M M M M M M M M M | ARRAY STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(30) STR(30) | CC_INFO NAME ADDRESS CITY STATE ZIP COUNTRY DEBIT_NUM DEBIT_EXP
O O O O O O O O O O O O O O O M M | ARRAY STR(255) STR(25) STR(60) STR(30) STR(30) STR(60) STR(60) STR(255) STR(30) STR(30) STR(12) STR(60) STR(1023) ARRAY ENUM STR(25) | NAMEINFO CONTACT_TYPE SALUTATION LAST_NAME FIRST_NAME MIDDLE_NAME TITLE COMPANY ADDRESS CITY STATE ZIP COUNTRY EMAIL_ADDR PHONES TYPE PHONE
O M O | ARRAY ENUM NUM | EXAMPTIONS TYPE PERCENT
O M | ARRAY STR(255) | LOCALES LOCALE
O O O O O O O | ARRAY NUM NUM UINT NUM UINT NUM | BALANCES CREDIT_FLOOR CREDIT_LIMIT CREDIT_THRESHOLDS CREDIT_CURRENT_BAL FLAGS OPEN_BAL
O O O O O O O O O O O O O O O O O O | ARRAY TSTAMP NUM NUM TSTAMP TSTAMP STR UINT TSTAMP TSTAMP UINT NUM NUM TSTAMP TSTAMP STR STR STR | PRODUCTS CREATED_T CYCLE_DISCOUNT CYCLE_DISC_AMT CYCLE_END_T CYCLE_START_T DEAL_NAME FLAGS MMC_END_T MMC_START_T MMC_TYPE PURCHASE_DISCOUNT PURCHASE_DISC_AMT PURCHASE_END_T PURCHASE_START_T SERVICE_TYPE LOGIN PASSWORD_CLEAR

Get Product Information Service

Table A-45 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO

Table A-46 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR
O O O | ARRAY STR STR | PRODUCTS FIELD_NAME FIELD_DESCR

Get Rate Information Service

Table A-47 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | ACCOUNT_NO
M | STR | PROD_NAME

Table A-48 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | UINT | CURRENCY
O | STR | DESCR
O | TSTAMP | END_T
O | STR | NAME
O | UINT | PRIORITY
O | NUM | PRIORITY_FIRST
O | NUM | PRIORITY_LAST
O | UINT | PURCHASE_MAX
O | UINT | PURCHASE_MIN
0 | TSTAMP | RELATIVE_END_T
0 | TSTAMP | RELATIVE_START_T
0 | UINT | VALID_DOM
0 | UINT | VALID_DOW
0 | UINT | VALID_MOY

The GET_AUTH Service

The GET_AUTH (Get Authorization) service requests authorization from Portal Infranet to confirm that a specified login has access to a service type (email, IP, wireless, etc.) that is billed by Portal Infranet. The GET_AUTH service requests Portal Infranet to validate the user's login and password, the user's account status / balance, and whether they are subscribing to the specified service type (email, IP, wireless, etc.) The RESULT field indicates success (value of 1) or failure (value of 0). If the authorization check fails additional information as to why the authorization check failed is returned in the TYPE and DESCR fields.

Table A-49 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | PASSWD_CLEAR

Table A-50 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | RESULT
O | UINT | TYPE
O | STR | DESCR

The POST_ACTIVITY Service

The POST_ACTIVITY Service is used to record usage activity of a service type that is billed by Portal Infranet. For example, if Portal Infranet is used to bill wireless telephone customers, then usage of a wireless phone can be posted to Portal Infranet using the POST_ACTIVITY service. The SERVICE_TYPE and LOGIN fields specify that a customer (LOGIN) was using a service type (IP, wireless, email etc.)

The NAME field indicates the name of the rate to apply to the account for this usage. For example "ip/dialup/async/hourly" is the name of rate for billing Internet access on an hourly basis. The QUANTITY field is used to indicate how many units of a service type was used (30 hours, 600 minutes, etc). The units (hours, minutes, etc.) of the QUANTITY are implied by the NAME field (the rate to use). OPS_ERROR and DESCR fields are used to indicate the success or failure of the POST_ACTIVITY service.

Table A-51 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | DESCR
M | STR | NAME
M | UINT | QUANTITY
O | STR | IMPACE_CATEGORY

Table A-52 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
M | STR | DESCR

The LOGIN Service

The LOGIN service requests authorization from Portal Infranet to confirm that a specified login has access to a service type (email, IP, wireless, etc.) that is billed by Portal Infranet (see description for the GET_AUTH). If authorization is granted, the LOGIN service starts a session within Portal Infranet to indicate that a customer is using the specified service type.

For example, suppose Portal Infranet is used to bill wireless telephone customers. When a wireless telephone customer dials a number, the LOGIN Service could be used to validate that the customer is valid, that his/her account is paid, etc. If this validation is successful, the LOGIN Service then starts a session within Portal Infranet to reflect the customer's usage of the wireless service. The LOGOUT Service (described below) can later be used to end this session.

The RESULT field indicates success (value of 1) or failure (value of 0). If the authorization check fails additional information as to why the authorization check failed is returned in the TYPE and DESCR fields. If authorization is successful, the field HANDLE contains a string that identifies the session that is started on behalf of the customer. This string needs to be supplied when this session is subsequently terminated with the LOGOUT service.

Table A-53 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE
M | STR | LOGIN
M | STR | PASSWD_CLEAR
M | STR | DESCR
M | TSTAMP | START_T

Table A-54 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | RESULT
O | UINT | TYPE
O | STR | DESCR
M | STR | HANDLE

The LOGOUT Service

The LOGOUT service requests that a session in the Portal Infranet system be ended, and that the usage associated with this session be applied to the customer's account. The LOGOUT service is used to end sessions that are started with the LOGIN service.

The HANDLE field should contain a string that specifies the session to end. This string is returned by the LOGIN service or the GET_SESSIONS service (described below). The DESCR field can be used to record a description of this session in Portal Infranet. The END_T (end time) field is used to denote at what time the customer's session ended. The NAME field should supply a rate name and the QUANTITY field should indicate the number of units this session used. OPS_ERROR and DESCR fields indicate success or failure of the LOGOUT service request.

Table A-55 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | HANDLE
M | STR | DESCR
M | STR | END_T
M | STR | NAME
M | UINT | QUANTITY
O | STR | IMPACE_CATEGORY

Table A-56 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | UINT | OPS_ERROR
O | STR | DESCR

The GET_SESSIONS Service

The GET_SESSIONS service returns sessions that are active within Portal Infranet for a specified service type (email, IP, wireless, etc). The SERVICE_TYPE field specifies what type of sessions to return. For every session of that type, the following information is returned: the session ID (HANDLE), start time of the session (START_T), login of session user (LOGIN), service type (SERVICE_TYPE), and account number (ACCOUNT_NO).

Table A-57 INPUT Service List

####

Mandatory/Optional | Data Type | Input Service Request
--- | --- | ---
M | STR | SERVICE_TYPE

Table A-58 OUTPUT Service List

####

Mandatory/Optional | Data Type | Output Service Response
--- | --- | ---
M | STR | OPS_ERROR
M | STR | DESCR
M | STR | HANDLE
M | STR | START_T
M | STR | LOGIN
M | STR | SERVICE_TYPE
M | STR | ACCOUNT_NO

Copyright © 2000 BEA Systems, Inc. All rights reserved. Required browser: Netscape 4.0 or higher, or Microsoft Internet Explorer 4.0 or higher.