5 Event Web Service Reference

This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Event Web Service.

About the Event Web Service

The Event Web Service lets an external system retrieve and update gateway event information in MSS. Event Web Service operations enable you to:

Get integration event data.
Update the event status for inbound, integration, and outbound event status values.

About the Event Web Service Packaging

The Event Web Service is packaged in the MSS_WebService.ear file, which contains the events.war file. When the installer deploys the EAR file, the Event Web Service is automatically deployed and ready to use.

Note:

The MSS_WebService.ear file also includes the other MSS web service operations. See Web Services Overview for information about these operations.

About the Event WSDL, WAR, and Schema Files

The Event Web Service is defined by the EventsAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the events.war file.

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

About Event Schema Files

Several schema files support the Event Web Service. Within events.war file, the schema files are located in the WEB-INF/wsdls directory. These schemas are categorized as common schemas, entity schemas, and data schemas.

Common Schemas

For information about the common schema files, see "About Schema Files".

Entity Schemas

The entity schemas define elements, such as keys and types, specific to the web service.

The Event entity schemas are defined in the following files:

CustomerManagementEntities.xsd
InventoryManagementEntities.xsd
MIPCommonEntities.xsd
OrderManagementEntities.xsd
OrderManagementEvents.xsd
ServiceEntities.xsd

Data Schemas

The data schemas contain numerous complex type structures, enumerations, and simple types.

The Event data schemas are defined in the following files:

CustomerManagementData.xsd
InventoryManagementData.xsd
OrderAncillaryManagementData.xsd
OrderManagementData.xsd
ServiceData.xsd

API Schemas

The API schemas contain the high-level response and request type definitions and exception definitions.

The Event API schemas are defined in the following file:

OrderManagementAPI.xsd

getIntegrationEventData Operation

The getIntegrationEventData operation enables you to retrieve the details of the gateway event by passing the external system name and its corresponding key.

The following are the request and response structures:

Request Structure: getIntegrationEventData

Response Structure: getIntegrationEventDataResponse

getIntegrationEventData

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

Table 5-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
getIntegrationEventData	complexType	Contains the following fields: pExternalSystemName pExternalSystemKey	EventsAPI.wsdl

Name

Defined As

Type Description

File Name

getIntegrationEventData

complexType

Contains the following fields:

pExternalSystemName
pExternalSystemKey

EventsAPI.wsdl

Table 5-2 describes the required fields for getIntegrationEventData.

Table 5-2 Required Fields for getIntegrationEventData

Field Name	Data Type	Field Description
pExternalSystemName	string	Field that defines the name for an external system order.
pExternalSystemKey	string	Field that defines the key for an external system order.

getIntegrationEventDataResponse

The getIntegrationEventDataResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 5-3 describes the information returned in the response.

Table 5-3 Payload Information for the Response

Name	Defined As	Type Description	File Name
getIntegrationEventDataResponse	element	metasolvOrderTaskEventStatusChange	EventsAPI.wsdl
metasolvOrderTaskEventStatusChange	element	MetaSolvOrderTaskEventStatusChangeType	OrderManagementEvents.xsd
MetaSolvOrderTaskEventStatusChangeType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd

Name

Defined As

Type Description

File Name

getIntegrationEventDataResponse

element

metasolvOrderTaskEventStatusChange

EventsAPI.wsdl

metasolvOrderTaskEventStatusChange

element

MetaSolvOrderTaskEventStatusChangeType

OrderManagementEvents.xsd

MetaSolvOrderTaskEventStatusChangeType

complexType

Extension of BaseEventType

Contains a list of fields

OrderManagementEvents.xsd

Table 5-4 describes the error messages for the operation.

Table 5-4 Error Messages for the Operation

Error Message	Cause	Resolution
No data found for externalSystemKey: key and externalSystemName: name	The external system key and external system name passed are invalid values.	Verify the external system details that are passed as Input.

updateInboundEventStatus Operation

The updateInboundEventStatus operation enables you to update the inbound gateway events by passing the valid input data.

The following are the request and response structures:

Request Structure: updateInboundEventStatus

Response Structure: updateInboundEventStatusResponse

updateInboundEventStatus

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

Table 5-5 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateInboundEventStatus	element	updateOrderTaskEventProcedureValue	EventsAPI.wsdl
updateOrderTaskEventProcedureValue	element	UpdateOrderTaskEventProcedureValue	OrderManagementAPI.xsd
UpdateOrderTaskEventProcedureValue	complexType	Extension of UpdateProcedureValue Contains a list of fields	OrderManagementAPI.xsd

Name

Defined As

Type Description

File Name

updateInboundEventStatus

element

updateOrderTaskEventProcedureValue

EventsAPI.wsdl

updateOrderTaskEventProcedureValue

element

UpdateOrderTaskEventProcedureValue

OrderManagementAPI.xsd

UpdateOrderTaskEventProcedureValue

complexType

Extension of UpdateProcedureValue

Contains a list of fields

OrderManagementAPI.xsd

Table 5-6 describes the required fields for updateInboundEventStatus.

Table 5-6 Required Fields for updateInboundEventStatus

Field Name	Data Type	Field Description
gatewayName	string	Name of the third party vendor defined gateway in MSS.
eventName	string	Name of the gateway event that is assigned to a provisioning plan task or to a gateway event behavior.
documentNumber	long	Number of the order that relates to the gateway event.
servItemId	long	Oracle generated sequence that uniquely identifies a service item in the MetaSolv Solution database. Note: This value is only supplied for an item-level gateway event.
taskStatus	TaskEventStatusEnumType	Status of the task associated to the gateway event.
errorMessage	string	Error message that needs to be updated if the status is set as ERROR.

updateInboundEventStatusResponse

The updateInboundEventStatusResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 5-7 describes the information returned in the response.

Table 5-7 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateInboundEventStatusResponse	element	Contains the updateInboundEventStatusResult string	EventsAPI.wsdl

Table 5-8 shows the error messages for the operation.

Table 5-8 Error Messages for the Operation

Error Message	Cause	Resolution
No Gateway for Gateway Name	The gateway name provided in input is not a valid gateway name.	Populate a valid Gateway Name in the input structure.
No Gateway Event found for event name in Gateway	There is no gateway event found for the provided event name in gateway name.	Populate the event name with gateway id which has a gateway event associated to it.
No usage (ServReqGateway) for event name in gateway for document	There is no ServReqGatewayEvents that match this gatewayeventid.	Populate a valid gateway event details in the input.
Multiple Gateway Events exist for document number event name	Multiple Gateway Events exist for document number, event name, and update to many is set to false.	Populate the input by executing one by one instead of executing multiple or set the updateMany as true.
SRSI_GATEWAY_EVENT row not found for document number, task id, event name, event version, serv item	There is no data exist for the provided input.	Populate the data which has the data for the given input.

updateIntegrationEventStatus Operation

The UpdateIntegrationEventStatus operation enables an update of integration gateway events and integration details like external key and external name.

The following are the request and response structures:

Request Structure: updateIntegrationEventStatus

Response Structure: updateIntegrationEventStatusResponse

updateIntegrationEventStatus

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

Table 5-9 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateIntegrationEventStatus	element	metasolvOrderTaskEventStatusChange	EventsAPI.wsdl
metasolvOrderTaskEventStatusChange	element	MetaSolvOrderTaskEventStatusChangeType	OrderManagementEvents.xsd
MetaSolvOrderTaskEventStatusChangeType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd
eventNotes	element	GatewayEventNoteType	OrderManagementEvents.xsd
GatewayEventNoteType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd
metasolvIntegrationStatus	element	MetaSolvIntegrationEventStatusChangeType	OrderManagementEvents.xsd
MetaSolvIntegrationEventStatusChangeType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd

Table 5-10 describes the required fields for updateIntegrationEventStatus

Table 5-10 Required Fields for updateIntegrationEventStatus

Field Name	Data Type	Field Description
eventName	string	Name of the gateway event that is assigned to a provisioning plan task or to a gateway event behavior.
eventId	long	Number that identifies the ID of the Gateway Event.
documentNumber	long	Number of the order that relates to the gateway event.
servItemId	long	Oracle generated sequence that uniquely identifies a service item in the MetaSolv Solution database. Note: This value is only supplied for an item-level gateway event.
taskNumber	long	Oracle generated sequence that uniquely identifies a task in the MetaSolv Solution database.
taskStatus	TaskEventStatusEnumType	Status of the task associated to the gateway event.
eventVersion	string	Error message that needs to be updated if the status is set as ERROR.
externalSystemName	string	Field that defines the name for an external system order.
externalSystemKey	string	Field that defines the key for an external system order.
Status	Enum	Integration event valid status.

updateIntegrationEventStatusResponse

The updateIntegrationEventStatusResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 5-11 describes the information returned in the response.

Table 5-11 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateIntegrationEventStatusResponse	element	Contains the updateIntegrationEventStatusResult string	EventsAPI.wsdl

Table 5-12 describes the error messages for the operation.

Table 5-12 Error Messages for the Operation

Error Message	Cause	Resolution
IntegrationEventManager: Error message is required when the event status is ERROR.	The error message is not populated, but the event status is set as ERROR.	Populate the Error message if the error status is set as ERROR.
IntegrationEventManager: Preference for Gateway Event Notes is set as 'N'.	The preference to update the gateway event notes is set as N.	Enable the “GATEWAYEVENTNOTES" preference in work management else do not populate the gateway event notes section.
IntegrationEventManager: Given External System Name and Key already exists for another record.	The provided integration data already exists in the database.	Populate the right integration details in the input.

updateOutboundEventStatus Operation

The updateOutboundEventStatus operation enables you to update the outbound gateway events by passing the input values.

The following are the request and response structures:

Request Structure: updateOutboundEventStatus

Response Structure: updateOutboundEventStatusResponse

updateOutboundEventStatus

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

Table 5-13 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateOutboundEventStatus	element	metasolvOrderTaskEventStatusChange	EventsAPI.wsdl
metasolvOrderTaskEventStatusChange	element	MetaSolvOrderTaskEventStatusChangeType	OrderManagementEvents.xsd
MetaSolvOrderTaskEventStatusChangeType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd
eventNotes	element	GatewayEventNoteType	OrderManagementEvents.xsd
GatewayEventNoteType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd
metasolvIntegrationStatus	element	MetaSolvIntegrationEventStatusChangeType	OrderManagementEvents.xsd
MetaSolvIntegrationEventStatusChangeType	complexType	Extension of BaseEventType Contains a list of fields	OrderManagementEvents.xsd

Table 5-14 describes the required fields for updateOutboundEventStatus

Table 5-14 Required Fields for updateOutboundEventStatus

Field Name	Data Type	Field Description
eventName	string	Name of the gateway event that is assigned to a provisioning plan task or to a gateway event behavior.
eventId	long	Number that identifies the ID of the Gateway Event.
documentNumber	long	Number of the order that relates to the gateway event.
servItemId	long	Oracle generated sequence that uniquely identifies a service item in the MSS database. Note: This value is only supplied for an item-level gateway event.
taskNumber	long	Oracle generated sequence that uniquely identifies a task in the MetaSolv Solution database.
taskStatus	TaskEventStatusEnumType	Status of the task associated to the gateway event.
eventVersion	string	Error message that needs to be updated if the status is set as ERROR.
externalSystemName	string	Field defines the name for an external system order.
externalSystemKey	string	Field defines the key for an external system order.
Status	Enum	Integration event valid status.

updateOutboundEventStatusResponse

The updateOutboundEventStatusResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 5-15 describes the returned information in the response.

Table 5-15 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateOutboundEventStatusResponse	element	Contains the updateIntegrationEventStatusResult string	EventsAPI.wsdl

Table 5-16 describes the error messages for the operation.

Table 5-16 Error Messages for the Operation

Error Message	Cause	Resolution
No Gateway for Gateway Name	The gateway name provided in input is not a valid gateway name.	Populate a valid Gateway Name in the input structure.
No Gateway Event found for event name in Gateway	There is no gateway event found for the provided event name in gateway name.	Populate the event name with gateway ID which has a gateway event associated to it.
No usage (ServReqGateway) for event name in gateway for document	There is no ServReqGatewayEvents that match this gateway event ID.	Populate a valid gateway event ID in the input.