3 CABS Web Service Reference
This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Access Service Request (ASR) Carrier Access Billing System (CABS) Web Service.
About the CABS Web Service
The CABS Web Service enables an external system to export and query for billing information contained in the ASR tables in MSS.
-
Export CABS information.
-
Query CABS information with criteria.
About the CABS Web Service Packaging
The CABS Web Service is packaged in the ASR EAR file. The EAR file contains the cabsws.war file. When the installer deploys the EAR file, the ASR Web Service is automatically deployed and ready to use.
About the CABS WSDL, WAR, and Schema Files
The CABS Web Service is defined by the CABSWebService.wsdl file and is supported by schema files. The WSDL file and supporting schema files are located in the cabsws.war file.
See "Understanding ASR Web Services" for more information about WSDL and WAR files, and about their directory locations in the EAR file.
exportCABS Operation
The exportCABS operation enables you to request access billing information for a given document number. Exported data includes general CABS, circuit, location, and USOC information.
The following are the request and response structures:
Request Structure: exportCABSReq
Response Structure: queryCABSByCriteriaReqResponse
exportCABSReq
The exportCABSReq element contains the input information for the operation. Each row in Table 3-1 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 3-1 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
exportCABSReq |
element |
exportCABS |
CABSWebService.wsdl |
|
exportCABS |
element |
exportCABS |
CABSWebService.xsd |
|
exportCABS |
complexType |
Complex type with a document number. |
CABSWebService.xsd |
|
documentNumber |
int |
The document number to export. |
CABSWebService_schema.xsd |
Table 3-2 describes the required fields for the exportCABSReq element.
Table 3-2 Required Fields for exportCABS Operation
| Field Name | Data Type | Field Description |
|---|---|---|
|
documentNumber |
int |
The document number or order number to retrieve the access billing information. |
exportCABSReqResponse
The exportCABSReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 3-3 describes the returned information in the response.
Table 3-3 Payload Information for the Response
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
exportCABSReqResponse |
element |
exportCABSResponse |
CABSWebService.wsdl |
|
exportCABSResponse |
element |
exportCABSResponse |
CABSWebService.xsd |
|
exportCABSResponse |
element |
cabsData |
CABSWebService.xsd |
|
cabsData |
complexType |
Complex type with a set of fields. |
CABSWebService.xsd |
queryCABSByCriteria Operation
This operation requests a query of CABS by criteria and retrieves the information. Any combination of a CCNA and PON is valid.
The following are the request and response structures:
Request Structure: queryCABSByCriteriaReq
Response Structure: queryCABSByCriteriaReqResponse
queryCABSByCriteriaReq
The queryCABSByCriteriaReq element contains the input information for the operation. Each row in Table 3-4 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 3-4 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
queryCABSByCriteriaReq |
element |
queryCABSByCriteria |
CABSWebService.wsdl |
|
queryCABSByCriteria |
element |
queryCABSByCriteria |
CABSWebService.xsd |
|
queryCABSByCriteria |
complexType |
Complex type with a CCNA and a PON. |
CABSWebService.xsd |
Table 3-5 describes the required fields for the queryCABSByCriteriaReq element.
Table 3-5 Required Fields for queryCABSByCriteria Operation
| Field Name | Data Type | Field Description |
|---|---|---|
|
CCNA |
string |
The CCNA value of the document number that you want to query. |
|
PON |
string |
The PON value of the document number that you want to query. |
queryCABSByCriteriaReqResponse
The queryCABSByCriteriaReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 3-6 describes the returned information in the response.
Table 3-6 Payload Information for the Response
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
queryCABSByCriteriaReqResponse |
element |
queryCABSByCriteriaResponse |
CABSWebService.wsdl |
|
queryCABSByCriteriaResponse |
element |
queryCABSByCriteriaResponse |
CABSWebService.xsd |
|
queryCABSByCriteriaResponse |
element |
cabsQueryDetail |
CABSWebService.xsd |
|
cabsQueryDetail |
complexType |
Complex type with a set of fields. |
CABSWebService.xsd |