Inventory Web Service Reference

About the Inventory Web Service Packaging

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

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

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

Common Schemas

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

Entity Schemas

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

The Inventory entity schemas are defined in the following files:

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

Data Schemas

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

The Inventory data schemas are defined in the following files:

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

API Schemas

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

The Inventory API schemas are defined in the following files:

InventoryManagementAPI.xsd
OrderManagementAPI.xsd

auditTrailRecording Operation

This operation returns the success or failure of AuditTrail recording information.

The following are the request and response structures:

Request Structure: auditTrailRecording

Response Structure: auditTrailRecordingResponse

auditTrailRecording

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

Table 6-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
auditTrailRecording	element	queryInventoryManagementResponse	InventoryAPI.wsdl
queryInventoryManagementResponse	element	MimQueryResponse	InventoryManagementAPI.xsd
MimQueryResponse	element	MetaSolvInventoryQueryResponseChoice	InventoryManagementAPI.xsd
MetaSolvInventoryQueryResponseChoice	complexType	queryMSAGResponse This operation uses only queryMSAGResponse and not queryTelephoneNumberInventoryResponse.	InventoryManagementAPI.xsd
queryMSAGResponse	element	msagSearch	InventoryManagementAPI.xsd
msagSearch	element	MetaSolvMSAGSearch	InventoryManagementEntities.xsd
MetaSolvMSAGSearch	complexType	StructureFormatType	InventoryManagementEntities.xsd
StructureFormatType	complexType	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd

This operation only uses queryMSAGResponse and not queryTelephoneNumberInventoryResponse. Therefore, only queryMSAGResponse is defined in this operation.

Table 6-2 describes the required fields for auditTrailRecording.

Table 6-2 Required Fields for auditTrailRecording

Field Name	Data Type	Field Description
partnerId	string	Partner ID.
successOrFailure	string	Success or failure response for the operation.

Table 6-3 describes the required fields for MetaSolvMSAGSearch.

Table 6-3 Required Fields for MetaSolvMSAGSearch

Field Name	Data Type	Field Description
keyValue	string	Specifies whether the Master Street Address Guide (MSAG) information uses the NENA 2.0 standards.
partnerId	string	Partner ID.

Table 6-4 describes the required fields for StructureFormatType.

Table 6-4 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 6-5 describes the required fields for StructureFormatComponentType.

Table 6-5 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.

auditTrailRecordingResponse

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

Table 6-6 Payload Information for the Response

Name	Defined As	Type Description	File Name
auditTrailRecordingResponse	element	Contains the auditTrailRecordingResult string	InventoryAPI.wsdl

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

Table 6-7 Error Messages for the Operation

Error Messages	Cause	Resolution
Not executing the stored procedure SP_PSR_MSAG_CUSTOM_VALIDATION because the partyId is either null or is an empty string	The party ID passed on the input is either null or an empty string.	Populate a valid party ID in the input structure to get a successful output.

createEntityByValueRequest Operation

This operation creates an end user location or a network location and returns the key for the new object. This operation also creates a new inventory item using createNumberInventoryValue.

The following are the request and response structures:

Request Structure: createEntityByValueRequest

Response Structure: createEntityByValueResponse

createEntityByValueRequest

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

Table 6-8 Payload Information for the Request

Name	Defined As	Type Description	File Name
createEntityByValueRequest	element	mimCreateEntityByValueRequest	InventoryAPI.wsdl
mimCreateEntityByValueRequest	element	createEntityValue	InventoryManagementAPI.xsd
createEntityValue	element	CreateEntityValueChoice	InventoryManagementAPI.xsd
CreateEntityValueChoice	complexType	Contains the following: createPSRServiceLocationValue createNumberInventoryValue	InventoryManagementAPI.xsd
createPSRServiceLocationValue	element	CreatePSRServiceLocationValue	InventoryManagementAPI.xsd
CreatePSRServiceLocationValue	complexType	serviceLocationValue	InventoryManagementAPI.xsd
serviceLocationValue	complexType	Extension of LocationValue serviceLocationKey	InventoryManagementEntities.xsd
serviceLocationKey	element	EndUserLocationKey	InventoryManagementEntities.xsd
networkLocationKey	element	networkLocationKey	InventoryManagementEntities.xsd
networkLocationKey	element	networkLocationKey	InventoryManagementEntities.xsd
structureFormats	element	StructureFormatType	InventoryManagementEntities.xsd
StructureFormatType	complexType	Contains a list of fields	CustomerManagementData.xsd

Table 6-9 describes the required fields for serviceLocationValue.

Table 6-9 Required Fields for serviceLocationValue

Field Name	Data Type	Field Description
serviceLocationRef	integer	Reference value of Service Location.
endUserLocatoinName	string	End user location name.
servLocClliCodeTn	string	Network location with switch detail. If you select a value from the drop-down, you must enter a value in the Switch Network Area field on the End User Location Maintenance Window - Network Areas tab.
servLocClliCodeData	string	Network location that is not in one of the following categories: Customer or Non-building.
e911PayableEntity	string	Company that receives the E911 surcharge collected for a customer with E911 service.
switchedNetworkArea	integer	Switch network area associated with an end user location.
associatedNA	integer	Network areas associated with the end user location.
updateAddressMode	Enum	Valid values of UpdateModeEnumType.

Table 6-10 describes the required fields for EndUserLocationKey.

Table 6-10 Required Fields for EndUserLocationKey

Field Name	Data Type	Field Description
endUserLocationPrimaryKey	string	The end user location ID value of the end user location.

Table 6-11 describes the required fields for NetworkLocationKey.

Table 6-11 Required Fields for NetworkLocationKey

Field Name	Data Type	Field Description
networkLocationPrimaryKey	string	The network location ID value of the network location.

Table 6-12 describes the required fields for NumberInventoryValue.

Table 6-12 Required Fields for NumberInventoryValue

Field Name	Data Type	Field Description
identText	string	Logical identifier of the inventory item stored in the repository, for instance, IP Addresses and Domain Names.
identTextSuffix	string	Value that uniquely defines the Ident Text within an item type category.
userPassword	string	User password for access to the internet.
emailPassword	string	User password for access to the email box.
nIStatus	string	Specifies the status of the inventory item.
apiActivity	string	Code set by the API to pre-assign or flag Number Inventories (for instance, telephone numbers and email addresses) that are used in a subsequent API order import process. The API pre-assign process exists because of the time-lag between the assignment of the number inventory to a customer and the actual assignment of that number inventory through the API order import.
toEffectDate	CbeDateTime	Date the entity type instance became inactive.
fromEffectDate	CbeDateTime	Date the entity type instance became effective.
numberInventoryType	string	Defines the valid Number Inventory Types that can be stored in number inventory.

Table 6-13 describes the required fields for metaSolvNumberInventoryKey.

Table 6-13 Required Fields for metaSolvNumberInventoryKey

Field Name	Data Type	Field Description
numberInventoryKey	int	Foreign key to the entity NI_NBR_INV. The TEL_NUM_INV table stores all the US telephone numbers. This table is a subtype of number inventory table. This new attribute establishes a relationship between TEL_NUM_INV and the Number Inventory tables.

createEntityByValueResponse

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

Table 6-14 Payload Information for the Response

Name	Defined As	Type Definition	File Name
createEntityByValueRequestResponse	element	createEntityByValueResponse	InventoryAPI.wsdl
createEntityByValueResponse	element	createEntityValueResponse	InventoryManagementAPI.xsd
createEntityValueResponse	element	CreateEntityResponseChoice	InventoryManagementAPI.xsd
CreateEntityResponseChoice	complexType	Contains the following: createPSRServiceLocationResponse createNumberInventoryResponse	InventoryManagementAPI.xsd
createPSRServiceLocationResponse	element	CreatePSRServiceLocationRespone	InventoryManagementAPI.xsd
CreatePSRServiceLocationResponse	complexType	Contains the following: endUserLocationKey addressKey	InventoryManagementAPI.xsd
endUserLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
addressKey	element	String	InventoryManagementEntities.xsd
createNumberInventoryResponse	element	CreateNumberInventoryRespone	InventoryManagementAPI.xsd
CreateNumberInventoryRespone	complexType	metaSolvNumberInventoryKey	InventoryManagementAPI.xsd
metaSolvNumberInventoryKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd

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

Table 6-15 Error Messages for the Operation

Error Message	Cause	Resolution
Invalid Relationship: Network Area is Invalid for switch.	The input switch details do not map with network area information.	Populate the switch details which has the provided network area.
Missing Data: End User Location does not exist.	The input end user location ID does not exist in the database.	Verify the end user location ID and provide a valid value.
Missing Data: Network Location does not exist for this LocationIdSr.	The input network location ID (location_id_sr) does not exist in the database.	Please verify the network location id (location_id_sr) and provide a valid value.
Error. E-mail name is required for importing E-mail Number Inventory Item	The input email name is empty.	For creating inventory of EMAIL, you must pass the email ID.
Error. URL Domain is required for importing URL Number Inventory Item.	The input URL domain value is passed as an empty value.	For creating URL inventory, URL domain name is required in the input structure.

createLocationRequest Operation

This operation creates an end user, or network location object in the system and returns the key for the new object.

The following are the request and response structures:

Request Structure: createLocationRequest

Response Structure: createLocationRequestResponse

createLocationRequest

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

Table 6-16 Payload Information for the Request

Name	Defined As	Type Description	File Name
createLocationRequest	element	mimCreateLocationRequest	InventoryAPI.wsdl
mimCreateLocationRequest	element	locationValue	InventoryManagementAPI.xsd
locationValue	element	MimLocationValue	InventoryManagementEntities.xsd
MimLocationValue	complexType	Extension of LocationValue Contains a list of fields	InventoryManagementEntities.xsd
networkLocationValue	element	NetworkLocationValue	InventoryManagementEntities.xsd
NetworkLocationValue	complexType	NetworkLocationRelationship	InventoryManagementEntities.xsd
NetworkLocationRelationship	complexType	Contains a list of fields	InventoryManagementEntities.xsd
endUserLocationValue	element	endUserLocationValue	InventoryManagementEntities.xsd
endUserLocationValue	complexType	Contains the following: endUserLocationKey EndUserLocationAddressRange SecondaryLSO	InventoryManagementEntities.xsd
endUserLocationKey	complexType	endUserLocationPrimaryKey	InventoryManagementEntities.xsd
EndUserLocationAddressRange	complexType	Contains a list of fields	InventoryManagementEntities.xsd
SecondaryLSO	complexType	Contains a list of fields	InventoryManagementEntities.xsd
netLocAddress	element	netLocAddress	InventoryManagementEntities.xsd
netLocAddress	complexType	sfAddress	InventoryManagementEntities.xsd
sfAddress	element	StructureFormatType	InventoryManagementEntities.xsd
StructureFormatType	complexType	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd
caUsageInstance	element	CaUsageInstanceType	InventoryManagementEntities.xsd
CaUsageInstanceType	complexType	caUsageValue	OrderManagementData.xsd
caUsageValue	element	CaUsageValueType	OrderManagementData.xsd
CaUsageValueType	complexType	Contains a list of fields	OrderManagementData.xsd
metaSolvUserDataValue	element	metaSolvUserDataValue	InventoryManagementEntities.xsd
metaSolvUserDataValue	complexType	MetaSolvUserDataValueType	MIPCommonEntities.xsd
MetaSolvUserDataValueType	complexType	UserDataValueType	MIPCommonEntities.xsd
UserDataValueType	complexType	BaseNameValueType	MIPCommonEntities.xsd
tandemType	element	TandemType	InventoryManagementEntities.xsd
TandemType	complexType	Contains a list of fields	InventoryManagementEntities.xsd
associatedNetworkArea	element	AssociatedNetworkArea	InventoryManagementEntities.xsd
AssociatedNetworkArea	complexType	Contains a list of fields	InventoryManagementEntities.xsd

Table 6-17 describes the required fields for MimLocationValue.

Table 6-17 Required Fields for MimLocationValue

Field Name	Data Type	Field Description
locationType	Enum	Valid values of LocationTypeEnumType. Indicates if a location is a network location, end-user location, or both (an end-user location with a network location alias).
locationId	string	Numeric value. New location when locationId is equal to 0. If locationId ID greater then 0, then it is an update of the location.

Table 6-18 describes the required fields for NetworkLocationValue.

Table 6-18 Required Fields for NetworkLocationValue

Field Name	Data Type	Field Description
locationCodeFormat	string	Select CLLI if you use 8- to 11-character Telcordia standard code.
locationCode	string	Location identification code that identifies specific locations or terminations. This code may be free-form and user-defined, or the Common Language Location. Identification (CLLI) code administered by Telcordia.
locationName	string	Full name of the network location.
switchingOfficeClass	string	Class of a switch in a telephone network.
exchangeArea	string	The CO exchange area, or central office, related to the network location. This item is created on the CO Exchange Area window.
locationCategory	string	Class of network locations.
locationTypeId	string	Function a network location plays in supporting a network and a business.
intraNodalSwitching	boolean	Indicates a network location can provide switching functions on either a routine or an emergency basis.
emergencySwitching	boolean	Indicates the network location that can provide switching functions on an emergency basis only.
owned	boolean	Indicates you own the network location and the network location does not serve as an access customer terminal location (ACTL)/Gateway.
ACTL	boolean	Indicates the network location serves as an access customer terminal location or gateway.

Table 6-19 describes the required fields for NetworkLocationRelationship.

Table 6-19 Required Fields for NetworkLocationRelationship

Field Name	Data Type	Field Description
locationIdRel	string	Location ID rel value.
locationRelTypeCode	string	Relationship to the network location entered in the Exchange Area field on the Network Location Assistant - Physical Location Information: Classes and Functions window.
actionCode	string	Action code.

Table 6-20 describes the required fields for EndUserLocationValue.

Table 6-20 Required Fields for EndUserLocationValue

Field Name	Data Type	Field Description
endUserLocationName	string	Full name of the end user location.
endUserLocationType	string	Identifies the type of location.
e911PayableEntity	string	Company that receives the E911 surcharge collected for a customer with E911 service.
telephoneNumberSwitchLocationId	string	Sequence number that uniquely identifies a location. In this case it is the location associated with this address.
dataSwitchLocationId	string	Sequence number that uniquely identifies a location. In this case it is the location associated with this address.

Table 6-21 describes the required fields for EndUserLocationKey.

Table 6-21 Required Fields for EndUserLocationKey

Field Name	Data Type	Field Description
endUserLocationPrimaryKey	string	End user location ID value.

Table 6-22 describes the required fields for EndUserLocationAddressRange.

Table 6-22 Required Fields for EndUserLocationAddressRange

Field Name	Data Type	Field Description
fromRange	long	Starting point for a range.
toRange	long	Ending number in a range of address numbers.
numberPattern	string	Enables selection of odd or even numbering for an address number range.

Table 6-23 describes the required fields for SecondaryLSO.

Table 6-23 Required Fields for SecondaryLSO

Field Name	Data Type	Field Description
networkLocationId	string	Code for identifying a physical point in a network.
servingOfficeTypeCode	string	Type of local serving office (LSO) used for a circuit.
actionCode	string	Action code.

Table 6-24 describes the required fields forNetLocAddress.

Table 6-24 Required Fields for NetLocAddress

Field Name	Data Type	Field Description
primaryIndicator	boolean	Indicates if this record is the primary network location address and whether to display the primary address of a network location in infrastructure.
addressImpactMode	string	Address impact mode.
addressId	string	Address ID.

Table 6-25 describes the required fields for CaUsageInstanceType.

Table 6-25 Required Fields for CaUsageInstanceType

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

Table 6-26 describes the required fields for CaUsageValueType.

Table 6-26 Required Fields for CaUsageValueType

Field Name	Data Type	Field Description
caValueKey	integer	Key of valid value CA.
caValue	string	Value of a custom attribute.
caUom	string	Unit of measure, for example: meters, feet.
caUsageVvKey	integer	Key of valid value CA.

Table 6-27 describes the required fields for UserDataValueType.

Table 6-27 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 6-28 describes the required fields for BaseNameValueType.

Table 6-28 Required Fields for BaseNameValueType

Field Name	Data Type	Field Description
column	string	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: Number, Decimal, VARCHAR2, Date, Dropdown.

Table 6-29 describes the required fields for TandemType.

Table 6-29 Required Fields for TandemType

Field Name	Data Type	Field Description
tandemLocationId	string	Unique identifier for a specific location. This ID, visible only to the system, is used to store and retrieve information about the location.
tandemServiceType	string	Code that identifies the type of function performed by the tandem and whether this function is for originating (ORIG) or terminating (TERM) traffic from or to a subtending End Office.
tandemTrafficType	string	Code indicating whether the end office uses this tandem for ORIG or TERM traffic of a specific type.
actionCode	string	Action code.

Table 6-30 describes the required fields for AssociatedNetworkArea.

Table 6-30 Required Fields for AssociatedNetworkArea

Field Name	Data Type	Field Description
networkAreaId	string	Sequence number that uniquely identifies entities of this type.
Name	string	Name of the network area.
actionCode	string	Action code value.

createLocationRequestResponse

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

Table 6-31 Payload Information for the Response

Name	Defined As	Type Description	File Name
createLocationRequestResponse	element	createLocationResponse	InventoryAPI.wsdl
createLocationResponse	element	CreateLocationResponse	InventoryManagementAPI.xsd
CreateLocationResponse	complexType	networkLocationKey	InventoryManagementAPI.xsd
networkLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd

Table 6-32 describes the error messages for the operation.

Table 6-32 Error Messages for the Operation

Error Message	Cause	Resolution
Location not found.	The input network location ID does not exist.	Populate a valid network location ID in the input
The End User Location Type must be populated with a valid value (NEWARCH, PREMISE, PRILOC, or SECLOC).	The input end user location type is not valid.	Populate the end user location type with one of the valid values NEWARCH, PREMISE, PRILOC, or SECLOC.
The network area {0} cannot be a switch network area for this Location because it is not served by the specified TN Switch.	The populated network area is not served by the TN switch populated.	Populate the network area which is associated to the specified TN switch.

createNewInventoryItemRequest Operation

This operation creates a new inventory item by populating the inventory item structure.

The following are the request and response structures:

Request Structure: createNewInventoryItemRequest

Response Structure: createNewInventoryItemResponse

createNewInventoryItemRequest

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

Table 6-33 Payload Information for the Request

Name	Defined As	Type Description	File Name
createNewInventoryItemRequest	element	mimCreateNewInventoryItemRequest	InventoryAPI.wsdl
mimCreateNewInventoryItemRequest	element	inventoryItem	InventoryManagementAPI.xsd
inventoryItem	complexType	Contains the following: metaSolvNumberInventoryKey inventoryType inventorySubType inventoryStatus	InventoryManagementEntities.xsd
metaSolvNumberInventoryKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
inventoryType	complexType	Contains a list of fields	InventoryManagementData.xsd
inventorySubType	complexType	Contains a list of fields	InventoryManagementData.xsd
inventoryStatus	complexType	Contains a list of fields	InventoryManagementData.xsd

Table 6-34 describes the required fields for MetaSolvNumberInventoryKey.

Table 6-34 Required Fields for MetaSolvNumberInventoryKey

Field Name	Data Type	Field Description
numberInventoryKey	int	Number Inventory Identifier is the foreign key to the entity NI_NBR_INV. The Tel_Num_Inv table stores all the US telephone numbers. This table is a subtype of number inventory table. This new attribute establishes a relationship between Tel_Num_Inv and the Number Inventory tables.

Table 6-35 describes the required fields for inventoryType.

Table 6-35 Required Fields for inventoryType

Field Name	Data Type	Field Description
Code	Enum	Valid values of InventoryTypeCodeTypeEnum. The code that identifies the type of inventory item stored.
Alpha	string	Alpha equivalent of the Number Inventory type code.

Table 6-36 describes the required fields for InventorySubType.

Table 6-36 Required Fields for InventorySubType

Field Name	Data Type	Field Description
Code	Enum	Valid values of InventoryTypeCodeTypeEnum. The code that identifies the inventory item type subtype.
Alpha	string	Alpha equivalent of valid subtype code of inventory item type.

Table 6-37 describes the required fields for InventoryStatus.

Table 6-37 Required Fields for InventoryStatus

Field Name	Data Type	Field Description
Code	Enum	Valid values of InventoryTypeCodeTypeEnum. The code that identifies the status of the inventory item.
Alpha	string	Alpha equivalent of the Number Inventory status code Alpha Description.

createNewInventoryItemResponse

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

Table 6-38 Payload Information for the Response

Name	Defined As	Type Description	File name
createLocationRequestResponse	element	createNewInventoryItemResponse	InventoryAPI.wsdl
createLocationResponse	element	CreateLocationResponse	InventoryManagementAPI.xsd
CreateLocationResponse	complexType	networkLocationKey	InventoryManagementAPI.xsd
networkLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd

getAvailablePhysicalPortsRequest Operation

This operation retrieves the available physical port details for the provided network node key.

The following are the request and response structures:

Request Structure: getAvailablePhysicalPortsRequest

Response Structure: getAvailablePhysicalPortsRequestResponse

getAvailablePhysicalPortsRequest

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

Table 6-39 Payload Information for the Request

Name	Defined As	Type Description	File Name
getAvailablePhysiclaPortsRequest	element	mimGetAvailablePhysicalPortsRequest	InventoryAPI.wsdl
mimGetAvailablePhysicalPortsRequest	element	GetAvailablePhysicalPortsRequestValue	InventoryManagementAPI.xsd
GetAvailablePhysicalPortsRequestValue	element	getAvailablePhysicalPortsRequestValueType	InventoryManagementAPI.xsd
getAvailablePhysicalPortsRequestValueType	element	networkNodeKey	InventoryManagementData.xsd
networkNodeKey	complexType	networkNodePrimaryKey	InventoryManagementEntities.xsd

Table 6-40 describes the required fields for networkNodeKey.

Table 6-40 Required Fields for networkNodeKey

Field Name	Data Type	Field Description
networkNodePrimaryKey	string	The network node ID where the physical port details are configured.

getAvailablePhysicalPortsRequestResponse

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

Table 6-41 Payload Information for the Response

Name	Defined As	Type Description	File Name
getAvailablePhysicalPortsRequestResponse	element	getAvailablePhysicalPortsResponse	InventoryAPI.wsdl
getAvailablePhysicalPortsResponse	element	physicalPort	InventoryManagementAPI.xsd
physicalPort	complexType	Contains the following: Port hasSubPorts	InventoryManagementAPI.xsd
Port	complexType	Contains a list of fields	InventoryManagementData.xsd
equipmentKey	element	EquipmentKey	InventoryManagementData.xsd

Table 6-42 describes the error messages for the operation.

Table 6-42 Error Messages for the Operation

Error Message	Cause	Resolution
Network Node Key is required criteria.	The network node ID is not populated in the input structure.	Populate the network node ID value on the network node key.

getDlrByKeyRequest Operation

This operation retrieves the location information by using the supplied location key.

The following are the request and response structures:

Request Structure: getDlrByKeyRequest

Response Structure: getDlrByKeyRequestResponse

getDlrByKeyRequest

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

Table 6-43 Payload Information for the Request

Name	Defined As	Type Description	File Name
getDlrByKeyRequest	element	mimGetEntityByKeyRequest	InventoryAPI.wsdl
mimGetEntityByKeyRequest	element	getEntityByKeyValueChoice	InventoryManagementAPI.xsd
getEntityByKeyValueChoice	complextype	Contains the following: getPSRServiceLocationByKey getDlrByKey	InventoryManagementAPI.xsd
getPSRServiceLocationByKey	element	serviceLocationKey	InventoryManagementAPI.xsd
serviceLocationKey	complexType	endUserLocationKey	InventoryManagementEntities.xsd
endUserLocationKey	complexType	endUserLocationPrimaryKey	InventoryManagementEntities.xsd
getDlrByKey	element	metaSolvDLRKey	InventoryManagementAPI.xsd
metaSolvDLRKey	element	MetaSolvDLRKey	InventoryManagementEntities.xsd
MetaSolvDLRKey	complexType	Extension of EntityKey Contains: dlrPrimaryKey	InventoryManagementEntities.xsd
dlrPrimaryKey	complexType	DLRPrimaryKey	InventoryManagementEntities.xsd

Table 6-44 describes the required fields for endUserLocationKey.

Table 6-44 Required Fields for endUserLocationKey

Field Name	Data Type	Field Description
endUserLocationPrimaryKey	string	End user location ID of the location.

Table 6-45 describes the required fields for DLRPrimaryKey.

Table 6-45 Required Fields for DLRPrimaryKey

Field Name	Data Type	Field Description
circuitDesignIDNumber	long	Circuit design ID value for which the DLR information is required.
Issue	long	Issue number of the circuit for which the DLR is required. Zero (0) should be passed if all the issue details are required.

getDlrByKeyRequestResponse

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

Table 6-46 Payload Information for the Response

Name	Defined As	Type Description	File Name
getDlrByKeyRequestResponse	element	getEntityByKeyResponse	InventoryAPI.wsdl
getEntityByKeyResponse	element	getEntityByKeyResponseChoice	InventoryManagementAPI.xsd
getEntityByKeyResponseChoice	complexType	Contains the following: getPSRServiceLocationResponse getDlrByKeyResponse	InventoryManagementAPI.xsd
getPSRServiceLocationResponse	complexType	Contains the following: serviceLocationValue addressKey	InventoryManagementAPI.xsd
addressKey	complexType	addressPrimaryKey	InventoryManagementEntities.xsd
serviceLocationValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
serviceLocationKey	element	EndUserLocationKey	InventoryManagementEntities.xsd
networkLocationKey	element	networkLocationKey	InventoryManagementEntities.xsd
structureFormats	element	StructureFormatType	InventoryManagementEntities.xsd
getDlrByKeyResponse	element	dlrValue	InventoryManagementAPI.xsd
dlrValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
dlrKey	element	MetaSolvDLRKey	InventoryManagementEntities.xsd
dlrCircuitInfo	element	DLRCircuitInfo	InventoryManagementEntities.xsd
dlrAdminInfo	element	DLRAdminInfo	InventoryManagementEntities.xsd
dlrDesignInfo	element	DLRDesignInfo	InventoryManagementEntities.xsd
dlrEndUserInfo	element	DLREndUserInfo	InventoryManagementEntities.xsd
designLines	element	DLRDesignLine	InventoryManagementEntities.xsd
Notes	element	DLRNote	InventoryManagementEntities.xsd

Table 6-47 describes the error messages for the operation.

Table 6-47 Error Messages for the Operation

Error Message	Cause	Resolution
DLR Data Not Found for CircuitDesignId=circuitDesignIdInput Issue Number=issueNumberInput	The DLR data does not exist for the provided input values of circuit design ID and issue number.	Populate the circuit design ID and issue number with values that has DLR data existing in the database.
Circuit design id is not valid	The circuit design ID passed in the input is not valid.	Populate the circuit design ID with a value that is valid and exists in the database.
DLR for circuit issue not found	For the provided circuit design ID, the issue number does not exist.	Populate a valid issue number of the circuit design ID to get the DLR output.

getDlrByOrderKey Operation

This operation retrieves the Circuit Design (DLR) information for an input order key (document number).

The following are the request and response structures:

Request Structure: getDlrByOrderKey

Response Structure: getDlrByOrderKeyResponse

getDlrByOrderKey

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

Table 6-48 Payload Information for the Request

Name	Defined As	Type Description	File Name
getDlrByOrderKey	element	getServiceRequestDLRsValue	InventoryAPI.wsdl
getServiceRequestDLRsValue	element	GetServiceRequestDLRsValue	OrderManagementAPI.xsd
GetServiceRequestDLRsValue	complexType	Extension of MomQueryValue Contains the following: orderKey	OrderManagementAPI.xsd
orderKey	element	OrderKey	OrderManagementAPI.xsd
OrderKey	complexType	primaryKey	OrderManagementEntities.xsd

Table 6-49 describes the required fields for OrderKey.

Table 6-49 Required Fields for OrderKey

Field Name	Data Type	Field Description
primaryKey	string	Document number of the circuit for which the DLR information is required.

getDlrByOrderKeyResponse

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

Table 6-50 Payload Information for the Response

Name	Defined As	Type Description	File Name
getDlrByOrderKeyResponse	element	getServiceRequestDLRsResponse	InventoryAPI.wsdl
getServiceRequestDLRsResponse	complexType	Contains the following: orderKey dlrResults	OrderManagementAPI.xsd
orderKey	element	primaryKey	OrderManagementAPI.xsd
dlrResults	element	DLRResult	OrderManagementAPI.xsd
DLRResult	complexType	Contains a list of fields	OrderManagementAPI.xsd
dlrIssues	element	DLRIssue	OrderManagementAPI.xsd
DLRIssue	complexType	Contains a list of fields	InventoryManagementEntities.xsd

Table 6-51 describes the error messages for the operation.

Table 6-51 Error Messages for the Operation

Error Message	Cause	Resolution
Document Number is not populated.	The input value of document number is not populated.	Populate the document number with a valid value.

getEntityByKeyRequest Operation

The getEntityByKeyRequest operation provides the following:

Retrieving the PSR Service Location details.
Retrieving the DLR information.

The following are the request and response structures:

Request Structure: getEntityByKeyRequest

Response Structure: getEntityByKeyRequestResponse

getEntityByKeyRequest

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

Table 6-52 Payload Information for the Request

Name	Defined As	Type Description	File Name
getEntityByKeyRequest	element	mimGetEntityByKeyRequest	InventoryAPI.wsdl
mimGetEntityByKeyRequest	element	getEntityByKeyValueChoice	InventoryManagementAPI.xsd
getEntityByKeyValueChoice	complexType	Contains the following: getPSRServiceLocationByKey getDlrByKey	InventoryManagementAPI.xsd
getPSRServiceLocationByKey	complexType	serviceLocationKey	InventoryManagementAPI.xsd
serviceLocationKey	complexType	endUserLocationKey	InventoryManagementEntities.xsd
getDlrByKey	element	metaSolvDLRKey	InventoryManagementAPI.xsd
metaSolvDLRKey	element	MetaSolvDLRKey	InventoryManagementEntities.xsd
MetaSolvDLRKey	complexType	Extension of EntityKey Contains: dlrPrimaryKey	InventoryManagementEntities.xsd
dlrPrimaryKey	complexType	DLRPrimaryKey	InventoryManagementEntities.xsd

Table 6-53 describes the required fields for EndUserLocationKey.

Table 6-53 Required Fields for EndUserLocationKey

Field Name	Data Type	Field Description
endUserLocationPrimaryKey	string	The end user location ID value of the end user location.

Table 6-54 describes the required fields for DLRPrimaryKey.

Table 6-54 Required Fields for DLRPrimaryKey

Field Name	Data Type	Field Description
circuitDesignIDNumber	long	Circuit design ID value for which the DLR information is required.
Issue	long	Issue number of the circuit for which the DLR is required. Zero (0) should be passed if all the issue details are required.

getEntityByKeyRequestResponse

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

Table 6-55 Payload Information for the Response

Name	Defined As	Type Description	File Name
getEntityByKeyRequestResponse	element	getEntityByKeyResponse	InventoryAPI.wsdl
getEntityByKeyResponse	element	getEntityByKeyResponseChoice	InventoryManagementAPI.xsd
getEntityByKeyResponseChoice	complexType	Contains the following: getPSRServiceLocationResponse getDlrByKeyResponse	InventoryManagementAPI.xsd
getPSRServiceLocationResponse	complexType	Contains the following: serviceLocationValue addressKey	InventoryManagementAPI.xsd
addressKey	complexType	addressPrimaryKey	InventoryManagementEntities.xsd
serviceLocationValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
serviceLocationKey	element	EndUserLocationKey	InventoryManagementEntities.xsd
networkLocationKey	element	networkLocationKey	InventoryManagementEntities.xsd
structureFormats	element	StructureFormatType	InventoryManagementEntities.xsd
getDlrByKeyResponse	element	dlrValue	InventoryManagementAPI.xsd
dlrValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
dlrKey	element	MetaSolvDLRKey	InventoryManagementEntities.xsd
dlrCircuitInfo	element	DLRCircuitInfo	InventoryManagementEntities.xsd
dlrAdminInfo	element	DLRAdminInfo	InventoryManagementEntities.xsd
dlrDesignInfo	element	DLRDesignInfo	InventoryManagementEntities.xsd
dlrEndUserInfo	element	DLREndUserInfo	InventoryManagementEntities.xsd
designLines	element	DLRDesignLine	InventoryManagementEntities.xsd
Notes	element	DLRNote	InventoryManagementEntities.xsd

Table 6-56 describes the error messages for the operation.

Table 6-56 Error Messages for the Operation

Error Message	Cause	Resolution
Location data not found for Location Key	The location details does not exist for the provided location ID.	Populate the location ID which has the service location details.
Document Number is not populated.	The input value of document number is not populated.	Populate the document number with a valid value.

getIpAddressesRequest Operation

This operation retrieves IP Addresses based on the criteria specified in the request. You must specify either the network area name or network area key.

The following are the request and response structures:

Request Structure: getIpAddressesRequest

Response Structure: getIpAddressesRequestResponse

getIpAddressesRequest

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

Table 6-57 Payload Information for the Request

Name	Defined As	Type Description	File Name
getIpAddressesRequest	element	mimGetIpAddressesRequest	InventoryAPI.wsdl
mimGetIpAddressesRequest	element	GetIpAddressesRequestValue	InventoryManagementAPI.xsd
GetIpAddressesRequestValue	element	IpAddressCriteria	InventoryManagementAPI.xsd
IpAddressCriteria	complexType	Contains the following: networkArea ipAddressesValue	InventoryManagementData.xsd
networkArea	complexType	networkAreaKey	InventoryManagementEntities.xsd
networkAreaKey	complexType	networkAreaPrimaryKey	InventoryManagementEntities.xsd
ipAddressesValue	complexType	Contains a list of fields	InventoryManagementData.xsd

Table 6-58 describes the required fields for networkAreaKey.

Table 6-58 Required Fields for networkAreaKey

Field Name	Data Type	Field Description
networkAreaPrimaryKey	string	Identifier or key for the network area.

Table 6-59 describes the required fields for ipAddressesValue.

Table 6-59 Required Fields for ipAddressesValue

Field Name	Data Type	Field Description
IPaddress	string	IP address for which the details are required.
Subnet	string	Defines the portion of the IP address that is the network prefix. The remaining portion of the IP address is the host number. If not populated, then the value is defaulted to 0.
Status	Enum	Valid values of IpAddressStatusEnumType. Assignment status of the IP address. If not defined or value equal to 0, then the search ignores the status.
useGroupCode	string	Used to describe the intended use for IP addresses. If not populated, then the value is defaulted to 0. If value is 0, then the use group is ignored.
useCodeCode	string	Used with use groups to identify intended IP address usage more specifically. If not populated, then the value is defaulted to 0 and the use code is ignored.
retrivalLimit	string	Number of IP Addresses that should be returned. If not defined or value equal to 0, then all IP Addresses are returned.

getIpAddressesRequestResponse

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

Table 6-60 Payload Information for the Response

Name	Defined As	Type Description	File Name
getIpAddressesRequestResponse	element	getIpAddressesResponse	InventoryAPI.wsdl
getIpAddressesResponse	element	GetIpAddressesResponseValue	InventoryManagementAPI.xsd
GetIpAddressesResponseValue	element	IpAddressesValue	InventoryManagementAPI.xsd
IpAddressesValue	complexType	Contains a list of fields	InventoryManagementData.xsd

getLocationRequest Operation

This operation retrieves the location information for the input location key.

The following are the request and response structures:

Request Structure: getLocationRequest

Response Structure: getLocationRequestResponse

getLocationRequest

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

Table 6-61 Payload Information for the Request

Name	Defined As	Type Description	File Name
getLocationRequest	element	getLocationRequest	InventoryAPI.wsdl
getLocationRequest	element	mimGetLocationRequest	InventoryManagementAPI.xsd
mimGetLocationRequest	element	networkLocationKey	InventoryManagementAPI.xsd
networkLocationKey	complexType	networkLocationPrimaryKey	InventoryManagementEntities.xsd

getLocationRequestResponse

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

Table 6-62 Payload Information for the Response

Name	Defined As	Type Description	File Name
getLocationRequestResponse	element	getLocationResponse	InventoryAPI.wsdl
getLocationResponse	element	locationValue	InventoryManagementAPI.xsd
locationValue	element	MimLocationValue	InventoryManagementEntities.xsd
MimLocationValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
locationType	element	LocationTypeEnumType	InventoryManagementEntities.xsd
networkLocationValue	element	networkLocationValue	InventoryManagementEntities.xsd
endUserLocationValue	element	endUserLocationValue	InventoryManagementEntities.xsd
netLocAddress	element	netLocAddress	InventoryManagementEntities.xsd
caUsageInstance	element	CaUsageInstanceType	InventoryManagementEntities.xsd
metaSolvUserDataValue	element	metaSolvUserDataValue	InventoryManagementEntities.xsd
tandemType	element	TandemType	InventoryManagementEntities.xsd
associatedNetworkArea	element	AssociatedNetworkArea	InventoryManagementEntities.xsd

Table 6-63 describes the error messages for the operation.

Table 6-63 Error Messages for the Operation

Error Message	Cause	Resolution
Location data not found for Location Key	The location details do not exist for the provided location ID.	Populate the location ID with a valid value that has service location details.

getNetworkAreasByGeoAreaRequest Operation

This operation retrieves the network areas given the input geographical area criteria. You must pass the geographic area values in the order of the Geo Area Type (GAT) hierarchy defined for the country in the Utilities application. A GAT hierarchy can consist of up to seven GA types.

The following are the request and response structures:

Request Structure: getNetworkAreasByGeoAreaRequest

Response Structure: getNetworkAreasByGeoAreaRequestResponse

getNetworkAreasByGeoAreaRequest

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

Table 6-64 Payload Information for the Request

Name	Defined As	Type Description	File Name
getNetworkAreasByGeoAreaRequest	element	mimGetNetworkAreasByGeoAreaRequest	InventoryAPI.wsdl
mimGetNetworkAreasByGeoAreaRequest	element	geoAreaCriteria	InventoryManagementAPI.xsd
geoAreaCriteria	complexType	Contains a list of fields	InventoryManagementEntities.xsd

Table 6-65 describes the required fields for GeoAreaCriteria.

Table 6-65 Required Fields for GeoAreaCriteria

Field Name	Data Type	Field Description
geoAreaValue	string	Value represents the name or abbreviation of a geographic area.
isAbbreviation	boolean	Element indicates if the value defined in geoAreaValue element is abbreviated.

getNetworkAreasByGeoAreaRequestResponse

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

Table 6-66 Payload Information for the Response

Name	Defined As	Type Description	File Name
getNetworkAreasByGeoAreaRequestResponse	element	getNetworkAreasByGeoAreaResponse	InventoryAPI.wsdl
getNetworkAreasByGeoAreaResponse	element	networkArea	InventoryManagementAPI.xsd
networkArea	complexType	Contains the following: networkAreaName networkAreaKey	InventoryManagementEntities.xsd
networkAreaKey	element	networkAreaPrimaryKey	InventoryManagementEntities.xsd

Table 6-67 describes the error messages for the operation.

Table 6-67 Error Messages for the Operation

Error Message	Cause	Resolution
At least one Geographic area is required.	No geographic area details are populated in the input.	Populate any one of the geographic area details in the input.

getNetworkComponentsRequest Operation

This operation retrieves network components based on the network area, component type and component status. The operation only retrieves network elements if the schema element networkElementOnly is set to true. You must either specify the network area name or network area key.

The following are the request and response structures:

Request Structure: getNetworkComponentsRequest

Response Structure: getNetworkComponentsRequestResponse

getNetworkComponentsRequest

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

Table 6-68 Payload Information for the Request

Name	Defined As	Type Description	File Name
getNetworkComponentsRequest	element	mimGetNetworkComponentsRequest	InventoryAPI.wsdl
mimGetNetworkComponentsRequest	element	GetNetworkComponentsRequestValue	InventoryManagementAPI.xsd
GetNetworkComponentsRequestValue	element	getNetworkComponentsRequestValueType	InventoryManagementEntities.xsd
getNetworkComponentsRequestValueType	complexType	networkArea	InventoryManagementData.xsd
networkArea	element	networkArea	InventoryManagementData.xsd

Table 6-69 describes the required fields for getNetworkComponentsRequestValueType.

Table 6-69 Required Fields for getNetworkComponentsRequestValueType

Field Name	Data Type	Field Description
componentType	string	User-defined category for a network component, such as DSLAM. If populated, must be a valid component type.
componentStatus	Enum	Valid values of ComponentStatusEnumType. Status of the network component.
networkElementsOnly	boolean	Indicates that the query should return only components that are defined as network elements and are contained in a network system. If no value is passed, it defaults to false.

getNetworkComponentsRequestResponse

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

Table 6-70 Payload Information for the Response

Name	Defined As	Type Description	File Name
getNetworkComponentsRequestResponse	element	getNetworkComponentsResponse	InventoryAPI.wsdl
getNetworkComponentsResponse	element	networkComponent	InventoryManagementAPI.xsd
networkComponent	complexType	Contains a list of fields	InventoryManagementEntities.xsd
componentStatus	element	ComponentStatusEnumType	InventoryManagementEntities.xsd
componentKey	element	componentKey	N/A
componentLocationKey	element	componentLocationKey	N/A
networkNodeKey	element	networkNodeKey	N/A

Table 6-71 describes the error messages for the operation.

Table 6-71 Error Messages for the Operation

Error Message	Cause	Resolution
At least one network area is required.	No network area details are populated in the input.	Populate network area details in the input.
Network area name and network area key are not populated. Either can be populated, but both cannot be blank.	Network area name and key is not populated.	Populate with either a network area name or key or both. At least one value is required.

inventoryAssociationRequest Operation

This operation associates inventory details such as IP Address to IP Address, IP Address to Domain, and Domain to URL. You define the parent and child inventory IDs along with the type of association as input.

The following are the request and response structures:

Request Structure: inventoryAssociationRequest

Response Structure: inventoryAssociationRequestResponse

inventoryAssociationRequest

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

Table 6-72 Payload Information for the Request

Name	Defined As	Type Description	File Name
inventoryAssociationRequest	element	createInventoryAssociationRequest	InventoryAPI.wsdl
createInventoryAssociationRequest	element	importInventoryAssociationType	InventoryManagementAPI.xsd
importInventoryAssociationType	element	ImportInventoryAssociation	InventoryManagementData.xsd
ImportInventoryAssociation	complexType	Contains a list of fields	InventoryManagementData.xsd
parentInventoryID	element	MetaSolvNumberInventoryKey	InventoryManagementData.xsd
childInventoryID	element	MetaSolvNumberInventoryKey	InventoryManagementData.xsd

Table 6-73 describes the required fields for ImportInventoryAssociation.

Table 6-73 Required Fields for ImportInventoryAssociation

Field Name	Data Type	Field Description
inventoryRelationTypeCode	Enum	Valid values of InventoryRelationTypeCodeTypeEnum. Indicates the relation of the inventory items passed.

inventoryAssociationRequestResponse

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

Table 6-74 Payload Information for the Response

Name	Defined As	Type Description	File Name
inventoryAssociationRequestResponse	element	createInventoryAssociationResponse	InventoryAPI.wsdl
createInventoryAssociationResponse	complexType	Status	InventoryManagementAPI.xsd

processTNRecallRequestDocument Operation

This operation takes the input telephone number and recalls the specified telephone number.

The following are the request and response structures:

Request Structure: processTNRecallRequest

Response Structure: processTNRecallResponse

processTNRecallRequest

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

Table 6-75 Payload Information for the Request

Name	Defined As	Type Description	File Name
processTNRecallRequestDocument	element	processTNRecallRequest	InventoryAPI.wsdl
processTNRecallRequest	complexType	tn	InventoryManagementAPI.xsd

Table 6-76 describes the required fields for processTNRecallRequest.

Table 6-76 Required Fields for processTNRecallRequest

Field Name	Data Type	Field Description
tn	string	Telephone number for which the TN Recall should be invoked.

processTNRecallResponse

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

Table 6-77 Payload Information for the Response

Name	Defined As	Type Description	File Name
processTNRecallRequestDocumentResponse	element	processTNRecallResponse	InventoryManagementAPI.xsd
processTNRecallResponse	element	ProcessTNRecallResponseValue	InventoryManagementAPI.xsd
ProcessTNRecallResponseValue	complexType	ProcessTNRecallResponseValueType	InventoryManagementAPI.xsd
ProcessTNRecallResponseValueType	complexType	Contains a list of fields	InventoryManagementData.xsd

Table 6-78 describes the error messages for the operation.

Table 6-78 Error Messages for the Operation

Error Message	Cause	Resolution
Telephone Number {0} is not in the inventory	The telephone number does not exist in the inventory.	Populate the TN which exist in the inventory for RECALL.

queryEndUserLocation Operation

This operation requests end user location for specific criteria and limiting the number of records returned.

The following are the request and response structures:

Request Structure: queryEndUserLocation

Response Structure: queryEndUserLocationResponse

queryEndUserLocation

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

Table 6-79 Payload Information for the Request

Name	Defined As	Type Description	File Name
queryEndUserLocation	element	queryEndUserLocationRequest	InventoryAPI.wsdl
queryEndUserLocationRequest	complexType	queryEndUserLocationRequestValue	InventoryManagementAPI.xsd
queryEndUserLocationRequestValue	element	EndUserLocationQueryValue	InventoryManagementData.xsd
EndUserLocationQueryValue	complexType	sfAddress	InventoryManagementEntities.xsd
sfAddress	element	StructureFormatType	InventoryManagementEntities.xsd
StructureFormatType	complexType	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd

Table 6-80 describes the required fields for EndUserLocationQueryValue.

Table 6-80 Required Fields for EndUserLocationQueryValue

Field Name	Data Type	Field Description
networkLocationName	string	Name for a location.
enduserLocationName	string	Name of the end user location where the circuit is being provided.
countryId	long	Unique ID implemented with an Oracle sequence that identifies a GA instance for a structure format.
custAcctNbr	string	Customer account number.

queryEndUserLocationResponse

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

Table 6-81 Payload Information for the Response

Name	Defined As	Type Description	File Name
queryEndUserLocationResponse	element	mimQueryEndUserLocationResponse	InventoryAPI.wsdl
mimQueryEndUserLocationResponse	element	queryEndUserLocationResponseValue	InventoryManagementAPI.xsd
queryEndUserLocationResponseValue	element	EndUserLocationResultValue	InventoryManagementData.xsd
EndUserLocationResultValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd

Table 6-82 describes the error messages for the operation.

Table 6-82 Error Messages for the Operation

Error Message	Cause	Resolution
Country not found in the database.	The country passed as input does not exist in the database.	Populate the country which exists in the database.
Cannot have a structure format address and the address lines or country id populated on the same query.	Both structure format and country ID has been populated in the input.	Either one of the structured format or country ID has to be populated.

queryInventoryManagementRequest Operation

This operation retrieves the inventory for queryTelephoneNumberInventoryValue and queryMSAGInventoryValue.

The following are the request and response structures:

Request Structure: queryInventoryManagementRequest

Response Structure: queryInventoryManagementRequestResponse

queryInventoryManagementRequest

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

Table 6-83 Payload Information for the Request

Name	Defined As	Type Description	File Name
queryInventoryManagementRequest	element	mimQueryInventoryManagementRequest	InventoryAPI.wsdl
mimQueryInventoryManagementRequest	complexType	MimQueryValue	InventoryManagementAPI.xsd
MimQueryValue	element	MetaSolvInventoryQueryValueChoice	InventoryManagementAPI.xsd
MetaSolvInventoryQueryValueChoice	complexType	Contains the following: queryTelephoneNumberInventoryValue queryMSAGInventoryValue	InventoryManagementAPI.xsd
queryTelephoneNumberInventoryValue	complexType	telephoneNumberSearchCritera	InventoryManagementAPI.xsd
telephoneNumberSearchCritera	element	MetaSolvTelephoneNumberSearchCriteria	InventoryManagementEntities.xsd
MetaSolvTelephoneNumberSearchCriteria	complexType	Contains the following: strucFmt customerAccountKey statusSeq telnbrTypeCd	InventoryManagementEntities.xsd
strucFmt	element	StructureFormatType	InventoryManagementEntities.xsd
queryMSAGInventoryValue	complexType	msagSearch	InventoryManagementAPI.xsd
msagSearch	element	MetaSolvMSAGSearch	InventoryManagementEntities.xsd
MetaSolvMSAGSearch	complexType	StructureFormatType	InventoryManagementEntities.xsd
StructureFormatType	complexType	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd
customerAccountKey	complexType	customerAccountPrimaryKey	CustomerManagementEntities.xsd
statusSeq	element	TelephoneNumberStatusEnumArray	InventoryManagementEntities.xsd
TelephoneNumberStatusEnumArray	complexType	telephoneNumberStatus	InventoryManagementData.xsd
telephoneNumberStatus	element	TelephoneNumberStatusEnumType	InventoryManagementData.xsd
telnbrTypeCd	element	TelephoneNumberTypeEnumArray	InventoryManagementEntities.xsd
TelephoneNumberTypeEnumArray	complexType	telephoneNumberType	InventoryManagementData.xsd
telephoneNumberType	element	TelephoneNumberTypeEnumType	InventoryManagementData.xsd

Table 6-84 describes the required fields for MetaSolvTelephoneNumberSearchCriteria.

Table 6-84 Required Fields for MetaSolvTelephoneNumberSearchCriteria

Field Name	Data Type	Field Description
inventorySubTypeCd	int	Inventory sub type code.
locationCode	string	Location identification code that identifies specific locations or terminations.
networkAreaCity	int	Oracle sequence that uniquely identifies a GA instance for a city. It enables the ability to tie a network area to an actual city.
networkAreaStateProv	int	Oracle sequence that uniquely identifies a GA instance for a state.
networkAreaCountry	int	Oracle sequence that uniquely identifies a GA instance for a country.
tniCategoryId	int	Telephone number category ID.
tniSubcategoryId	int	Telephone number sub category ID.

Table 6-85 describes the required fields for MetaSolvMSAGSearch.

Table 6-85 Required Fields for MetaSolvMSAGSearch

Field Name	Data Type	Field Description
keyValue	string	Specifies whether the Master Street Address Guide (MSAG) information uses the NENA 2.0 standards.
partnerId	string	Partner ID.

Table 6-86 describes the required fields for StructureFormatType.

Table 6-86 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 6-87 describes the required fields for StructureFormatComponentType.

Table 6-87 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 6-88 describes the required fields for customerAccountKey.

Table 6-88 Required Fields for customerAccountKey

Field Name	Data Type	Field Description
MetaSolvCustom customerAccountPrimaryKey	string	Customer account primary key value which is the customer account number.

Table 6-89 describes the required fields for TelephoneNumberStatusEnumArray.

Table 6-89 Required Fields for TelephoneNumberStatusEnumArray

Field Name	Data Type	Field Description
telephoneNumberStatus	Enum	Valid values of TelephoneNumberStatusEnumType.

Table 6-90 describes the required fields for TelephoneNumberTypeEnumArray.

Table 6-90 Required Fields for TelephoneNumberTypeEnumArray

Field Name	Data Type	Field Description
telephoneNumberType	Enum	Valid values of TelephoneNumberTypeEnumType.

queryInventoryManagementRequestResponse

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

Table 6-91 Payload Information for the Response

Name	Defined As	Type Description	File Name
queryInventoryManagementRequestResponse	element	queryInventoryManagementResponse	InventoryAPI.wsdl
queryInventoryManagementResponse	element	MimQueryResponse	InventoryManagementAPI.xsd
MimQueryResponse	element	MetaSolvInventoryQueryResponseChoice	InventoryManagementAPI.xsd
MetaSolvInventoryQueryResponseChoice	complexType	Contains the following: queryTelephoneNumberInventoryResponse queryMSAGResponse	InventoryManagementAPI.xsd
QueryTelephoneNumberInventoryResponse	complexType	Contains the following: telephoneNumberArray checkOutId	InventoryManagementAPI.xsd
telephoneNumberArray	element	TelephoneNumberValueArray	InventoryManagementEntities.xsd
TelephoneNumberValueArray	element	item	InventoryManagementEntities.xsd
Item	element	MetaSolvTelephoneNumberValue	InventoryManagementEntities.xsd
MetaSolvTelephoneNumberValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
metaSolvNumberInventoryKey	element	metaSolvNumberInventoryKey	InventoryManagementEntities.xsd
customerAccountKey	element	MetaSolvCustomerAccountKey	InventoryManagementEntities.xsd
structureFormat	element	StructureFormatType	InventoryManagementEntities.xsd
Reservation	element	TelephoneNumberReservationType	InventoryManagementEntities.xsd
QueryMSAGResponse	complexType	Contains the following: msagAddress errorMessages	InventoryManagementAPI.xsd
msagAddress	element	MetaSolvMSAGAddress	InventoryManagementEntities.xsd
MetaSolvMSAGAddress	element	MSAGAddressType	InventoryManagementEntities.xsd
MSAGAddressType	complexType	Contains a list of fields	InventoryManagementData.xsd

Table 6-92 describes the error messages for the operation.

Table 6-92 Error Messages for the Operation

Error Message	Cause	Resolution
Status, Customer Id or Reservation is required.	Status, customer ID or reservation is not populated.	Populate either status, customer ID or reservation in the input structure.
Inventory subtype code is required.	Inventory subtype code is not populated.	Populate Inventory subtype code in the input structure.
Miscellaneous Error: No Network Preference set up.	EnableNetworkAreas preference is not set.	Enable the EnableNetworkAreas preference.

queryNetworkLocation Operation

This operation requests network locations for specific criteria and limits the number of records returned.

The following are the request and response structures:

Request Structure: queryNetworkLocation

Response Structure: queryNetworkLocationResponse

queryNetworkLocation

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

Table 6-93 Payload Information for the Request

Name	Defined As	Type Description	File Name
queryNetworkLocation	element	queryNetworkLocationRequest	InventoryAPI.wsdl
queryNetworkLocationRequest	complexType	queryNetworkLocationRequestValue	InventoryManagementAPI.xsd
queryNetworkLocationRequestValue	element	NetworkLocationQueryValue	InventoryManagementData.xsd
NetworkLocationQueryValue	complexType	sfAddress	InventoryManagementEntities.xsd
StructureFormatType	complexType	StructureFormatComponentType	CustomerManagementData.xsd
StructureFormatComponentType	complexType	Contains a list of fields	CustomerManagementData.xsd

Table 6-94 describes the required fields for NetworkLocationQueryValue.

Table 6-94 Required Fields for NetworkLocationQueryValue

Field Name	Data Type	Field Description
locationCodeFormat	long	Indicates the industry format used to create the location code.
networkLocationCode	string	Location identification code that identifies specific locations or terminations. This code may be free-form and user-defined, or the Common Language Location Identification (CLLI) code administered by Telcordia.
networkLocationName	string	Name for a location. This name often appears in the Description field of the Telcordia CLLI practice.
networkLocationTypeId	long	Unique identifier sequence number that identifies the Network Location Type.
countryId	long	Unique ID implemented with an Oracle sequence that identifies a GA instance for a structure format. This is required if the query is done using Country ID. This is not required if the search uses structure format.
version	string	Used to convert the container to the appropriate generated structure class. Currently not used and defaulted to 1.
maxRow	string	Number of End User Location that should be returned. If not defined or the value is equal to 0, then all End User Locations are returned.

queryNetworkLocationResponse

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

Table 6-95 Payload Information for the Response

Name	Defined As	Type Description	File Name
queryNetworkLocationResponse	element	mimQueryNetworkLocationResponse	InventoryAPI.wsdl
mimQueryNetworkLocationResponse	element	queryNetworkLocationResponseValue	InventoryManagementAPI.xsd
queryNetworkLocationResponseValue	element	NetworkLocationResultValue	InventoryManagementData.xsd
NetworkLocationResultValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
sfAddress	element	StructureFormatType	InventoryManagementEntities.xsd

processtnValidationRequest Operation

This operation validates an input telephone number including the additional input as criteria.

The following are the request and response structures:

Request Structure: processTNValidationRequest

Response Structure: processTNValidationResponse

processTNValidationRequest

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

Table 6-96 Payload Information for the Request

Name	Defined As	Type Description	File Name
tnValidationRequest	element	processTNValidationRequest	InventoryAPI.wsdl
processTNValidationRequest	complexType	Contains a list of fields	InventoryManagementAPI.xsd

Table 6-97 describes the required fields for processTNValidationRequest.

Table 6-97 Required Fields for processTNValidationRequest

Field Name	Data Type	Field Description
tnNumber	string	Telephone number for which the validation is required.
validationType	Enum	Valid values of TNValidationTypeEnumType.
activityType	Enum	Valid values of TNActivityTypeEnumType.
allowICP	boolean	Indicates whether to allow the ICP or not.

processTNValidationResponse

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

Table 6-98 Payload Information for the Response

Name	Defined As	Type Description	File Name
tnValidationRequestResponse	element	processTNValidationResponse	InventoryAPI.wsdl
processTNValidationResponse	complexType	ProcessTNValidationResponseValue	InventoryManagementAPI.xsd

Table 6-99 describes the error messages for the operation.

Table 6-99 Error Messages for the Operation

Error Message	Cause	Resolution
The Telephone Number is incomplete.	The populated telephone number is not complete number.	Populate a valid telephone number in the input structure.
The Telephone Number activity is invalid.	The activity populated is not valid.	Populate a valid TN activity in the input structure.

updateEntityByValueRequest Operation

This operation updates the inventory details for the following:

The attributes of the location that are populated (updatePSRServiceLocationValue)
Releases the previously reserved telephone numbers (updatePreAssignTelephoneNumberValue)

This operation only updates the attributes that are populated.

The following are the request and response structures:

Request Structure: updateEntityByValueRequest

Response Structure: updateEntityByValueRequestResponse

updateEntityByValueRequest

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

Table 6-100 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateEntityByValueRequest	element	mimUpdateEntityByValueRequest	InventoryAPI.wsdl
mimUpdateEntityByValueRequest	element	updateEntityValue	InventoryManagementAPI.xsd
updateEntityValue	element	UpdateEntityValueChoice	InventoryManagementAPI.xsd
UpdateEntityValueChoice	complexType	Contains the following: updatePSRServiceLocationValue updatePreAssignTelephoneNumberValue	InventoryManagementAPI.xsd
updatePSRServiceLocationValue	element	serviceLocationValue	InventoryManagementAPI.xsd
serviceLocationValue	complexType	Contains the following: serviceLocationKey networkLocationKey updateAddressMode structureFormats	InventoryManagementEntities.xsd
serviceLocationKey	element	EndUserLocationKey	InventoryManagementEntities.xsd
networkLocationKey	element	networkLocationKey	InventoryManagementEntities.xsd
updateAddressMode	element	UpdateModeEnumType	InventoryManagementEntities.xsd
structureFormats	element	StructureFormatType	InventoryManagementEntities.xsd
updatePreAssignTelephoneNumberValue	element	UpdatePreAssignTelephoneNumberValue	InventoryManagementAPI.xsd
UpdatePreAssignTelephoneNumberValue	complexType	preAssignTelephoneNumberValue	InventoryManagementAPI.xsd
preAssignTelephoneNumberValue	element	PreAssignTelephoneNumberValue	InventoryManagementAPI.xsd
PreAssignTelephoneNumberValue	complexType	Extension of ResourceValue Contains a list of fields and the following: metaSolvNumberInventoryKey	InventoryManagementEntities.xsd
metaSolvNumberInventoryKey	complexType	See Table 6-13.	InventoryManagementEntities.xsd

Table 6-101 describes the required fields for EndUserLocationKey.

Table 6-101 Required Fields for EndUserLocationKey

Field Name	Data Type	Field Description
endUserLocationPrimaryKey	string	The end user location ID value of the end user location.

Table 6-102 describes the required fields for NetworkLocationKey.

Table 6-102 Required Fields for NetworkLocationKey

Field Name	Data Type	Field Description
networkLocationPrimaryKey	string	The network location ID value of the network location.

Table 6-103 describes the required fields for StructureFormatType.

Table 6-103 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 6-104 describes the required fields for PreAssignTelephoneNumberValue.

Table 6-104 Required Fields for PreAssignTelephoneNumberValue

Field Name	Data Type	Field Description
inventorySubTypeCd	int	The code that identifies the inventory item type subtype.
checkOutId	int	System generated number that is set by the operation when a number is exported.
quantity	int	Number to range from the starting point.
releaseIndicator	boolean	Specifies if these telephone numbers should be released.
activityIndicator	Enum	Valid values of TelephoneNumberActivityEnumType. Activity code set by the operation to pre-assign or flag Number Inventories (for instance, telephone numbers and email addresses) that are used in a subsequent operation order import process.

updateEntityByValueRequestResponse

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

Table 6-105 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateEntityByValueRequestResponse	element	updateEntityByValueResponse	InventoryAPI.wsdl
updateEntityByValueResponse	element	updateEntityResponse	InventoryManagementAPI.xsd
updateEntityResponse	complextype	Contains the following: updatePSRServiceLocationResponse updatePreAssignTelephoneNumberResponse	InventoryManagementAPI.xsd
updatePSRServiceLocationResponse	complexType	Contains the following: locationKey addressKey	InventoryManagementAPI.xsd
locationKey	element	MetaSolvLocationKeyChoice	InventoryManagementEntities.xsd
MetaSolvLocationKeyChoice	complexType	Contains the following: serviceLocationKey endUserLocationKey networkLocationKey	InventoryManagementEntities.xsd
ServiceLocationKey	element	ServiceLocationKey	InventoryManagementEntities.xsd
ServiceLocationKey	complexType	EndUserLocationKey	InventoryManagementEntities.xsd
EndUserLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
endUserLocationKey	element	EndUserLocationKey	InventoryManagementEntities.xsd
EndUserLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
networkLocationKey	element	NetworkLocationKey	InventoryManagementEntities.xsd
NetworkLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
addressKey	element	AddressKey	InventoryManagementEntities.xsd
AddressKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd
updatePreAssignTelephoneNumberResponse	complexType	telephoneNumberArray	InventoryManagementAPI.xsd
telephoneNumberArray	element	TelephoneNumberValueArray	InventoryManagementEntities.xsd
TelephoneNumberValueArray	complexType	MetaSolvTelephoneNumberValue	InventoryManagementEntities.xsd
MetaSolvTelephoneNumberValue	complexType	Contains a list of fields	InventoryManagementEntities.xsd
metaSolvNumberInventoryKey	element	metaSolvNumberInventoryKey	InventoryManagementEntities.xsd
customerAccountKey	element	MetaSolvCustomerAccountKey	InventoryManagementEntities.xsd
structureFormat	element	StructureFormatType	InventoryManagementEntities.xsd
Reservation	element	TelephoneNumberReservationType	InventoryManagementEntities.xsd

updateLocationRequest Operation

This operation changes the attributes of a location. The operation only updates the attributes that are populated.

The following are the request and response structures:

Request Structure: updateLocationRequest

Response Structure: updateLocationRequestResponse

updateLocationRequest

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

Table 6-106 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateLocationRequest	element	updateLocationRequest	InventoryAPI.wsdl
updateLocationRequest	element	mimUpdateLocationRequest	InventoryManagementAPI.xsd
mimUpdateLocationRequest	element	locationValue	InventoryManagementAPI.xsd
locationValue	element	MimLocationValue	InventoryManagementEntities.xsd
MimLocationValue	complexType	Contains the following: NetworkLocationValue EndUserLocationValue NetLocAddress CaUsageInstanceType metaSolvUserDataValue TandemType AssociatedNetworkArea	InventoryManagementEntities.xsd
networkLocationValue	element	NetworkLocationValue	InventoryManagementEntities.xsd
endUserLocationValue	element	endUserLocationValue	InventoryManagementEntities.xsd
netLocAddress	element	netLocAddress	InventoryManagementEntities.xsd
caUsageInstance	element	CaUsageInstanceType	InventoryManagementEntities.xsd
metaSolvUserDataValue	element	metaSolvUserDataValue	InventoryManagementEntities.xsd
tandemType	element	TandemType	InventoryManagementEntities.xsd
associatedNetworkArea	element	AssociatedNetworkArea	InventoryManagementEntities.xsd

updateLocationRequestResponse

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

Table 6-107 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateLocationRequestResponse	element	updateLocationResponse	InventoryAPI.wsdl
updateLocationResponse	element	UpdateLocationResponse	InventoryManagementAPI.xsd
UpdateLocationResponse	complexType	networkLocationKey	InventoryManagementAPI.xsd
networkLocationKey	complexType	Contains a list of fields	InventoryManagementEntities.xsd

updateTNRequest Operation

This operation updates the telephone number.

The following are the request and response structures:

Request Structure: updateTNRequest

Response Structure: updateTNRequestResponse

updateTNRequest

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

Table 6-108 Payload Information for the Request

Name	Defined As	Type Description	File Name
updateTNRequest	element	mimUpdateTNRequest	InventoryAPI.wsdl
mimUpdateTNRequest	element	UpdateTNRequestValue	InventoryManagementAPI.xsd
UpdateTNRequestValue	element	MetaSolvTelephoneNumberValue	InventoryManagementData.xsd
MetaSolvTelephoneNumberValue	complexType	Contains the following: metaSolvNumberInventoryKey customerAccountKey structureFormat reservation	InventoryManagementEntities.xsd
metaSolvNumberInventoryKey	element	metaSolvNumberInventoryKey	InventoryManagementEntities.xsd
customerAccountKey	element	MetaSolvCustomerAccountKey	InventoryManagementEntities.xsd
structureFormat	element	StructureFormatType	InventoryManagementEntities.xsd
reservation	element	TelephoneNumberReservationType	InventoryManagementEntities.xsd
telephoneNumberStatus	element	TelephoneNumberStatusEnumType	InventoryManagementEntities.xsd
telephoneNumberTypeCode	element	TelephoneNumberTypeEnumType	InventoryManagementEntities.xsd

Table 6-109 describes the required fields for MetaSolvTelephoneNumberValue.

Table 6-109 Required Fields for MetaSolvTelephoneNumberValue

Field Name	Data Type	Field Description
countryCode	string	Identifies the country code for a telephone number. This is different from the postal country code on the country table. It defaults from a preference.
telephoneNumberSuf	string	Used when numbers are in high demand and limited supply. This allows for faster turn around time on reuse of a number as toll can be tracked down to this PIN.
telephoneNumberStatus	Enum	Valid values of TelephoneNumberStatusEnumType. This gives information about the state of a telephone number.
telephoneNumberTypeCode	Enum	Valid values of TelephoneNumberTypeEnumType. Determines the type of telephone number.
locationId	long	Required code for identifying a network location.

Table 6-110 defines the reservation element.

Table 6-110 reservation Definition

Name	Defined As	Type Description	File Name
reservation	element	TelephoneNumberReservationType	InventoryManagementData.xsd
TelephoneNumberReservationType	complexType	Contains the following: telephoneNumberReservationKey customerAccountKey	InventoryManagementData.xsd
TelephoneNumberReservationKey	complexType	reservationKey	InventoryManagementData.xsd
customerAccountKey	element	MetaSolvCustomerAccountKey	InventoryManagementData.xsd
MetaSolvCustomerAccountKey	complexType	customerAccountPrimaryKey	CustomerManagementEntities.xsd

Table 6-111 describes the required fields for reservation.

Table 6-111 Required Fields for reservation

Field Name	Data Type	Field Description
qtyOfWtn	int	Number of telephone numbers that are reserved on this telephone number reservation.
reservationNbr	int	Identifier of the reservation that is meaningful for the customer/user reserving the phone numbers.
reservationExpiredInd	YesNoIndicatorType	If a telephone number reservation has expired, then set this indicator to Y. The other valid value is the default N.
endUserLoc	string	Free form text area where the customer reserving the telephone numbers can indicate an end user location for which the numbers are being reserved.
reservedReason	string	Indicates why this telephone number is reserved. For example, it can be reserved because it is a vanity number, or because a customer has requested it.
requestedByName	string	Person who initiated the request for the customer, such as the salesperson.

Table 6-112 describes the required fields for TelephoneNumberReservationKey.

Table 6-112 Required Fields for TelephoneNumberReservationKey

Field Name	Data Type	Field Description
reservationKey	integer	Reservation key.

updateTNRequestResponse

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

Table 6-113 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateTNRequestResponse	element	updateTNResponse	InventoryAPI.wsdl
updateTNResponse	complexType	UpdateTNReponseValue	InventoryManagementAPI.xsd