ASR Web Service Reference

2 ASR Web Service Reference

This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Access Service Request (ASR) Web Service.

About the ASR Web Service

The ASR Web Service enables an external system to import and export various types of ASR orders in MSS. ASR Web Service operations enable you to:

Import and export ASR orders with order types such as transport, trunk, SES, Ring, PIP, DIS, and WAL.
Import and export a Confirmation Notice.
Import and export a Clarification Request.
Import and export a Provider Test Acceptance.
Import an external DLR.

About the ASR Web Service Packaging

The ASR Web Service is packaged in the ASR EAR file. The EAR file contains the asrws.war file. When the installer deploys the EAR file, the ASR Web Service is automatically deployed and ready to use.

About the ASR WSDL, WAR, and Schema Files

The ASR Web Service is defined by the ASRWebService.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the asrws.war file.

See "Understanding ASR Web Services" for more information about WSDL and WAR files, and about their directory locations in the EAR file.

About ASR Schema Files

Several schema files support the ASR Web Service. Within the asrws.war file, the schema files are located in the WEB-INF/wsdls directory. These schemas are categorized as ASR form schemas, an external DLR schema, and a query ASR schema.

ASR Form Schemas

The ASR form schemas are the schemas that define each ASR form. The following are the ASR form schema files:

ACI.xsd
ASR.xsd
ASRWebService_schema.xsd
CN.xsd
CR.xsd
DIS.xsd
EOD.xsd
EUSA.xsd
EVC.xsd
FGA.xsd
MSL.xsd
MULTI-EC.xsd
NAI.xsd
PC.xsd
PIP.xsd
PTA.xsd
RING-ARI.xsd
SALI.xsd
SES.xsd
TQ.xsd
TRANSPORT.xsd
TRUNKING.xsd
VC.xsd
VCAT.xsd
WAL.xsd

External DLR Schema

The external DLR schema contains types for the import external DLR web service operation.

The external DLR schema is the following file:

externalDLR.xsd

Query ASR Schema

The query ASR schema contains types for the query ASR by criteria web service operation.

The query ASR schema is the following file:

queryASRByCriteria.xsd

importCN Operation

The importCN operation enables you to import a confirmation notice type ASR order. This operation takes the confirmation notice information as input and returns a success message in the response.

The following are the request and response structures:

Request Structure: importCNReq

Response Structure: importCNReqResponse

importCNReq

The importCNReq element contains the input information for the operation. Each row in Table 2-1 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-1 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importCNReq	element	importCN	ASRWebService.wsdl
importCN	element	importCN	ASRWebService_schema.xsd
importCN	complexType	Complex type with a Cn	ASRWebService_schema.xsd
aCn	element	cn	ASRWebService_schema.xsd
cn	complexType	Complex type with a list of CN form fields.	CN.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importCNReqResponse

The importCNReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-2 describes the returned information in the response.

Table 2-2 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importCNReqResponse	element	importCNResponse	ASRWebService.wsdl
importCNResponse	element	importCNResponse	ASRWebService_schema.xsd
importCNResponse	complexType	Complex type with a result.	ASRWebService_schema.xsd
result	string	Contains the string “success" for successful output.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importCN operation. This documentation contains the list of valid errors thrown based on different scenarios.

importCR Operation

The importCR operation enables you to import a clarification request type ASR order. This operation takes the clarification request information as input and returns a success message in the response.

The following are the request and response structures:

Request Structure: importCRReq

Response Structure: importCRReqResponse

importCRReq

The importCRReq element contains the input information for the operation. Each row in Table 2-3 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-3 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importCRReq	element	importCR	ASRWebService.wsdl
importCR	element	importCR	ASRWebService_schema.xsd
importCR	complexType	Complex type with a Cr	ASRWebService_schema.xsd
aCr	element	cr	ASRWebService_schema.xsd
cr	complexType	Complex type with a list of CR form fields	CR.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importCRReqResponse

The importCRReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-4 describes the returned information in the response.

Table 2-4 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importCRReqResponse	element	importCRResponse	ASRWebService.wsdl
importCRResponse	element	importCRResponse	ASRWebService_schema.xsd
importCRResponse	complexType	Complex type with a result.	ASRWebService_schema.xsd
result	string	Contains the string “success" for successful output.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importCR operation. This documentation contains the list of valid errors thrown based on different scenarios.

importExternalDLR Operation

The importExternalDLR operation enables you to import external DLR information for ASR orders. The input for the operation is DLR related information and the operation provides a successful completion message as the output.

The following are the request and response structures:

Request Structure: importExternalDLRReq

Response Structure: importExternalDLRReqResponse

importExternalDLRReq

The importExternalDLRReq element contains the input information for the operation. Each row in Table 2-5 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-5 Payload Information for the Request

Name	Defined As	Type Description	File Name
importExternalDLRReq	element	importExternalDLR	ASRWebService.wsdl
importExternalDLR	element	importExternalDLR	ASRWebService_schema.xsd
importExternalDLR	complexType	Contains the aExternalDLR element	ASRWebService_schema.xsd
aExternalDLR	element	externalDLR	ASRWebService_schema.xsd
externalDLR	complexType	Complex type with the following: externalDLRAdminInfo externalDLRDesignInfo externalDLREndUserInfo externalDLRDesignLines externalDLRNotes	externalDLR.xsd
externalDLRAdminInfo	complexType	Complex type with a list of fields	externalDLR.xsd
externalDLRDesignInfo	complexType	Complex type with a list of fields	externalDLR.xsd
externalDLREndUserInfo	complexType	Complex type with a list of fields	externalDLR.xsd
externalDLRDesignLines	complexType	Complex type with a list of fields	externalDLR.xsd
externalDLRNotes	complexType	Complex type with a list of fields	externalDLR.xsd

The details of the required fields can be found in the ASOG documentation.

importExternalDLRReqResponse

The importExternalDLRReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-6 describes the returned information in the response.

Table 2-6 Payload Information for the Response

Name	Defined As	Type Description	File Name
importExternalDLRReqResponse	element	importExternalDLRResponse	ASRWebService.wsdl
importExternalDLRResponse	element	importExternalDLRResponse	ASRWebService_schema.xsd
importExternalDLRResponse	complexType	Complex type with a result.	ASRWebService_schema.xsd
result	string	Contains the string “success" for successful output.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importExternalDLR operation. This documentation contains the list of valid errors thrown based on different scenarios.

importDIS Operation

The importDIS operation enables you to import DIS type ASR orders. This operation takes the DIS related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importDISReq

Response Structure: importDISReqResponse

importDISReq

The importDISReq element contains the input information for the operation. Each row in Table 2-7 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-7 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importDISReq	element	importDIS	ASRWebService.wsdl
importDIS	element	importDIS	ASRWebService_schema.xsd
importDIS	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	disASR	ASRWebService_schema.xsd
disASR	complexType	Contains a list of forms: aASR aDISSeq aMulti_ECSeq aACISeq aSALISeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aDISSeq	element	dis	ASRWebService_schema.xsd
dis	complexType	Contains the list of DIS form fields	DIS.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG guidelines document.

importDISReqResponse

The importDISReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-8 describes the returned information in the response.

Table 2-8 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importDISReqResponse	element	importDISResponse	ASRWebService.wsdl
importDISResponse	element	importDISResponse	ASRWebService_schema.xsd
importDISResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importDIS operation. This documentation contains the list of valid errors thrown based on different scenarios.

importEUSA Operation

The importEUSA operation enables you to import EUSA type ASR orders. This operation takes the EUSA related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importEUSAReq

Response Structure: importEUSAReqResponse

importEUSAReq

The importEUSAReq element contains the input information for the operation. Each row in Table 2-9 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-9 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importEUSAReq	element	importEUSA	ASRWebService.wsdl
importEUSA	element	importEUSA	ASRWebService_schema.xsd
importEUSA	complexType	eusaASR	ASRWebService_schema.xsd
eusaASR	complexType	Contains a list of forms: aASR aEUSA aMulti_ECSeq aACISeq aNAISeq aMSLSeq aVCSeq aSALISeq aPCSeq aEVCSeq aVCATSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aEUSA	element	eusa	ASRWebService_schema.xsd
eusa	complexType	Contains the list of EUSA form fields	EUSA.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aMSLSeq	element	msl	ASRWebService_schema.xsd
msl	complexType	Contains the list of MSL form fields	MSL.xsd
aVCSeq	element	vc	ASRWebService_schema.xsd
vc	complexType	Contains the list of VC form fields	VC.xsd
aPCSeq	element	pc	ASRWebService_schema.xsd
pc	complexType	Contains the list of PC form fields	PC.xsd
aEVCSeq	element	evc	ASRWebService_schema.xsd
evc	complexType	Contains the list of EVC form fields	EVC.xsd
aVCATSeq	element	vcat	ASRWebService_schema.xsd
vcat	complexType	Contains the list of VCAT form fields	VCAT.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importEUSAReqResponse

The importEUSAReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-10 describes the returned information in the response.

Table 2-10 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importEUSAReqResponse	element	importEUSAResponse	ASRWebSerivce.wsdl
importEUSAResponse	element	importEUSAResponse	ASRWebService_schema.xsd
importEUSAResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importEUSA operation. This documentation contains the list of valid errors thrown based on different scenarios.

importFGA Operation

The importFGA operation enables you to import an FGA request type ASR order. This operation takes the FGA related form details as input and provides document number as output.

The following are the request and response structures:

Request Structure: importFGAReq

Response Structure: importFGAReqResponse

importFGAReq

The importFGAReq element contains the input information for the operation. Each row in Table 2-11 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-11 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importFGAReq	element	importFGA	ASRWebService.wsdl
importFGA	element	importFGA	ASRWebService_schema.xsd
importFGA	complexType	Contains a sequence of the ASR element	ASRWebService_schema.xsd
ASR	element	fgaASR	ASRWebService_schema.xsd
fgaASR	complexType	Contains the list of forms aASR aTransportSeq aFGA aMulti_ECSeq aACISeq aNAISeq aMSLSeq aSALISeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aTransportSeq	element	transport	ASRWebService_schema.xsd
transport	complexType	Contains the list of Transport form fields	TRANSPORT.xsd
aFGA	element	fga	ASRWebService_schema.xsd
fga	complexType	Contains the list of FGA form fields	FGA.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aMSLSeq	element	msl	ASRWebService_schema.xsd
msl	complexType	Contains the list of MSL form fields	MSL.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importFGAReqResponse

The importFGAReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-12 describes the returned information in the response.

Table 2-12 Payload Information for the Response

Name	Defined As	Type Description	File Name
importFGAReqResponse	element	importFGAResponse	ASRWebService.wsdl
importFGAResponse	element	importFGAResponse	ASRWebService_schema.xsd
importFGAResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importFGA operation. This documentation contains the list of valid errors thrown based on different scenarios.

importPIP Operation

The importPIP operation enables you to import PIP request type ASR orders. This operation takes the PIP related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importPIPReq

Response Structure: importPIPReqResponse

importPIPReq

The importPIPReq element contains the input information for the operation. Each row in Table 2-13 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-13 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importPIPReq	element	importPIP	ASRWebService.wsdl
importPIP	element	importPIP	ASRWebService_schema.xsd
importPIP	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	pipASR	ASRWebService_schema.xsd
pipASR	complexType	Contains a list of forms: aASR aPIPSeq aSALISeq aMulti_ECSeq aACISeq aPVCSeq aEVCSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aPIPSeq	element	pip	ASRWebService_schema.xsd
pip	complexType	Contains the list of PIP form fields	PIP.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aPVCSeq	element	pvc	ASRWebService_schema.xsd
pvc	complexType	Contains the list of PVC form fields	PIP.xsd
aEVCSeq	element	evc	ASRWebService_schema.xsd
evc	complexType	Contains the list of EVC form fields	EVC.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importPIPReqResponse

The importPIPReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-14 describes the returned information in the response.

Table 2-14 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importPIPReqResponse	element	importPIPResponse	ASRWebService.wsdl
importPIPResponse	element	importPIPResponse	ASRWebService_schema.xsd
importPIPResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importPIP operation. This documentation contains the list of valid errors thrown based on different scenarios.

importPTA Operation

The importPTA operation enables you to import a provider test acceptance type ASR order. This operation takes the provider test acceptance information as input and returns a success message in the response.

The following are the request and response structures:

Request Structure: importPTAReq

Response Structure: importPTAReqResponse

importPTAReq

The importPTAReq element contains the input information for the operation. Each row in Table 2-15 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-15 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importPTAReq	element	importPTA	ASRWebService.wsdl
importPTA	element	importPTA	ASRWebService_schema.xsd
importPTA	complexType	Complex type with name aPta	ASRWebService_schema.xsd
aPta	element	pta	ASRWebService_schema.xsd
pta	complexType	Complex type with a list of PTA form fields.	PTA.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importPTAReqResponse

The importPTAReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-16 describes the returned information in the response.

Table 2-16 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importPTAReqResponse	element	importPTAResponse	ASRWebService.wsdl
importPTAResponse	element	importPTAResponse	ASRWebService_schema.xsd
importPTAResponse	complexType	Complex type with a result.	ASRWebService_schema.xsd
result	string	Contains the string "success" for successful output.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importPTA operation. This documentation contains the list of valid errors thrown based on different scenarios.

importRING Operation

The importRING operation enables you to import RING request type ASR orders. This operation takes the RING related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importRINGReq

Response Structure: importRINGReqResponse

importRINGReq

The importRINGReq element contains the input information for the operation. Each row in Table 2-17 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-17 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importRINGReq	element	importRING	ASRWebService.wsdl
importRING	element	importRING	ASRWebService_schema.xsd
importRING	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	ringASR	ASRWebService_schema.xsd
ringASR	complexType	Contains a list of forms: aASR aRing aARISeq aMulti_ECSeq aSALISeq aNAISeq aPCSeq aVCATSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aRing	element	ring	ASRWebService_schema.xsd
ring	complexType	Contains the list of RING form fields	RING-ARI.xsd
aARISeq	element	ari	ASRWebService_schema.xsd
ari	complexType	Contains the list of ARI form fields	RING-ARI.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aPCSeq	element	pc	ASRWebService_schema.xsd
pc	complexType	Contains the list of PC form fields	PC.xsd
aVCATSeq	element	vcat	ASRWebService_schema.xsd
vcat	complexType	Contains the list of VCAT form fields	VCAT.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importRINGReqResponse

The importRINGReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-18 describes the returned information in the response.

Table 2-18 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importRINGReqResponse	element	importRINGResponse	ASRWebService.wsdl
importRINGResponse	element	importRINGResponse	ASRWebService_schema.xsd
importRINGResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importRING operation. This documentation contains the list of valid errors thrown based on different scenarios.

importSES Operation

The importSES operation enables you to import SES request type ASR orders. This operation takes the SES related form details as an input and provides document number as an output.

The following are the request and response structures:

Request Structure: importSESReq

Response Structure: importSESReqResponse

importSESReq

The importSESReq element contains the input information for the operation. Each row in Table 2-19 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 2-19 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importSESReq	element	importSES	ASRWebService.wsdl
importSES	element	importSES	ASRWebService_schema.xsd
importSES	complexType	Complex Type with ASR	ASRWebService_schema.xsd
ASR	element	sesASR	ASRWebService_schema.xsd
sesASR	complexType	Contains a list of forms: aASR aSES aMulti_ECSeq aACISeq aNAISeq aSALISeq aEVCSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aSESSeq	element	ses	ASRWebService_schema.xsd
ses	complexType	Contains the list of SES form fields	SES.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aEVCSeq	element	evc	ASRWebService_schema.xsd
evc	complexType	Contains the list of EVC form fields	EVC.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importSESReqResponse

The importSESReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-20 describes the returned information in the response.

Table 2-20 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importSESReqResponse	element	importSESResponse	ASRWebService.wsdl
importSESResponse	element	importSESResponse	ASRWebService_schema.xsd
importSESResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importSES operation. This documentation contains the list of valid errors thrown based on different scenarios.

importTransport Operation

The importTransport operation enables you to import transport type ASR orders. This operation takes the transport related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importTransportReq

Response Structure: importTransportReqResponse

importTransportReq

The importTransportReq element contains the input information for the operation. Each row in Table 2-21 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-21 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importTransportReq	element	importTransport	ASRWebService.wsdl
importTransport	element	importTransport	ASRWebService_schema.xsd
importTransport	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	transportASR	ASRWebService_schema.xsd
transportASR	complexType	Contains a list of forms: aASR aTransportSeq aMulti_ECSeq aACISeq aNAISeq aMSLSeq aVCSeq aSALISeq aPCSeq aEVCSeq aVCATSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aTransportSeq	element	transport	ASRWebService_schema.xsd
transport	complexType	Contains the list of Transport form fields	TRANSPORT.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aMSLSeq	element	msl	ASRWebService_schema.xsd
msl	complexType	Contains the list of MSL form fields	MSL.xsd
aVCSeq	element	vc	ASRWebService_schema.xsd
vc	complexType	Contains the list of VC form fields	VC.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aPCSeq	element	pc	ASRWebService_schema.xsd
pc	complexType	Contains the list of PC form fields	PC.xsd
aEVCSeq	element	evc	ASRWebService_schema.xsd
evc	complexType	Contains the list of EVC form fields	EVC.xsd
aVCATSeq	element	vcat	ASRWebService_schema.xsd
vcat	complexType	Contains the list of VCAT form fields	VCAT.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importTransportReqResponse

The importTransportReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-22 describes the returned information in the response.

Table 2-22 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importTransportReqResponse	element	importTransportResponse	ASRWebService.wsdl
importTransportResponse	element	importTransportResponse	ASRWebService_schema.xsd
importTransportResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importTransport operation. This documentation contains the list of valid errors thrown based on different scenarios.

importTrunking Operation

The importTrunking operation enables you to import trunking type ASR orders. This operation takes the trunking related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importTrunkingReq

Response Structure: importTrunkingReqResponse

importTrunkingReq

The importTrunkingReq element contains the input information for the operation. Each row in Table 2-23 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-23 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importTrunkingReq	element	importTrunking	ASRWebService.wsdl
importTrunking	element	importTrunking	ASRWebService_schema.xsd
importTrunking	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	trunkingASR	ASRWebService_schema.xsd
transportASR	complexType	Contains a list of forms: aASR aTrunking aMulti_ECSeq aACISeq aTQSeq aEODSeq aNAIeq aPCSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aTrunking	element	trunking	ASRWebService_schema.xsd
trunking	complexType	Contains the list of trunking form fields	TRANSPORT.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aTQSeq	element	tq	ASRWebService_schema.xsd
tq	complexType	Contains the list of TQ form fields	TQ.xsd
aEODSeq	element	eod	ASRWebService_schema.xsd
eod	complexType	Contains the list of EOD form fields	EOD.xsd
aNAI	element	nai	ASRWebService_schema.xsd
nai	complexType	Contains the list of NAI form fields	NAI.xsd
aPCSeq	element	pc	ASRWebService_schema.xsd
pc	complexType	Contains the list of PC form fields	PC.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importTrunkingReqResponse

The importTrunkingReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-24 describes the returned information in the response.

Table 2-24 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importTrunkingReqResponse	element	importTrunkingResponse	ASRWebService.wsdl
importTrunkingResponse	element	importTrunkingResponse	ASRWebService_schema.xsd
importTrunkingResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importTrunking operation. This documentation contains the list of valid errors thrown based on different scenarios.

importWAL Operation

The importWAL operation enables you to import WAL type ASR orders. This operation takes the WAL related form information as input and provides the document number in the response.

The following are the request and response structures:

Request Structure: importWALReq

Response Structure: importWALReqResponse

importWALReq

The importWALReq element contains the input information for the operation. Each row in Table 2-25 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-25 Payload Information for the Request

Name	Defined As	Type Definition	File Name
importWALReq	element	importWAL	ASRWebService.wsdl
importWAL	element	importWAL	ASRWebService_schema.xsd
importWAL	complexType	Complex type with ASR	ASRWebService_schema.xsd
ASR	element	walASR	ASRWebService_schema.xsd
walASR	complexType	Contains a list of forms: aASR aWAL aMulti_ECSeq aSALISeq aACISeq aMSLSeq	ASRWebService_schema.xsd
aASR	element	asr	ASRWebService_schema.xsd
asr	complexType	Contains the list of ASR form fields	ASR.xsd
aWAL	element	wal	ASRWebService_schema.xsd
wal	complexType	Contains the list of WAL form fields	WAL.xsd
aMulti_ECSeq	element	multiEC	ASRWebService_schema.xsd
multiEC	complexType	Contains the list of multi EC form fields	MULTI-EC.xsd
aSALISeq	element	sali	ASRWebService_schema.xsd
sali	complexType	Contains the list of SALI form fields	SALI.xsd
aACISeq	element	aci	ASRWebService_schema.xsd
aci	complexType	Contains the list of ACI form fields	ACI.xsd
aMSLSeq	element	msl	ASRWebService_schema.xsd
msl	complexType	Contains the list of MSL form fields	MSL.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

importWALReqResponse

The importWALReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-26 describes the returned information in the response.

Table 2-26 Payload Information for the Response

Name	Defined As	Type Definition	File Name
importWALReqResponse	element	importWALResponse	ASRWebService.wsdl
importWALResponse	element	importWALResponse	ASRWebService_schema.xsd
importWALResponse	complexType	Complex type with a document number.	ASRWebService_schema.xsd
documentNumber	int	The newly created document number.	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the importWAL operation. This documentation contains the list of valid errors thrown based on different scenarios.

exportASR Operation

The exportASR operation enables you to export ASR order of all types. This operation takes the document number as input and retrieves the details of the ASR order. The requested ASR order must be a sent order. If it is received order, then the request returns an error.

The following are the request and response structures:

Request Structure: exportASRReq

Response Structure: exportASRReqResponse

exportASRReq

The exportASRReq element contains the input information for the operation. Each row in Table 2-27 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-27 Payload Information for the Request

Name	Defined As	Type Description	File Name
exportASRReq	element	exportASR	ASRWebService.wsdl
exportASR	element	exportASR	ASRWebService_schema.xsd
exportASR	complexType	Complex type with the document number.	ASRWebService_schema.xsd
documentNumber	int	The document number to export.	ASRWebService_schema.xsd

Required Fields for exportASR

The following tables describe the required fields for the exportASR operation.

Table 2-28 describes the required fields for exportASRReq.

Table 2-28 Required Fields for exportASRReq

Field Name	Data Type	Field Description
documentNumber	int	Document number or order number of the ASR order for the export.

exportASRReqResponse

The exportASRReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-29 describes the returned information in the response.

Table 2-29 Payload Information for the Response

Name	Defined As	Type Description	File Name
exportASRReqResponse	element	exportASRResponse	ASRWebService.wsdl
exportASRResponse	element	expASR	ASRWebService_schema.xsd
expASR	complexType	Contains a list of forms	ASRWebService_schema.xsd
fgaASR	complexType	Contains the list of FGA forms	ASRWebService_schema.xsd
transportASR	complexType	Contains the list of Transport forms	ASRWebService_schema.xsd
eusaASR	complexType	Contains the list of EUSA forms	ASRWebService_schema.xsd
sesASR	complexType	Contains the list of SES forms	ASRWebService_schema.xsd
trunkingASR	complexType	Contains the list of Trunking forms	ASRWebService_schema.xsd
ringASR	complexType	Contains the list of Ring forms	ASRWebService_schema.xsd
walASR	complexType	Contains the list of WAL forms	ASRWebService_schema.xsd
disASR	complexType	Contains the list of DIS forms	ASRWebService_schema.xsd
pipASR	complexType	Contains the list of PIP forms	ASRWebService_schema.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

Table 2-30 describes the error messages for the operation.

Table 2-30 Error Messages for the Operation

Error Message	Cause	Resolution
5855 Failed: No Order Found for PON 123.	The document number passed in the input does not exist in database.	Populate a valid document number which needs to be exported.
The order for PON 123 is received not sent and cannot be exported.	The document number provided in the input is a RECEIVED order and not a SENT order.	For an export request, you must provide a SENT order and not a RECEIVED order.

Refer to the ASOG documentation for additional error messages given by the exportASR operation. This documentation contains the list of valid errors thrown based on different import scenarios.

exportCN Operation

The exportCN operation enables you to export the confirmation notice details of the provided ASR order. This operation takes the document number as input and provides the confirmation notice details as the output.

The following are the request and response structures:

Request Structure: exportCNReq

Response Structure: exportCNReqResponse

exportCNReq

The exportCNReq element contains the input information for the operation. Each row in Table 2-31 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-31 Payload Information for the Request

Name	Defined As	Type Description	File Name
exportCNReq	element	exportCN	ASRWebService.wsdl
exportCN	element	exportCN	ASRWebService_schema.xsd
exportCN	complexType	Complex type with the document number.	ASRWebService_schema.xsd
documentNumber	int	The document number to export.	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

exportCNReqResponse

The exportCNReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-32 describes the returned information in the response.

Table 2-32 Payload Information for the Response

Name	Defined As	Type Description	File Name
exportCNReqResponse	element	exportCNResponse	ASRWebService.wsdl
exportCNResponse	element	exportCNResponse	ASRWebService_schema.xsd
exportCNResponse	complexType	Complex type with aCn	ASRWebService_schema.xsd
aCn	element	cn	ASRWebService_schema.xsd
cn	complexType	Complex type with a list of CN form fields	CN.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the exportCN operation. This documentation contains the list of valid errors thrown based on different scenarios.

exportCR Operation

The exportCR operation enables you to export the clarification request details of the provided ASR order. This operation takes the document number as input and provides the clarification request details as the output.

The following are the request and response structures:

Request Structure: exportCRReq

Response Structure: exportCRReqResponse

exportCRReq

The exportCRReq element contains the input information for the operation. Each row in Table 2-33 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-33 Payload Information for the Request

Name	Defined As	Type Description	File Name
exportCRReq	element	exportCR	ASRWebService.wsdl
exportCR	element	exportCR	ASRWebService_schema.xsd
exportCR	complexType	Complex type with the document number.	ASRWebService_schema.xsd
documentNumber	int	The document number to export.	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

exportCRReqResponse

The exportCRReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-34 describes the returned information in the response.

Table 2-34 Payload Information for the Response

Name	Defined As	Type Description	File Name
exportCRReqResponse	element	exportCRResponse	ASRWebService.wsdl
exportCRResponse	element	exportCRResponse	ASRWebService_schema.xsd
exportCRResponse	complexType	Complex type with aCr	ASRWebService_schema.xsd
aCr	element	cr	ASRWebService_schema.xsd
cr	complexType	Complex type with a list of CR form fields.	CR.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the exportCR operation. This documentation contains the list of valid errors thrown based on different scenarios.

exportPTA Operation

The exportPTA operation enables you to export the Provider Test Acceptance details of the provided ASR order. This operation takes the document number as input and provides the provider test acceptance details as the output.

The following are the request and response structures:

Request Structure: exportPTAReq

Response Structure: exportPTAReqResponse

exportPTAReq

The exportPTAReq element contains the input information for the operation. Each row in Table 2-35 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-35 Payload Information for the Request

Name	Defined As	Type Description	File Name
exportPTAReq	element	exportPTA	ASRWebService.wsdl
exportPTA	element	exportPTA	ASRWebService_schema.xsd
exportPTA	complexType	Complex type with the document number.	ASRWebService_schema.xsd
documentNumber	int	The document number to export.	ASRWebService_schema.xsd

The details of the required fields in each form can be found in the ASOG documentation.

exportPTAReqResponse

The exportPTAReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-36 describes the returned information in the response.

Table 2-36 Payload Information for the Response

Name	Defined As	Type Description	File Name
exportPTAReqResponse	element	exportPTAResponse	ASRWebService.wsdl
exportPTAResponse	element	exportPTAResponse	ASRWebService_schema.xsd
exportPTAResponse	complexType	Complex type with aPta	ASRWebService_schema.xsd
aPta	element	Pta	ASRWebService_schema.xsd
Pta	complexType	Complex type with a list of PTA form fields	PTA.xsd
metaSolvUserDataValue	complexType	Refer Table 2-39	ASRWebService_schema.xsd

Refer to the ASOG documentation for the error messages given by the exportPTA operation. This documentation contains the list of valid errors thrown based on different scenarios.

queryASRByCriteria Operation

The queryASRByCriteria operation enables you to query various ASR orders. The operation takes the PON, CCNA and ICSC field values as input and provides the ASR order information as the output.

The following are the request and response structures:

Request Structure: queryASRByCriteriaReq

Response Structure: queryASRByCriteriaReqResponse

queryASRByCriteriaReq

The queryASRByCriteriaReq element contains the input information for the operation. Each row in Table 2-37 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.

Table 2-37 Payload Information for the Request

Name	Defined As	Type Description	File Name
queryASRByCriteriaReq	element	queryASRByCriteria	ASRWebService.wsdl
queryASRByCriteria	element	queryASRByCriteria	ASRWebService_schema.xsd
queryASRByCriteria	complexType	Complex type with the aQc.	ASRWebService_schema.xsd
aQc	element	queryCriteria	ASRWebService_schema.xsd
queryCriteria	element	Complex type with a set of input fields.	queryASRByCriteria.xsd

The details of the required fields in each form can be found in the ASOG documentation.

queryASRByCriteriaReqResponse

The queryASRByCriteriaReqResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 2-38 describes the returned information in the response.

Table 2-38 Payload Information for the Response

Name	Defined As	Type Description	File Name
queryASRByCriteriaReqResponse	element	queryASRByCriteriaResponse	ASRWebService.wsdl
queryASRByCriteriaResponse	element	queryASRByCriteriaResponse	ASRWebService_schema.xsd
queryASRByCriteriaResponse	complexType	Complex type with aServReqQueryDetailCr.	ASRWebService_schema.xsd
aServReqQueryDetail	element	servReqQueryDetail	ASRWebService_schema.xsd
servReqQueryDetail	complexType	Complex type with a list of ASR service request fields.	queryASRByCriteria.xsd

Refer to the ASOG documentation for the error messages given by the queryASRByCriteria operation. This documentation contains the list of valid errors thrown based on different scenarios.

metaSolvUserDataValue Definition Information

This section describes the metaSolvUserDataValue definition information.

Table 2-39 metaSolvUserDataValue Definition Information

Name	Defined As	Type Definition	File Name
metaSolvUserDataValue	metaSolvUserDataValue	MetaSolvUserDataValueType	ASRWebService_ schema.xsd
MetaSolvUserDataValueType	complexType	UserDataValueType	ASR.xsd
UserDataValueType	complexType	complexType with a list of fields BaseNameValueType	ASR.xsd

Table 2-40 Fields for UserDataValueType

Field Name	Data Type	Field Description
tableNm	string	Table where the user data is stored. This table corresponds to where the user data was originally defined.
keyColumnNm	string	Actual primary key column name of the product area. This is required so the user data row can be associated with one item.
keyValue	integer	Actual value of the product area.

Table 2-41 Fields for BaseNameValueType

Field Name	Data Type	Field Description
column	string	Field is the user data column that is updated.
value	string	Value entered into the defined column.
dataType	string	Function of a user data field. Determines the kind of information a user can enter in a field on the User Data window. Valid values are number, decimal, VARCHAR2, date, dropdown.