1/13

Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

1 Web Services Overview

• Overview
  • About the MSS Web Services
    • Customer Web Service
    • Event Web Service
    • Inventory Web Service
    • Order Web Service
    • Activation Web Service
    • Service Order Activation (SOA) Web Service
• About MSS Web Service Standards and Specifications
• About the MSS Web Services Framework
  • About the MSS Web Service Module
  • About Transaction Handling
  • About Exception Stacktraces
• Understanding How MSS Defines Web Services
  • About WAR and WSDL Files
  • About WSDL Definitions
  • About WSDL Locations
  • About WSDL Bindings
  • About Namespaces
  • Understanding MSS WSDL Operations
  • About Schema Files
• Getting Information about MSS WSDL Operations
  • Using the Message Payload Documentation

2 Migrating XML APIs to Web Services

• About MSS XML APIs
• Migrating XML APIs to Web Services
  • Migrating XML APIs Developed Using Workshop Using Java
  • Migrating XML APIs Using Oracle SOA Suite
  • Migrating XML APIs Using a Java Class
• Mapping Existing XML APIs to Web Services
• Functional Differences from the XML APIs
  • Empty Structures on Responses
  • Get DLR Response Field Changes
  • Schema File Changes
• Sample Build XML File

3 Deploying, Testing, and Invoking Secure Web Services

• About Deploying MSS Web Services
  • Undeploying MSS Web Services
  • Deploying MSS Web Services
• About Testing MSS Web Services
  • Testing MSS Web Services using SOAPUI
  • Testing MSS Web Services with a Java Test Client
• About Invoking Secure MSS Web Services
  • Securing Web Services
  • About Policy Files
  • Modifying Web Service Security
    • Accessing Security
    • Associating a Policy File
    • Disassociating a Policy File
  • Enabling Transactions Transport Security Mode
• Troubleshooting
  • Connecting to the WSDL Location
  • Redirecting Log Messages
  • Invoking MSS Web Services in an SSL Environment

4 Customer Web Service Reference

• About the Customer Web Service
• About the Customer Web Service Packaging
• About the Customer WSDL, WAR, and Schema Files
  • About Customer Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• deleteCustomerRequest Operation
  • deleteCustomerRequest
  • deleteCustomerRequestResponse
• getCustomerAccountByKey Operation
  • getCustomerAccountByKey
  • getCustomerAccountByKeyResponse
• importCustomerAccount Operation
  • importCustomerAccount
  • importCustomerAccountResponse

5 Event Web Service Reference

• About the Event Web Service
• About the Event Web Service Packaging
• About the Event WSDL, WAR, and Schema Files
  • About Event Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• getIntegrationEventData Operation
  • getIntegrationEventData
  • getIntegrationEventDataResponse
• updateInboundEventStatus Operation
  • updateInboundEventStatus
  • updateInboundEventStatusResponse
• updateIntegrationEventStatus Operation
  • updateIntegrationEventStatus
  • updateIntegrationEventStatusResponse
• updateOutboundEventStatus Operation
  • updateOutboundEventStatus
  • updateOutboundEventStatusResponse

6 Inventory Web Service Reference

• About the Inventory Web Service
• About the Inventory Web Service Packaging
• About the Inventory WSDL, WAR, and Schema Files
  • About Inventory Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• auditTrailRecording Operation
  • auditTrailRecording
  • auditTrailRecordingResponse
• createEntityByValueRequest Operation
  • createEntityByValueRequest
  • createEntityByValueResponse
• createLocationRequest Operation
  • createLocationRequest
  • createLocationRequestResponse
• createNewInventoryItemRequest Operation
  • createNewInventoryItemRequest
  • createNewInventoryItemResponse
• getAvailablePhysicalPortsRequest Operation
  • getAvailablePhysicalPortsRequest
  • getAvailablePhysicalPortsRequestResponse
• getDlrByKeyRequest Operation
  • getDlrByKeyRequest
  • getDlrByKeyRequestResponse
• getDlrByOrderKey Operation
  • getDlrByOrderKey
  • getDlrByOrderKeyResponse
• getEntityByKeyRequest Operation
  • getEntityByKeyRequest
  • getEntityByKeyRequestResponse
• getIpAddressesRequest Operation
  • getIpAddressesRequest
  • getIpAddressesRequestResponse
• getLocationRequest Operation
  • getLocationRequest
  • getLocationRequestResponse
• getNetworkAreasByGeoAreaRequest Operation
  • getNetworkAreasByGeoAreaRequest
  • getNetworkAreasByGeoAreaRequestResponse
• getNetworkComponentsRequest Operation
  • getNetworkComponentsRequest
  • getNetworkComponentsRequestResponse
• inventoryAssociationRequest Operation
  • inventoryAssociationRequest
  • inventoryAssociationRequestResponse
• processTNRecallRequestDocument Operation
  • processTNRecallRequest
  • processTNRecallResponse
• queryEndUserLocation Operation
  • queryEndUserLocation
  • queryEndUserLocationResponse
• queryInventoryManagementRequest Operation
  • queryInventoryManagementRequest
  • queryInventoryManagementRequestResponse
• queryNetworkLocation Operation
  • queryNetworkLocation
  • queryNetworkLocationResponse
• processtnValidationRequest Operation
  • processTNValidationRequest
  • processTNValidationResponse
• updateEntityByValueRequest Operation
  • updateEntityByValueRequest
  • updateEntityByValueRequestResponse
• updateLocationRequest Operation
  • updateLocationRequest
  • updateLocationRequestResponse
• updateTNRequest Operation
  • updateTNRequest
  • updateTNRequestResponse

7 Order Web Service Reference

• About the Order Web Service
• About the Order Web Service Packaging
• About the Order WSDL, WAR, and Schema Files
  • About Order Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• addTaskRequest Operation
  • addTaskRequest
  • addTaskRequestResponse
• addTaskJeopardyRequest Operation
  • addTaskJeopardyRequest
  • addTaskJeopardyResponse
• assignProvPlanRequest Operation
  • assignProvPlanRequest
  • assignProvPlanRequestResponse
• billingTelephoneNumberRequest Operation
  • billingTelephoneNumberRequest
  • billingTelephoneNumberRequestResponse
• completeTaskRequest Operation
  • completeTaskRequest
  • completeTaskRequestResponse
• createAttachment Operation
  • createAttachment
  • createAttachmentResponse
• createISROrderRequest Operation
  • createISROrderRequest
  • createISROrderResponse
• createOrderRelationship Operation
  • createOrderRelationship
  • createOrderRelationshipResponse
• createOrderRequest Operation
  • createOrderRequest
  • createOrderRequestResponse
• createPSROrderRequest Operation
  • createPSROrderRequest
  • createPSROrderRequestResponse
• getCnamData Operation
  • getCnamData
  • getCnamDataResponse
• getE911Data Operation
  • getE911Data
  • getE911DataResponse
• getLidbData Operation
  • getLidbData
  • getLidbDataResponse
• getOrderByKey Operation
  • getOrderByKey
  • getOrderByKeyResponse
• getPSROrderByTN Operation
  • getPSROrderByTN
  • getPSROrderByTNResponse
• processSuppOrderRequest Operation
  • processSuppOrderRequest
  • processSuppOrderRequestResponse
• queryOrderManagementRequest Operation
  • queryOrderManagementRequest
  • queryOrderManagementRequestResponse
• reopenTaskRequest Operation
  • reopenTaskRequest
  • reopenTaskRequestResponse
• rejectTaskRequest Operation
  • rejectTaskRequest
  • rejectTaskRequestResponse
• startOrderRequest Operation
  • startOrderRequest
  • startOrderRequestResponse
• TaskJeopardyRequest Operation
  • TaskJeopardyRequest
  • TaskJeopardyRequestResponse
• TaskRequest Operation
  • TaskRequest
  • TaskRequestResponse
• transferTaskRequest Operation
  • transferTaskRequest
  • transferTaskRequestResponse
• updateCnamData Operation
  • updateCnamData
  • updateCnamDataResponse
• updateE911DataRequest Operation
  • updateE911DataRequest
  • updateE911DataRequestResponse
• updateEstimationCompletedDateRequest Operation
  • updateEstimationCompletedDateRequest
  • updateEstimationCompletedDateRequestResponse
• updateGWEventRequest Operation
  • updateGWEventRequest
  • updateGWEventRequestResponse
• updateLidbData Operation
  • updateLidbData
  • updateLidbDataResponse
• updateOrderRequest Operation
  • updateOrderRequest
  • updateOrderRequestResponse
• updatePSROrderRequest Operation
  • updatePSROrderRequest
  • updatePSROrderRequestResponse

8 Activation Web Service Reference

• About the Activation Web Service
• About the Activation Web Service Packaging
• About the Activation WSDL, WAR, and Schema Files
  • About Activation Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• getActivationData Operation
  • getActivationData
  • getActivationDataResponse

9 SOA Web Service Reference

• About the SOA Web Service
• About the SOA Web Service Packaging
• About the SOA WSDL, WAR, and Schema Files
  • About SOA Schema Files
    • Common Schemas
    • Entity Schemas
    • Data Schemas
    • API Schemas
• createSoaMessageRequest Operation
  • createSoaMessageRequest
  • createSoaMessageRequestResponse
• getSoaDefaultsRequest Operation
  • getSoaDefaultsRequest
  • getSoaDefaultsRequestResponse
• getSoaInformationRequest Operation
  • getSoaInformationRequest
  • getSoaInformationRequestResponse
• getSoaMessageToSendRequest Operation
  • getSoaMessageToSendRequest
  • getSoaMessageToSendRequestResponse
• getSoaTnsForOrderRequest Operation
  • getSoaTnsForOrderRequest
  • getSoaTnsForOrderRequestResponse
• setTnSoaCompleteRequest Operation
  • setTnSoaCompleteRequest
  • setTnSoaCompleteRequestResponse

10 Engineering Work Order Web Service Reference

• About the Engineering Work Order Web Service
• About the Engineering Work Order Web Service Packaging
• About the Engineering Work Order WSDL, WAR, and Schema Files
  • About Engineering Work Order Schema Files
    • API Schemas
• createWorkOrder Operation
  • createWorkOrder
  • createWorkOrderResponse
• associateConnectionToWorkOrder Operation
  • associateConnectionToWorkOrder
  • associateConnectionToWorkOrderResponse
• associateEquipmentToWorkOrder Operation
  • associateEquipmentToWorkOrder
  • associateEquipmentToWorkOrderResponse
• createWorkOrderNote Operation
  • createWorkOrderNote
  • createWorkOrderNoteResponse
• updateWorkOrderNote Operation
  • updateWorkOrderNote
  • updateWorkOrderNoteResponse
• processDDChangeSupplement Operation
  • processDDChangeSupplement
  • processDDChangeSupplementResponse
• updateWorkOrder Operation
  • updateWorkOrder
  • updateWorkOrderResponse
• getWorkOrder Operation
  • getWorkOrder
  • getWorkOrderResponse