Order Web Service Reference

7 Order Web Service Reference

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

About the Order Web Service

The Order Web Service enables an external system to import and maintain order information in MSS. Order Web Service operations enable you to:

Create, get, update, and finish an order.
Complete, reopen, and a transfer task for an order.
Assign a provisioning plan to an order.
Process a supplement order.
Get and update CNAM/LIDB and E911 data.

The following summarizes the CNAM/LIDB and E911 data terms:
- Calling Name (CNAM) is a telephone service used to display the name and telephone number of the caller.
- Line Database (LIDB) is a telephone service used to verify a telephone number for toll service and third-party billing, such as for validation of calling card numbers.
- E911 is a telephone service used to provide emergency (911) operators with the caller's telephone number and location.

About the Order Web Service Packaging

The Order Web Service is packaged in the MSS_WebService.ear file, which contains the order.war file. When the installer deploys the EAR file, the Order 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 Order WSDL, WAR, and Schema Files

The Order Web Service is defined by the OrderAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the order.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 Order Schema Files

Numerous schema files support the Order Web Service. Within the order.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, and API 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 Order entity schemas are defined in the following files:

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

Data Schemas

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

The Order data schemas are defined in the following files:

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

API Schemas

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

The Order API schemas are defined in the following files:

InventoryManagementAPI.xsd
OrderAPI.wsdl
OrderManagementAPI.xsd

addTaskRequest Operation

The addTaskRequest operation enables external systems to add a task to an existing provisioning plan assigned order which is not completed.

The following are the request and response structures:

Request Structure: addTaskRequest

Response Structure: addTaskRequestResponse

addTaskRequest

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

Table 7-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
addTaskRequest	element	momAddTaskRequest	OrderAPI.wsdl
momAddTaskRequest	element	addTaskRequestValue	OrderManagementAPI.xsd
addTaskRequestValue	element	AddTaskRequestValueType	OrderManagementAPI.xsd
AddTaskRequestValueType	ComplexType	ComplexType with task, taskKey, addTaskPolicy	OrderManagementData.xsd
task	element	Task	OrderManagementData.xsd
Task	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd
taskKey	element	TaskOrderKey	OrderManagementData.xsd
TaskOrderKey	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd
addTaskPolicy	element	AddTaskPolicy	OrderManagementData.xsd
AddTaskPolicy	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd

Table 7-2 describes the required fields for addTaskRequest.

Table 7-2 Required Fields

File Name	Data Type	Field Description
primaryKey	string	A system-assigned identifier for the document number. Value should be zero for creating new order.

addTaskRequestResponse

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

Table 7-3 Payload Information for the Request

Name	Defined As	Type Description	File Name
addTaskRequestResponse	element	addTaskResponse	OrderAPI.wsdl
addTaskResponse	element	addTaskResponseValue	OrderManagementAPI.xsd
addTaskResponseValue	element	AddTaskResponseValueType	OrderManagementAPI.xsd
AddTaskResponseValueType	ComplexType	ComplexType with task, planKey, planDefinition	OrderManagementData.xsd
task	element	Task	OrderManagementData.xsd
Task	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd
planKey	element	PlanKey	OrderManagementData.xsd
PlanKey	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd
planDefinition	element	PlanDefinition	OrderManagementData.xsd
PlanDefinition	ComplexType	ComplexType with a list of fields	OrderManagementEntities.xsd

addTaskJeopardyRequest Operation

This operation enables external systems to add jeopardy information for a task. Adding jeopardy information with reason codes identifies a task as being at risk of completing late and specifies the reason for the risk.

The following are the request and response structures:

Request Structure: addTaskJeopardyRequest

Response Structure: addTaskJeopardyResponse

addTaskJeopardyRequest

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

Table 7-4 Payload Information for the Request

Name	Defined As	Type Description	File Name
addTaskJeopardyRequest	element	momAddTaskJeopardyRequest	OrderAPI.wsdl
momAddTaskJeopardyRequest	element	addTaskJeopardyRequestValue	OrderManagementAPI.xsd
addTaskJeopardyRequestValue	element	AddTaskJeopardyRequestValueType	OrderManagementAPI.xsd
AddTaskJeopardyRequestValueType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-5 describes the required fields for addTaskJeopardyRequest.

Table 7-5 Required Fields

Field Name	Data Type	Field Description
jeopId	int	Oracle-generated sequence that uniquely identifies the object in the MSS database.
docNum	OrderKey	System-assigned identifier for the document number.
taskNum	TaskKey	System-assigned identifier for the task.
jeopardyReasonCode	string	Four-digit numeric code for identifying why a key date was missed and why a task was not performed by the scheduled completion date.

addTaskJeopardyResponse

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

Table 7-6 Payload Information for the Response

Name	Defined As	Type Description	File Name
addTaskJeopardyRequestResponse	element	Contains the addTaskJeopardyResponse string	OrderAPI.wsdl

Table 7-7 describes the error messages for the operation.

Table 7-7 Error Messages for the Operation

Error Message	Cause	Resolution
The document number is not found.	The provided document number does not exist in the database.	Verify and pass in a valid document number.
The jeopardy reason code is not valid.	An invalid jeopardy reason code was provided in the request.	Verify and provide a valid jeopardy reason code value in the request.

assignProvPlanRequest Operation

This operation assigns a provisioning plan to the order. This operation takes the provisioning plan ID and order key as the input.

The following are the request and response structures:

Request Structure: assignProvPlanRequest

Response Structure: assignProvPlanRequestResponse

assignProvPlanRequest

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

Table 7-8 Payload Information for the Request

Name	Defined As	Type Description	File Name
assignProvPlanRequest	element	assignProvisionPlanProcedureRequest	OrderAPI.wsdl
assignProvisionPlanProcedureRequest	element	AssignProvisionPlanProcedureValue	OrderManagementAPI.xsd
AssignProvisionPlanProcedureValue	complexType	Extension of MetaSolvAssignProvPlanValue Contains a list of fields	OrderManagementAPI.xsd

Name

Defined As

Type Description

File Name

assignProvPlanRequest

element

assignProvisionPlanProcedureRequest

OrderAPI.wsdl

assignProvisionPlanProcedureRequest

element

AssignProvisionPlanProcedureValue

OrderManagementAPI.xsd

AssignProvisionPlanProcedureValue

complexType

Extension of MetaSolvAssignProvPlanValue

Contains a list of fields

OrderManagementAPI.xsd

Table 7-9 describes the required fields for ProvPlanRequest.

Table 7-9 Required Fields for ProvPlanRequest

Field Name	Data Type	Field Description
OrderKey	OrderKey	Document number of the order to assign the provisioning plan.
ProvisioningPlanKey	string	Provisioning plan key value to be assigned to this order.

assignProvPlanRequestResponse

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

Table 7-10 Payload Information for the Response

Name	Defined As	Type Description	File Name
assignProvPlanRequestResponse	element	assignProvisionPlanProcedureResponse	OrderAPI.wsdl
assignProvisionPlanProcedureResponse	element	mommekey	OrderManagementAPI.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Extension of ManagedEntityKey Contains a list of fields	OrderManagementEntities.xsd

Table 7-11 describes the error messages for the operation.

Table 7-11 Error Messages for the Operation

Error Message	Cause	Resolution
Miscellaneous Error: Tasks cannot be assigned. Order status is invalid.	Tasks are requested assignment when the order status is not valid for task assignment.	Change the status of the input order number or change the input order number.

billingTelephoneNumberRequest Operation

This operation assigns the billing telephone number (BTN) on an order that has multiple telephone numbers. This operation assigns and unassigns the billing telephone number. It takes the number inventory ID as input for the telephone number.

The following are the request and response structures:

Request Structure: billingTelephoneNumberRequest

Response Structure: assignProvPlanRequestResponse

billingTelephoneNumberRequest

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

Table 7-12 Payload Information for the Request

Name	Defined As	Type Definition	File Name
billingTelephoneNumberRequest	element	billingTelephoneNumber	OrderAPI.wsdl
billingTelephoneNumber	complexType	Contains a list of fields	OrderManagementAPI.xsd

Table 7-13 describes the required fields for billingTelephoneNumberRequest.

Table 7-13 Required Fields for billingTelephoneNumberRequest

Field Name	Data Type	Field Description
documentNumber	long	Document number of the order where the billing telephone number is being set.
servItemId	long	Corresponding Service Item ID for the billing telephone number values.
BtnFunctionEnum	Enum	Corresponding BTN function ' 0 - Assign and 1 - Unassign'.
nbrInvId	long	Corresponding Number Inventory ID of the telephone number.

billingTelephoneNumberRequestResponse

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

Table 7-14 Payload Information for the Response

Name	Defined As	Type Description	File Name
billingTelephoneNumberRequestResponse	element	billingTelephoneNumberResponse	OrderAPI.wsdl
billingTelephoneNumberResponse	complexType	Contains the documentNumber integer for the order	OrderManagementAPI.xsd

Table 7-15 describes the error messages for the operation.

Table 7-15 Error Messages for the Operation

Error Message	Cause	Resolution
BTN Assign/UnAssign is allowed only for ''pending'' or ''electronically received'' orders.	You are requesting an assign or unassign of billing telephone number for an order that is not in correct status.	You can only perform this action when the order is pending or electronically received.

completeTaskRequest Operation

This operation completes a task for an order. It takes order number and task number as input and marks the task as complete.

Note:

This completeTaskRequest operation is used for only complete task requests. The following are in the schema files, however this operation does not support:

updateServicesInOrderProcedureValue
updateOrderTaskGWEventValue

To execute these operations use the updateOrderRequest operation.

The following are the request and response structures:

Request Structure: completeTaskRequest

Response Structure: completeTaskRequestResponse

completeTaskRequest

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

Table 7-16 Payload Information for the Request

Name	Defined As	Type Description	File Name
completeTaskRequest	element	updateOrderManagementRequest	OrderAPI.wsdl
updateOrderManagementRequest	element	updateValue	OrderManagementAPI.xsd
updateValue	element	MetaSolvUpdateProcedureValueChoice	OrderManagementAPI.xsd
MetaSolvUpdateProcedureValueChoice	complexType	completeTaskProcedureValue	OrderManagementAPI.xsd
completeTaskProcedureValue	element	CompleteTaskProcedureValue	OrderManagementAPI.xsd
CompleteTaskProcedureValue	complexType	See Table 7-17	OrderManagementAPI.xsd

Table 7-17 defines CompleteTaskProcedureValue.

Table 7-17 CompleteTaskProcedureValue Definition

Name	Defined As	Type Description	File Name
CompleteTaskProcedureValue	complexType	Contains a list of fields	OrderManagementAPI.xsd
whyMissInputs	element	WhyMissInputType	OrderManagementAPI.xsd
WhyMissInputType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-18 describes the required fields for completeTaskRequest.

Table 7-18 Required Fields for completeTaskRequest

Field Name	Data Type	Field Description
taskNumber	long	Task Number of the task to be completed.
OrderKey	OrderKey	Document Number of the order where the task is assigned.
whyMissReasonCode	string	Reason code for why the task was not completed on time. This field is only required when the task exceeds the actual completion date.

completeTaskRequestResponse

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

Table 7-19 Payload Information for the Response

Name	Defined As	Type Description	File Name
completeTaskRequestResponse	element	completeTaskProcedureResponse	OrderAPI.wsdl
completeTaskProcedureResponse	element	CompleteTaskProcedureResponse	OrderManagementAPI.xsd
CompleteTaskProcedureResponse	complexType	mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Extension of ManagedEntityKey Contains a list of fields	OrderManagementEntities.xsd

Table 7-20 describes the error messages for the operation.

Table 7-20 Error Messages for the Operation

Error Message	Cause	Resolution
Task row not found for document number, task number.	For the input document number and task number, the task could not be found in inventory.	Check that the document number and task number exist for the document number/order.
The task requires a why missed code before it can be completed.	For the input task number, the why-missed code is not yet populated to complete the task.	Populate the why-missed code for the task and then request the task completion again.

createAttachment Operation

The createAttachment operation creates an attachment for the input order.

The following are the request and response structures:

Request Structure: createAttachment

Response Structure: createAttachmentResponse

createAttachment

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

Table 7-21 Payload Information for the Request

Name	Defined As	Type Description	File Name
CreateAttachment	element	createAttachmentRequest	OrderAPI.wsdl
createAttachmentRequest	element	CreateAttachmentRequestValue	OrderManagementAPI.xsd
CreateAttachmentRequestValue	element	CreateAttachmentType	OrderManagementAPI.xsd
CreateAttachmentType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-22 describes the required fields for createAttachment.

Table 7-22 Required Fields for createAttachment

Field Name	Data Type	Field Description
attachmentKey	string	Valid PSR document number.
attachmentName	string	Valid attachment name which appears in GUI.
transformationName	string	Name of the XSL file stored in ms_attachment_transform table.
attachmentType	Enum	ORDER is the valid enum value for attachment.

createAttachmentResponse

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

Table 7-23 Payload Information for the Response

Name	Defined As	Type Description	File Name
createAttachmentResponse	element	momCreateAttachmentResponse	OrderAPI.wsdl
momCreateAttachmentResponse	element	Contains the CreateAttachmentResponseValue long	OrderManagementAPI.xsd

createISROrderRequest Operation

This operation creates a new ISR order in the system and returns the new order key. A single OrderValue is the only value passed into the request. The state values in OrderValue are ignored; the state is initialized to STARTED by the system.

The following are the request and response structures:

Request Structure: createISROrderRequest

Response Structure: createISROrderResponse

createISROrderRequest

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

Note:

This operation only supports the metaSolvISROrderValue schema in the request. For creating a PSR order using the metaSolvPSROrderValue schema, use the createOrderRequest and createPSROrderRequest operations.

Table 7-24 Payload Information for the Request

Name	Defined As	Type Description	File Name
createISROrderRequest	element	createOrderByValueRequest	OrderAPI.wsdl
createOrderByValueRequest	element	Mommevalue	OrderManagementAPI.xsd
Mommevalue	element	MetaSolvOrderValueChoice	OrderManagementAPI.xsd
MetaSolvOrderValueChoice	complexType	complexType with a choice of type: metaSolvPSROrderValue metaSolvISROrderValue	OrderManagementEntities.xsd
metaSolvISROrderValue	complexType	See Table 7-41	OrderManagementEntities.xsd

The complexType metaSolvISROrderValue for the create IRS order operation. metaSolvISROrderValue is a choice in the MetaSolvOrderValueChoice definition. The metaSolvISROrderValue element is mutually exclusive with the PSR order information metaSolvPSROrderValue.

Table 7-25 describes the required fields for ISROrderHeaderType.

Table 7-25 Required Fields for ISROrderHeaderType

Field Name	Data Type	Field Description
externalOrderKey	string	External order key from the external system.
requestType	string	Request type for the ISR order.
activityCd	string	Activity code for the order.
broadbandServiceCategory	string	Broad band service category if required.
uniValue	string	UNI value for the order.
organizationId	string	Organization ID for the order.
userId	string	User ID for the order.
desiredDueDate	string	Desired due date for the order that is planned.
serviceOrderDate	string	Service order date for the order that is planned.
servReqStatus	int	Service request status of the order.
quantityUnit	string	Quantity on the order.
quantityCircuitUnit	int	Quantity of circuit on the order.
quantityVirtConnUnit	int	Quantity of virtual circuit on the order.
activeInd	string	Active Indicator for the order.

Table 7-26 describes the required fields for ISRContactType.

Table 7-26 Required Fields for ISRContactType

Field Name	Data Type	Field Description
actionCd	string	Action code for the contact.
orderKey	int	Document number of the order.
companyContact	string	Company contact details of the order.
assocContactName	string	Associate contact details.
customerContactName	string	Customer contact details.

Table 7-27 describes the required fields for ISRNoteValueType.

Table 7-27 Required Fields for ISRNoteValueType

Field Name	Data Type	Field Description
noteKey	int	Note key value.
actionCd	string	Action code for the note.
noteText	string	Data to be entered on the note.
circuitNoteInd	string	Note for the circuit.

Table 7-28 describes the required fields for ISRLocationValueType.

Table 7-28 Required Fields for ISRLocationValueType

Field Name	Data Type	Field Description
isTerminationPoint	boolean	Indicates if this is a termination point.
netLocUse	string	Network location use code.

Table 7-29 describes the required fields for ISRServiceValueType.

Table 7-29 Required Fields for ISRServiceValueType

Field Name	Data Type	Field Description
actionCd	string	Action code for the service.
activityCd	string	Activity code for the service.
serviceItemKey	string	Service item id of the ISR order.
orderKey	int	Document number of the order.

Table 7-30 describes the required fields for ISRRemarkType.

Table 7-30 Required Fields for ISRRemarkType

Field Name	Data Type	Field Description
orderKey	int	Document number of the order.
formId	string	Form ID value.
seqNumber	int	Sequence number of the order.
remarkText	string	Remark that can be updated.

createISROrderResponse

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

Table 7-31 Payload Information for the Response

Name	Defined As	Type Description	File Name
createISROrderResponse	element	createOrderByValueResponse	OrderAPI.wsdl
createOrderByValueResponse	element	mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

createOrderRelationship Operation

This operation creates a relationship between two input order numbers. The input values are parent order ID and child order ID.

The following are the request and response structures:

Request Structure: createOrderRelationship

Response Structure: createOrderRelationshipResponse

createOrderRelationship

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

Table 7-32 Payload Information for the Request

Name	Defined As	Type Description	File Name
createOrderRelationship	element	createOrderRelationshipRequest	OrderAPI.wsdl
createOrderRelationshipRequest	complexType	Contains the following: parentOrderKey childOrderKey	OrderManagementAPI.xsd

Name

Defined As

Type Description

File Name

createOrderRelationship

element

createOrderRelationshipRequest

OrderAPI.wsdl

createOrderRelationshipRequest

complexType

Contains the following:

parentOrderKey
childOrderKey

OrderManagementAPI.xsd

Table 7-33 describes the required fields for createOrderRelationship.

Table 7-33 Required Fields for createOrderRelationship

Field Name	Data Type	Field Description
parentOrderKey	OrderKey	Document number of the parent order of the relationship.
childOrderKey	OrderKey	Document number of the child order of the relationship.

createOrderRelationshipResponse

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

Table 7-34 Payload Information for the Response

Name	Defined As	Type Description	File Name
createOrderRelationshipResponse	element	Contains the momCreateOrderRelationshipResponse string	OrderAPI.wsdl

createOrderRequest Operation

The createOrderRequest operation enables external systems to create orders in MSS. You can request two different types of orders with this operation: PSR orders and ISR orders.

The following are the request and response structures:

Request Structure: createOrderRequest

Response Structure: createOrderRequestResponse

createOrderRequest

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

Table 7-35 Payload Information for the Request

Name	Defined As	Type Description	File Name
createOrderRequest	element	createOrderByValueRequest	OrderAPI.wsdl
createOrderByValueRequest	element	mommevalue	OrderManagementAPI.xsd
mommevalue	element	MetaSolvOrderValueChoice	OrderManagementAPI.xsd
MetaSolvOrderValueChoice	complexType	complexType with a choice of type: metaSolvPSROrderValue metaSolvISROrderValue	OrderManagementEntities.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd
metaSolvISROrderValue	complexType	Described in Table 7-41	OrderManagementEntities.xsd

metaSolvPSROrderValue

Table 7-36 describes the metaSolvPSROrderValue definition information for the create PSR order operation. metaSolvPSROrderValue was referenced in Table 7-35 as a choice in the MetaSolvOrderValueChoice definition. The metaSolvPSROrderValue element is mutually exclusive with the ISR order information.

Table 7-36 metaSolvPSROrderValue Definition

Name	Defined As	Type Description	File Name
metaSolvPSROrderValue	element	MetaSolvPSROrderValue	OrderManagementEntities.xsd
MetaSolvPSROrderValue	complexType	Extension of OrderValue OrderHeaderType metaSolvUserDataValue MetaSolvServiceValueChoice LineDirType	OrderManagementEntities.xsd
OrderValue	complexType	Extension of ManagedEntityValue	OrderManagementEntities.xsd
OrderHeaderType	complexType	complexType with a list of fields	OrderManagementData.xsd
metaSolvUserDataValue	complexType	MetaSolvUserDataValueType	MIPCommonEntities.xsd
MetaSolvUserDataValueType	complexType	UserDataValueType	MIPCommonEntities.xsd
UserDataValueType	complexType	complexType with a list of fields BaseNameValueType	MIPCommonEntities.xsd
MetaSolvServiceValueChoice	complexType	choice of metaSolvServiceValue	ServiceEntities.xsd
metaSolvServiceValue	element	MetaSolvServiceValue	ServiceEntities.xsd
MetaSolvServiceValue	complexType	Extension of ServiceValue and a list of fields	ServiceEntities.xsd
ServiceValue	complexType	Extension of EntityValue complexType with a list of fields	Service.xsd
EntityValue	complexType	CBEManagedEntityValue	Core.xsd
LineDirType	complexType	lineDirectoryType	OrderManagementData.xsd
lineDirectoryType	complexType	complexType with a list of fields	OrderManagementData.xsd

Table 7-37 describes the required fields for OrderValue.

Table 7-37 Required Fields for OrderValue

Field Name	Data Type	Field Description
PrimaryKey	OrderKey	Value should be 0 if it is new or change order and the document number for update order.

Table 7-38 describes the required fields for OrderHeaderType.

Table 7-38 Required Fields for OrderHeaderType

Field Name	Data Type	Field Description
organizationId	string	Organization responsible for processing the order and providing service.
servReqStatus	Enum	Valid values are defined in OrderStatusEnumType. Any new or change order created through an API should have osRECEIVED which refers as Electronically Received order. For update order, the corresponding order status should be passed.
customerAccountKey	integer	Customer account key to associate to the order.
orderedByFirstName	string	First name of the individual placing the order.
orderedByLastName	string	Last name of the individual placing the order.
orderedByTelephoneNr	string	Telephone number of the individual placing the order.
desiredDueDate	CbeDateTime	Date that the customer desires the products to be installed and in-service.
serviceOrderDate	CbeDateTime	Date the order is placed (entered).
responsibleParty	string	Person responsible for the order, such as the customer care rep or the sales person.
orderActivityCd	Enum	Valid values are oaNEW, oaCHANGE and oaDISCONNECT
billActivationDate	CbeDateTime	Date for the customer invoice.
suppType	Enum	Valid values are stcorrect, stcancell, stduedate and stnone. For a new order, this is always the value stnone and for update orders, this can be updated according to the requirement.

Table 7-39 describes the required fields for UserDataValueType.

Table 7-39 Required 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 7-40 describes the required fields for BaseNameValueType.

Table 7-40 Required 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.

metaSolvISROrderValue

Table 7-41 describes the metaSolvISROrderValue definition information for the create IRS order operation. metaSolvISROrderValue was referenced in Table 7-35 as a choice in the MetaSolvOrderValueChoice definition. The metaSolvISROrderValue element is mutually exclusive with the PSR order information metaSolvPSROrderValue.

Table 7-41 metaSolvISROrderValue Definition

Name	Defined As	Type Description	File Name
metaSolvISROrderValue	element	MetaSolvISROrderValue	OrderManagementEntities.xsd
MetaSolvISROrderValue	complexType	Extension of OrderValueISROrderHeaderType	OrderManagementEntities.xsd
ISROrderHeaderType	complexType	complexType with a list of fields, contact, notes, locations, serviceValue, remarks, userData	OrderManagementData.xsd
Contact	element	ISRContactType	OrderManagementData.xsd
ISRContactType	complexType	Contains a list of fields	OrderManagementData.xsd
notes	element	ISRNoteValueType	OrderManagementData.xsd
ISRNoteValueType	complexType	Contains a list of fields	OrderManagementData.xsd
locations	element	ISRLocation	OrderManagementData.xsd
ISRLocation	complexType	locationValueA, locationValueB	OrderManagementData.xsd
locationValueA	element	ISRLocationValueType	OrderManagementData.xsd
locationValueB	element	ISRLocationValueType	OrderManagementData.xsd
ISRLocationValueType	complexType	MetaSolvLocationKey	OrderManagementData.xsd
serviceValue	element	ISRServiceValueType	OrderManagementData.xsd
ISRServiceValueType	complexType	Contains a list of fields	OrderManagementData.xsd
remarks	element	ISRRemarkType	OrderManagementData.xsd
ISRRemarkType	complexType	Contains a list of fields	OrderManagementData.xsd
userData	element	UserDataValueType	OrderManagementData.xsd
UserDataValueType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-42 describes the required fields for MetaSolvServiceValue.

Table 7-42 Required Fields for MetaSolvServiceValue

Field Name	Data Type	Field Description
externalServiceKey	string	External service key value from the external system.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item. Pass the value based on the scenario.
productGroup	integer	The name of the product grouping. This field should be zero if a value is not applicable.

Table 7-43 describes the required fields for serviceKey and parentServiceKey.

Table 7-43 Required Fields for serviceKey and parentServiceKey

Field Name	Data Type	Field Description
servicePrimaryKey	string	Field is required only for change orders and is populated using service item ID. For new orders, this value is 0.

Table 7-44 describes the required fields for parentSpecKey and describingSpecificationKey.

Table 7-44 Required Fields for parentSpecKey and describingSpecificationKey

Field Name	Data Type	Field Description
serviceSpecificationPrimaryKey	string	Field is populated using the product catalog ID which is added under the service structure.

Table 7-45 describes the required fields for serviceLocationKey.

Table 7-45 Required Fields for serviceLocationKey

Field Name	Data Type	Field Description
locationPrimaryKey	string	Value of the location ID where the product is assigned. This is populated for products which are under Service Location and is 0 for Global products.

Table 7-46 describes the required fields for ipNumberInventoryKey and addressKey.

Table 7-46 Required Fields for ipNumberInventoryKey and addressKey

Field Name	Data Type	Field Description
resourcePrimaryKey	string	Value of the address ID where the product is assigned. This is populated for products which are under Service Location and is 0 for Global products.

Table 7-47 describes the required values for serviceItemValues.

Table 7-47 Required Values for serviceItemValues

Field Name	Data Type	Field Description
label	string	Name or purpose of additional information that you want to capture for a service item.
Value	string	Specific value for a given value label. Values can be lists of predefined choices, or text-entry fields.
valueCd	string	Code used to identify a value, such as a shortened version of the value's “name" or a number.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item. Pass the value based on the scenario.

assignedTelephoneNr

Table 7-48 defines assignedTelephoneNr information.

This tag applies for PSR orders which has products that require Telephone Numbers to be assigned.

Table 7-48 assignedTelephoneNr Definition

Name	Defined As	Type Description	File Name
assignedTelNr	element	AssignedTelNrType	OrderManagementData.xsd
AssignedTelNrType	complexType	Set of simple data types: CnamType LidbType StructureFormatType	OrderManagementData.xsd
CnamType	element	psrCnam	OrderManagementData.xsd
psrCnam	element	PsrCnamType	OrderManagementData.xsd
PsrCnamType	complexType	Contains a list of fields	OrderManagementData.xsd
LidbType	element	psrLidbType	OrderManagementData.xsd
psrLidbType	element	PsrLidbType	OrderManagementData.xsd
PsrLidbType	complexType	Contains a list of fields	OrderManagementData.xsd
StructureFormatType	complexType	structureFormatComponents	CustomerManagementData.xsd
structureFormatComponents	element	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd
assignedTelNrRel	element	AssignedTelNrRelType	OrderManagementData.xsd
AssignedTelNrRelType	complexType	Set of simple data types: AssignedTelNrType MetaSolvServiceKey	OrderManagementData.xsd
AssignedTelNrType	complexType	Contains a list of fields	OrderManagementData.xsd
MetaSolvServiceKey	element	MetaSolvServiceKey	ServiceEntities.xsd
MetaSolvServiceKey	complexType	servicePrimaryKey	ServiceEntities.xsd

Table 7-49 describes the required fields for MetaSolvServiceKey.

Table 7-49 Required Fields for MetaSolvServiceKey

Field Name	Data Type	Field Description
servicePrimaryKey	string	Field is required only for change orders and is populated using service item ID and for new orders, this is 0.

Table 7-50 describes the required fields for assignedTelephoneNr.

Table 7-50 Required Fields for assignedTelephoneNr

Field Name	Data Type	Field Description
relationshipType	Enum	Relationship between two telephone numbers. Valid values are rtRCF, rtPorted, rtPortedTo, rtTollfree and rtNone.

Table 7-51 describes the required fields for AssignedTelNrType.

Table 7-51 Required Fields for AssignedTelNrType

Field Name	Data Type	Field Description
telNrSuf	string	System tracks a number's history by assigning a suffix counter to each number. Each time the number is recalled into an Unassigned status, the counter increases by one.
respOrg	string	Organization that owns the NPA NXX.
telNrTypeCd	Enum	Telephone number type code and valid values are Valid values are tntINPOUT, tntRESALE, tntNPIN, tntTFWTN, tntTF, tntFORWTN, tntNPOUT, tntWTN, tntNone.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item. Pass the value based on the scenario.
identityCd	Enum	Identify whether the telephone number as main telephone number or alternate. Valid values are: MPTN, ALT and NONE.
locationId	Long	The location ID of the telephone number and if not mapped, it should be 0.
btnInd	Boolean	Default is false and should be changed to true if the TN needs to set as billing telephone number.

Table 7-52 describes the required fields for PsrCnamType.

Table 7-52 Required Fields for PsrCnamType

Field Name	Data Type	Field Description
callingName	string	The name of the business or residential customer, as desired for the caller ID display.
presentationInd	Enum	Valid values of PresentationIndEnumType. Indicates that caller ID name information is sent for calls made from this number.
activityCode	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.
manualIndicator	Enum	Valid values of IndicatorEnumType. Indicates that you do not want to send the CNAM information electronically to the gateway vendor. If you do not send the information electronically, you must send it manually.
effectiveDateChg	CbeDateTime	Indicates a future date for any change to be effective, if it is not effective immediately.

Table 7-53 describes the required fields for PsrLidbType.

Table 7-53 Required Fields for PsrLidbType

Field Name	Data Type	Field Description
bnsCode	Enum	Valid values of BNSCodeEnumType. The Billed Number Screening Code is a code to indicate the type of screening, if any, applied to this number.
marketInd	Enum	Valid values of MarketIndicatorEnumType. Indicates the type of market this number is assigned to.
serviceClassCode	Enum	Valid values of ClassCodeEnumType. A code that describes how a service is used by a business, residential, or pay phone customer. Examples include business, residential, public coin, public non-coin, and semi-public coin.
manualIndicator	Enum	Valid values of IndicatorEnumType. Indicates that you do not want to send the LIDB information electronically to the gateway vendor. If you do not send the information electronically, you must send it manually.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.
effectiveDateChg	CbeDateTime	Indicates a future date for any change to be effective, if it is not effective immediately.

Table 7-54 describes the required fields for StructureFormatType.

Table 7-54 Required Fields for StructureFormatType

Field Name	Data Type	Field Description
sfType	string	Category that describes a structure.
name	string	Name of a specific customizing of a structured format type.

Table 7-55 describes the required fields for StructureFormatComponentType.

Table 7-55 Required Fields for StructureFormatComponentType

Field Name	Data Type	Field Description
Id	int	ID of a component of a structured format.
name	string	Name of a component of a structured format.
componentType	string	Type of component, such as table-driven drop-down or valid value drop-down.
Value	string	Name of a value for a component.

Table 7-56 describes Access.

Table 7-56 Access Definition

Name	Defined As	Type Description	File Name
Access	element	AccessType	ServiceEntities.xsd
AccessType	complexType	AccessInformationType	OrderManagementData.xsd
AccessInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-57 describes the required fields for AccessInformationType.

Table 7-57 Required Fields for AccessInformationType

Field Name	Data Type	Field Description
Floor	string	The floor where the product is installed.
Room	string	The room where the product is installed.
jackCd	string	A standard code for the registered or non-registered jack used to terminate service at the service location.
jackNr	string	If the jack is existing, the number associated with the jack.
jackPosition	integer	The position of the circuit within the jack.
jackStatus	string	Indicates whether the jack used to terminate service is new or existing.
accessInfo	string	Special instructions regarding access to the service location and times that access is available.
additionalLocationDetails	string	Specific details not included in the Additional Information field.
locationIdSpot	integer	The CLLI code for the physical point of termination at the end user location.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-58 describes isdnTrunkGroup.

Table 7-58 isdnTrunkGroup Definition

Name	Defined As	Type Description	File Name
isdnTrunkGroup	element	IsdnTrunkGroupType	ServiceEntities.xsd
IsdnTrunkGroupType	complexType	isdnTrunkGroupInformation	OrderManagementData.xsd
isdnTrunkGroupInformation	complexType	IsdnTrunkGroupInformationType	OrderManagementData.xsd
IsdnTrunkGroupInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-59 describes the required fields for IsdnTrunkGroupInformationType.

Table 7-59 Required Fields for IsdnTrunkGroupInformationType

Field Name	Data Type	Field Description
bchanFunctionCd	Enum	Valid values of BchanFuncEnumType. Identifies the purpose of the bearer channels.
nfasBkupDchanInd	Enum	Valid values of IndicatorWNAEnumType. Indicates if a backup D-Channel is used on a subsequent DS1 in a multiple DS1 trunk group.
premierCallInd	Enum	Valid values of IndicatorEnumType. Identifies whether the premier calling features are available.
nfasInd	Enum	Valid values of IndicatorEnumType. Indicates whether the DS1 circuits in the ISDN trunk group shares the same D channel for signaling. When NFAS is not used, each DS1 uses its own D channel.
dialableGroup	Enum	Valid values of DialableGroupEnumType. The grouping method for the DS0 time slot (channel).
dialableSearch	Enum	Valid values of DialableSrchEnumType.

Table 7-60 defines trunkGroup.

Table 7-60 trunkGroup Definition

Name	Defined As	Type Description	File Name
trunkGroup	element	TrunkGroupType	ServiceEntities.xsd
TrunkGroupType	complexType	TrunkGroupInformation	OrderManagementData.xsd
TrunkGroupInformation	complexType	TrunkGroupInformationType	OrderManagementData.xsd
TrunkGroupInformationType	complexType	Contains the following: intoCO outFromCO	OrderManagementData.xsd
intoCO	element	IntoCOType	OrderManagementData.xsd
outFromCO	element	OutFromCOType	OrderManagementData.xsd

Table 7-61 describes the required fields TrunkGroupInformationType.

Table 7-61 Required Fields for TrunkGroupInformationType

Field Name	Data Type	Field Description
coDirection	string	Describes the direction of the signals traveling along this trunk.
interfaceType	string	Indicates whether the interface for the trunk group is digital or analog.
glareAction	string	Indicates who has control of the trunks when both ends are seized at the same time for different uses or by different users.
ncCd	string	Network Channel code - A code that identifies the type of service provided by the trunk.
ncCdOption	string	Two optional characters further identify the performance specifications and transmission options of the trunk.
nciCd	string	Network Channel Interface code - A code that identifies the electrical conditions of the trunk at the customer location.
twoSixCd	string	A code that identifies the trunk group. The code consists of a two-character company code, followed by the six-digit serial number of the trunk.
framing	string	The type of frame pattern used for DS1 service.
lineCoding	string	The type of pulse code modulation (PCM) pattern used for DS1 service.
trunkSegment	string	Suffix added to a trunk to make it unique. This suffix is created by a local telephone trunk service.
selectionSequence	string	The method of selecting idle trunks in a trunk group during call processing. This field is required for all types of special trunk groups.

Table 7-62 describes the required fields for IntoCOType.

Table 7-62 Required Fields for IntoCOType

Field Name	Data Type	Field Description
digitsQty	integer	The number of digits that are to be received by the central office switch from the customer for a Direct Outward-Dial (DOD) trunk.
maxDigit	string	The maximum number of digits that can be sent from a PBX, terminal equipment, or similar device to the central office switch.
minDigit	string	The minimum number of digits that can be sent from a PBX, terminal equipment, or similar device to the central office switch.
pulseType	string	The pulsing method used to send digits from a customer to a central office switch.
startSignal	string	The timing or method used to start signaling from the customer to the central office switch.
supervisionSignal	string	The type of signaling sent from a PBX, terminal equipment, or similar device to a central office switch.

Table 7-63 describes the required fields for OutFromCOType.

Table 7-63 Required Fields for OutFromCOType

Field Name	Data Type	Field Description
digitsQty	integer	The number of digits sent from the central office switch to the customer for a Direct In-Dial (DID) trunk.
maxDigit	string	The actual digits that are inserted before the Digits Outpulsed and sent from the central office switch to the PBX, terminal equipment, or similar device.
minDigit	string	The quantity of digits that are extracted from the Digits Outpulsed before they are sent from the central office switch to the PBX, terminal equipment, or similar device.
pulseType	string	The pulsing method used to send digits from a central office switch to a customer.
startSignal	string	The timing or method used to start signaling from the customer to the central office switch.
supervisionSignal	string	The type of signaling sent from a PBX, terminal equipment, or similar device to a central office switch.

Table 7-64 defines Circuit.

Table 7-64 Circuit Definition

Name	Defined As	Type Description	File Name
circuit	element	CircuitType	ServiceEntities.xsd
CircuitType	complexType	circuitInformation	OrderManagementData.xsd
circuitInformation	complexType	CircuitInformationType	OrderManagementData.xsd
CircuitInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-65 describes the required fields for CircuitInformationType.

Table 7-65 Required Fields for CircuitInformationType

Field Name	Data Type	Field Description
rateCd	string	Identifies the transmission rate of the requested circuit (measured in bits per second).
aPot	string	The CLLI associated with the additional termination point of the circuit, if applicable.
framing	string	The type of frame pattern used for DS1 service.
framingAnsiInd	Enum	Valid values of IndicatorWNAEnumType. Only applicable if framing is used.
lineCoding	string	The type of pulse code modulation (PCM) pattern used for DS1 service.
ownedLeasedCd	Enum	Valid values of CktServiceTypeEnumType. Description of the service provided, broken down into Special Services (for IntraLATA/Boundary and LATA/Boundary Access), Switched Services, and Facility Services.
serviceTypeExt	string	Service a circuit provides. The extension further defines a service type code.
serviceTypeCd	string	Service type code.
ncCd	string	Identifies performance and other technical specifications for the circuit.
ncCdOption	string	Identifies performance and other technical specifications for the circuit.
Jurisdiction	string	Jurisdiction classification, which categorizes the circuit (for its originating/terminating end) for toll separation purposes.

Table 7-66 defines circuitLocation.

Table 7-66 circuitLocation Definition

Name	Defined As	Field Description	File Name
circuitLocation	element	CircuitLocationType	ServiceEntities.xsd
CircuitLocationType	complexType	circuitLocationInformation	OrderManagementData.xsd
circuitLocationInformation	complexType	CircuitLocationInformationType	OrderManagementData.xsd
CircuitLocationInformationType	complexType	Contains the following: primaryLocation secondaryLocation	OrderManagementData.xsd
primaryLocation	element	LocationType	OrderManagementData.xsd
secondaryLocation	element	LocationType	OrderManagementData.xsd
LocationType	complexType	CodedLocationType, EndUserLocationType	OrderManagementData.xsd
CodedLocationType	complexType	locationKey	OrderManagementData.xsd
locationKey	element	MetaSolvLocationKey	OrderManagementData.xsd
EndUserLocationType	complexType	Contains the following: locationKey jackInformation	OrderManagementData.xsd
jackInformation	element	JackInformationType	OrderManagementData.xsd
JackInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-67 describes the required fields for CodedLocationType.

Table 7-67 Required Fields for CodedLocationType

Field Name	Data Type	Field Description
serviceLocationRef	integer	Relates to the Service Location field that appears for End User locations.
clliCd	string	Only applicable for network locations. The network location for the circuit connection. This field is only applicable to network locations and is only required when the CodedLocationType is populated.
nciCd	string	Network Channel Interface code that identifies the interface specifications associated with a circuit.
cfa	string	Connecting Facility Assignment field. If applicable, the circuit on another provider's network where the ordered circuit is connected and the channel that it is assigned.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.
supervisionSignal	string	Type of signaling sent from a PBX, terminal equipment, or similar device to a central office switch.

Table 7-68 describes the required fields for EndUserLocationType.

Table 7-68 Required Fields for EndUserLocationType

Field Name	Data Type	Field Description
serviceLocationRef	integer	Relates to the Service Location field that appears for End User locations.
endUserClli	Enum	Valid values of MomLocationTypeEnumType. The network location for the circuit connection.
nciCd	string	Network Channel Interface code that identifies the interface specifications associated with a circuit.
cfa	string	Connecting Facility Assignment field. If applicable, the circuit on another provider's network where the ordered circuit is connected and the channel that it is assigned.
backboardSpace	Enum	Valid values of IndicatorWNAEnumType. This field is only required if the parent tag is populated. This field is applicable for private line (including LAN) connections. Indicates whether backboard space for equipment installation is available, not available, or not applicable at this location.
offNetType	Enum	Valid values of NniUniCDEnumType. This field is only required if the parent tag is populated. This field is applicable for frame relay orders when the On Net Location box is not checked.
equipSpace	Enum	Valid values of IndicatorWNAEnumType. Indicates whether equipment space is available, not available, or not applicable at this location.
seperatlyFused	Enum	Valid values of IndicatorEnumType. Indicates whether the power available to this location is separately fused.
buildingGround	Enum	Valid values of IndicatorEnumType. Indicates whether a building ground is available at this location.
powerAvail	Enum	Valid values of IndicatorEnumType. Indicates whether power is available at this location.
localLoop	Enum	Valid values of IndicatorEnumType. Indicates whether you need to order a local loop connection to this location.
Muxing	Enum	Valid values of IndicatorEnumType. Indicates whether the customer requests multiplexing (muxing).
onNetLoc	Enum	Valid values of IndicatorEnumType. Indicates whether your company currently serves this location.
powerType	Enum	Valid values of PowerTypeEnumType. A description of the type of power available at this location.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-69 describes the required fields for JackInformationType.

Table 7-69 Required Fields for JackInformationType

Field Name	Data Type	Field Description
jackCd	string	Standard code for the registered or non-registered jack used to terminate service at the service location.
jackPosition	integer	Position of the circuit within the jack.
jackNr	string	If the jack is existing, the number associated with the jack.
jackStatus	Enum	Valid values of JackStatusEnumType. Indicates whether the jack used to terminate service is new or existing.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-70 defines Connector.

Table 7-70 Connector Definition

Name	Defined As	Type Description	File Name
connector	element	ConnectorType	ServiceEntities.xsd
ConnectorType	complexType	connectorInformation	OrderManagementData.xsd
connectorInformation	complexType	ConnectorInformationType	OrderManagementData.xsd
ConnectorInformationType	complexType	Contains the following: serviceLocationKeyA serviceLocationKeyB	OrderManagementData.xsd
serviceLocationKeyA	element	MetaSolvLocationKey	OrderManagementData.xsd
serviceLocationKeyB	element	MetaSolvLocationKey	OrderManagementData.xsd

Table 7-71 describes the required fields for ConnectorInformationType.

Table 7-71 Required Fields for ConnectorInformationType

Field Name	Data Type	Field Description
compTypeConId	integer	Type of connection on an order.
rateCd	string	Identifies the transmission rate of the requested circuit (measured in bits per second).
Framing	string	Type of frame pattern used for DS1 service.
lineCoding	string	Type of pulse code modulation (PCM) pattern used for DS1 service.
Jurisdiction	string	Jurisdiction classification, which categorizes the circuit (for its originating/terminating end) for toll separation purposes.
serviceLocationRefA	integer	Primary location for the circuit termination for A.
addressKeyA	integer	Address key A value.
serviceLocationRefB	integer	Primary location for the circuit termination for B.
addressKeyB	integer	Address key B value.

Table 7-72 defines caUsageInstance.

Table 7-72 caUsageInstance Definition

Name	Defined As	Type Description	File Name
caUsageInstance	element	CaUsageInstanceType	ServiceEntities.xsd
CaUsageInstanceType	complexType	caUsageValue	OrderManagementData.xsd
caUsageValue	element	CaUsageValueType	OrderManagementData.xsd
CaUsageValueType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-73 describes the required fields for CaUsageInstanceType.

Table 7-73 Required Fields for CaUsageInstanceType

Field Name	Data Type	Field Description
caUsageKey	integer	Unique ID of custom attribute.
caValueLabel	string	Label of custom attribute.

Table 7-74 describes the required fields for CaUsageValueType.

Table 7-74 Required Fields for CaUsageValueType

Field Name	Data Type	Field Description
caValueKey	integer	Key of valid value custom attribute.
caValue	string	Value of custom attribute.
caUom	string	Unit of measure. For example, meters, yards, or feet.
caUsageVvKey	integer	Key of valid value custom attribute.

Table 7-75 defines picInfo.

Table 7-75 picInfo Definition

Name	Defined As	Type Description	File Name
picInfo	element	PicInfoType	ServiceEntities.xsd
PicInfoType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-76 describes the required fields for PicInfoType.

Table 7-76 Required Fields for PicInfoType

Field Name	Data Type	Field Description
Pic	string	A Primary Interexchange (or IntraLata) Carrier code or Carrier identification code (CIC) that represents an end user's toll provider.
picTypeCd	string	Toll calling area of a PIC, including intraLATA/Boundary, interLATA/Boundary, and international.
freezePic	Enum	Valid values of IndicatorType. Indicates the customer requested the freeze option on the PIC. The end user is specifying that the PIC can only be changed when authorized by the end user.
partyName	string	Name for the given primary interexchange code. This field is information only not used in business logic for create or update transactions.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-77 defines orderItemPrice.

Table 7-77 orderItemPrice Definition

Name	Defined As	Field Description	File Name
orderItemPrice	element	PSROrderItemPriceType	ServiceEntities.xsd
PSROrderItemPriceType	complexType	psrOrderItemPrice	OrderManagementData.xsd
psrOrderItemPrice	complexType	MomPsrOrderItemPriceType	OrderManagementData.xsd
MomPsrOrderItemPriceType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-78 describes the required fields for MomPsrOrderItemPriceType.

Table 7-78 Required Fields for MomPsrOrderItemPriceType

Field Name	Data Type	Field Description
priceID	integer	ID for the price.
basePriceSeq	string	Base price sequence.
priceVarSeq	string	Price variation sequence.
priceOverride	Float	Indicator on whether to override the price.
activityCD	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-79 defines EmailInfo.

Table 7-79 EmailInfo Definition

Name	Defined As	Type Description	File Name
EmailInfo	element	EmailInfoType	ServiceEntities.xsd
EmailInfoType	complexType	internetEmailInformation	OrderManagementData.xsd
internetEmailInformation	complexType	InternetEmailInformationType	OrderManagementData.xsd
InternetEmailInformationType	complexType	complexType with a list of fields	OrderManagementData.xsd

Table 7-80 describes the required fields for InternetEmailInformationType.

Table 7-80 Required Fields for InternetEmailInformationType

Field Name	Data Type	Field Description
emailName	string	Email that is used by the customer.
Domain	string	Domain name.
domainSuffix	string	Suffix for the domain name.

Table 7-81 defines DialupInfo.

Table 7-81 DialupInfo Definition

Name	Defined As	Field Description	File Name
DialupInfo	element	DialupInfoType	ServiceEntities.xsd
DialupInfoType	complexType	internetDialupInformation	OrderManagementData.xsd
internetDialupInformation	complexType	InternetDialupInformationType	OrderManagementData.xsd
InternetDialupInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-82 describes the required fields for InternetDialupInformationType.

Table 7-82 Required Fields for InternetDialupInformationType

Field Name	Data Type	Field Description
url	string	URL for the dial up.
Domain	string	Domain name.
domainSuffix	string	Suffix for the domain name.
userId	string	User ID for the dial up.
accessTnNbrInvId	integer	Associated Number inventory ID.

Table 7-83 defines TemplateInfo.

Table 7-83 TemplateInfo Definition

Name	Defined As	Type Definition	File Name
TemplateInfo	element	TemplateInfoType	ServiceEntities.xsd
TemplateInfoType	complexType	templateInformation	OrderManagementData.xsd
templateInformation	complexType	TemplateInformationType	OrderManagementData.xsd
TemplateInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-84 describes the required fields for TemplateInformationType.

Table 7-84 Required Fields for TemplateInformationType

Field Name	Data Type	Field Decription
configTypeId	integer	Config type ID.
shortName	string	Short name that is going to be defined for the template product.
longName	string	Long name that is going to be defined for the template product.
providerId	string	Provider ID of the template.
customerId	string	Customer ID that is assigned to this template.

Table 7-85 defines ElementInfo.

Table 7-85 ElementInfo Definition

Name	Defined As	Type Description	File Name
ElementInfo	element	ElementInfoType	ServiceEntities.xsd
ElementInfoType	complexType	elementInformation	OrderManagementData.xsd
elementInformation	complexType	ElementInformationType	OrderManagementData.xsd
ElementInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-86 describes the required fields for ElementInformationType.

Table 7-86 Required Fields for ElementInformationType

Field Name	Data Type	Field Description
configTypeId	integer	Config type ID.
elementType	string	Type of element that is used.
elementNbr	integer	Element number.
elementNm	string	Element name that is used.
networkElementId	string	Network element ID that is assigned.
locationId	string	Location ID that is assigned.
addressId	string	Address ID that is assigned.

Table 7-87 defines EquipmentInfo.

Table 7-87 EquipmentInfo Definition

Name	Defined As	Type Description	File Name
EquipmentInfo	element	EquipmentInfoType	ServiceEntities.xsd
EquipmentInfoType	complexType	equipmentInformation	OrderManagementData.xsd
equipmentInformation	complexType	EquipmentInformationType	OrderManagementData.xsd
EquipmentInformationType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-88 describes the required fields for EquipmentInformationType.

Table 7-88 Required Fields for EquipmentInformationType

Field Name	Data Type	Field Description
equipmentSpecId	integer	Equipment specification ID that is assigned to this order.
equipmentId	integer	Equipment id that is assigned to this order.

Table 7-89 defines PSRDirServ.

Table 7-89 PSRDirServ Definition

Name	Defined As	Type Description	File Name
PSRDirServ	element	PSRDirServType	ServiceEntities.xsd
PSRDirServType	complexType	directoryServiceRequest	OrderManagementData.xsd
directoryServiceRequest	complexType	directoryServiceType	OrderManagementData.xsd
directoryServiceType	complexType	Contains the following: BANUsageOne BANUsageTwo ACNAInfo	OrderManagementData.xsd
BANUsageOne	element	PSRBillingAccountNumberUsageType	OrderManagementData.xsd
BANUsageTwo	element	PSRBillingAccountNumberUsageType	OrderManagementData.xsd
PSRBillingAccountNumberUsageType	complexType	Contains a list of fields	OrderManagementData.xsd
ACNAInfo	element	PSRDirServReqACNAType	OrderManagementData.xsd
PSRDirServReqACNAType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-90 describes the required fields for directoryServiceType.

Table 7-90 Required Fields for directoryServiceType

Field Name	Data Type	Field Description
serviceCenter1	string	Service center 1 details.
serviceCenter2	string	Service center 2 details.
accountNumber	string	Identifies the main account number assigned by the NSP.
accountTelNbr	string	Identifies the account telephone number assigned by the NSP.
TOSTYPE	Enum	Valid values of TypeOfServiceEnumType. Type of Service identifies the type of service or the line ordered. Byte 1 of 4-byte field.
TOSPROD	Enum	Valid values of TypeOfServiceProdEnumType. Type of Service identifies the type of service for the line ordered. Byte 2 of 4-byte field.
TOSCLASS	Enum	Valid values of TypeOfServiceClassEnumType. Type of Service identifies the type of service or the line ordered. Byte 3 of 4-byte field.
TOSCHAR	Enum	Valid values of TypeOfServiceClassEnumType. Type of Service identifies the type of service or the line ordered. Byte 4 of 4-byte field.

Table 7-91 describes the required fields for PSRBillingAccountNumberUsageType.

Table 7-91 Required Fields for PSRBillingAccountNumberUsageType

Field Name	Data Type	Field Description
billingAcctNbr	string	Identifies the billing account number for the recurring and non-recurring charges for this request.
banSvcCat	Enum	Valid values of BanServiceTypeEnumType. Identifies the type of billing account number.

Table 7-92 describes the required fields for PSRDirServReqACNAType.

Table 7-92 Required Fields for PSRDirServReqACNAType

Field Name	Data Type	Field Description
Acna	string	ACNA value.
partyPrimaryName	string	Primary name of the party.
partySecondaryName	string	Secondary name of the party.

Table 7-93 defines PSRDirListing.

Table 7-93 PSRDirListing Definition

Name	Defined As	Type Description	File Name
PSRDirListing	element	PSRDirListingType	ServiceEntities.xsd
PSRDirListingType	complexType	directoryListing	OrderManagementData.xsd
directoryListing	complexType	directoryListingType	OrderManagementData.xsd
directoryListingType	complexType	Contains the following: address telNbr delivery addlInfo text	OrderManagementData.xsd
Address	element	PSRDirectoryListingAddress	OrderManagementData.xsd
PSRDirectoryListingAddress	complexType	Contains a list of fields	OrderManagementData.xsd
telNbr	element	PSRDirectoryListingTelephoneNumber	OrderManagementData.xsd
PSRDirectoryListingTelephoneNumber	complexType	Contains a list of fields	OrderManagementData.xsd
delivery	element	PSRDirectoryListingDeliveryLocation	OrderManagementData.xsd
PSRDirectoryListingDeliveryLocation	complexType	Contains a list of fields PSRDirectoryListingDirectoryTypeSegments	OrderManagementData.xsd
addlInfo	element	PSRDirectoryListingAdditionalInformation	OrderManagementData.xsd
PSRDirectoryListingAdditionalInformation	complexType	Contains a list of fields	OrderManagementData.xsd
Text	element	PSRDirectoryListingLinesOfText	OrderManagementData.xsd
PSRDirectoryListingLinesOfText	complexType	Contains a list of fields	OrderManagementData.xsd
PSRDirectoryListingDirectoryTypeSegments	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-94 describes the required fields for directoryListingType

Table 7-94 Required Fields for directoryListingType

Field Name	Data Type	Field Description
ALICd	string	Uniquely identifies each listing for an account number.
listingType	Enum	Valid values of listingType. For DSR, identifies the type of listing being submitted for the publication and directory assistance (DA) appearance rules.
listAcctType	Enum	Valid values of TypeOfAccountEnum. Identifies the type of account for this listing and determines the placement of the listing in split directories and directory assistance.
styleCd	Enum	Valid values of StyleCodeEnum. Identifies if the listing is a straight line, caption header.
Yphdgcd	string	Identifies the heading under which a business listing should appear in the Yellow Pages Directory.
Yphdgverbiage	string	Identifies the heading under which a business listing should appear in the Yellow Pages.
placeListingAs	string	When a customer wishes to override the normal sequencing, the special filing words that are used rather than using the listed name.
dirName	string	Identifies the name of the directory in which the listing is to be placed.
listedNmAddrAddl	string	This is a twelve-character alphaNumeric field.
listedNmLineageDual	Enum	Valid values of LineageNameEnum.
listedNmAddrDual	Enum	Valid values of AddressNameEnum.

Table 7-95 describes the required fields for PSRDirectoryListingAddress.

Table 7-95 Required Fields for PSRDirectoryListingAddress

Field Name	Data Type	Field Description
listedNmLineage	Enum	Valid values of LineageNameEnum.
listedNmLast	string	Last name for the listing.
listedNmFirst	string	First name for the listing.
houseNbrPref	string	Identifies the prefix for the house number.
houseNbr	string	The number of the street address, not including extensions such as 1/2, A, D.
streetNm	string	Name of the road of the address.
City	string	Community of the street name/house number as designated by the Master Street Address Guide, MSAG.
stateCd	string	A two-character abbreviation for the State associated with the address.
zipCode	string	Zip code of the address.
omitAddr	Enum	Valid values of CheckBoxOptionEnum.
omitTelNbr	Enum	Valid values of CheckBoxOptionEnum.

Table 7-96 describes the required fields for PSRDirectoryListingTelephoneNumber.

Table 7-96 Required Fields for PSRDirectoryListingTelephoneNumber

Field Name	Data Type	Field Description
Listingtelnbr	string	Indicates the telephone number to be placed in the directory and quoted in Directory Assistance (DA) as appropriate based on LTY, RTY, and STYC field entries.
mainTelNbr	string	Field identifies the main telephone number used to link the main listing with any other associated listings.
Telnbrnpa	string	Area code (NPA) portion of the telephone number. The first three digits of a ten-digit phone number.
Telnbrnxx	string	Central Office, or Exchange, portion of the phone number. The first three digits of a seven-digit telephone number, and the fourth through sixth digits of a ten-digit phone number.
Telnbrlinerange	string	Line number of the telephone. This is the last four digits a ten-digit telephone number, and the last four digits of a seven-digit number.
Telnbrsuf	string	Suffix or PIN used to differentiate between two otherwise identical telephone numbers.

Table 7-97 describes the required fields for PSRDirectoryListingDeliveryLocation.

Table 7-97 Required Fields for PSRDirectoryListingDeliveryLocation

Field Name	Data Type	Field Description
dirDirectoryDeliveryId	integer	Oracle sequence uniquely identifies the delivery location information.
delRefNbr	string	Identifies the delivery address/information segment and each additional delivery address/information segment with a unique number.
delAddressType	Enum	Valid values of deliveryAddTypeEnum. Identifies a delivery address segment as being valid for hand delivery, postal delivery or both. (Represents the DATY field on the DL Form.).
endUserName	string	Recipient name for the delivery address.
houseNbrPref	string	Identifies the prefix for the house number.
houseNbr	string	Number of the street address, not including extensions such as 1/2, A, D.
streetnm	string	Name of the road of the address.
City	string	Community of the street name/house number as designated by the Master Street Address Guide, MSAG.
stateCd	string	Two-character abbreviation for the State associated with the address.
zipCd	string	Zip code of the address.

Table 7-98 describes the required fields for PSRDirectoryListingAdditionalInformation.

Table 7-98 Required Fields for PSRDirectoryListingAdditionalInformation

Field Name	Data Type	Field Description
ttyttdCd	Enum	Valid values of TTYTDDEnum. Identifies that this listing should include a special TTY or TDD phrase and which phrase should be included.
localNpaNxx	string	The telephone number being listed is not local to the service address and this column indicates the provider's local NPA NXX. Examples of when this might be used include foreign exchange numbers and ported numbers.
noSoliciationCd	Enum	Valid values of CheckBoxOptionEnum.
listedNmPlacement	Enum	Valid values of CheckBoxOptionEnum.
omitStAddr	Enum	Valid values of CheckBoxOptionEnum. Identifies if this listing is to be omitted from the street address (reverse) directory.
omitDirectMail	Enum	Valid values of CheckBoxOptionEnum. Indicates whether this listing is to be omitted from any direct mail lists.
omitTeleMktg	Enum	Valid values of CheckBoxOptionEnum. Indicates that this listing is to be omitted from any telemarketing lists.
placementOverrideCd	Enum	Valid values of OverrideCodeEnum. Identifies an override of the normal placement of business or residence listings.
profList	Enum	Valid values of CheckBoxOptionEnum. Indicates that this is a professional listing.
doNotAbbrev	Enum	Valid values of doNotAbbrevEnum. Identifies that data in specific fields must not be abbreviated.
existingAdvert	Enum	Valid values of ExistingAdvertisingEnum. Identifies the end user's directory advertising status.

Table 7-99 describes the required fields for PSRDirectoryListingDirectoryTypeSegments.

Table 7-99 Required Fields for PSRDirectoryListingDirectoryTypeSegments

Field Name	Data Type	Field Description
dirTypeCd	Enum	Valid values of DirectoryTypeEnum. Identifies the type of directory to be delivered.
dirAnnualQty	integer	Identifies the number of directories to be delivered on an annual basis.
dirNCQty	integer	Identifies the number of directories to be delivered at the time of new connection.
dirDelCd	integer	Identifies the directory code of the book to be delivered.
dirName	string	Identifies the name of the directory in which the listing is to be placed.

Table 7-100 defines AuthCDUsage.

Table 7-100 AuthCDUsage Definition

Name	Defined As	Type Description	File Name
AuthCDUsage	element	AuthCDUsageType	ServiceEntities.xsd
AuthCDUsageType	complexType	authCodeUsage	OrderManagementData.xsd
authCodeUsage	complexType	AuthCodeUsageType	OrderManagementData.xsd
AuthCodeUsageType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-101 describes the required fields for AuthCodeUsageType.

Table 7-101 Required Fields for AuthCodeUsageType

Field Name	Data Type	Field Description
authTypeCD	string	User recognizable code for the auth type being defined.
authCD	string	Actual code assigned to the service item.
Translation	string	For a verified auth code, you must enter a verbal translation which is the response to the telephone user after the user enters the verified auth code correctly.
authCDName	string	Describes who is using an auth code. This name can be used on the bill format.
fromEffectiveDateTime	CbeDateTime	The date the entity became effective.
toEffectiveDateTime	CbeDateTime	Date product became inactive. This field must be non-null. It may have a zero date value.
activityCD	Enum	Valid values of ActivityCodeEnumType. An enumerated type describing the activity for this item. Set this type to indicate how the operation processes this structure.

Table 7-102 defines huntGroup.

Table 7-102 huntGroup Definition

Name	Defined As	Type Description	File Name
huntGroup	element	HuntGroupType	ServiceEntities.xsd
HuntGroupType	complexType	huntGroupToFrom	OrderManagementData.xsd
huntGroupToFrom	element	HuntToFromType	OrderManagementData.xsd
HuntToFromType	complexType	huntToServItemKey, huntFromServItemKey	OrderManagementData.xsd
huntToServItemKey	element	MetaSolvServiceKey	OrderManagementData.xsd
huntFromServItemKey	element	MetaSolvServiceKey	OrderManagementData.xsd

Table 7-103 describes the required fields for HuntGroupType.

Table 7-103 Required Fields for HuntGroupType

Field Name	Data Type	Field Description
huntKey	integer	Unique Key that identifies a hunt group in the database.
huntType	string	Hunt Type of hunting requested.
huntName	string	Hunt Group Name
huntNumber	string	Number of members in the hunt group.
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-104 describes the required fields for HuntToFromType.

Table 7-104 Required Fields for HuntToFromType

Field Name	Data Type	Field Description
activityCd	Enum	Valid values of ActivityCodeEnumType. Activity to be performed on this item.

Table 7-105 defines lineDirectoryType.

Table 7-105 lineDirectoryType Definition

Name	Defined As	Type Description	File Name
lineDirectoryType	complexType	Contains the following: address telNbr addlInfo text	OrderManagementData.xsd
Address	element	PSRDirectoryListingAddress	OrderManagementData.xsd
PSRDirectoryListingAddress	complexType	Contains a list of fields	OrderManagementData.xsd
telNbr	element	PSRDirectoryListingTelephoneNumber	OrderManagementData.xsd
PSRDirectoryListingTelephoneNumber	complexType	Contains a list of fields	OrderManagementData.xsd
delivery	element	PSRDirectoryListingDeliveryLocation	OrderManagementData.xsd
PSRDirectoryListingDeliveryLocation	complexType	Contains a list of fields PSRDirectoryListingDirectoryTypeSegments	OrderManagementData.xsd
addlInfo	element	PSRDirectoryListingAdditionalInformation	OrderManagementData.xsd
PSRDirectoryListingAdditionalInformation	complexType	Contains a list of fields	OrderManagementData.xsd
Text	element	PSRDirectoryListingLinesOfText	OrderManagementData.xsd
PSRDirectoryListingLinesOfText	complexType	Contains a list of fields	OrderManagementData.xsd
PSRDirectoryListingDirectoryTypeSegments	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-106 describes the required fields for lineDirectoryType.

Table 7-106 Required Fields for lineDirectoryType

Field Name	Data Type	Field Description
rcdType	Enum	Valid values of RecordTypeEnum
rcdTypeArea	Enum	Valid values of RecordTypeAreaEnum
referenceNumber	string	A number that uniquely identifies a delivery location.
listingType	Enum	Valid values of ListingTypeEnum. For DSR, identifies the type of listing being submitted for the publication and directory assistance (DA) appearance rules.
styleCd	Enum	Valid values of StyleCodeEnum. Identifies if the listing is a straight line, caption header.
listAcctType	Enum	Valid values of TypeOfAccountEnum. Identifies the type of account for this listing and determines the placement of the listing in split directories and directory assistance.
degreeofIdent	Long	Identifies the degree of indention for this listing.
listedNmLineageDual	Enum	Valid values of LineageNameEnum
listedNmAddrDual	Enum	Valid values of AddressNameEnum
ALICd	string	Uniquely identifies each listing for an account number
Yphdgcd	string	Identifies the heading under which a business listing should appear in the Yellow Pages Directory.
Yphdgverbiage	string	Identifies the heading under which a business listing should appear in the Yellow Pages.
sicCode	string	Industry code to identify yellow page heading.

createOrderRequestResponse

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

Table 7-107 Payload Information for the Response

Name	Defined As	Type Description	File Name
createOrderRequestResponse	element	createOrderByValueResponse	OrderAPI.wsdl
createOrderByValueResponse	element	mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd

createPSROrderRequest Operation

This operation creates a new PSR order in the system and returns the key for the new order created. A single OrderValue is the only value passed into the request. The state values in OrderValue are ignored; the state is initialized to STARTED by the system.

The following are the request and response structures:

Request Structure: createPSROrderRequest

Response Structure: createPSROrderRequestResponse

createPSROrderRequest

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

Table 7-108 Payload Information for the Request

Name	Defined As	Type Description	File Name
createPSROrderRequest	element	createOrderByValueRequest	OrderAPI.wsdl
createOrderByValueRequest	element	Mommevalue	OrderManagementAPI.xsd
Mommevalue	element	MetaSolvOrderValueChoice	OrderManagementAPI.xsd
MetaSolvOrderValueChoice	complexType	Contains a choice of types: metaSolvPSROrderValue metaSolvISROrderValue	OrderManagementEntities.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd

createPSROrderRequestResponse

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

Table 7-109 Payload Information for the Response

Name	Defined As	Type Description	File Name
createPSROrderRequestResponse	element	createOrderByValueResponse	OrderAPI.wsdl
createOrderByValueResponse	element	mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

Table 7-110 describes the error messages for the operation.

Table 7-110 Error Messages for the Operation

Error Message	Cause	Resolution
Miscellaneous Error: Telephone Number already exists in inventory and has status of statusValue.	The telephone number you specified already exists in the database.	Provide a new telephone number.
Telephone Number already exists in inventory with a different telephone number type.	The telephone number type you specified does not match the type in the database or the telephone number already exists.	Retrieve the type for the telephone number and provide the matching type or provide a new telephone number.
Unable to copy item valueForItem to the order as the Service Item is on another open PSR Order. The Preference to Copy Pending PSR Items is set to No.	You requested a copy of a service item that is on an open PSR.	Remove the request to copy the item or change the preference for the Copy Pending PSR Items to Yes.

getCnamData Operation

This operation retrieves the Calling Name (CNAM) records. This operation provides the extract sequence for updating the Calling Name information.

The following are the request and response structures:

Request Structure: getCnamData

Response Structure: getCnamDataResponse

getCnamData

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

Table 7-111 Payload Information for the Request

Name	Defined As	Type Description	File Name
getCnamData	element	getCNAMDataRequest	OrderAPI.wsdl

getCnamDataResponse

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

Table 7-112 Payload Information for the Response

Name	Defined As	Type Descriptions	File Name
getCnamDataResponse	element	momGetCNAMDataResponse	OrderAPI.wsdl
momGetCNAMDataResponse	element	CNAMDataValue	OrderManagementAPI.xsd
CNAMDataValue	element	CNAMDataType	OrderManagementAPI.xsd
CNAMDataType	complexType	CNAMRecords	OrderManagementEntities.xsd
CNAMRecords	element	CNAMRecordType	OrderManagementEntities.xsd
CNAMRecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

getE911Data Operation

This operation retrieves the E911 records. This operation provides the extract sequence for updating the E911 information.

The following are the request and response structures:

Request Structure: getE911Data

Response Structure: getE911DataResponse

getE911Data

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

Table 7-113 Payload Information for the Request

Name	Defined As	Type Description	File Name
getE911Data	element	getE911DataRequest	OrderAPI.wsdl

getE911DataResponse

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

Table 7-114 Payload Information for the Response

Name	Defined As	Type Description	File Name
getE911DataResponse	element	momGetE911DataResponse	OrderAPI.wsdl
momGetE911DataResponse	element	e911DataValue	OrderManagementAPI.xsd
e911DataValue	element	E911DataType	OrderManagementAPI.xsd
E911DataType	complexType	e911Records	OrderManagementEntities.xsd
e911Records	element	E911RecordType	OrderManagementEntities.xsd
E911RecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

getLidbData Operation

This operation retrieves the Line Database (LIDB) records. This operation provides the extract sequence used for updating the Line Database details.

The following are the request and response structures:

Request Structure: getLidbData

Response Structure: getLidbDataResponse

getLidbData

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

Table 7-115 Payload Information for the Request

Name	Defined As	Type Description	File Name
getLidbData	element	getLIDBDataRequest	OrderAPI.wsdl

getLidbDataResponse

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

Table 7-116 Payload Information for the Response

Name	Defined As	Type Description	File Name
getLidbDataResponse	element	momGetLIDBDataResponse	OrderAPI.wsdl
momGetLIDBDataResponse	element	LIDBDataValue	OrderManagementAPI.xsd
LIDBDataValue	element	LIDBDataType	OrderManagementAPI.xsd
LIDBDataType	complexType	LIDBRecords	OrderManagementEntities.xsd
LIDBRecords	element	LIDBRecordType	OrderManagementEntities.xsd
LIDBRecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

getOrderByKey Operation

This operation retrieves the order details given an input order number (document number of the order). The output consists of order header, user data, and services information.

The following are the request and response structures:

Request Structure: getOrderByKey

Response Structure: getOrderByKeyResponse

getOrderByKey

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

Table 7-117 Payload Information for the Request

Name	Defined As	Type Description	File Name
getOrderByKey	element	momGetOrderByKeyRequest	OrderAPI.wsdl
momGetOrderByKeyRequest	element	mommekey	OrderManagementAPI.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	primaryKey	OrderManagementEntities.xsd

Table 7-118 describes the required fields for getOrderByKey.

Table 7-118 Required Fields for getOrderByKey

Field Name	Data Type	Field Description
PrimaryKey	string	Document number of the order where the details are required.

getOrderByKeyResponse

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

Table 7-119 Payload Information for the Response

Name	Defined As	Type Description	File Name
getOrderByKeyResponse	element	momGetOrderByKeyResponse	OrderAPI.wsdl
momGetOrderByKeyResponse	element	Mommevalue	OrderManagementAPI.xsd
mommevalue	element	MetaSolvOrderValueChoice	OrderManagementAPI.xsd
MetaSolvOrderValueChoice	complexType	Contains the following: metaSolvPSROrderValue metaSolvISROrderValue	OrderManagementEntities.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd
metaSolvISROrderValue	complexType	Described in Table 7-41	OrderManagementEntities.xsd

getPSROrderByTN Operation

This operation retrieves the PSR order details given the input telephone number and TN format. The output includes the order header, user data and service details.

The following are the request and response structures:

Request Structure: getPSROrderByTN

Response Structure: createPSROrderRequestResponse

getPSROrderByTN

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

Table 7-120 Payload Information for the Request

Name	Defined As	Type Description	File Name
getPSROrderByTN	element	getPSROrderByTNRequest	OrderAPI.wsdl
getPSROrderByTNRequest	element	GetPSROrderByTNRequestValue	OrderManagementAPI.xsd
GetPSROrderByTNRequestValue	element	GetPSROrderByTNRequestValueType	OrderManagementAPI.xsd
GetPSROrderByTNRequestValueType	complexType	Contains a list of fields	OrderManagementData.xsd

Table 7-121 describes the required fields for getPSROrderByTN.

Table 7-121 Required Fields for getPSROrderByTN

Field Name	Data Type	Field Description
TelephoneNbr	string	Element is used to pass the telephone number and the details are required.
TelephoneNbrFormat	string	Element is used to specify the format of the telephone number. For example in case of US format i.e NPA-NXX-LINE the format is 'xxx-xxx-xxxx'.

getPSROrderByTNResponse

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

Table 7-122 Payload Information for the Response

Name	Defined As	Type Description	File Name
getPSROrderByTNResponse	element	momGetPSROrderByTNResponse	OrderAPI.wsdl
momGetPSROrderByTNResponse	element	mommevalue	OrderManagementAPI.xsd
mommevalue	element	MetaSolvOrderValueChoice	OrderManagementAPI.xsd
MetaSolvOrderValueChoice	complexType	Contains the following: metaSolvPSROrderValue metaSolvISROrderValue	OrderManagementEntities.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd
metaSolvISROrderValue	complexType	Described in Table 7-41	OrderManagementEntities.xsd

processSuppOrderRequest Operation

This operation requests a supplement to the order. It takes in the supplement type, and order number. You have the option to reopen tasks and gateway events attached to the order.

The following are the request and response structures:

Request Structure: processSuppOrderRequest

Response Structure: assignProvPlanRequestResponse

processSuppOrderRequest

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

Table 7-123 Payload Information for the Request

Name	Defined As	Type Description	File Name
processSuppOrderRequest	element	momProcessSuppOrderRequest	OrderAPI.wsdl
momProcessSuppOrderRequest	element	ProcessSuppOrderRequestValueType	OrderManagementAPI.xsd
ProcessSuppOrderRequestValueType	complexType	orderKey	OrderManagementData.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

Table 7-124 describes the required fields for processSuppOrderRequest.

Table 7-124 Required Fields for processSuppOrderRequest

Field Name	Data Type	Field Description
suppType	Enum	Valid values of SuppTypeEnumType. This field indicates the reason that the order is being supplemented, or changed.
reopenTasksIndicator	boolean	Indicates whether the found tasks need to be re-opened for later processing.
reopenGatewayEventsIndicator	boolean	Indicates whether the found Gateway Events need to re-opened for later processing.

Table 7-125 describes the required fields for OrderKey.

Table 7-125 Required Fields for OrderKey

Field Name	Data Type	Field Description
PrimaryKey	string	Document number of the order where the details are required.

processSuppOrderRequestResponse

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

Table 7-126 Payload Information for the Response

Name	Defined As	Type Description	File Name
processSuppOrderRequestResponse	element	processSuppOrderResponse	OrderAPI.wsdl

queryOrderManagementRequest Operation

This operation retrieves the order management information for:

validateOrderQueryValue
getTaskGWEventQueryValue
getServReqTasksQueryValue
getServiceRequestDLRsValue
getDLRInfosByOrderAndServiceItemIdValue
getDLRInfosByServiceItemIdInServiceValue
getServItemReferenceValue
getServItemsValue

The following are the request and response structures:

Request Structure: queryOrderManagementRequest

Response Structure: queryOrderManagementRequestResponse

queryOrderManagementRequest

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

Table 7-127 Payload Information for the Request

Name	Defined As	Type Description	File Name
queryOrderManagementRequest	element	momQueryOrderManagementRequest	OrderAPI.wsdl
momQueryOrderManagementRequest	element	queryValue	OrderManagementAPI.xsd
queryValue	element	MetaSolvQueryValueChoice	OrderManagementAPI.xsd
MetaSolvQueryValueChoice	complexType	Contains a choice of: getTaskGWEventQueryValue getServReqTasksQueryValue getServiceRequestDLRsValue getDLRInfosByOrderAndServiceItemIdValue getDLRInfosByServiceItemIdInServiceValue getServItemReferenceValue getServItemsValue getProductCatalog getOrderStatus	OrderManagementAPI.xsd

Table 7-128 defines getTaskGWEventQueryValue.

Table 7-128 getTaskGWEventQueryValue Definition

Name

Defined As

Type Description

File Name

getTaskGWEventQueryValue

complexType

Extension of MomQueryValue

Contains the following:

orderKey
taskKey
requestId

OrderManagementAPI.xsd

orderKey

element

OrderKey

OrderManagementAPI.xsd

taskKey

element

TaskKey

OrderManagementAPI.xsd

Table 7-129 describes the required fields for getTaskGWEventQueryValue.

Table 7-129 Required Fields for getTaskGWEventQueryValue

Field Name	Data Type	Field Description
requestId	short	Request ID for get task gateway event query.

Table 7-130 describes the required fields for orderKey.

Table 7-130 Required Fields for OrderKey

Field Name	Data Type	Field Description
primaryKey	string	Document number of the order in the OrderKey type.

Table 7-131 describes the required fields for TaskKey.

Table 7-131 Required Fields for TaskKey

Field Name	Data Type	Field Description
taskPrimaryKey	string	Task number of the order.

Table 7-132 defines getServReqTasksQueryValue.

Table 7-132 getServReqTasksQueryValue Definition

Name	Defined As	Type Description	File Name
getServReqTasksQueryValue	complexType	Extension of MomQueryValue mommekey	OrderManagementAPI.xsd
mommekey	element	mommekey	OrderManagementAPI.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	element	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd

Table 7-133 describes the required fields for getServTasksQueryValue.

Table 7-133 Required Fields for getServReqTasksQueryValue

Field Name	Data Type	Field Description
timeZone	string	Time zone.

Table 7-134 defines getServiceRequestDLRsValue.

Table 7-134 getServiceRequestDLRsValue Definition

Name

Defined As

Type Description

File Name

getServiceRequestDLRsValue

element

GetServiceRequestDLRsValue

OrderManagementAPI.xsd

GetServiceRequestDLRsValue

complexType

Extension of MomQueryValue

orderKey

OrderManagementAPI.xsd

orderKey

element

OrderKey

OrderManagementAPI.xsd

Table 7-135 defines getDLRInfosByOrderAndServiceItemIdValue.

Table 7-135 getDLRInfosByOrderAndServiceItemIdValue Definition

Name

Defined As

Type Description

File Name

getDLRInfosByOrderAndServiceItemIdValue

complexType

Extension of MomQueryValue

orderKey

OrderManagementAPI.xsd

orderKey

element

OrderKey

OrderManagementAPI.xsd

Table 7-136 describes the required fields for getDLRInfosByOrderAndServiceItemIdValue.

Table 7-136 Required Fields for getDLRInfosByOrderAndServiceItemIdValue

Field Name	Data Type	Field Description
serviceItemId	long	Service item ID of the product where the DLR information is retrieved.

Table 7-137 defines getServItemReferenceValue.

Table 7-137 getServItemReferenceValue Definition

Name	Defined As	Type Definition	File Name
getServItemReferenceValue	complexType	Contains a list of fields	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd

Table 7-138 describes the required fields for getServItemReferenceValue.

Table 7-138 Required Fields for getServItemReferenceValue.

Field Name	Data Type	Field Description
serviceItemId	long	The service item ID of the product where the DLR information is retrieved.

Table 7-139 defines getProductCatalog.

Table 7-139 getProductCatalog Definition

Name	Defined As	Type Description	File Name
getProductCatalog	complexType	Contains the following: productCatalogPolicy criteria	OrderManagementAPI.xsd
productCatalogPolicy	element	productCatalogPolicy	OrderManagementAPI.xsd
criteria	element	CatalogExportCriteria	OrderManagementAPI.xsd
CatalogExportCriteria	complexType	Contains the following: specificationKey partyRoleCriteria	MIPCommonEntities.xsd
specificationKey	element	MetaSolvServiceSpecificationKey	MIPCommonEntities.xsd
MetaSolvServiceSpecificationKey	complexType	serviceSpecificationPrimaryKey	ServiceEntities.xsd

Table 7-140 defines CatalogExportCriteria.

Table 7-140 CatalogExportCriteria Definition

Name

Defined As

Type Description

File Name

CatalogExportCriteria

complexType

Contains the following:

specificationKey
partyRoleCriteria

MIPCommonEntities.xsd

specificationKey

element

MetaSolvServiceSpecificationKey

MIPCommonEntities.xsd

MetaSolvServiceSpecificationKey

complexType

serviceSpecificationPrimaryKey

ServiceEntities.xsd

Table 7-141 describes the required fields for productCatalogPolicy.

Table 7-141 Required Fields for productCatalogPolicy

Field Name	Data Type	Field Description
customAttribute	boolean	Specifies whether the custom attribute should be included with the product catalog.

Table 7-142 describes the required fields for CatalogExportCriteria.

Table 7-142 Required Fields for CatalogExportCriteria

Field Name	Data Type	Field Description
exportInd	boolean	Indicates if you only want level one products.
applicationUseCode	string	Application use code indicates which module uses the product catalog item created. If the application use code is Global the product catalog item is used by a PSR order.

Table 7-143 describes the required fields for MetaSolvServiceSpecificationKey.

Table 7-143 Required Fields for MetaSolvServiceSpecificationKey

Field Name	Data Type	Field Description
serviceSpecificationPrimaryKey	string	Product specification ID of the product

Table 7-144 defines getOrderStatus.

Table 7-144 getOrderStatus Definition

Name	Defined As	Type Description	File Name
getOrderStatus	complexType	Contains a list of fields	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd

queryOrderManagementRequestResponse

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

Table 7-145 Payload Information for the Response

Name	Defined As	Type Description	File Name
queryOrderManagementRequestResponse	element	queryOrderManagementResponse	OrderAPI.wsdl
queryOrderManagementResponse	element	queryResponse	OrderManagementAPI.xsd
queryResponse	element	MetaSolvQueryResponseChoice	OrderManagementAPI.xsd
MetaSolvQueryResponseChoice	complexType	Contains a choice of the following: getTaskGWEventQueryResponse getServReqTasksQueryResponse getDLRInfosByOrderAndServiceItemIdResponse getDLRInfosByServiceItemIdInServiceResponse getServItemReferenceResponse getServItemsResponse getProductCatalogResponse getOrderStatusResponse	OrderManagementAPI.xsd

Table 7-146 defines getTaskGWEventQueryResponse.

Table 7-146 getTaskGWEventQueryResponse Definition

Name	Defined As	Type Description	File Name
getTaskGWEventQueryResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
gWEventTypes	element	MetaSolvGatewayEventValue	OrderManagementAPI.xsd
MetaSolvGatewayEventValue	element	GatewayEventType	OrderManagementEntities.xsd
GatewayEventType	complexType	Contains a list of fields	OrderManagementEvents.xsd
gatewayEventKey	element	GatewayEventKey	OrderManagementEvents.xsd
taskKeyPredecessor	element	TaskKey	OrderManagementEvents.xsd

Table 7-147 defines GetServReqTasksQueryResponse.

Table 7-147 GetServReqTasksQueryResponse Definition

Name	Defined As	Type Description	File Name
GetServReqTasksQueryResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
predFollows	element	PredFollowType	OrderManagementAPI.xsd
PredFollowType	complexType	Contains a list of fields	OrderManagementData.xsd
taskKey	element	TaskKey	OrderManagementEvents.xsd
orderKey	element	OrderKey	OrderManagementEvents.xsd

Table 7-148 defines getDLRInfosByOrderAndServiceItemIdResponse.

Table 7-148 getDLRInfosByOrderAndServiceItemIdResponse Definition

Name	Defined As	Type Description	File Name
getDLRInfosByOrderAndServiceItemIdResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd
dlrInfos	element	DLRInfo	OrderManagementAPI.xsd
DLRInfo	complexType	Contains a list of fields	OrderManagementAPI.xsd

Table 7-149 defines getDLRInfosByServiceItemIdInServiceResponse.

Table 7-149 getDLRInfosByServiceItemIdInServiceResponse Definition

Name	Defined As	Type Description	File Name
getDLRInfosByServiceItemIdInServiceResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd
dlrInfos	element	DLRInfo	OrderManagementAPI.xsd
DLRInfo	complexType	Contains a list of fields	OrderManagementAPI.xsd

Table 7-150 defines getServItemReferenceResponse.

Table 7-150 getServItemReferenceResponse Definition

Name	Defined As	Type Description	File Name
getServItemReferenceResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd
serviceItemAlias	string	Contains a list of fields	OrderManagementAPI.xsd
numberKey	element	MetaSolvResourceKey	OrderManagementAPI.xsd

Table 7-151 defines getServItemsResponse.

Table 7-151 getServItemsResponse Definition

Name	Defined As	Type Description	File Name
getServItemsResponse	complexType	metaSolvServiceValue	OrderManagementAPI.xsd
metaSolvServiceValue	element	metaSolvServiceValue	OrderManagementAPI.xsd
metaSolvServiceValue	complexType	Contains a list of fields	ServiceEntities.xsd
serviceKey	element	MetaSolvServiceKey	ServiceEntities.xsd
parentSpecKey	element	MetaSolvServiceSpecificationKey	ServiceEntities.xsd
describingSpecificationKey	element	MetaSolvServiceSpecificationKey	ServiceEntities.xsd
parentServiceKey	element	MetaSolvServiceKey	ServiceEntities.xsd
serviceLocationKey	element	MetaSolvLocationKey	ServiceEntities.xsd
addressKey	element	MetaSolvResourceKey	ServiceEntities.xsd
ipNumberInventoryKey	element	MetaSolvResourceKey	ServiceEntities.xsd
serviceItemValues	element	ServiceItemValueType	ServiceEntities.xsd
assignedTelephoneNr	element	AssignedTelephoneNrType	ServiceEntities.xsd
Access	element	AccessType	ServiceEntities.xsd
isdnTrunkGroup	element	IsdnTrunkGroupType	ServiceEntities.xsd
trunkGroup	element	TrunkGroupType	ServiceEntities.xsd
Circuit	element	CircuitType	ServiceEntities.xsd
circuitLocation	element	CircuitLocationType	ServiceEntities.xsd
Connector	element	ConnectorType	ServiceEntities.xsd
caUsageInstance	element	CaUsageInstanceType	ServiceEntities.xsd
picInfo	element	PicInfoType	ServiceEntities.xsd
orderItemPrice	element	PSROrderItemPriceType	ServiceEntities.xsd
EmailInfo	element	EmailInfoType	ServiceEntities.xsd
DialupInfo	element	DialupInfoType	ServiceEntities.xsd
TemplateInfo	element	TemplateInfoType	ServiceEntities.xsd
ElementInfo	element	ElementInfoType	ServiceEntities.xsd
EquipmentInfo	element	EquipmentInfoType	ServiceEntities.xsd
PSRDirServ	element	PSRDirServType	ServiceEntities.xsd
PSRDirListing	element	PSRDirListingType	ServiceEntities.xsd
AuthCDUsage	element	AuthCDUsageType	ServiceEntities.xsd
huntGroup	element	HuntGroupType	ServiceEntities.xsd

Table 7-152 defines getProductCatalogResponse.

Table 7-152 getProductCatalogResponse Definition

Name	Defined As	Type Description	File Name
getProductCatalogResponse	complexType	Contains a list of fields	OrderManagementAPI.xsd
productSpecification	element	productSpecification	OrderManagementAPI.xsd
pSRSpecItemType	element	pSRSpecItemType	OrderManagementEntities.xsd
pSRSpecItemType	complexType	Contains a list of fields	OrderManagementData.xsd
specificationKey	element	MetaSolvServiceSpecificationKey	OrderManagementData.xsd
levelOneSpecKey	element	LevelOneSpecKey	OrderManagementData.xsd
parentSpecId	element	parentSpecId	OrderManagementData.xsd
Netarea	element	NetworkAreaType	OrderManagementData.xsd
Prices	element	PSRSpecItemPriceType	OrderManagementData.xsd
Labels	element	PSRDefaultValueType	OrderManagementData.xsd
levelOne	element	LevelOneUnionType	OrderManagementData.xsd
Standard	element	IndicatorEnumType	OrderManagementData.xsd
Required	element	IndicatorEnumType	OrderManagementData.xsd
global	element	IndicatorEnumType	OrderManagementData.xsd
guideInd	element	IndicatorEnumType	OrderManagementData.xsd
softProvInd	element	IndicatorEnumType	OrderManagementData.xsd
CaUsages	element	CaUsageType	OrderManagementData.xsd
partyRoles	element	PSRSpecItemPartyRoleType	OrderManagementData.xsd

Table 7-153 defines getOrderStatusResponse.

Table 7-153 getOrderStatusResponse Definition

Name	Defined As	Type Description	File Name
getOrderStatusResponse	complexType	orderStatus	OrderManagementAPI.xsd
orderStatus	element	OrderStatusEnumType	OrderManagementAPI.xsd

reopenTaskRequest Operation

This operation requests a task to be reopened. This is for a task that is already completed. This operation takes an input order number and task number.

The following are the request and response structures:

Request Structure: reopenTaskRequest

Response Structure: reopenTaskRequestResponse

reopenTaskRequest

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

Table 7-154 Payload Information for the Request

Name	Defined As	Type Description	File Name
reopenTaskRequest	element	momReopenTaskRequest	OrderAPI.wsdl
momReopenTaskRequest	element	reopenTaskValue	OrderManagementAPI.xsd
reopenTaskValue	element	ReopenTaskValueType	OrderManagementAPI.xsd
ReopenTaskValueType	complexType	Contains a list of fields	OrderManagementData.xsd
orderNumber	element	OrderKey	OrderManagementData.xsd
taskNumber	element	TaskKey	OrderManagementData.xsd

reopenTaskRequestResponse

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

Table 7-155 Payload Information for the Response

Name	Defined As	Type Description	File Name
reopenTaskRequestResponse	element	reopenTaskResponse	OrderAPI.wsdl
reopenTaskResponse	element	orderKey	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

rejectTaskRequest Operation

This operation rejects a completed predecessor task. It takes an input order number, task number, new work queue id, and reject reason.

The following are the request and response structures:

Request Structure: rejectTaskRequest

Response Structure: rejectTaskRequestResponse

rejectTaskRequest

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

Table 7-156 Payload Information for the Request

Name	Defined As	Type Description	File Name
rejectTaskRequest	element	momRejectTaskRequest	OrderAPI.wsdl
momRejectTaskRequest	element	rejectTaskValue	OrderManagementAPI.xsd
rejectTaskValue	element	RejectTaskValueType	OrderManagementAPI.xsd
RejectTaskValueType	complexType	Contains a list of fields	OrderManagementData.xsd
orderNumber	element	OrderKey	OrderManagementData.xsd
taskNumber	element	TaskKey	OrderManagementData.xsd
newWorkQueueId	element	string	OrderManagementData.xsd
rejectReason	element	string	OrderManagementData.xsd

rejectTaskRequestResponse

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

Table 7-157 Payload Information for the Response

Name	Defined As	Type Description	File Name
rejectTaskRequestResponse	element	rejectTaskResponse	OrderAPI.wsdl
rejectTaskResponse	element	orderKey	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

startOrderRequest Operation

This operation validates the order along with a finish order option request. This operation takes an input document number (order number).

The following are the request and response structures:

Request Structure: startOrderRequest

Response Structure: startOrderRequestResponse

startOrderRequest

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

Table 7-158 Payload Information for the Request

Name	Defined As	Type Description	File Name
startOrderRequest	element	startOrderByKeyRequest	OrderAPI.wsdl
startOrderByKeyRequest	element	mommekey	OrderManagementAPI.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

startOrderRequestResponse

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

Table 7-159 Payload Information for the Response

Name	Defined As	Type Description	File Name
startOrderRequestResponse	element	startOrderByKeyResponse	OrderAPI.wsdl
startOrderByKeyResponse	element	mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

Table 7-160 describes the error messages for the operation.

Table 7-160 Error Messages for the Operation

Error Message	Cause	Resolution
The Broadband Service Category is missing for this bandwidth circuit. Please add a Broadband Service Category value to this order.	This order cannot be started until the Broadband Service Category is added.	Add the Broadband Service Category to this circuit.
Error: This service item has required labels with no values. Please add values.	You have requested a start order but values are missing from a service item.	Put in values for the required labels on the service items.

TaskJeopardyRequest Operation

This operation adds task jeopardy information for the input task number.

The following are the request and response structures:

Request Structure: TaskJeopardyRequest

Response Structure: TaskRequestResponse

TaskJeopardyRequest

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

Table 7-161 Payload Information for the Request

Name	Defined As	Type Description	File Name
TaskJeopardyRequest	element	getTaskJeopardyRequest	OrderAPI.wsdl
getTaskJeopardyRequest	element	GetTaskJeopardyRequestValue	OrderManagementAPI.xsd
GetTaskJeopardyRequestValue	element	GetTaskJeopardyRequestValueType	OrderManagementAPI.xsd
GetTaskJeopardyRequestValueType	element	Contains the following: orderKey taskKey	OrderManagementData.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
taskKey	element	TaskKey	OrderManagementData.xsd

Table 7-162 describes the required fields for TaskJeopardyRequest.

Table 7-162 Required Fields for TaskJeopardyRequest

Field Name	Data Type	Field Description
circuitId	string	Circuit ID assigned to the order.
timeZone	string	Time zone.

TaskJeopardyRequestResponse

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

Table 7-163 Payload Information for the Response

Name	Defined As	Type Description	File Name
TaskJeopardyRequestResponse	element	getTaskJeopardyResponse	OrderAPI.wsdl
getTaskJeopardyResponse	element	getTaskJeopardyReponseValue	OrderManagementAPI.xsd
getTaskJeopardyReponseValue	element	GetTaskJeopardyResponseValueType	OrderManagementAPI.xsd
GetTaskJeopardyResponseValueType	complexType	Contains a list of fields	OrderManagementData.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
taskKey	element	TaskKey	OrderManagementData.xsd

TaskRequest Operation

This operation retrieves task details for the input task number and document number.

The following are the request and response structures:

Request Structure: TaskRequest

Response Structure: TaskRequestResponse

TaskRequest

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

Table 7-164 Payload Information for the Request

Name	Defined As	Type Description	File Name
TaskRequest	element	getTaskDetailRequest	OrderAPI.wsdl
getTaskDetailRequest	element	getTaskDetailValue	OrderManagementAPI.xsd
getTaskDetailValue	element	getTaskDetailRequestValueType	OrderManagementAPI.xsd
getTaskDetailRequestValueType	complexType	Contains the following: orderKey taskKey	OrderManagementData.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
taskKey	element	TaskKey	OrderManagementData.xsd

Table 7-165 describes the required fields for getTaskDetailRequestValueType.

Table 7-165 Required Fields for getTaskDetailRequestValueType

Field Name	Data Type	Field Description
timeZone	string	Time zone.

TaskRequestResponse

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

Table 7-166 Payload Information for the Response

Name	Defined As	Type Description	File Name
TaskRequestResponse	element	getTaskDetailResponse	OrderAPI.wsdl
getTaskDetailResponse	element	TaskDetailResponseValue	OrderManagementAPI.xsd
TaskDetailResponseValue	element	getTaskDetailResponseValueType	OrderManagementAPI.xsd
getTaskDetailResponseValueType	complexType	Contains a list of fields	OrderManagementData.xsd
orderKey	element	OrderKey	OrderManagementData.xsd
taskKey	element	TaskKey	OrderManagementData.xsd

transferTaskRequest Operation

This operation transfers tasks from one work queue to another work queue.

The following are the request and response structures:

Request Structure: transferTaskRequest

Response Structure: transferTaskRequestResponse

transferTaskRequest

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

Table 7-167 Payload Information for the Request

Name	Defined As	Type Description	File Name
transferTaskRequest	element	momTransferTaskRequest	OrderAPI.wsdl
momTransferTaskRequest	element	transferTaskValue	OrderManagementAPI.xsd
transferTaskValue	element	TransferTaskValueType	OrderManagementAPI.xsd
TransferTaskValueType	complexType	orderKey	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd

Table 7-168 describes the required fields for TransferTaskValueType.

Table 7-168 Required Fields for TransferTaskValueType

Field Name	Data Type	Field Description
taskNumber	long	Task that is being transferred.
currentWorkQueue	string	Work queue where a task is currently assigned.
newWorkQueue	string	Work queue where you are transferring a task.

transferTaskRequestResponse

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

Table 7-169 Payload Information for the Response

Name	Defined As	Type Description	File Name
transferTaskRequestResponse	element	transferTaskResponse	OrderAPI.wsdl
transferTaskResponse	element	orderKey	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd

Table 7-170 describes the error messages for the operation.

Table 7-170 Error Messages for the Operation

Error Message	Cause	Resolution
The Transfer TO Work Queue is an invalid work queue.	For the input task, the provided work queue to transfer the task, does not exist in the database.	Populate the transfer to work queue with a valid input value that exists in the database.

updateCnamData Operation

This operation updates the details of CNAM records.

The following are the request and response structures:

Request Structure: updateCnamData

Response Structure: updateCnamDataResponse

updateCnamData

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

Table 7-171 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateCnamData	element	updateCNAMDataRequest	OrderAPI.wsdl
updateCNAMDataRequest	element	CNAMDataValue	OrderManagementAPI.xsd
CNAMDataValue	element	CNAMDataType	OrderManagementAPI.xsd
CNAMDataType	complexType	CNAMRecords	OrderManagementEntities.xsd
CNAMRecords	element	CNAMRecordType	OrderManagementEntities.xsd
CNAMRecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

Table 7-172 describes the required fields for CNAMDataType.

Table 7-172 Required Fields for CNAMDataType

Field Name	Data Type	Field Description
extractSequence	long	Oracle-generated sequence that identifies a group of CNAM records returned from a call to getCNAMDataRequest. You must pass back the same extractSequence value for the corresponding set of extract records in the call to updateCNAMDataRequest.

Table 7-173 describes the required fields for CNAMRecordType.

Table 7-173 Required Fields for CNAMRecordType

Field Name	Data Type	Field Description
bsp	string	Billing service provider.
callingNm	string	Name that is shown on the called party's caller ID.
Line	string	Line portion of the telephone number. Valid values are a 4-digit number created using numeric characters (0-9).
Npa	string	Numbering plan area of the telephone number. Valid values are a 3-digit number created using numeric characters (0-9).
Nxx	string	Exchange portion of the telephone number. NXX is also known as the central office (CO) prefix or code. Valid values are a 3-digit number created using numeric characters (0-9).
ocn	string	Number assigned to a local exchange carrier or an interexchange carrier. This field is also referred to as the company code (CC).
presCd	CharType	Code that indicates if the name should be presented when the called party has caller ID. Valid values are ALLOW and RESTRICT.
rao	string	Revenue accounting office (RAO) associated with the NPA NXX. The RAO processes message usage in the form of automatic message accounting (AMA).
transCd	CharType	Indicates the action taken by the database provider. Valid values are ADD, MODIFY, and DELETE.
Date	string	The effective date of the CNAM update. This date field is only recorded to resolve discrepancies. Format: YYYY-MM-DD. Example: 2015-06-01.
entrySrc	CharType	Identifies the mechanism used to send information to the LIDB/CNAM database provider.

updateCnamDataResponse

The updateCnamDataResponse elementelementelement contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 7-174 describes the returned information in the response.

Table 7-174 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateCnamDataResponse	element	updateCNAMDataReponse	OrderAPI.wsdl
updateCNAMDataReponse	element	status	OrderManagementAPI.xsd

updateE911DataRequest Operation

This operation updates the status of E911 records.

The following are the request and response structures:

Request Structure: updateE911DataRequest

Response Structure: updateE911DataRequestResponse

updateE911DataRequest

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

Table 7-175 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateE911DataRequest	element	momUpdateE911DataRequest	OrderAPI.wsdl
momUpdateE911DataRequest	element	e911DataValue	OrderManagementAPI.xsd
e911DataValue	element	E911DataType	OrderManagementAPI.xsd
E911DataType	complexType	e911Records	OrderManagementEntities.xsd
e911Records	element	E911RecordType	OrderManagementEntities.xsd
E911RecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd
E911ErrorType	complexType	e911ErrorStruc	OrderAncillaryManagementData.xsd
e911ErrorStruc	element	E911ErrorStruc	OrderAncillaryManagementData.xsd
E911ErrorStruc	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

Table 7-176 describes the required fields for E911DataType.

Table 7-176 Required Fields for E911DataType

Field Name	Data Type	Field Description
extractSequence	long	Oracle-generated sequence that identifies a group of E911 records returned from a call to getE911DataRequest. You must pass back the same extractSequence value for the corresponding set of extract records in the call to updateE911DataRequest.

Table 7-177 describes the required fields for E911RecordType.

Table 7-177 Required Fields for E911RecordType

Field Name	Data Type	Field Description
Cls	CharType	Class of service.
cpd	string	Completion date (YYYY-MM-DD) .
Ctn	string	Calling telephone number.
Exd	string	Extract Date YYYY-MM-DD
Foc	CharType	Function code (function of change).
Hno	string	House number of the service location for the calling telephone number.
Nam	string	Customer name.
Ord	string	Order number.
Pcn	string	Postal community name of the service location for the calling telephone number.
Sta	string	State/province of the service location for the calling telephone number.
Stn	string	Street name of the service location for the calling telephone number.

Table 7-178 describes the required fields for E911ErrorStruc.

Table 7-178 Required Fields for E911ErrorStruc

Field Name	Data Type	Field Description
Code	integer	Error code.
Reason	string	Reason for the error.

updateE911DataRequestResponse

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

Table 7-179 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateE911DataRequestResponse	element	updateE911DataReponse	OrderAPI.wsdl
updateE911DataReponse	element	status	OrderManagementAPI.xsd

updateEstimationCompletedDateRequest Operation

This operation updates the estimated completion date for an input task. The request takes an input document number, task number and estimated completion date.

The following are the request and response structures:

Request Structure: updateEstimationCompletedDateRequest

Response Structure: updateEstimationCompletedDateRequestResponse

updateEstimationCompletedDateRequest

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

Table 7-180 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateEstimationCompletedDateRequest	element	updateEstimatedCompletionDateRequest	OrderAPI.wsdl
updateEstimatedCompletionDateRequest	element	updateEstimatedCompletionDateValue	OrderManagementAPI.xsd
updateEstimatedCompletionDateValue	element	UpdateEstimatedCompletionDateValueType	OrderManagementAPI.xsd
UpdateEstimatedCompletionDateValueType	complexType	Contains the following: orderNumber taskNumber	OrderManagementData.xsd
orderNumber	element	OrderKey	OrderManagementData.xsd
taskNumber	element	TaskKey	OrderManagementData.xsd

Table 7-181 describes the required fields for UpdateEstimatedCompletionDateValueType.

Table 7-181 Required Fields for UpdateEstimatedCompletionDateValueType

Field Name	Data Type	Field Description
timeZone	string	Time zone associated with an NPA NXX/building location.
estCompDateTime	string	Work queue owner's estimate of the task completion date and time.

updateEstimationCompletedDateRequestResponse

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

Table 7-182 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateEstimationCompletedDateRequestResponse	element	updateEstimatedCompletionDateResponse	OrderAPI.wsdl
updateEstimatedCompletionDateResponse	element	status	OrderManagementAPI.xsd

updateGWEventRequest Operation

This operation updates order management details for the following:

updateOrderTaskGWEventValue
completeTaskProcedureValue
updateOrderTaskEventProcedureValue
reopenTaskProcedureValue
updateServicesInOrderProcedureValue

The following are the request and response structures:

Request Structure: updateGWEventRequest

Response Structure: updateGWEventRequestResponse

updateGWEventRequest

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

Table 7-183 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateGWEventRequest	element	updateOrderManagementRequest	OrderAPI.wsdl
updateOrderManagementRequest	element	updateValue	OrderManagementAPI.xsd
updateValue	element	MetaSolvUpdateProcedureValueChoice	OrderManagementAPI.xsd
MetaSolvUpdateProcedureValueChoice	complexType	updateOrderTaskGWEventValue	OrderManagementAPI.xsd
updateOrderTaskGWEventValue	complexType	metaSolvGatewayEventKey	OrderManagementAPI.xsd
metaSolvGatewayEventKey	element	GatewayEventKey	OrderManagementEntities.xsd
GatewayEventKey	complexType	Contains the following: orderKey taskKey serviceKey	OrderManagementEvents.xsd
orderKey	element	OrderKey	OrderManagementEntities.xsd
taskKey	element	TaskKey	OrderManagementEntities.xsd
serviceKey	element	MetaSolvServiceKey	ServiceEntities.xsd

Table 7-184 describes the required fields for updateOrderTaskGWEventValue.

Table 7-184 Required Fields for updateOrderTaskGWEventValue

Field Name	Data Type	Field Description
statusCode	Enum	Valid values of GatewayEventStatusEnumType. Current state of the gateway event.
requestId	short	Request ID

Table 7-185 describes the required fields for serviceKey.

Table 7-185 Required Fields for serviceKey

Field Name	Data Type	Field Description
servicePrimaryKey	string	Service item ID of the product

updateGWEventRequestResponse

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

Table 7-186 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateGWEventRequestResponse	element	updateOrderTaskGWEventResponse	OrderAPI.wsdl
updateOrderTaskGWEventResponse	element	UpdateOrderTaskGWEventResponse	OrderManagementAPI.xsd
UpdateOrderTaskGWEventResponse	complexType	Extension of UpdateProcedureResponse metaSolvGatewayEventKey	OrderManagementAPI.xsd
metaSolvGatewayEventKey	element	GatewayEventKey	OrderManagementEntities.xsd
GatewayEventKey	complexType	Extension of EventKey Contains the following: orderKey taskKey serviceKey	OrderManagementEvents.xsd
EventKey	complexType	Extension of ManagedEntityKey	OrderManagementEvents.xsd
orderKey	element	OrderKey	OrderManagementEvents.xsd
taskKey	element	TaskKey	OrderManagementEvents.xsd
serviceKey	element	MetaSolvServiceKey	OrderManagementEvents.xsd

updateLidbData Operation

This operation updates the details of LIDB records.

The following are the request and response structures:

Request Structure: updateLidbData

Response Structure: updateLidbDataResponse

updateLidbData

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

Table 7-187 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateLidbData	element	updateLIDBDataRequest	OrderAPI.wsdl
updateLIDBDataRequest	element	LIDBDataValue	OrderManagementAPI.xsd
LIDBDataValue	element	LIDBDataType	OrderManagementAPI.xsd
LIDBDataType	complexType	LIDBRecords	OrderManagementEntities.xsd
LIDBRecords	element	LIDBRecordType	OrderManagementEntities.xsd
LIDBRecordType	complexType	Contains a list of fields	OrderAncillaryManagementData.xsd

Table 7-188 describes the required fields for LIDBDataType.

Table 7-188 Required Fields for LIDBDataType

Field Name	Data Type	Field Description
extractSequence	long	Oracle-generated sequence that identifies a group of LIDB records returned from a call to getLIDBDataRequest. You must pass back the same extractSequence value for the corresponding set of extract records in the call to updateLIDBDataRequest.

Table 7-189 describes the required fields for LIDBRecordType.

Table 7-189 Required Fields for LIDBRecordType

Field Name	Data Type	Field Description
bnsCd	CharType	Determines what kind of calls can be made from another telephone but billed to this number.
busResCd	CharType	Indicates the type of market that this telephone number is intended. Valid values are B = BUSINESS, R = RESIDENCE.
Line	string	Line portion of the telephone number. Valid values are a 4-digit number created using numeric characters (0-9).
Npa	string	Numbering plan area of the telephone number. Valid values are a 3-digit number created using numeric characters (0-9).
Nxx	string	Exchange portion of the telephone number. NXX is also known as the central office (CO) prefix or code. Valid values are a 3-digit number created using numeric characters (0-9).
ocn	string	Number assigned to a local exchange carrier or an interexchange carrier. This field is also referred to as the company code (CC).
servClassCd	string	Class of Service code. Valid values are BUS = Business, RES = Residential, PBC = Public Coin, PBN = Public non-coin.
transCd	CharType	Indicates the action taken by the database provider. Valid values are I = ADD, C = MODIFY, D = DELETE.
entrySrc	CharType	Field identifies the mechanism used to send information to the LIDB/CNAM database provider.
thirdNbrAcc	CharType	Third number acceptance indicator. Valid values are B = DENIED (This value prevents the PSR from go into Complete status), C = VERIFIED.
collCallAcc	CharType	Collect call acceptance indicator. Valid values are B = DENIED, A = VERIFIED.

updateLidbDataResponse

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

Table 7-190 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateLidbDataResponse	element	updateLIDBDataReponse	OrderAPI.wsdl
updateLIDBDataReponse	element	Success	OrderManagementAPI.xsd

updateOrderRequest Operation

This operation updates order management details for the following:

updateServicesInOrderProcedureValue
updateOrderTaskGWEventValue
completeTaskProcedureValue

The following are the request and response structures:

Request Structure: updateOrderRequest

Response Structure: updateOrderRequestResponse

updateOrderRequest

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

Table 7-191 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateOrderRequest	element	updateOrderManagementRequest	OrderAPI.wsdl
updateOrderManagementRequest	element	updateValue	OrderManagementAPI.xsd
updateValue	element	MetaSolvUpdateProcedureValueChoice	OrderManagementAPI.xsd
MetaSolvUpdateProcedureValueChoice	complexType	Contains the following: updateServicesInOrderProcedureValue updateOrderTaskGWEventValue completeTaskProcedureValue	OrderManagementAPI.xsd

Table 7-192 defines UpdateServicesInOrderProcedureValue.

Table 7-192 UpDateServicesInOrderProcedureValue Definition

Name	Defined As	Type Description	File Name
UpdateServicesInOrderProcedureValue	element	metaSolvPSROrderValue	OrderManagementAPI.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd

Table 7-193 defines updateOrderTaskGWEventValue.

Table 7-193 updateOrderTaskGWEventValue Definition

Name	Defined As	Type Description	File Name
updateOrderTaskGWEventValue	element	UpdateOrderTaskGWEventValue	OrderManagementAPI.xsd
UpdateOrderTaskGWEventValue	complexType	metaSolvGatewayEventKey,statusCode	OrderManagementAPI.xsd
metaSolvGatewayEventKey	element	GatewayEventKey	OrderManagementEntities.xsd
GatewayEventKey	complexType	Contains a list of fields	OrderManagementEvents.xsd

Table 7-194 defines CompleteTaskProcedureValue

Table 7-194 CompleteTaskProcedureValue Definition

Name	Defined As	File Description	File Name
CompleteTaskProcedureValue	complexType	Contains a list of fields	OrderManagementAPI.xsd
whyMissInputs	element	WhyMissInputType	OrderManagementAPI.xsd
WhyMissInputType	complexType	Contains a list of fields	OrderManagementData.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	element	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd

updateOrderRequestResponse

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

Table 7-195 updateOrderRequestResponse

Name	Defined As	Type Description	File Name
updateOrderRequestResponse	element	updateOrderManagementResponse	OrderAPI.wsdl
updateOrderManagementResponse	element	updateValueResponse	OrderManagementAPI.xsd
updateValueResponse	element	MetaSolvUpdateProcedureValueResponseChoice	OrderManagementAPI.xsd
MetaSolvUpdateProcedureValueResponseChoice	complexType	Contains the following: updateServicesInOrderProcedureResponse completeTaskProcedureResponse updateOrderTaskGWEventResponse	OrderManagementAPI.xsd
updateServicesInOrderProcedureResponse	element	UpdateServicesInOrderProcedureResponse	OrderManagementAPI.xsd
UpdateServicesInOrderProcedureResponse	complexType	Extension of UpdateProcedureResponse metaSolvOrderKey	OrderManagementAPI.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd
completeTaskProcedureResponse	element	CompleteTaskProcedureResponse	OrderManagementAPI.xsd
CompleteTaskProcedureResponse	complexType	Extension of UpdateProcedureResponse mommekey	OrderManagementAPI.xsd
mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	complexType	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd
updateOrderTaskGWEventResponse	element	UpdateOrderTaskGWEventResponse	OrderManagementAPI.xsd
UpdateOrderTaskGWEventResponse	complexType	Extension of UpdateProcedureResponse metaSolvGatewayEventKey	OrderManagementAPI.xsd
metaSolvGatewayEventKey	element	GatewayEventKey	OrderManagementEntities.xsd
GatewayEventKey	complexType	Extension of EventKey Contains the following: orderKey taskKey serviceKey	OrderManagementEvents.xsd
EventKey	complexType	Extension of ManagedEntityKey Contains a list of fields	OrderManagementEvents.xsd
orderKey	element	OrderKey	OrderManagementEvents.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd
taskKey	element	TaskKey	OrderManagementEvents.xsd
TaskKey	complexType	Contains a list of fields	OrderManagementEntities.xsd
serviceKey	element	MetaSolvServiceKey	OrderManagementEvents.xsd
MetaSolvServiceKey	complexType	Contains a list of fields	ServiceEntities.xsd

updatePSROrderRequest Operation

This operation updates order management details for the following:

updateServicesInOrderProcedureValue
updateOrderTaskGWEventValue
completeTaskProcedureValue

The following are the request and response structures:

Request Structure: updatePSROrderRequest

Response Structure: updatePSROrderRequestResponse

updatePSROrderRequest

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

Table 7-196 Payload Information for the Request

Name	Defined As	Type Description	File Name
updatePSROrderRequest	element	updateOrderManagementRequest	OrderAPI.wsdl
updateOrderManagementRequest	element	updateValue	OrderManagementAPI.xsd
updateValue	element	MetaSolvUpdateProcedureValueChoice	OrderManagementAPI.xsd
MetaSolvUpdateProcedureValueChoice	complexType	Contains the following: updateServicesInOrderProcedureValue updateOrderTaskGWEventValue completeTaskProcedureValue	OrderManagementAPI.xsd

Table 7-197 defines updateServicesInOrderProcedureValue.

Table 7-197 UpdateServicesInOrderProcedureValue

Name	Defined As	Type Description	File Name
updateServicesInOrderProcedureValue	element	metaSolvPSROrderValue	OrderManagementAPI.xsd
metaSolvPSROrderValue	complexType	Described in Table 7-36	OrderManagementEntities.xsd

Table 7-198 defines updateOrderTaskGWEventValue.

Table 7-198 updateOrderTaskGWEventValue

Name	Defined As	Type Description	File Name
updateOrderTaskGWEventValue	element	UpdateOrderTaskGWEventValue	OrderManagementAPI.xsd
UpdateOrderTaskGWEventValue	complexType	Extension of UpdateProcedureValue Contains a list of fields	OrderManagementAPI.xsd
statusCode	element	GatewayEventStatusEnumType	OrderManagementAPI.xsd
metaSolvGatewayEventKey	element	GatewayEventKey	OrderManagementEntities.xsd
GatewayEventKey	complexType	Contains a list of fields	OrderManagementEvents.xsd
EventKey	element	eventPrimaryKey	OrderManagementEvents.xsd
taskKey	element	taskKey	OrderManagementEvents.xsd
orderKey	element	taskKey	OrderManagementEvents.xsd
serviceKey	element	MetaSolvServiceKey	OrderManagementEvents.xsd

Table 7-199 defines CompleteTaskProcedureValue.

Table 7-199 CompleteTaskProcedureValue Definition

Name	Defined As	Type Description	File Name
CompleteTaskProcedureValue	complexType	Contains a list of fields	OrderManagementAPI.xsd
whyMissInputs	element	WhyMissInputType	OrderManagementAPI.xsd
WhyMissInputType	complexType	Contains a list of fields	OrderManagementData.xsd
Mommekey	element	MetaSolvOrderKeyChoice	OrderManagementAPI.xsd
MetaSolvOrderKeyChoice	element	metaSolvOrderKey	OrderManagementEntities.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEntities.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

updatePSROrderRequestResponse

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

Table 7-200 Payload Information for the Response

Name	Defined As	Type Description	File Name
updatePSROrderRequestResponse	element	updateServicesInOrderProcedureResponse	OrderAPI.wsdl
updateServicesInOrderProcedureResponse	element	UpdateServicesInOrderProcedureResponse	OrderManagementAPI.xsd
UpdateServicesInOrderProcedureResponse	complexType	Extension of UpdateProcedureResponse metaSolvOrderKey	OrderManagementAPI.xsd
metaSolvOrderKey	element	OrderKey	OrderManagementEvents.xsd
OrderKey	complexType	Contains a list of fields	OrderManagementEntities.xsd

Table 7-201 describes the error messages for the operation.

Table 7-201 Error Messages for the Operation

Error Message	Cause	Resolution
Miscellaneous Error: Telephone Number already exists in inventory and has status of statusValue.	The telephone number you specified already exists in the database.	Provide a new telephone number.
Telephone Number already exists in inventory with a different telephone number type.	The telephone number type you specified does not match the type in the database or the telephone number is invalid.	Retrieve the type for the telephone number and provide the matching type or provide a new telephone number.
Unable to copy item valueForItem to the order as the Service Item is on another open PSR Order. The Preference to Copy Pending PSR Items is set to No.	You requested a copy of a service item that is on an open PSR.	Remove the request to copy the item or change the preference for the Copy Pending PSR Items to Yes.