Clarity System Connect Web Services Guide PDF

System Connect Web Services Guide
Document Version 3.0

Released –14/Feb/2011
Table of Contents
CHAPTER 1 INTRODUCTION .................................................................. 3
Error Handling ......................................................................................................... 3
Web Services Guidelines ....................................................................................... 3
CHAPTER 2 COMMON DATA TYPES ..................................................... 4
CHAPTER 3 CORPORATE MANAGER..................................................... 7
Customer Management Data Objects ........................................................................ 10
Customer Management Web Methods ...................................................................... 16
Address Management Data Objects ............................................................................ 27
Address Management Web Methods .......................................................................... 30
Area Management Data Objects .................................................................................. 38
Area Management Web Methods ................................................................................ 39
Account Management Data Objects............................................................................ 42
Account Management Web Methods.......................................................................... 45
CHAPTER 4 IDENTITY (NUMBER) MANAGER.................................... 49
Identity (Number) Management Data Objects ......................................................... 51
Identity (Number) Management Web Methods ....................................................... 61
Voice Number........................................................................................................ 61
IPv4 Number .......................................................................................................... 94
CHAPTER 5 SERVICE MANAGER ......................................................... 101
Sevice Management Data Objects .............................................................................. 103
Service Management Web Methods .......................................................................... 121
Service Provisioning API ............................................................................................... 147
CHAPTER 6 INVENTORY MANAGER .................................................. 150
Inventory Management Data Objects........................................................................ 152
Inventory Management Web Methods ..................................................................... 164
CHAPTER 7 FAULT MANAGER ............................................................ 195
Fault Management Data Objects ................................................................................ 196
Fault Management Web Methods .............................................................................. 199
APPENDIX A WSDL FILE AND SCHEMA ............................................... 214
APPENDIX B ERROR CODES .................................................................... 215
Corporate Manager ............................................................................................ 215
Identity (Number) Manager .............................................................................. 217
Service Manager ................................................................................................... 220
Configuration/Inventory Manager.................................................................... 223
Inventory Manager (Reserve Facility) ............................................................. 224
Fault Manager ....................................................................................................... 227
DOCUMENT INFORMATION .................................................................... 230
2
Chapter 1 Introduction
This document describes the Clarity web services available for integration with external system such
as an Order Management System or a Business Support System (BSS). It can be accessed from
external system or via a middleware process over a network, such as the Internet, and executed on a
remote system hosting the requested services.
This document describes the functionality of each web services (WS) and also specifies the data
elements that will be sent and received across interfaces between Clarity‟s modules and an external
system.
Error Handling
Most of the web services, when executed, will go through the process of basic validation that may
result in erroneous conditions. The erroneous conditions which may arise due to the basic validation
are enumerated for each individual web services. The list of errors is not exhaustive and more entries
may be added to the list during the integration. Every web services may raise errors which are
common to the web services of a particular module or common to all Clarity web services. The
complete list of exceptions raised by various web services is listed in the Appendix – Error Codes.
The web service may also raise Oracle specific exceptions.
For each web service call, the caller is expected to check the returned result, if available. The type
callStatus is used to encapsulate the success or failure status as well as the failure reasons.
callStatus is a composite type that contains the following fields:
Field Type Description
Code int The code field will be set to zero to indicate success, a non zero number
will indicate the type of error.
Msg string The human-readable description of the error.
codeType string Specifies the namespace of the error code (typically represents a module,
“INV” for Inventory Manager related errors).
Web Services Guidelines

The following are the general guidelines for reading this document:
 The range of input parameters is not validated for correctness unless otherwise specified. In
case the input parameter is to be one of the values in a Reference Table, the input value will
be validated against the values from the Reference Table.
 In general, NULL values are accepted for input parameters unless specified otherwise for that
specific parameter.
 In general, the uniqueness of input parameters is not checked unless specified otherwise for
that specific parameter.
3
Chapter 2 Common Data Types

Following are some of the data types defined in the common web API. The attributes of these data
types are all MANDATORY:
WSALIAS
Attribute Value
aliasID STRING (maximum 40 characters)
domain STRING (maximum 40 characters)
WSATTRIBUTE
Attribute Value
name STRING (maximum 100 characters)
value STRING (maximum 1000 characters)
WSTYPEDATTRIBUTE
Attribute Value
name STRING (maximum 100 characters)
value STRING (maximum 1000 characters)
type STRING (maximum 20 characters)
WSENTITY
Attribute Value
entityID STRING (maximum 100 characters)
entityType STRING (maximum 100 characters)
WSCOMMENT
Attribute Value
createdby STRING (maximum 20 characters)
timestamp DATE
commentText STRING (maximum 1000 characters)
WSFEATURE
An object type that groups a feature, Its list of attribute values and the action to be taken on a single
entity.
4
Attribute Value
parent STRING (Maximum 400 characters)
action STRING (Maximum 20 characters)
featureName STRING (Maximum 20 characters)
attributes wsAttribute
RETURNSTATUS
Contains information about a web service call status: success or failure as well as the failure reasons.
Attribute Value
code LONG
codeType STRING (Maximum 400 characters)
message STRING (Maximum 40 characters)
details STRING
COMMONRESULT
An object that represents a generic return of a web service call.
Attribute Value
callStatus returnStatus
ATTRIBUTERESULT
Attribute Value
Attributes wsAttribute
returnStatus returnStatus
NUMBERRESULT
Attribute Value
ID LONG
NUMBERLISTRESULT
Attribute Value
ID LONG
5
STRINGLISTRESULT
Attribute Value
ID STRING
6
Chapter 3 Corporate Manager
Summary of Corporate Management Web Methods and Data Objects available in this document.
Web Methods Data Objects
Customer Management
createCustomer createCustomerResult
updateCustomer updateCustomerResult
deleteCustomer deleteCustomerResult
getCustomerID getCustomerIDResult
getCustomerDetails getCustomerDetailsResult
createContactPoint getContactPointIDResult
deleteContactPoint returnStatus
updateContactPoint returnStatus
getContactPointID getContactPointIDResult
getFullContactPoints getFullContactPointsResult
getAgentAvailable getAgentAvailableResult
reserveAgentTimeslot reserveAgentTimeSlotResult
addContact returnStatus
deleteContact returnStatus
setAddressCustomerID returnStatus
Address Management
createAddress createAddressResult
updateAddress updateAddressResult
addressExists addressExistsResult
addressExistsCRServiceability addressExistsResult
getAddress getAddressResult
getAddressID getAddressIDResult
getAddressByAlias getAddressByAliasResult
createAddressServiceability createAddressServiceabiltyResult
getAddressList addressListResult
7
Area Management
getAreaForServiceNoRelocate areaForServiceNoRelocateResult
getAreaForServiceNumber getAreaForServiceNumberResult
getExchangeArea getAreaForServiceNumberResult
getChildAreaCodes getChildAreaCodesResult
Account Management
createAccount createAccountResult
updateAccount updateAccountResult
getAccountID getAccountIDResult
createAccountManager createAccountManagerResult
getAccountManagerID getAccountManagerIDResult
updateAccountManager returnStatus
8
Generic Data Objects
This section lists the data objects used by the Corporate Manager web services.
COMMON BUSINESS OBJECTS

The following are the generic objects used by the Corporate Manager web services.
 ReturnStatus
 CommonResult
 AppConstant
 wsAttribute
WSALIAS
A data object that containing alias (alternate name).
Attribute Value Description
aliasID STRING (maximum 40 An alias (alternate name). NULL

characters) allowed.
domain STRING (maximum 40 The domain.

characters)
WSATTRIBUTE
A data object that containing additional information.
name STRING An attribute name.

(maximum 240
characters)
value STRING Value of an attribute.

(maximum 1000
characters)
Note
The following relationships exist within the Corporate Manager data:
 Customer:
o A customer must have exactly one customer type
o A customer must have exactly one status
o A customer may have zero or more locations
o A customer may have zero or more contact points
o A customer may have zero or more accounts
 Accounts
o An account must have exactly one account ID (Number)
o An account must have exactly one account status
o An account must belong to exactly one customer
 Addresses
o An address must have exactly one address ID
9
o An address may have zero or more contact points

o An address may have zero or more billing accounts
 Locations
o A location must have exactly one location type
o A location may have zero or more customers
 Contact point:
o A contact point has exactly one contact type
o A contact point may be assigned to : a location and/or customer and/or account and/or
address
o A contact point may have zero or more contact persons
 Contact person
o A contact person is for exactly one contact point
Customer Management Data Objects

This section explains the specific data objects used by the Customer Management web services.
WSCUSTOMERDETAIL
A data object that containing details about a customer.
id STRING Optional. This is the unique identifier for

(maximum 15 the customer. The customer id is also known
characters) as Customer Abbreviation. If the id is not
entered by the user, the system will
automatically generate one using the customer
name. The customer ID is converted to upper
case before it is stored in the database
regardless of whether it was supplied or
generated.
name STRING Mandatory. The name of the customer.

(maximum 80
characters)
type STRING Optional. The type of customer. If no value

(maximum 30 is provided, it will be automatically set to
characters) OTHER.
status STRING Optional. The current status of the customer.

(maximum 30 If the user does not define a value, it will
characters) be set to ACTIVE.
marketseg STRING Optional. The market segment of the customer

(maximum 5 determined based on pre-defined market
characters) segments.
comments STRING Optional. This is a free text field. If no

(maximum 2000 comments are entered, the system will
characters) automatically populate the field with the
text Active.
attributes wsAttribute Optional. An array of wsAttribute.

Supplementary data about the customer. NULL
is allowed. The allowed customer attributes
10
are: External Customer Reference, Mega
Identifier, Industry Code, ACN, and Created
Date.
Note
The customerID may be specified, or it can be automatically generated by using the first 7 characters
of the customer name and appending an 8-digit number to make it unique. The reason that the
customer ID can be specified is that the ID is used as a display field in many applications, so it is often
desirable to provide a recognizable ID. The customer ID is converted to upper case before it is stored.
This is for both auto-generated IDs and user supplied IDs. If an external system uses case-sensitive
names, it should use the customerAlias fields to associate other alternate names with the customer.
CREATECUSTOMERRESULT
An object represents the result of web service call createCustomer.
customerDetail wsCustomerDetail Mandatory. An instance of the

wsCustomerDetail objects data type. This
is a Unique Identifier and it may be
derived from the CRM system or calculated
in Clarity based on interface agreement.
returnStatus returnStatus Return the status of the web service

call.
UPDATECUSTOMERRESULT
An object represents the result of web service call updateCustomer.
returnStatus returnStatus Return the status of the web service call.
DELETECUSTOMERRESULT
An object represents the result of web service call deleteCustomer.
GETCUSTOMERIDRESULT
An object represents the result of web service call getCustomerID.
customerID STRING This is the unique identifier for the

customer. The customer id is also known as
Customer Abbreviation. If the id is not
entered by the user, the system will
automatically generate one using the customer
name. The customer ID is converted to upper
case before it is stored in the database
11
regardless of whether it was supplied or

generated.
GETCUSTOMERDETAILSRESULT
An object represents the result of web service call getCustomerDetails.
myCustomerDetail wsCustomerDetail Details of a customer

call
WSCONTACT
An object represents the result of web service call addContact.
contactName STRING Customer contact name.

(maximum 40
characters)
contactClassification STRING Customer contact classification.

(maximum 20
characters)
WSFULLCONTACTPOINT
An object represents the result of web method getFullContactPointsResult.
contactName STRING The name of the contact.

(maximum 40
characters)
contactClassification STRING The classification of the contact.

(maximum 20
characters)
contactPointID LONG This is a unique identifier for the

contact point. It is internally
generated and cannot be specified
when defining a contact. If the user
enters a value, it will be
neglected.
locationID LONG A location ID for selecting location

based contact points.
customer STRING A customer abbreviation for

(maximum 15 selecting customer based contact
characters) points.
accountNumber STRING An account ID for selecting account

(maximum 20
12
characters) based contact points.
contactPointType STRING The type of contact i.e. phone,

(maximum 15 email, mobile.
characters)
contactNumber STRING The number (or email address) for

(maximum 50 this contact point.
characters)
hours STRING The hours (availability) for this

(maximum 30 contact point.
characters)
usage STRING The usage for this contact point.

(maximum 20
characters)
addressId LONG The address ID for this contact

point.
CLARITYALIAS
A data object that containing alias information.
aliasId STRING An alias (alternate name) to the Contact

Point. NULL allowed.
domain STRING The domain to the Contact Point.
CLARITYATTRIBUTE
An object represents the result of web method clarityContactPoint.
attributeName STRING An attribute name.

(maximum 240
charaters)
attributeValue STRING Value of an attribute.

(maximum
1000
characters)
CLARITYCONTACT
An object represents the result of web method clarityContactPoint.
contactName STRING Customer contact name.

(maximum 40
characters)
contactClassification STRING Customer contact classification.

(maximum 20
13
characters)
CLARITYCONTACTPOINT
An object represents the result of web service call createContactPoint.
contactPointID LONG Optional. This is an Implementation

controlled attribute and is a unique
identifier for the contact point. It
is internally generated and cannot be
specified when defining a contact. If
the user enters a value, it will be
neglected.
customerId STRING (maximum Optional. Unique identifier for

15 characters) Customer. NULL allowed.
accountID STRING (maximum Optional. Unique identifier for

10 characters) Customer. NULL allowed.
locationID LONG Optional. Unique identifier for

Location. NULL allowed.
addressID LONG Optional. Unique identifier for

Address. NULL allowed.
contactPointType STRING (maximum Mandatory. A reference to a contact

15 characters) type record. A contact type defines
the mechanism for contacting the
contact point, e.g. phone, fax, email,
modem, etc.
contactNumber STRING (maximum Mandatory. The contact phone number,

50 characters) email address, etc. This field would
be interpreted relative to the "type"
field.
clarityContacts clarityContact Optional. A list of contacts to be

associated with this Contact Point.
NULL allowed.
clarityAttributes clarityAttribute An array of wsAttribute.Supplementary

data about contactPoint. Allowed
contactPoint attributes are: Hours;
and Usage.Valid attributename(s) for
contactPointAttributes
HOURS MANDATORY
USAGE OPTIONAL
GETCONTACTPOINTIDRESULT
An object represents the result of web service call getContactPointID.
14
contactPointID LONG This is an Implementation controlled
attribute and is a unique identifier for the
contact point. It is internally generated
and cannot be specified when defining a
contact. If the user enters a value, it will
be neglected.
GETFULLCONTACTPOINTSRESULT
An object represents the result of web service call getFullContactPoints.
contactPointsList wsFullContactPoint List of contact point.

call.
CLARITYAGENTAVAILABLEESULT
An object represents the result of web method getAgentAvailableResult.
availableID LONG The agent availability ID.
availableStartDate DATE The agent available start date.
jobDuration LONG The job duration.
attributesList ClarityAttribute An array of clarityAttribute.
GETAGENTAVAILABLERESULT
An object represents the result of web service call getAgentAvailable.
agentAvailableList ClarityAgentAvailable List of agent availability.
returnStatus returnStatus Return the status of the web

service call.
RESERVEAGENTTIMESLOTRESULT
An object represents the result of web service call reserveAgentTimeslot.
jobTicketId LONG Job ticket ID.
15
Customer Management Web Methods

This section explains the Customer Management web services in detail.
CREATECUSTOMER
Purpose
This web service is used to create a new customer record.
Input Parameters
Name Type Comment
custDetail wsCustomerDetail Mandatory. An instance of the

wsCustomerDetail objects data
type. This is a Unique Identifier
and it may be derived from the
CRM system or calculated in
Clarity based on interface
agreement.
customAlias wsAlias Can be used to add an alias

(alternate name) to a customer.
NULL allowed.
locId DOUBLE A location for the customer. NULL

allowed.
Returns
Type Comment
createCustomerResult Returned result for the web service call
containing the following information:
An instance of the CustomerDetail object data
type
The result of the web service call.
Error Conditions
Code
Invalid Customer Type
Invalid Market Segment
Invalid Customer Status
Customer Identifier already used
16
UPDATECUSTOMER
Purpose
This web service is used to update the details of a customer record.
Input Parameters
Name Type Comment
customAlias wsAlias Can be used to search using an

alias (alternate name) to a
customer. NULL allowed if the
theCustomer object has customerID
specified. Customer Alias and
CustomerID cannot be both NULL.
One of them must be provided to
identify the customer record.
custDetail wsCustomerDetail Mandatory. An instance of the

wsCustomerDetail objects data
type. This is a Unique Identifier
and it may be derived from the
CRM system or calculated in
Clarity based on interface
agreement.
Returns
Type Comment
updateCustomerResult Returned result for the web service call
Error Conditions
Code
Invalid Customer Type
Invalid Customer Status
17
DELETECUSTOMER
Purpose
This web service deletes an existing customer record. Account records that are only associated with
the deleted customer will also be deleted.
Input Parameters
Name Type Comment
customerId STRING The customer ID to be deleted.
Returns
Type Comment
deleteCustomerResult Returned result for the webservice call
containing the following detail:
Error Conditions
Code
Invalid Customer ID
GETCUSTOMERID
Purpose
This web service identifies the Clarity customer ID given an alias (alternate name).
Input Parameters
Name Type Comment
customAlias wsAlias Mandatory. Refers to the alias

that should be used to search for
the Customer ID.
Note
The ID of the customer record, that has the specified alias in the specified naming domain.
Returns
Type Comment
GetCustomerIdResult Returned result for the webservice call
Error Conditions
Code
Unknown Alias
18
GETCUSTOMERDETAILS
Purpose
This web service is used to retrieve the Clarity customer details given a customer ID for the customer.
Input Parameters
Name Type Comment
customerId STRING The ID to use when searching for

the Customer ID.
Returns
Type Comment
getCustomerDetailsResult Returned result for the webservice call
Error Conditions
Code
Invalid Customer ID
CREATECONTACTPOINT
Purpose
This web service is used to create a new contact point record.
Input Parameters
Name Type Comment
contactPoint ClarityContactPoint Mandatory. An instance of the

Contact Point object.
contactPointAlias ClarityAlias An alias (alternate name) to the
Contact Point. NULL allowed.
Returns
Type Comment
getContactPointIdResult Returned result for the webservice call
The ID the system has allocated to the
contact point.
Error Conditions
Code
Duplicate Alias
19
DELETECONTACTPOINT
Purpose
This web service deletes an existing contact point record and all the contacts associated with the
contact point, as many people may be contacted at one contact point.
Input Parameters
Name Type Comment
contactPointID LONG Mandatory. A reference to an

existing contact point record.
Returns
Type Comment
returnStatus Return status of a web service call.
Error Conditions
Code
Invalid Contact Point ID
Contact Point Cannot be Deleted
UPDATECONTACTPOINT
Purpose
This web service is used to update an existing contact point record.
Input Parameters
Name Type Comment
contactPoint ClarityContactPoint Mandatory. An instance of the

Contact Point object.
Returns
Type Comment
Error Conditions
Code
20
GETCONTACTPOINTID
Purpose
This web service identifies the Clarity contact point ID given an alias (alternate name) for a contact
point.
Input Parameters
Name Type Comment
contactPointId STRING The ID of the contact point

record that has the specified
alias in the specified naming
domain.
contactAlias ClarityAlias Mandatory. The alias used to
find the contact point ID.
Returns
Type Comment
getContactPointIdResult Returned result for the webservice call
The ID of the contact point record that has
the specified alias in the specified naming
domain.
Error Conditions
Code
Unknown Alias
21
GETFULLCONTACTPOINTS
Purpose
This web service can be used to find the Clarity contact point ID given an alias (alternate name) for a
contact point.
Input Parameters
Name Type Comment
locationID LONG A location ID for selecting

location based contact
points.
CustomerID STRING A customer abbreviation for
selecting customer based
contact points.
AccountID STRING An account ID for selecting
account based contact
points.
contactType STRING The type of contact i.e.
phone, email, mobile.
Returns
Type Comment
getFullContactPointsResult Returned result for the webservice call
Error Conditions
Code
Invalid Argument
22
GETAGENTAVAILABLE
Purpose
This web service can be used to obtain a list of timeslots which are available in FSM for the Job ticket
and purpose defined by the parameters. The address and reservation parameters are for the
purposes of determining the workgroup.
Input Parameters
Name Type Comment
address STRING A text address string of a format

defined in Product Feature
Parameter SM:00761 for when an
address id is not available
within the system.
adde_id LONG An address ID from the Clarity

System.
reservationId STRING A reservation ID which has

already been used by Reserve
Facility.
preferredDate DATE A preferred date for the job

ticket.
jobTicketType STRING The FSM Job ticket Type.
source STRING A generic text input string used

to identify the purpose of the
call.
parameter1 STRING A generic text input string used

call.

call.

call.
Returns
Type Comment
getAgentAvailableResult Returned result for the webservice call
Error Conditions
Code
Invalid Argument
23
RESERVEAGENTTIMESLOT
Purpose
This web service is used is used in conjunction with the getAgentAvailable web service to create and
assign a job ticket in a timeslot determined by getAgentAvailable.
Input Parameters
Name Type Comment
availableId LONG The timeslot id from the get

agent available call.
reservationId STRING If not provided previously in the

call to get agent available, this
parameter is mandatory and
represents the external ID used
in reserve facility and service
order calls.
date DATE The current timestamp of the

request. Not currently used.
Returns
Type Comment
reserveAgentTimeslotResult Returned result for the webservice call
Error Conditions
Code
Invalid Argument
24
ADDCONTACT
Purpose
This web service is used to create a contact and attach the newly created contact to a contact point.
Multiple contacts may be attached to one contact point.
Input Parameters
Name Type Comment
contactPointID STRING Mandatory. A reference to a

contact point record to which
the contact is to be attached.
wsContact wsContact Mandatory. The contact being
attached to the contactPoint.
Returns
Type Comment
Error Conditions
Code
DELETECONTACT
Purpose
This web service deletes a contact for a contact point.
Input Parameters
Name Type Comment
contactPointID STRING Mandatory. A reference

to a contact point
record from which the
contact is to be
removed.
contactName STRING Mandatory. The name of
the person being removed
from the contact point.
Returns
Type Comment
Error Conditions
Code
Invalid Contact
25
SETADDRESSCUSTOMERID
Purpose
This web service associates the specified customer with the address of the specified id.
Input Parameters
Name Type Comment
addressID LONG Mandatory. Address ID for

specified customer.
customerID STRING Mandatory. A customer
abbreviation for selecting
address.
Returns
Type Comment
Error Conditions
Code
Invalid Customer ID
Invalid Address ID
26
Address Management Data Objects
This section explains the specific data objects used by the Address Management web services.
WSADDRESS
A data object that contains information related to an address record.
addressId LONG The address id is an Implementation

identifier for the Address. It is internally
generated and cannot be specified when
creating the address. If the user enters a
value, it will be neglected.
suiteNumber STRING Optional. The suite number of the address.

(maximum 20 NULL allowed.
characters)
levelNumber STRING Optional. The level number of the address.

characters)
streetNumber STRING Optional. The street number of the address.

characters)
streetName STRING Optional. A reference to a valid street

(maximum 80 name. NULL allowed.
characters)
postCode STRING Mandatory. The postal code of the area

(maximum 40 containing this address. NULL allowed.
characters)
suburb STRING Mandatory.The name of the suburb/town

(maximum 40 containing this address. NULL allowed.
characters)
city STRING Mandatory. The name of the city containing

(maximum 40 this address. NULL allowed.
characters)
stateCode STRING Mandatory. A reference to a valid state.

(maximum 40
characters)
country STRING Mandatory. The name of the country containing

(maximum 40 this address. NULL allowed.
characters)
attributes wsAttribute Optional. An array of

wsAttribute.Supplementary data about the
address. NULL allowed.
The Address entity contains extra fields
which may not necessarily be used for an
installation of Clarity. The object has been
27
extended to pass these fields through the API

interface.
Valid attributename(s) for address
Attributes:
ADDE_FIELD_3OPTIONAL
CREATEADDRESSRESULT
An object represents the result of web service call createAddress.
theAddress wsAddress An object that defines the details of an

address.
UPDATEADDRESSRESULT
An object represents the result of web service call updateAddress.
ADDRESSEXISTSRESULT
An object represents the result of web service call addressExists.
addressID LONG The unique address ID.
GETADDRESSRESULT
An object represents the result of web service call getAddress.

address.
28
GETADDRESSIDRESULT
An object represents the result of web service call getAddressId.
addresseId LONG The unique address ID.
GETADDRESSBYALIASRESULT
An object represents the result of web service call getAddressByAlias.

address.
CREATEADDRESSSERVICEABILTYRESULT
An object represents the result of web service call createAddressServiceability.
returnStatus returnStatus Contains the status of the web service call.
ADDRESSLISTRESULT
An object represents the result of web service call getAddressList.

An object that defines the details of an
addressList wsAddress
address.
29
Address Management Web Methods

This section explains the Address Management web services in detail.
CREATEADDRESS
Purpose
This web service is used to create a new address record.
Input Parameters
Name Type Comment
theAddress wsAddress Mandatory. An instance of the

Address object. Unique
identifier for the specified
alias.
addressAlias wsAlias Can be used to add an Alias

(alternate name) to the Address.
NULL allowed.
Returns
Type Comment
createAddressResult Returned result of the web service call
containing the following details:
The address details.
Note
addressID will be automatically generated from a database sequence. If supplied, it will be neglected.
If the post code or post code - street name combination does not currently exist, this procedure will
attempt to create them.
Error Conditions
Code
Duplicate Alias
30
UPDATEADDRESS
Purpose
This web service is used to update an existing address record.
Input Parameters
Name Type Comment
theAddress Address
HU Mandatory. An instance of the
Address object.
Returns
Type Comment
updateAddressResult Returned result of the web service call
Note
Unlike the createAddress procedure, if the specified post code does not exist, an error will be raised.
However, this procedure will still attempt to create a post code street record if the specified post code
– street name combination does not exist.
Error Conditions
Code
Invalid Address ID
Invalid State
Invalid PostCode
Update Address already exists
31
ADDRESSEXISTS
Purpose
This web service is used to check if an address exists or not. If the address exists and the address is
unique, the web service returns the unique address ID. The postcode, state code, suburb and street
Name fields are mandatory. If values are not entered in these mandatory fields, an error will be
returned.
Input Parameters
Name Type Comment
address wsAddress The address that will be

queried.
Returns
Type Comment
addressExistsResult Returned result of the web service call
The unique address ID
Error Conditions
Code
Post Code must be specified
State must be specified
Suburb must be specified
Street Name must be specified
32
ADDRESSEXISTSCRSERVICEABILITY
Purpose
This web service is used to request Clarity to allow address matching via child and parent
methodology. The SO with the child address will match with the parent address to allow reserve
facility to assign access from Inventory.
Input Parameters
Name Type Comment
theAddress wsAddress The address that will be

queried.
Returns
Type Comment
addressExistsResult Returned result of the web service call
The unique address ID.
Error Conditions
Code
e_no_street_name
e_no_suburb
e_no_state
e_no_post_code
33
GETADDRESS
Purpose
This web service identifies an address based on the AddressID for the address.
Input Parameters
Name Type Comment
addressId LONG The unique address ID.
Returns
Type Comment
getAddressResult Returned result of the web service call
contaning the following details:
Address details.
Error Conditions
Code
Unknown Address ID
GETADDRESSID
Purpose
This web service is used to find the Clarity address ID given an alias (alternate name) for the address.
Input Parameters
Name Type Comment
addressAlias wsAlias Mandatory. The address alias

used to find the address ID.
Returns
Type Comment
getAddressIdResult Returned result of the web result call
The address ID.
Error Conditions
Code
Unknown Address Alias
34
GETADDRESSBYALIAS
Purpose
This web service is used to find the address given an alias (alternate name) for the address.
Input Parameters
Name Type Comment
addressAlias wsAlias Mandatory. The address alias

used to find the address ID.
Returns
Type Comment
getAddressByAliasResult Returned result of the web service call
The address details.
Error Conditions
Code
Unknown Address Alias
35
CREATEADDRESSSERVICEABILITY
Purpose
This web service is used to create a record in the Address Serviceability table between the specified
entity and the Address ID. The type of the entity is determined by the elementType parameter. It can
either be a Frame Container (FRAME) or Equipment (NE). Priority value and distance of the record is
defaulted to “1” and “0” respectively.
Input Parameters
Name Type Comment
STRING Mandatory. The location TTNAME

entityLoc
of the entity.
Mandatory. The type of the
entityType STRING
entity.
entityIndex STRING Mandatory. The index of the

entity.
elementType STRING Mandatory. The type of the

element. Valid values are:
FRAME: to indicate that the
entity is a frame.
NE: to indicate that the entity
is a network element.
addressID LONG Mandatory. The address ID of

that identifies the address for
this serviceability mapping.
Returns
Type Comment
createAddressServiceability Returned result of the web service call
Result containing the following details:
Address details
Note
The parameter values entityLocation, entityType and entityIndex will uniquely identify the frame or
equipment.
Error Conditions
Code
Address Servicability already exists
Invalid Entity
Invalid Address ID
36
GETADDRESSLIST
Purpose
This web service is used to find a list of addresses that match the criteria specified in the address
parameter.
Parameters
Name Type Comment
address wsAddress An address object that

contains the information for
which the user wants to
retrieve the matching
addresses. The API will search
the address table for an exact
match with the user supplied
criteria. However user can use
wild cards (e.g. %) in the
values supplied in the
p_address parameter for
greater flexibility. For
example, if a street name
„Main‟ is supplied in the
streetname attribute, only
addresses whose street name is
exactly „Main‟ will be
returned (not „Main St.‟,
„Main Rd.‟, „Main Ave.‟).
However, if a street name
„Main%‟ is supplied all
addresses containing that
street name, regardless of
their street types, will be
returned. (e.g. „Main St.‟,
„Main Rd.‟, „Main Ave.‟)
Also note that the procedure
performs a case sensitive
search. For example, if field
streetname contains „main st‟,
the API will not return the
addresses whose street name is
like „MAIN ST‟, „Main St‟,
„Main st‟.
Returns
Type Comment
addressListResult A list of address objects that match the
information provided in the p_address object.
Note
For performance reason, this procedure retrieves maximum 200 addresses. User needs to specify
more criteria for restricting the search if the address is not among the 200 records.
Error Conditions
Code
Unexpected Error
37
Area Management Data Objects

AREAFORSERVICENORELOCATERESULT
An object represents the result of web service call getAreaForServiceNoRelocate.
areaCodeNew STRING(maximum The exchange code for the new location.

15 characters)
areaChanged STRING The indicator Y/N that the area is changed

for new location or not.
GETAREAFORSERVICENUMBERRESULT
An object represents the result of web services call getAreaForServiceNumber, getExchangeArea.
areaCode STRING(maximum The exchange code for the specified address.

15 characters)
GETCHILDAREACODESRESULT
An object represents the result of web services call getChildAreaCodes.
childAreaCodes Array of The list of child area codes specified for

Strings the entered area code.
38
Area Management Web Methods
This section explains the Area Management web services in detail.
GETAREAFORSERVICENORELOCATE
Purpose
Users want to do the RELOCATION within and outside of same exchange via one service order. So
facility reservation will be done via the web API. System needs to detect number change is required
based on the new facility reservation. This can be done by comparing the Outputs of
getAreaForServiceNumber web service called first for New Reservation Id and second for Existing
Service Id. If the outputs are different then a number change is required.
Input Parameters
Name Type Comment
reservationId STRING Optional. Indicates the reservation id

returned by a successful facility
reservation operation.
serviceID STRING Optional. Indicates valid service ID
for a service.
addressID STRING Optional. An Old Address ID for which
the area code needs to be retrieved.
This value may not be used depending on
the status of the service or facility
reservation.
addressIdNew STRING Optional. An Address id for the new
location for which the area code needs
to be retrieved. This value may not be
used depending on the status of the
service or facility reservation.
neGroup STRING Optional. The network Element Group
like SWITCHING etc.
Returns
Type Comment
areaForServiceNoRelocateRes The area code new and areaChanged(Y/N).
ult
Error Conditions
Code
Invalid Service ID
Invalid Reservation ID
Invalid Address
39
GETAREAFORSERVICENUMBER
Purpose
Returns the exchange code for the given service id or address or reservation Id.
Based on the inputs parameters the web API will find the circuit associated with reservation
ID/Service ID, identify the NE by matching the NE group and then identify the exchange code used by
the NE. The identified Exchange code will be returned as the output.
If the exchange code is not found based on circuit, then the web API will use the Address ID and
query the address serviceability table for equipment serving the address. Once a record is found, the
Exchange area of the equipment is identified and returned as web API output
Note: Mainly the Address ID should be provided for non circuit oriented service, ex: - mobile services
where the system does not record a circuit for the service.
Input Parameters
Name Type Comment
reservationId STRING Optional. Indicates the reservation id

for which the circuit is reserved
servicId STRING Optional. Indicates the service id
for which the circuit is linked
addressID LONG Mandatory. Indicates the address for
which the area code needs to be
retrieved. This value may not be used
depending on the status of the service
or facility reservation.
neGroup STRING Optional. The Network Element Group
like SWITCHING or DATA.
Returns
Type Comment
getAreaForServiceNumberResu The area code that the address belongs to.
lt
Error Conditions
Code
Invalid Service ID
Invalid Address
40
GETEXCHANGEAREA
Purpose
This web service identifies the exchange area code for an address.
Input Parameters
Name Type Comment
AddressID LONG The unique identifier of the address

for which the exchange area code needs
to be retrieved.
Returns
Type Comment
getAreaForServiceNumberResu The area code that the address belongs to.
lt
Error Conditions
Code
Invalid Address ID
False/Not exists
GETCHILDAREACODES
Purpose
This web service can be used to get the child area codes for the area code passed as parameters.
Note: This procedure returns only the immediate children of the area code.
.Input Parameters
Name Type Comment
AreaCode String Mandatory. This indicates an area code

of an address.
Returns
Type Comment
AreaCodeList A list of the child areas are returned..
Error Conditions
Code
Area Code is Mandatory
No child Area found for the area
41
Account Management Data Objects

WSACCOUNT
A data object that contains information related to an account record.
accountId STRING Optional. This is the unique identifier for

(maximum 10 the account. If not supplied, an ID is
characters) automatically generated using a database
sequence. The account ID will be converted
to upper case before it is stored in the
database, regardless of whether it was
supplied or generated
parentAccountId STRING Optional. An account can have a parent

(maximum 10 account linked to it. The parentAccountId
characters) represents the ID of the parent account.
NULL is allowed.
accountStatus STRING Optional. The status of the account.

(maximum 15
characters)
customerId STRING Mandatory. The id of the customer who owns

(maximum 15 the account.
characters)
estimatedRevenue STRING Mandatory. The estimated revenue for this

(maximum 20 account.
characters)
accountAttributes wsAttribute Optional. An array of wsAttribute.

Supplementary data about the account. NULL
allowed. The account attributes that the
user can define are: Location, Account
Manager, Sales Channel, and Account Number.
Valid attributename(s) for
accountAttributes:
LOCN_ID OPTIONAL
ACCM_ID OPTIONAL
SALESCHANNEL OPTIONAL
ACCT_NUMBER OPTIONAL
addresseId LONG Optional. The address id refers to the

designated address for the account.
CREATEACCOUNTRESULT
An object represents the result of web service call createAccount.
42
account wsAccount Contain the information of the account
created through the web service.
returnStatus returnStatus Return the status of the web service call
UPDATEACCOUNTRESULT
An object represents the result of web service call updateAccount.
GETACCOUNTIDRESULT
An object represents the result of web service call getAccountId.
accountId LONG The unique account ID
WSACCOUNTMANAGER
A data object that contains information related to an account record.
id LONG Optional. This is the unique identifier for

the account. If not supplied, an ID is
automatically generated using a database
sequence. The account ID will be converted
to upper case before it is stored in the
database, regardless of whether it was
supplied or generated
name STRING Mandatory. The name of the account. The

(maximum 50 name is a unique identifier of the account
characters) and it is mandatory.
description STRING Optional. The description of the account

(maximum 80
characters)
type STRING Optional. The type of account. Default to

(maximum 20 ACCOUNT MANAGER.
characters)
tercCode LONG Optional. The code of the territory that

this account is responsible for.
salesId STRING Optional. The sales id of the account

(maximum 20 manager. Sales id is a unique identifier of
characters) the account manager.
43
CREATEACCOUNTMANAGERRESULT
An object represents the result of web service call createAccountManager.
accountManager wsAccountManager Contain the information of the account

created through the web service.
GETACCOUNTMANAGERIDRESULT
An object represents the result of web service call getAccountManagerID.
accountManagerId LONG The unique identifier of the account.
44
Account Management Web Methods
This section explains the Account Management web services in detail.
CREATEACCOUNT
Purpose
This web service creates a new account record.
Input Parameters
Name Type Comment
theAccount wsAccount Mandatory. A unique identifier

for the account. It may be from
the CRM system or created in
Clarity depend on interface
agreement.
accountAlias wsAlias Optional. An alternate name to

an account. NULL allowed.
Returns
Type Comment
createAccountResult Returned result of the web service call
The account details.
Error Conditions
Code
Invalid Account ID
Invalid Account Status
Duplicate Alias
45
UPDATEACCOUNT
Purpose
This web service updates the details of an account record.
Input Parameters
Name Type Comment
theAccount Account Mandatory. An object containing

the details of an account to be
updated. Any non-null fields in
this object will be updated in
the account record.
Returns
Type Comment
updateAccountResult Returned result of the web service call
containing the following details.
Error Conditions
Code
Invalid Account ID
Invalid Account Status
GETACCOUNTID
Purpose
This web service identifies the Clarity account ID given an alias (alternate name) for the account.
Input Parameters
Name Type Comment
accountAlias wsAlias Mandatory. The account alias

used to find the account ID.
Returns
Type Comment
getAccountIDResult Returned result of the web service call
The account ID that has the specified alias
in the specified naming domain.
Error Conditions
Code
Unknown Alias
46
CREATEACCOUNTMANAGER
Purpose
This web service creates a new account record.
Input Parameters
Name Type Comment
theAccountManager wsAccountManager Optional. The account name is

mandatory. It may be from the CRM
system or created in Clarity
depend on interface agreement.
Returns
Type Comment
createAccountManagerResult Returned result of the web service call
The ID of the newly created Account Manager.
Error Conditions
Code
The Account Manager Name is not provided
The Account Manager ID is already in use
TERRITORY CODES is invalid
Sales ID is already existing
Account Manager Name is already existing
GETACCOUNTMANAGERID
Purpose
This web service will return the ID of the account record.
Input Parameters
Name Type Comment
AccountManagerName STRING Mandatory. The account manager

name.
Returns
Type Comment
getAccountManagerIDResult Returned result of the web service call
Error Conditions
Code
The Account Manager Name is not valid
47
UPDATEACCOUNTMANAGER
Purpose
This web service updates the attribute of the account.
Input Parameters
Name Type Comment
theAccountManager wsAccountManager Optional. The ACCM_ID is

mandatory. It may be from the CRM
system or created in Clarity
depend on interface agreement.
Returns
Type Comment
returnStatus Return the status of the web service call.
Error Conditions
Code
The Account Manager name is not provided
The Account Manager ID does not exist
TERRITORY CODES is invalid
Sales ID is already existing
Account MANAGER Name is already existing
48
Chapter 4 Identity (Number) Manager
Summary of Identity Management Web Methods and Data Objects available in this document.
Phone Number
get_Numbers getNumbersListResult
getNumbers getNumbersResult
getNumbersViaAreaHierarchy getNumbersViaAreaHierarchyResult
getNumbersByRedirectionNumber numbersDetailResult
getNumberDetails numbersDetailResult
getNumberByServiceID numberStatusResult
reserveNumbers reserveNumbersResult
addNumbers addNumberResult
setNumberStatus setNumberStatusResult
unreserveNumbers unreserveNumbersResult
getNextAvailableNumber getNextAvailableNumberResult
setNumberType commonResult
setServiceTypeForNumbers commonResult
extendReservation commonResult
reserveNextAvailableNumber reserveNextAvailableNumberResult
getAndReserveNumbers getNumbersResult
getAttributesByID attributeResult
insertAttributesByID commonResult
updateAttributesByID commonResult
deleteAttributesByID commonResult
quarantinedNumberByID commonResult
getNumberID numberResult
getAttributesByNumber attributeResult
insertAttributesByNumber commonResult
updateAttributesByNumber commonResult
49
deleteAttributesByNumber commonResult
quarantinedNumberByNumber commonResult
addGeneratedNumber commonResult
deleteGeneratedNumberByNumber commonResult
deleteGeneratedNumberByReservedID commonResult
addPortedINNumber commonResult
deletePortedINNumberByNumber commonResult
deletePortedINNumberByReserveID commonResult
setAttributesByNumbers commonResult
updateAttributesByNumbers commonResult
deleteAttributesByNumbers commonResult
IP4 Number
getIPAddressDetails IPAddressDetailsResult
getIPNumbers getIPNumbersResult
reserveIPNumbers reserveIPNumbersResult
unreserveIPNumber commonResult
50
Identity (Number) Management Data Objects
This section lists the data objects used by the Identity Management web services.

The following are the generic objects used by the Identity Manager web services.
 ReturnStatus
 CommonResult
 AppConstant
WSATTRIBUTE

(maximum 240
characters)

(maximum 1000
chanracters)
WSENTITY
A data object defines an entity to a number.
entityId STRING Associates entityID to a number.

(maximum 100
characters)
entityType STRING Associates entity type to a number.

(maximum 100
chanracters)
WSNUMBERATTRIBUTE
A data object whose values when taken together with the actual managed number define a unique
number.
numberType STRING The number type. Some companies set up

(maximum 15 number types such as „Platinum‟, „Gold,
characters) „Silver‟, etc. Can be NULL.
countryCode STRING The country code attached to the number. Can

(maximum 6 be NULL. Country Codes are defined in the
characters) Clarity Application. Only defined Country
Codes are allowed for use in the API.
Generally there is only one CountryCode for
the entire application and the value of the
CountryCode is defaulted to that value.
51
cityCode STRING The city code attached to the number. Can be

(maximum 6 NULL.
characters)
WSNUMBERRANGE
The wsNumberRange is useful for many batch operations. The StartNumber is the first number to be
used in the range. The EndNumber is the last number to be affected by the range activity.
startNumber STRING (maximum The first number of the number range.

40 characters)
endNumber STRING (maximum The last number of the number range.

40 characters)
attributes wsNumberAttribute Provides more information about the

number.
52
WSSERVICETYPEPRIORITY
A data object defines a Service Type to a number.
serviceType STRING Associates a service type to a number. Only

(maximum 20 defined Service Types are permitted for use
characters) in the web API.
priority LONG Associates a priority to a number.
WSNUMBERATTRIBUTES
A data object define attributes to a number.
attributename STRING An attribute name.
attributevalue STRING Value of an attribute.
attributetype STRING Type of attribute.
WSNUMBERDETAIL
The wsNumberDetail object provides the user with a set of details for the number(s). There is also a
sub Object ServiceTypePriorityResult which contains the Service Type(s) and their Priority, which are
associated with the Number.
numberType STRING (maximum 15 The number type. Some

characters) companies set up number
types such as „Platinum‟,
„Gold, „Silver‟, etc. Can be
NULL.
area STRING (maximum 15 The area code of the IP

characters) Address.
countryCode STRING (maximum 15 The country code attached to

characters) the number. Can be NULL.
Country Codes are defined in
the Clarity Application.
Only defined Country Codes
are allowed for use in the
web API. Generally there is
only one CountryCode for the
entire application and the
value of the CountryCode is
defaulted to that value.
cityCode STRING (maximum 15 The city code attached to

characters) the number. Can be NULL.
serviceID STRING (maximum 15 The service ID of the

characters) service attached to the IP
53
Address.
redirectionNumber STRING (maximum 15 The Redirection Number

characters) associated with the VOICE
number(s).
numberStatus STRING (maximum 15 The status of the number

characters) e.g. AVAILABLE, RESERVED,
HELD. It can be NULL. Only
defined Number Statuses are
allowed for use in the web
API.
numberStatusDate dateTime The date of the number

status.
reserveId STRING (maximum 15 The reservation ID, if the

characters) IP Address has been reserved
via web API.
serviceTypePriority wsServiceTypePriority The tagged service types on

the IP Address and its
priority.
WSNUMBERLONG
A data object that defines a unique managed number.
numberShort STRING (maximum The managed number.

40 characters)
attribute wsNumberAttribute Provides more information about the

number.
GETNUMBERSLISTRESULT
An object that returns result of a web service calls getNumbers.
numberLongList wsNumberLong The list of numbers and all their

associated attributes. If there are not
enough consecutive numbers to satisfy the
input criteria. No Numbers exception will
be returned.
returnStatus returnStatus Contains the status of the web service

call.
GETNUMBERSRESULT
An object that returns result of a web service calls getNumbers and getAndReserveNumbers.
54
numberLongs wsNumberLong The list of numbers and all their
associated attributes. If there are not
enough consecutive numbers to satisfy the
input criteria. No Numbers exception will
be returned.

call.
GETNUMBERSVIAAREAHIERARCHYRESULT
An object that returns result of a web service calls getNumbersViaAreaHierarchy.
areaCode STRING The area code associated with the number.

(maximum 15
characters)
NUMBERSDETAILRESULT
An object that returns result of a web service calls getNumbersByRedirectionNumber.
numberDetailList wsNumberDetail The wsNumberDetail object provides the

user with a set of details for the
number(s). There is also a sub Object
ServiceTypePriorityResult which contains
the Service Type(s) and their Priority,
which are associated with the Number.

call.
WSNUMBERSTATUSCODE
The data object provides the status of a number.
numbNumber STRING The list of numbers

(maximum 40
characters
numberStatusCode LONG Number status code
NUMBERSTATUSRESULT
An object that returns result of a web service calls getNumberByServiceID.
numberStatusCodeList wsNumberStatusCode The list of numbers and their

status code.
55
returnStatus returnStatus Contains the status of the web

service call.
RESERVENUMBERSRESULT
An object that returns result of a web service calls reserveNumbers.

call.
ADDNUMBERSRESULT
An object that returns result of a web service calls addNumbers.

call.
SETNUMBERSTATUSRESULT
An object that returns result of a web service calls setNumberStatus.

service call.
GETNEXTAVAILABLENUMBERRESULT
An object that returns result of a web service calls getNextAvailbleNumber.
availableNumber STRING The number that conforms to the input

parameters and it is in a state of
„Available‟.
UNRESERVENUMBERSRESULT
An object that returns result of a web service calls unreserveNumbers.

service call.
RESERVENEXTAVAILABLENUMBERRESULT
An object that returns result of a web service calls reserveNextAvailbleNumber.
56
availableNumber STRING The number that has been„Reserved‟.

call.
NUMBERRESULT
A data object that defines a number unique identifier.
id LONG A unique identifier to a number.
ATTRIBUTERESULT
A data object that defines a attributes to a number.
attributes wsAttribute Provides more information about the number.
WSIPADDRESSDETAIL
The data object provides the user with a set of details for the IP address(s).
IPAddress STRING IP Address.
subnetMask LONG CIDR (Classless Inter-

Domain Routing) or subnet
of the IP Address. This
would be a value between 5
– 32
IPAddressStatus STRING The IP Address statuses

such as AVAILABLE,
RESERVED, HELD.
networkName STRING (maximum 40 The name of the network.

characters) Maintains uniqueness for
private networks.
IPAddressType STRING This is the number sub type

rather than the number
type, since the number type
is always IPv4 for IP
Addresses.
57
areaCode STRING The area code of the IP

Address.
serviceID STRING The service ID of the

service attached to the IP
Address.
reserveID STRING The reservation ID, if the

IP Address has been
reserved via web API.
owner STRING The work group the IP

Address belongs too.
remark STRING Comments associated with

the IP Address.
parentBlock STRING The Parent Block IP Address

/ CIDR.
hostNetworkBroadcast STRING IP Address usage Identifier

H – Host IP Address
N – Network IP Address
B – Broadcast IP Address
domainHostname STRING Domain or Host name.
ipControl STRING (maximum 1 Indicates if an IP Address

character) is
I – Private
O – Public
If the IP Address is „I‟
Private then a NetworkName
becomes mandatory.
serviceTypePriority wsServiceTypePriority The tagged service types on

the IP Address and its
priority.
IPADDRESSDETAILSRESULT
An object that returns result of a web service calls getIPAddressDetails.
ipAddressDetailList wsIPAddressDetail The list of IP numbers and all

their associated attributes. If
there are not enough consecutive
numbers to satisfy the input
criteria. No Numbers exception will
be returned.

service call.
58
WSIPADDRESS
The data object provides the user with a set of details for the IP Number(s).
IPAddress STRING IP Address.
netMask LONG CIDR (Classless Inter-Domain

Routing) or subnet of the IP
Address. This would be a
value between 5 – 32
IPControl STRING (maximum 1 Indicates if an IP Address

charater) is
I – Private
O – Public
If the IP Address is „I‟
Private then a NetworkName
becomes mandatory.
networkName STRING (maximum 40 The name of the network.

characters) Maintains uniqueness for
private networks.
numberStatus STRING (maximum 50 A reference to a valid

characters) number status. Only defined
Number Statuses are allowed
for use in the web API.
GETIPNUMBERSRESULT
An object that returns result of a web service calls getIPNumbers.
IpAddressList wsIpAddress The wsIPAddress object provides the user

with a set of details for the IP Number(s).

call.
RESERVEIPNUMBERSRESULT
An object that returns result of a web service calls reserveIPNumbers.

service call.
59
SUBTYPE DEFINITIONS
To support the constrained length definitions inside a java, the following subtypes have been defined
and will be included in the web API specification.
 numbershort
 userid
 numberstatus
 numbertype
 expirydate
 numberpattern
 servicetype
 citycode
Note
The following relationships exist within the Identity (Number) Manager data:
Number
A Number must be included in at one Number Range to have been created
A Number may be changed along with other numbers in a Number Range
A Number may have be permitted to zero or more Service Types
A Number may have exactly one associated Area
A Number may have exactly one Service
A Number may have exactly one Number Type
A Number must have exactly one Number Status.
Number Range
A number range may be used in the creation or change of zero on more Numbers
Service Type
A Service Type must be associated with each Service.
A Service Type can be assigned to a Number Service Priority but it then Must be associated with a
Number or Number Range.
Service
A Service must have one and only one associated Service Type
A Service May have Zero or More associated numbers
Number Type
A Number Type may define zero or more Number usages.
A Number Type may be used to valuate zero or more Numbers that are composed of a Number
Pattern.
Number Pattern
A Number Pattern must be assigned to just one Number Type
Number Status
A Number Status may be assigned to zero or more Numbers
60
Identity (Number) Management Web Methods
Voice Number
This section explains the Voice Number web services in detail.
GET_NUMBERS
Purpose
This web service can be used to get one or more numbers and commonly requested details based on
most attributes of a number. All attributes are supplied on an optional basis. One or many conditions
can be specified in any combination. It will return a maximum of 100 numbers.
Input Parameters
Name Type Comment
startNumber STRING The first number of the number
range. Any number for PSTN,
ISDN – required unless Entity
Type and Entity ID are
specified.
endNumber STRING The last number of the number
range. Any number for PSTN,
ISDN – required unless Entity
Type and Entity ID are
specified.
serviceType STRING Mandatory. The service type of
the number, e.g., PSTN, ISDN.
numberType STRING (maximum 15 Mandatory.The number type e.g.
characters) GOLD, SILVER.
areaCode STRING Optional. The area code of the

number.
cityCode STRING (maximum 6 Optional. Refers to the city
characters) code of the number.
numberStatus STRING Mandatory. The status of the

number, e.g. AVAILABLE,
RESERVED, HELD.
numberPattern STRING Optional. To specify the
number pattern for the number.
The Oracle “%” can be used to
specify the pattern. If the
pattern is null, then no
number pattern is checked.
entityType STRING Mandatory. The Entity type can
be null or set to „Service‟ or
„External‟.
entityID STRING The entity ID should be the
Service ID or the Reservation
ID for the numbers to be
reserved.
areaFlag LONG 1/null assumed numbers can
only be associated with that
area and no other.
2 assumed numbers are either
61
associated with telephone

exchange or with higher order
areas (such as LEA). Therefore
if the area input is filled in
the search will start with
that area and if nothing is
found, it will look to the
next higher level (eg. LEA)
and above until at least one
number is found. If even one
number is found in the ara,
numbers in higher order areas
will not be returned.
howMany LONG Mandatory. The value entered
specifies how many numbers
will be retrieved. Only values
greater than or equal to zero
are valid. A value of 100 will
retrieve 100 numbers that
match the supplied attributes.
consecutiveFlag LONG Consecutive/Non-consecutive
numbers setting
0/null Non-consecutive
number(s) requested or no
number(s) returned
1 Consecutive number(s)
requested or no number(s)
returned
2 Non-consecutive up to
howMany
3 Consecutive up to howMany
attributes wsNumberAttributes Provides more information
about the number.
Returns
Type Comment
getNumbersListResult Returned result for the web service call
The list of numbers and all their associated
attributes.
Note
If any input parameter does not exist or is otherwise invalid, the return will be empty.
It will only return VOICE technology numbers.
The error numbers will match the when invoked condition. The error message description is user
configurable.
Error Conditions
Code
62
StartingNumberInValid
EndingNumberInValid
InvalidRangeUnequalLengths
InvalidRangeEndNumLowest
Rangetoolarge
InvalidAttributeName
InvalidserviceType
CountryCodeSetupFault
InvalidCityCode
InvalidNumberStatus
InvalidNumberType
InvalidArea
InvalidStatus
InvalidValue
InvalidEntity
Insufficientprivileges
InvaliduserID
NoNumbers
GETNUMBERS
Purpose
This web service can be used to get one or more numbers and all their details for a service type and
number type, e.g. Service Type = PSTN, Number Type = GOLD and number status. Not all tree
conditions are mandatory, one or many condition can be specified in any combinations.
Input Parameters
Name Type Comment
serviceType STRING (maximum 20 Mandatory. The service type
characters) of the number, e.g., PSTN,
ISDN.
numberType STRING (maximum 15 Mandatory. The number type
characters) e.g. GOLD, SILVER.
area STRING (maximum 15 Optional. The area code of
characters) the number.
numberStatus STRING (maximum 15 Mandatory. The status of the
characters) number, e.g. AVAILABLE,
RESERVED, HELD.
will be retrieved. Only
values greater than or equal
to zero are valid. A value of
100 will retrieve 100 numbers
that match the supplied
attributes.
numberPattern STRING Optional. Specify the number
pattern for the number. The
Oracle “%” can be used to
63

numbers setting
number(s) returned
returned
howMany
Returns
Type Comment
getNumbersResult Returned result for the web service call
attributes.
Note
If any input parameter does not exist or is otherwise invalid, the return will be empty. It will only return
VOICE technology numbers.
Error Conditions
Code
Success
InvalidServiceType
InvalidCityCode
InvalidNumberStatus
InvalidNumberType
InvalidArea
NoNumbers
64
GETNUMBERSVIAAREAHIERARCHY
Purpose
This web service is based on the getNumbers and the only difference is that it will trace up the Area
Hierarchy if suitable numbers are not found in the specified Area Level. Once the suitable numbers
are found they will be returned, as well as the Area that they belong too. All the suitable numbers will
need to belong to the same Area.
Input Parameters
Name Type Comment
characters) of the number, e.g., PSTN,
ISDN.
numberType STRING (maximum 15 Mandatory. The number type
characters) e.g. GOLD, SILVER.
area STRING (maximum 15 The area code of the number.
characters) This parameter returns the
area that the numbers were
found or the area that it has
ended up in.
characters) number, e.g. AVAILABLE,
RESERVED, HELD.
will be retrieved. Only
values greater than or equal
to zero are valid. A value of
100 will retrieve 100 numbers
that match the supplied
attributes.
numberPattern STRING Optinoal. Specify the number
pattern for the number. The
Oracle “%” can be used to
numbers setting
number(s) returned
returned
howMany
Returns
Type Comment
65
getNumbersViaAreaHierarchyR Returned result for the web service call

esult containing the following information:
attributes.
Note
If any input parameter does not exist or is otherwise invalid, the return will be empty. The web API has
been configured so that it will only search 50 levels of the Area Hierarchy. There should not be a need
to have more than 50 levels in the Area Hierarchy. If we have traversed through 50 levels of the Area
Hierarchy, it is most likely that there is a loop in the Area Hierarchy. It will only return VOICE
technology numbers.
Error Conditions
Code
Success
InvalidserviceType
InvalidCityCode
InvalidNumberStatus
InvalidNumberType
InvalidArea
NoNumbers
GETNUMBERSBYREDIRECTIONNUMBER
Purpose
This web service is to be used to get one or more numbers and their status code, by passing in the
Redirection Number. The Phone Number that has been redirected will be displayed in the output field
redirectionNumber, rather than the redirectionNumber which is the input parameter.
Input Parameters
Name Type Comment
redirectionNumber STRING (maximum 15 The Redirection Number
characters) associated with the VOICE
number(s).
Returns
Type Comment
numbersDetailResult Returned result for the web service call
The number details.
Note
If there are no numbers associated with the specified Redirection Number, the web API will return no
data in numberDetailResult; however the returnStatus will have error code 46 and description “There
are no numbers with the number criteria”.
Error Conditions
Code
66
Success
NoNumbers
GETNUMBERDETAILS
Purpose
This web service can be used to get the details for a number. Only the phone number is a mandatory
parameter, the others are optional.
Input Parameters
Name Type Comment
serviceType STRING (maximum 20 Optional. The service type of the
charcaters) number e.g. PSTN, ISDN.
numberType STRING (maximum 15 Optional. The number type e.g.
area STRING (maximum 15 Optional.The Area code.
characters)
countryCode STRING (maximum 6 Optional. The country code
characters) attached to the number.
cityCode STRING (maximum 6 Optional. The city code.
characters)
phoneNumber STRING (maximum 20 Mandatory.The number for which
characters) the details are required.
Returns
Type Comment
numbersDetailResult Returned result for the web service call
The number details list.
Error Conditions
Code
Success
InvalidServiceType
InvalidCountryCode
InvalidCityCode
InvalidNumberType
InvalidNumber
InvalidArea
NumberIsNotANumber
NoNumbers
67
GETNUMBERBYSERVICEID
Purpose
This web service is to be used to get one or more numbers and their status code.
Input Parameters
Name Type Comment
serviceID STRING (maximum 25 The Service ID associated with the
characters) number, whose number and status
code is to be extracted.
Returns
Type Comment
numberStatusResult Returned result for the web service call
The number status code list.
Error Conditions
Code
Success
NoNumbers
RESERVENUMBERS
Purpose
This web service reserves either a single number or a range of numbers for a Service or External
System.
Input Parameters
Name Type Comment
entityDetails wsEntity Mandatory. The Entity type
should be set to „Service‟ or
„External‟ and the entity ID
should be the Service ID or the
Reservation ID for the numbers
to be reserved.
numberRange wsNumberRange Mandatory. Specify the first and
last numbers as well as
identifying attributes of the
number range.
userId STRING The user that is making the

change to the numbers. This
will never generate an error
even if the UserID does NOT
match the userID of the
operator. If left blank also, no
error will occur.
Returns
Type Comment
68
reserveNumbersResult Returned result for the web service call
Note
Any raised exception will „rollback‟ any and all uncommitted data in the session. This includes a
mismatch of service types for a “SERVICE” reservation in the range.
Only numbers that meet all criteria will be changed.
Null Number Types, Country Codes & Null City Codes will expand the selection criteria to any number
within the number range.
Data will only be saved if commit is issued in the session.
Error Conditions
Code
EndingNumberInValid
Rangetoolarge
InvalidCountryCode
InvalidCityCode
InvalidNumberType
InvaliduserID
NumberNotAvailToRsrveNotOtined
NumberorNumbersareQuarantined
InvalidEntityID
InvalidEntityType
NumberReservedForService
InvalidServiceType
InvalidServiceID
NoNumbers
RecordsLocked
69
ADDNUMBERS
Purpose
This web service creates numbers based on the number range. The web service checks to ensure
that none of the numbers specified in the range already exist. If they do, then errors are raised,
number creation is aborted and no number is generated.
Input Parameters
Name Type Comment
numberRange wsNumberRange Mandatory. Specify the

properties of the number
range.
serviceTypeAllowan wsServiceTypePriority Mandatory. The service types
ce associated with the new
numbers.
areaCode STRING (maximum 15 Optional. Specify the area
characters) code associated with the
number.
numberRangeAttribu wsAttribute Optional. Attributes provides
tesList additional information about
the numbers.
userID STRING This field is not used for any
verification. It needs to be
phased out but current
signature must remain intact
for programs that call this
API.
Returns
Type Comment
addNumbersResult Returned result for the web service call
Note
The first error that is detectible from the inputs will be returned in the returnStatus OUT parameter.If
any errors are found, new data will not be written to the database. Creating numbers is possible with a
valid non-duplicate number range if the user has the permission to do so.
Error Conditions
Code
70
EndingNumberInValid
RangetooLarge
NumbersinRangeAlreadyExist
InvalidServiceType
InvalidServiceTypePriority
InvalidCountryCode
InvalidCityCode
InvalidNumberType
InvalidArea
InsufficientPrivileges
SETNUMBERSTATUS
Purpose
This web service can be used to set the status of a specified range of numbers to one of the valid
status in the reference data. If the start number and end number are the same then only one number
is updated.
Input Parameters
Name Type Comment
numberRange wsNumberRange The first and last number and
identifying attributes.
numberStatus STRING (maximum 50 The status that the number range

characters) will acquire. You must specify a
valid status for example, Available,
Reserved, and so on.
userId STRING The user that is making the change
to the numbers.
Returns
Type Comment
setNumberStatusResult Returned result for the web service call
Note
Business Rules dictate the only acceptable changes as follows:
Not Conditioned to Available
Not Conditioned to Held
Available to Not Conditioned
Available to Held
Held to Available
Held to Not Conditioned
Error Conditions
71
Code
InvalidNumberType
InvalidCountryCode
InvalidCityCode
InvalidNumberStatus
InvalidStatusChange: business rules violated
NumberAlreadyexists
Rangetoolarge
InvalidserviceType
InvalidcountryCode
InvalidCityCode
InvalidNumberStatus
InvalidnumberType
InvalidArea
NumberIsNotANumber
BusinessRulesforStatus
UNRESERVENUMBERS
Purpose
If a range of numbers has been reserved, you can use the unreserveNumbers web service to cancel
the reservation so that the numbers are available again. It can be used to unreserve either a single
number or range of numbers or for a Service/External entity.
Input Parameters
Name Type Comment
identifying attributes of the number
range.
userId STRING Optional. Is not used currently.
Returns
Type Comment
unreserveNumbersResult Returned result for the web service call
Note
These web services will only unreserve numbers that are reserved with a reservationID. Numbers
reserved with a service id (through a service order) cannot be unreserved by this web API.
Null Number Types, Country Codes and Null City Codes will expand the selection criteria to any
number within the number range.
72
Data will only be saved if commit is issued in the session.
Error Conditions
Code
EndingNumberInValid
Rangetoolarge
InvalidcountryCode
InvalidCityCode
InvalidnumberType
InvaliduserID
InvalidentityType
NoNumbers
RecordIsLocked
GETNEXTAVAILABLENUMBER
Purpose
This web service can be used to get the next available number and all its details for a specific service
type and number type, e.g. Service Type = PSTN, and Number Type = GOLD.
Input Parameters
Name Type Comment
numberAttribute wsNumberAttribute The Number Type, Country Code &
City Code for the number.
serviceType STRING (maximum 20 A number that allows an
characters) association with this service
type, e.g. PSTN, ISDN.
Returns
Type Comment
getNextAvailableNumberResul Returned result for web service call
t containing the following information:
The available number details.
Note
A return of nothing, or „null‟ is an indication there are no numbers available that meet the criteria.
Error Conditions
Code
InvalidServiceType
InvalidCountryCode
InvalidCityCode
InvalidNumberType
73
SETNUMBERTYPE
Purpose
This web service sets up the number type (for example, GOLD, SILVER, etc) for the specified range
of numbers. If the start number and end number are the same, then only that one number is updated.
Parameters
Name Type Comment
identifying attributes of the
number range.
numberType STRING (maximum 15 The number type value, GOLD, SILVER

characters) etc that the number should be set
to.
userId STRING Optional. Is not used currently.
Returns
Type Comment
commonResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidStartNumber
InvalidEndNumber
InvalidCountryCode
InvalidCityCode
InvalidNumberType
Insufficient Privilege
SETSERVICETYPEFORNUMBERS
Purpose
This web service assigns a service type to a specified range of numbers. If the start number and end
number are the same, then only this one number is updated.
Input Parameters
Name Type Comment
identifying attributes of the number
range.
serviceTypeAllowan wsServiceTypePrior Specifies the type of services to be

ce ity assigned to the number range.
to the numbers.
Returns
Type Comment
web service call.
74
Error Conditions
Code
NumberIsNotANumber
InvalidCountryCode
InvalidCityCode
InvalidNumberType
InvalidServiceType
InvalidServicePriority
InsufficientPrivilege
EXTENDRESERVATION
Purpose
This web service extends the reservation of a number.
Input Parameters
Name Type Comment
numberRange wsNumberRange Mandatory. Specify the first and
last number and properties of the
number range.
to the numbers.
newExpiryDate DATE Mandatory. The new expiry date for
the reservation. Note that this
date should be in the future, but
not necessarily later than the
original expiry date.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidStartNumber
InvalidEndNumber
NumbersNotReserved
InvalidEntityType
InvalidEntityID
InvalidCountryCode
InvalidCityCode
InvalidNumberType
NumberIsNotANumber
InvalidRnageEndNumLowest
NoNumbers
75
RESERVENEXTAVAILABLENUMBER
Purpose
This web service can be used to automatically reserve the next available number for the specified
input criteria. The function is a hybrid of the getNextAvailableNumber and reserveNumbers. It will retry
up to ten times to reserve a number. After the ten retries and still unable to reserve a number, it will
return error code 25 (NumberNotAvailToRsrveNotQtined).
Input Parameters
Name Type Comment
numberAttributes wsNumberAttribute The Number Type, Country Code
and City Code (Area Code) for
the required number selection.
theServiceType STRING (maximum 20 The Service Type that the number
characters) has been associated with. e.g.
PSTN, ISDN.
entityDetails wsEntity Mandatory. The Entity type
should be set to „Service‟ or
„External‟ and the entity ID
should be the Service ID or the
Reservation ID for the numbers
to be reserved.
userId STRING The user that is making the
change to the numbers. This
will never generate an error
even if the UserID does NOT
match the userID of the
operator. If left blank also, no
error will occur.
Returns
Type Comment
reserveNextAvailableNumberR Returned result for the web service call
The available number.
Error Conditions
Code
InvalidServiceType
Success
InvalidCountryCode
InvalidCityCode
InvalidServiceID
InvalidNumberType
InvalidEntityType
NumberNotAvailToRsrveNotOtined
NoNumbers
76
GETANDRESERVENUMBERS
Purpose
This web service is a hybrid of the functionality of the getNumbers and ReserveNumbers. It will get
the numbers that match the input criteria and automatically reserve those numbers. However, if the
numbers are being used by another process, it will skip those numbers. The web service keep looking
for numbers until the required amount is found or it runs out of numbers that meet the required
criteria.
Input Parameters
Name Type Comment
serviceType STRING (maximum 20 Mandatory. The service type of the
characters) number, e.g., PSTN, ISDN.
numberType STRING (maximum 15 Mandatory. The number type e.g.

area STRING (maximum 15 The area code of the number.
characters)
cityCode STRING (maximum 6 Refers to the city code of the
characters) number.
characters) number, e.g. AVAILABLE, RESERVED,
HELD.
specifies how many numbers will be
retrieved. Only values greater than
or equal to zero are valid. A value
of 100 will retrieve 100 numbers
that match the supplied attributes.
numberPattern STRING Optional. Specify the number
pattern for the number. The Oracle
“%” can be used to specify the
pattern. If the pattern is null,
then no number pattern is checked.
consecutiveFlag LONG If true, then returned numbers
should only be consecutive. 1=true,
0=false.
entityDetails wsEntity Mandatory. The Entity Type should
be set to „Service‟ or „External‟
and the entity ID should be the
Service ID or the Reservation ID
for the numbers to be reserved.
to the numbers.
Returns
Type Comment
getNumbersResult Returned result for the web service call
Impact and Dependencies on Third Party Applications (Optional when required)
77
The customer using this web service will need to change their processes / web service calls, i.e.,
rather than calling the getNumbers and then the reserveNumbers, just call getAndReserveNumbers.
Error Conditions
Code
Success
InvalidserviceType
InvalidCityCode
InvalidserviceID
InvalidNumberType
InvalidEntityType
NumberNotAvailToRsrveNotQtined
NoNumbers
InvalidConsecutiveFlag
GETATTRIBUTESBYID
Purpose
This web service is used to select VOICE number attributes by Number ID. A list of attribute names
can be specified, to be selected. The attribute value(s) are ignored and may have a value specified or
should be NULL. When the attributesList parameter is NULL all of the Number attributes will be
selected.
Input Parameters
Name Type Comment
numberID LONG The Number ID the unique
identified the Voice Number.
attributesList wsAttribute Attributes associated with the

NumberID that are to be selected.
If this parameter is NULL all of
the associated Number attributes
will be selected.
Returns
Type Comment
attributeResult Returned result for the web service call
Note
The first error that is detectible from the inputs will returned in the returnStatus OUT parameter.
There will be no error generated if a valid Attribute Name is requested to be selected from a number
which is not associated with.
Error Conditions
Code
Sucess
InvalidNumberID
78
INSERTATTRIBUTESBYID
Purpose
This web service is used to insert VOICE number attributes by Number ID. A list of attribute names
must be specified, to be inserted.
Input Parameters
Name Type Comment

NumberID that are to be inserted.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
InvalidNumberID
DuplicateAttribute
MissingAttribute
UPDATEATTRIBUTESBYID
Purpose
This web service is used to update VOICE number attributes by Number ID.
Input Parameters
Name Type Comment

NumberID that are to be updated.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
79
Success
InvalidNumberID
MissingAttribute
InvalidAttribute
DELETEATTRIBUTESBYID
Purpose
This web service is used to delete VOICE number attributes by Number ID. A list of attribute names
can be specified, to be deleted. The attribute value(s) are ignored and may have a value specified or
should be NULL. When the attributesList parameter is NULL all of the Number attributes will be
deleted.
Input Parameters
Name Type Comment

NumberID that are to be deleted.
If this parameter is NULL all of
the associated Number attributes
will be deleted.
Returns
Type Comment
web service call.
Note
There will be no error generated if a valid Attribute Name is requested to be deleted from a number
Error Conditions
Code
InvalidNumberID
80
QUARANTINEDNUMBERBYID
Purpose
This web service is used to quarantine a VOICE number by Number ID.
Input Parameters
Name Type Comment
days LONG The number of days that the Phone

Number should be quarantined.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
Success
InvalidNumberID
InvalidDays
GETNUMBERID
Purpose
This web service is used to select VOICE number ID from the Phone Number.
Input Parameters
Name Type Comment
number STRING (maximum 40 The Phone Number.
characters)
countryCode STRING (maximum 6 The Country Code part of the
characters) Phone Number.
cityCode STRING (maximum 6 The City Code part of the Phone

characters) Number.
Returns
Type Comment
NumberResult Returned result for the web service call
The list of number ID
Error Conditions
Code
81
Success
InvalidCountryCode
InvalidCityCode
NoNumbers
GETATTRIBUTESBYNUMBER
Purpose
This web service is used to select VOICE number attributes by Phone Number. A list of attribute
names can be specified, to be selected. The attribute value(s) are ignored and may have a value
specified or should be NULL. When the attributesList parameter is NULL all of the Number attributes
will be selected.
Input Parameters
Name Type Comment
characters)

characters) Number.
Phone Number that is to be
selected. If this parameter is
NULL all of the associated Number
attributes will be selected.
Returns
Type Comment
attributeResult Returned result for the web service call
Note
There will be no error generated if a valid Attribute Name is requested to be selected from a number
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
InvalidDays
82
INSERTATTRIBUTESBYNUMBER
Purpose
This web service is used to insert VOICE number attributes by Phone Number. A list of attribute
names must be specified, to be inserted.
Input Parameters
Name Type Comment
characters)

characters) Number.

inserted.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
DuplicateAttribute
MissingAttribute
UPDATEATTRIBUTESBYNUMBER
Purpose
This web service is used to update VOICE number attributes by Phone Number.
Input Parameters
Name Type Comment
characters)

characters) Number.
83

updated.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
MissingAttribute
InvalidAttribute
DELETEATTRIBUTESBYNUMBER
Purpose
This web service is used to delete VOICE number attributes by Phone Number. A list of attribute
names can be specified, to be deleted. The attribute value(s) are ignored and may have a value
specified or should be NULL. When the attributesList parameter is NULL all of the Number attributes
will be deleted.
Input Parameters
Name Type Comment
characters)
characters) Number.
deleted. If this parameter is
NULL all of the associated Number
attributes will be deleted.
Returns
Type Comment
web service call.
Note
84
Error Conditions
Code
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
QUARANTINEDNUMBERBYNUMBER
Purpose
This web service is used to quarantine a VOICE number by Phone Number.
Input Parameters
Name Type Comment
characters)

characters) Number.
days LONG The number of days that the Phone
Number should be quarantined.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
InvalidDays
85
ADDGENERATEDNUMBER
Purpose
This web service is used to create a GENERATED number. These would be numbers that are
generated for one time use only and will be DELETED once they are no longer in used. It will not go
into AVAILABLE state. The procedure will check that the number specified does not already exist with
the Identity (Number) Management System There will be an error raised if the number already exists,
which will abort the creation of the number.
Input Parameters
Name Type Comment
characters)
countryCode STRING (maximum 6 The Country Code for the Phone
characters) Number.
cityCode STRING (maximum 6 The City Code for the Phone
characters) Number.
areaCode STRING (maximum 15 The Area Code for the Phone
characters) Number.
numberType STRING (maximum 15 The Number Types for the Phone
characters) Number.
serviceTypeList wsServiceTypePriority The service(s) which can be
associated with the Phone Number.
attributesList wsAttribute Additional Attributes associated
with the Phone Number.
reservationID STRING (maximum 25 The External Reservation ID.
characters)
Returns
Type Comment
web service call.
Note
The first error that is detectable from the inputs will be returned in the returnStatus OUT parameter
If any errors are found, new data will not be written to the database
The Numbers created by this web service will be DELETED once they are no longer being used. They
should never go into an AVAILABLE state.
Error Conditions
Code
86
Success
NumbersinRangealreadyexist
InvalidserviceType
InvalidcountryCode
InvalidCityCode
InvalidnumberType
InvalidArea
MissingReservationID
DELETEGENERATEDNUMBERBYNUMBER
Purpose
This web service is used to delete generated numbers (Numbers created through the
addGeneratedNumber web service or database API). These only delete number(s) that have a status
other than Allocated.
Input Parameters
Name Type Comment
characters)
characters) Number.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
87
DELETEGENERATEDNUMBERBYRESERVEDID
Purpose
This web service is used to delete generated numbers (Numbers create throught the
addGeneratedNumber web service or database API). These only delete number(s) that have a status
Input Parameters
Name Type Comment
reservationID STRING External Reservation ID, which
would be associated with the
reserved number(s).
Returns
Type Comment
web service call.
Note
Error Conditions
Code
InvalidReservedID
ADDPORTEDINNUMBER
Purpose
This web service is used to create a PORTED-IN number. These would be the numbers that are
ported-in from other carriers, and thereby the Number Status is automatically set to “PORTED-IN”.
The procedure will check that the number specified does not already exist with the Identity (Number)
Management System. There will be an error raised if the number already exists, which will abort the
creation of the number.
Input Parameters
Name Type Comment
number STRING (maximum 40 The PORTED-IN Phone Number.
characters)
countryCode STRING (maximum 6 The Country Code for the PORTED-
characters) IN Phone Number.
cityCode STRING (maximum 6 The City Code for the PORTED-IN
areaCode STRING (maximum 15 The Area Code for the PORTED-IN
numberType STRING (maximum 15 The Number Types for the PORTED-
characters) IN Phone Number.
serviceTypeList wsServiceTypePriority The service(s) which can be
associated with the PORTED-IN
Phone Number.
attributesList wsAttribute Additional Attributes associated
with the PORTED-IN Phone Number.
88
reservationID STRING (maximum 25 The External Reservation ID.
characters)
Returns
Type Comment
web service call.
Note
The first error that is detectable from the inputs will be returned in the returnStatus OUT parameter
If any errors are found, new data will not be written to the database
The Numbers created by this web service will be DELETED once they are no longer being used. They
should never go into an AVAILABLE state.
Error Conditions
Code
Success
NumbersinRangealreadyexist
InvalidserviceType
InvalidcountryCode
InvalidCityCode
InvalidnumberType
InvalidArea
MissingReservationID
89
DELETEPORTEDINNUMBERBYNUMBER
Purpose
This web service is used to delete PORTED-IN Numbers (Numbers created through
addPortedINNumber web service or database API). These only delete number(s) that have a status
Input Parameters
Name Type Comment
characters)
characters) Number.
Returns
Type Comment
web service call.
Note
Error Conditions
Code
InvalidcountryCode
InvalidCityCode
NoNumbers
InvalidNumberID
DELETEPORTEDINNUMBERBYRESERVEID
Purpose
This web service is used to delete PORTED-IN Numbers (Number created by the
addPortedINNumber web servicve or database API). These only delete number(s) that have a status
Input Parameters
Name Type Comment
reservationID STRING External Reservation ID, which
would be associated with the
reserved number(s).
Returns
Type Comment
web service call.
Note
90
Error Conditions
Code
InvalidReservedID
SETATTRIBUTESBYNUMBERS
Purpose
This web service is used to set (update or insert) the VOICE number attributes by Phone Number
Range. A list of attribute names can be specified. These will either be updated if the Attribute Name
exists for the number or inserted if the attribute name does not currently exist.
Input Parameters
Name Type Comment
startNumber STRING Starting Range for the Phone
Numbers.
endNumber STRING Ending Range for the Phone

Numbers.
countryCode STRING The Country Code part of the

Phone Number.
cityCode STRING The City Code part the Phone

Number.

Phone Number to be deleted.
Returns
Type Comment
web service call.
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NumberIsNotANumber
MissingAttribute
91
UPDATEATTRIBUTESBYNUMBERS
Purpose
This web service is used to update the VOICE number attributes by Phone Number Range. A list of
attribute names can be specified, that are to be updated.
Input Parameters
Name Type Comment
Numbers.

Numbers.

Phone Number.

Number.

Phone Number that be deleted.
Returns
Type Comment
web service call.
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NumberIsNotANumber
MissingAttribute
92
DELETEATTRIBUTESBYNUMBERS
Purpose
This web service is used to delete VOICE number attributes by Phone Number Range. A list of
attribute names can be specified, to be deleted. The attribute value(s) are ignored and may have a
value specified or should be NULL.
Input Parameters
Name Type Comment
Numbers.

Numbers.

Phone Number.

Number.

Phone Number that be deleted.
Note
Only the Attribute Name is used for the deletion list.
Returns
Type Comment
web service call.
Error Conditions
Code
Success
InvalidcountryCode
InvalidCityCode
NumberIsNotANumber
93
IPv4 Number
GETIPADDRESSDETAILS
Purpose
This web service will return the details for the specified IP Address or IP Address Block. Only the IP
Address is a mandatory parameter all others are optional, except if the “IPControl” is specified as „I‟ –
Private, in which case the “NetworkName” will also need to be provided.
Input Parameters
Name Type Comment
IPAddress STRING The IP Address that will be
queried.
subnetMask LONG The CIDR (Classless Inter-
Domain Routing) or subnet of
the IP Addresses.
serviceType STRING (maximum 20 The service type of the
characters) service using the IP Address.
IPAddressType STRING This is the number sub type
rather than the number type,
since the number type is
always IPv4 for IP Addresses.
area STRING (maximum 15 The area code of the IP
characters) Address.
IPControl STRING (maximum 1 This would indicate if the IP
character) Number is going to be „O‟ –
Public or „I‟ – Private.
NOTE: If the IPControl
parameter is set to „I‟ –
Private then the NetworkName
becomes mandatory.
networkName STRING (maximum 40 The Name of the Network.
characters) Optional unless the IPControl
is „I‟ – Private then this
would become mandatory.
allAssociatedFlag STRING (maximum 1 If true, then returns all of
character) the IP Addresses that are
associated with the required
IP Address. Y=true, N=false
NOTE:
1. Default will be N=false,
which will just return the
details for the requested IP
Address.
2. If the AllAssociatedFlag
is set to Y=true then all of
the underlying IP Address.
Returns
Type Comment
IPAddressDetailsResult Returned result for the web service call
94
The IP Address Detail List.
Error Conditions
Code
Success
IPinvalidservicetype
IPInvalidnumberType
IPInvalidArea
IPInvalidIPControl
NoNumbers
IPInvalidNetName
IPInvalidCIDR
IPRequiredNetName
IPInvalidAllAssociatedFlag
IPNullIPAddress
IPInvalidAddress
GETIPNUMBERS
Purpose
This web service can be used to find one or more IP Addresses and commonly requested details
based on most attributes of an IP Address.
Input Parameters
Name Type Comment
characters) of the IP number e.g.DOMAIN.
numberSubType STRING Mandatory. The number type
e.g. TELECOM. Note the
following:
This value can only be up to
15 characters.
For IPv4 Numbers this would
be the Number SubType.
area STRING (maximum 15 Mandatory. The Area Code.
characters) Note: If there is not data
within the Area code field
within the table, the API
will not be able to extract
those IP Numbers since the
Area parameter is mandatory
and therefore can not be
NULL.
areaFlag LONG When the Area_Flag = 1 or is
NULL, the search assumes that
the IP Numbers can only be
associated with the specified
Area and no other. When
Area_Flag = 2, the search
assumes IP numbers are either
associated with the specified
95
Area or the next higher area.

If even one IP number is
found in the area, numbers in
the higher area will not be
returned.
IPControl STRING (maximum 1 This would indicate if the IP
character) Number is going to be „O‟ –
Public or „I‟ – Private.
NOTE: If the IPControl
parameter is set to „I‟ –
Private then the NetworkName
becomes mandatory.
characters) number e.g.AVAILABLE,
RESERVED, HELD.
howMany LONG Mandatory. Only values
greater than zero, the value
supplied specifies how many
IP Numbers or Blocks (if the
subnetMask is specified) to
retrieve.
networkName STRING (maximum 40 Optional. The Name of the
characters) Network.
subnetMask LONG Optional. The subnet mask.
This would be a value between
5 and 32.
Note
If the SubnetMask parameter is specified, the web service will return a block of number; if this is
NULL, then the individual numbers will be returned.
Returns
Type Comment
getIPNumbersResult Returned result for the web service call
The IP Address List.
Error Conditions
Code
96
Success
IPInvalidHowMany
IPinvalidservicetype
IPInvalidnumberStatus
IPInvalidnumberType
IPInvalidArea
IPInvalidIPControl
NoNumbers
IPInvalidAreaFlag
IPInvalidNetName
IPInvalidCIDR
IPRequiredNetName
RESERVEIPNUMBERS
Purpose
This web service can be used to either reserve a single IP Address or an IP Address Block identified
by its CIDR notation for a SERVICE or External System.
Input Parameters
Name Type Comment
entityType STRING (maximum Type should be set to „Service‟ or
100 characters) „External‟ and ID should be the
Service ID or the Reservation ID for
the numbers to be reserved.
entityID STRING (maximum The Service ID or the Reservation ID

100 characters) for the numbers to be reserved,
depending on the Entity_Type_IN value.
IPAddr STRING The starting IP address to be
reserved.
IPAddrEnd STRING For single IP Address reservations,
this is the ending IP address to be
reserved. This is only needed if more
than one single IP Address is to be
reserved at one time.
CIDR LONG This is null for a single IP Address
or a number between 5 and 32 for CIDR
reservations.
Note
The user running this web service must have either the IP_ADMINISTRATOR or
NM_MAINTENANCE role assigned.
If IPAddrEnd is used, the web service will reserve against the single address. If CIDR is used the
Block and the single addresses in the BLOCK will be reserved.
Returns
97
Type Comment
reserveIPNumbersResult Returned result for the web service call
Error Conditions
Code
EndingNumberInValid
Rangetoolarge
InvaliduserID
NumberNotAvailToRsrveNotQtined
NumberorNumbersareQuarantined
InvalidentityType
InvalidserviceID
InvalidentityID
NoNumbers
InvalidValue
98
UNRESERVEIPNUMBER
Purpose
This web service can be used to either un-reserve a single IP Address or an IP Address Block
identified by its CIDR notation, for Reservation ID, for IP Address(es) that have not yet been assigned
to a Service (i.e.: the Service ID column is NULL within the Numbers table).
Input Parameters
Name Type Comment
reservedID STRING Mandatory. The Reservation ID for the
numbers to be unreserved.
Note: The IP Number that is to have its
status changed from RESERVED ->
AVAILABLE must have a NULL Service_ID
field.
IpAddress STRING Mandatory. The starting IP address to be

unreserved.
IpAddressEnd STRING (maximum For single IP Address un-reservations,
40 characters) this is the ending IP address to be
unreserved. This is only needed if more
than one single IP Address is to be
unreserved at one time
CIDR LONG This is null for a single IP Address or
a number between 5 and 32 for CIDR un-
reservations.
Note
The user running this web service must have either the IP_ADMINISTRATOR or NM_MAINTENANCE role
assigned.
Only IP numbers that meet all criteria will be changed.
If IPAddrEnd is used, the web service will reserve against the single address (es). If CIDR is used, the Block and
the single addresses in the BLOCK will be unreserved.
The IP Number Range must Not have any ServiceID(s) specified.
The IP Number Range must have ALL the NUMB_RESERVE_ID's the same and/or Null.
The IP Number Range must have the ServiceStatus being 3 - 'RESERVED' and/or 2 - 'AVAILABLE'.
The IP Number Block and its sub Ranges must Not have any ServiceID(s) specified.
The IP Number Block and its sub Range must have ALL the NUMB_RESERVE_ID's the same and/or Null.
The IP Number Block and its sub Range must have the ServiceStatus being 3 - 'RESERVED' and/or 2 -
'AVAILABLE’.
Returns
Type Comment
web service call.
Error Conditions
Code
99
StartingNumberInvalid
EndingNumberInvalid
Rangetoolarge
InvalidEntityID
InvalidValue
IPNumbersAssigned2Service
IPNumbersWithMultiStatus
IPNumbersWithMultiReserveID
IPNoNumbers
100
Chapter 5 Service Manager
Summary of Service Management Web Methods and Data Objects available in this document.
createServiceOrder createServiceOrderResult
createWaitlistServiceOrder createWaitListServiceOrderResult
addExistingSOToWaiters addExistingSOToWaitersResult
cancelServiceOrder cancelServiceOrderResult
cancelWaiterOrder cancelWaiterOrderResult
transferService trasferServiceResult
setTaskStatus setTaskStatusResult
addServiceOrderComments commonResult
getServiceOrder getServiceOrderResult
getActiveServiceOrderID getServiceOrderIDResult
getServiceOrderID getServiceOrderIDResult
getServiceOrderStatus getServiceOrderStatusResult
getServiceOrderAttribute getServiceOrderAttributeResult
getServiceOrderAttributes getServiceOrderAttributesResult
getServiceOrderFeature getServiceOrderFeatureResult
getServiceOrderFeatures getServiceOrderFeaturesResult
getServiceOrderMilestones getServiceOrderMilestonesResult
getServiceOrderServiceID getServiceOrderServiceIDResult
getServiceOrderIDList serviceOrderIDExtendedResult
linkFacilityToSOWaiter commonResult
setServiceOrderAttribute commonResult
setServiceOrderAttributes commonResult
getServiceList getServiceListResult
getService getServiceResult
getServiceDetails getServiceDetailsResult
getServiceHierarchy getServiceHierarchyResult
101
getServiceIDsByName serviceIDExtendedResult
getServiceNodeByAddress getServiceNodeByAddressResult
getAddressByLocation getAddressByLocationResult
getWorkOrder workOrderDetailsResult
updateWorkOrderDetails workOrderDetailsResult
updateWorkOrderStatus commonResult
updateWorkOrderApproval commonResult
insertWorkOrderComment insertWorkOrderCommentResult
getWorkOrderActivity getWorkOrderActivityResult
updateWorkOrderActivityStatus commonResult
getServiceManagerIDByJobTicket serviceManagerIDResult
getAreaServiceTypeWorkGroup getAreaServiceTypeWorkGroupResult
getAllowedServiceTypes (for PLDT) getAllowedServiceTypesResult (for PLDT)
Service Provisioning API
setRequestStatus commonResult
102
Sevice Management Data Objects
This section lists the data objects used by the Service Management web services.

The following are the generic objects used by the Service Manager web services.
 ReturnStatus
 CommonResult
 AppConstant
 wsAttribute
WSATTRIBUTE
A data type that describes the service order attributes.

(maximum 240
characters)

(maximum 1000
characters)
WSADDRESS

suiteNumber STRING The suite number of the address. NULL

(maximum 20 allowed.
characters)
levelNumber STRING The level number of the address. NULL

characters)
streetNumber STRING The street number of the address. NULL

characters)
streetName STRING A reference to a valid street name. NULL

characters)
postCode STRING The postal code of the area containing this

(maximum 40 address. NULL allowed.
103
characters)
suburb STRING The name of the suburb/town containing this

characters)
city STRING The name of the city containing this address.

characters)
stateCode STRING A reference to a valid state.

(maximum 40
characters)
country STRING The name of the country containing this

characters)
attributes wsAttribute An array of wsAttribute.Supplementary data

about the address. NULL allowed.
interface.
Attributes:
WSCOMMENT
A data object containing details in comments including comment date and content.
commentText STRING The text of comment.

(maximum 1000
characters)
createdBy STRING The user who created the comment.

(maximum 20
characters)
timeStamp DATE The date when the comment created.
WSFEATURE
A data object that groups a feature, list of attribute values and the action to be taken on a single
entity.
104
Field Name Data Type Description
parent STRING (maximum 240 The parent field is used in

characters) constructing complex data
objects in conjunction with
other feature objects and
feature lists. Service orders
that do not require complexity
of high-level data object should
disregard this field. The parent
field contains the name of the
parent feature for the current
object. A single object can
therefore be used to form a
single linked list that points
from one Feature object to
another. This property when used
within a FeatureList allows for
the representation of complex
structured data types.
action STRING (maximum 20 The action attribute can be used

characters) to specify the action to be
taken against that feature. The
valid values and their
description are shown in the
Actions table provided below.
featureName STRING (maximum 240 The feature name.

characters)
attributes wsAttribute The feature attributes.
Note that a Feature is an object type that groups a feature, its list of attribute values and the action to
be taken on a single entity.
The Action attribute can be used to specify the action to be taken against that feature. The valid
values and their description are shown in the following table:
Action Description
ADD The feature and its associated attributes are to be added.
Y Same as ADD above.
REMOVE The feature is to be removed.

N Same as REMOVE above.
UPDATE The value of the feature attributes will be updated. The
feature values will stay the same.
U Same as UPDATE above.
NOCHANGE No change to be made.
Parent is used in constructing complex data structure in conjunction with other Feature objects and
FeatureList. Service orders that do not require the complexity of higher-level data structures should
disregard this field. The parent field contains the name of the parent feature for the current object. A
single object can therefore be used to form a singly linked list that points from one Feature object to
another. This property when used within a FeatureList allows for the representation of complex
structured data types, discussed in the section below.
105
WSNODE
A data object that list all the DPs or BTSes matching the address serviceability for the passed
address.
entityLocation STRING Location of the object.

(maximum 20
characters)
entityType STRING NE or Frame Type.

(maximum 15
characters)
entityIndex STRING Index of the object.

(maximum 15
characters)
WSLINKADDRESS
A data object that link an ID to a valid address.
addressId LONG Address ID to link against.
action STRING (maximum 10 The action to be taken for the

characters) specified address. Valid action
values are:
 A - Add. This action will
add the address.
 D - Delete. The action
will delete this address.
 N - No change. No action
will be taken on the
address.
WSSERVICE
A data object contains all information that defines a service.
customerID STRING (maximum 15 The id of the customer

characters) requesting the Service Order.
This is derived from a customer
record in the Corporate Manager
module. If a NULL value is
supplied, the API will
automatically populate the
value „SELF‟.
accountID STRING (maximum 10 The account ID for this order.

characters) This value is derived from an
account record in the Corporate
Manager module.
106
serviceType STRING (maximum 20 The type of service being
characters) ordered. This is based on the
service types defined in the
Service Definition reference
data window.
serviceSpeed STRING (maximum 20 The service speed associated

characters) with this service.
AddressIDA LONG Identifies the A-end address of

a service.
AddressIDB LONG Identifies the B-end address of

a service.
attributes wsAttribute A list of attributes associated

with the Service.
features wsFeature A list of features associated

with the Service.
WSSERVICEORDER
A data object that encompasses all the information required to ensure the successful creation of a
service order.
customerID STRING (maximum 15 The customer ID requesting the

characters) Service Order. This refers to a
customer record in the
Corporate Manager module. If a
NULL value is supplied, the API
will automatically populate it
with the value „SELF‟.
accountID STRING (maximum 10 The account ID for this order.

characters) This refers to an account
record in the Corporate Manager
module.
serviceType STRING (maximum 20 The type of the service being

characters) ordered. This is derived form
service types pre-defined in
the Service Definition
reference data window.
serviceSpeed STRING (maximum 20 The speed associated with this

characters) service.
addressIdA LONG Identifies the A-end address of

a service.
addressIdB LONG Identifies the B-end address of

a service.
projectId STRING (maximum 20 Identifies the customer‟s

characters) project.
107
servicePriority STRING (maximum 20 Specifies the priority that

characters) will be assigned to this
service order.
orderType STRING (maximum 20 Implementation controlled

characters) attribute; refers to the type
of order. The orderType should
be restricted to the clarity
provided order types. Any
additional order type should be
pre-discussed.
orderSubtype STRING (maximum 240 Defines an order sub-type. In

characters) some circumstances there is a
need for finer granularity to
differentiate between various
orders that the order Type can
offer.
externalID STRING (maximum 20 The id assigned to the service

characters) order in the CRM system. It
should be a unique identifier
for the service throughout its
lifespan.
slaClass STRING (maximum 20 The class of the SLA offered

characters) for this service.
areaCode STRING (maximum 15 A code that identifies a

characters) geographical area. Provides
additional information during
the assignment of tasks to the
appropriate workgroups.
workGroup STRING (maximum 20 The workgroup that owns this

characters) service order.
finishDate DATE The date by which the service

order is committed to be
completed. If this is null,
then this parameter will not be
used.
comments wsComment Any extra comments to be

attached to the order. If this
is null, then the parameter
will not be used. Refer to
Reference Data Document.
attributes wsAttribute Implementation controlled

attribute. A list of attributes
associated with the Service
Order. An example of Service
Order Attribute could be
“ApprovedBy” which should be
populated with the name of the
user who approved the Order.
features wsFeature A list of features associated

with the Service Order.
108
WSSTATUSDETAIL
An object types that group‟s information regarding an important milestone event into a single entity.
This type is typically used in the call back API to channel information back to an external system when
a service order has reached a milestone stage. For further information about this type, refer to the
procedure:milestoneReached.
implementationTask STRING (maximum 20 The name of the task.

characters)
workGroupID STRING (maximum 20 The name of the work group that

characters) has been assigned to the task.
taskStatus STRING (maximum 20 The status of the task.

characters)
statusDate DATE The date when the status is

changed.
milestone STRING (maximum 1 A value to denote whether this

character) is a milestone task. Either „Y‟
or „N‟.
comments wsComment A free text field to enter

comments.
CREATESERVICEORDERRESULT
An object represents the result of web service calls createServiceOrder.
serviceID STRING A unique identifier for the

service being offered.
serviceOrderID STRING A unique identifier for the

service orders.
returnStatus returnStatus Contains return status of a web

service call.
CREATEWAITLISTSERVICEORDERRESULT
An object represents the result of web service calls createWaitlistServiceOrder.
serviceID STRING (maximum 25 A unique identifier for the

characters) service being offered.
waiterID STRING (maximum 20 A unique identifier for the

characters) service orders pushed to the
waiters list.

service call.
109
ADDEXISTINGSOTOWAITERSRESULT
An object represents the result of web service calls addExistingSOToWaiters.
waiterID STRING A unique identifier for the

service orders pushed to the
waiters list.

service call.
CANCELSERVICEORDERRESULT
An object represents the result of web service calls cancelServiceOrder.

service call.
CANCELWAITERORDERRESULT
An object represents the result of web service calls cancelWaiterOrder.

service call.
TRASFERSERVICERESULT
An object represents the result of web service calls transferService.

service call.
SETTASKSTATUSRESULT
An object represents the result of web service calls setTaskStatus.

service call.
GETSERVICEORDERRESULT
An object represents the result of web service calls getServiceOrder.
wsServiceOrder wsServiceOrder A list of Service Orders

associated with the Service
Order.
110
service call.
GETSERVICEORDERIDRESULT
An object represents the result of web services call getServiceOrderID and getActiveServiceOrderID.

service order.

service call.
GETSERVICEORDERSTATUSRESULT
An object represents the result of web service calls getServiceOrderStatus.
statusDetailList wsStatusDetail A list of status assocated with

the Service Order.

service call.
GETSERVICEORDERATTRIBUTERESULT
An object represents the result of web service calls getServiceOrderAttribute.
attributeValue STRING The attribute value of a service

order.

service call.
GETSERVICEORDERATTRIBUTESRESULT
An object represents the result of web service calls getServiceOrderAttributes.
attributes wsAttribute A list of attributes associated with

the Service Order.

service call.
GETSERVICEORDERFEATURERESULT
An object represents the result of web service calls getServiceOrderFeature.
featureValue STRING The feature value of a service
111
order.

service call.
GETSERVICEORDERFEATURESRESULT
An object represents the result of web service calls getServiceOrderFeatures.
feature wsFeature A list of features associated

with the Service Order.

service call.
GETSERVICEORDERMILESTONESRESULT
An object represents the result of web service calls getServiceOrderMilestone.
statusDetailList wsStatusDetail A list of status associated with

the Service Order to gather
milestone information from.

service call.
GETSERVICEORDERSERVICEIDRESULT
An object represents the result of web service calls getServiceOrderServiceID.


service call.
WSSERVICEORDERIDEXTENDED
An object contains additional information that defines a service order.

Service Order ID.
serviceType STRING The service type.
status STRING The Service Order status.
SERVICEORDERIDEXTENDEDRESULT
An object that returns result of a web service calls getServiceOrderIDList.
112
serviceOrderIDExtendedList wsServiceOrderIDExtended A list of Service

Order ID‟s service
type and statuses.
callStatus returnStatus Contains return

status of a web
service call.
WSCIRCUITSERVICE
An object contain services detail given the circuit displayname starting with the given service number.
serviceType STRING The type of the service being

ordered. This is derived form
service types pre-defined in
the Service Definition
reference data window.

serviceStatus STRING Indicates the service status.
serviceSpeed STRING The service speed associated

with this service.
circuitDisplayname STRING Circuit Display Name.
GETSERVICELISTRESULT
An object represents the result of web service calls getServiceList.
serviceList wsCircuitService A list of services returned is

lookedup from the Circuits table
having Circuit Displayname
starting with the given Service
Number (phone number).

service call.
GETSERVICERESULT
An object represents the result of web service calls getService.
wsService wsService A list of services associated with

the existing Service.
returnStatus returnStatus Contains return status of the web

service call.
113
WSSERVICEDETAILS
An object contains all information that defines a service.
myCustomerID STRING (maximum The id of the customer requesting

15 characters) the Service Order. This is
derived from a customer record in
the Corporate Manager module. If
a NULL value is supplied, the API
will automatically populate the
value „SELF‟.
myAccountID STRING (maximum The account ID for this order.

10 characters) This value is derived from an
account record in the Corporate
Manager module.
myServiceType STRING (maximum The type of service being

20 characters) ordered. This is based on the
service types defined in the
Service Definition reference data
window.
myServiceSpeed STRING (maximum The service speed associated with

20 characters) this service.
myParentServiceID STRING (maximum The service ID for the parent

25 characters) service when the service is part
of a parent child service
relationship.
myAddressIDA LONG Identifies the A-end address of a

service.
myAddressIDB LONG Identifies the B-end address of a

service.
myAttributes wsAttribute A list of attributes associated

with the Service.
myFeatures wsFeature A list of features associated

with the Service.
myDetails wsAttribute A list of attributes associated

with the Service
GETSERVICEDETAILSRESULT
An object represents the result of web service calls getServiceDetails.
myServiceDetails ServiceDetails A list of services associated

with the existing services (full
details compare to GetService).
mycallStatus returnStatus Contains return status of a web

service call
114
WSSERVICEHIERARCHY
An object defines the parent child service relationship.
parentServiceId STRING (maximum The service ID for the parent

relationship.
childServiceId STRING (maximum The service ID for the child

relationship.
GETSERVICEHIERARCHYRESULT
An object represents the result of web service calls getServiceHierarchy.
serviceHierarchyList wsServiceHierarchy A list of service hierarchy

associated with a service.
callStatus returnStatus Contains return status of a web

service call.
WSSERVICEIDEXTENDED
A data object contains extended information associated with the service.
serviceID STRING (maximum A unique identifier for the

25 characters) service being offered.
serviceType STRING (maximum The type of service.

20 characters)
status STRING (maximum The status of the service.

20 characters)
SERVICEIDEXTENDEDRESULT
An object represents the result of web service calls getServiceIDsByName.
serviceIDExtendedList wsServiceIDExtended A list of Service IDs

associated with service types
and statuses.

service call.
GETSERVICENODEBYADDRESSRESULT
An object represents the result of web service calls getServiceNodeByAddress.
115
nodeList wsNode A list of node associated with

the service.

service call.
GETADDRESSBYLOCATIONRESULT
An object represents the result of web service calls getServiceNodeByAddress.
addressList wsAddress A list of addresses that are

being served by the specified
node.

service call.
WORKORDERDETAILS
An object contains all information to define a work order.
myserviceOrderId STRING The ID of the Service Order that this

(maximum 20 Work Order belongs to.
characters)
myworkGroup STRING The Work Group assigned to the Work

(maximum 20 Order.
characters)
myorderType STRING The Order Type for the Work Order.

(maximum 20
characters)
mycircuitId STRING The ID of the Circuit that the Work

(maximum 55 Order is associated with.
characters)
myfaultId INT The ID of the Fault that the Work Order

is associated with.
mytaskId INT The ID of the Service Implementation

Task that the Work Order is associated
with.
mydescription STRING The Work Order description.

(maximum 2000
characters)
mydetails wsAttribute An array of Attribute object.

Supplementary data about the work order.
NULL is allowed. The allowed work order
details are: CREATEDBY, CREATEDDATE,
REVIEWEDBY, REVIEWEDDATE, APPROVEDBY,
116
APPROVEDDATE, ASSIGNED_DATE,
PROPOSED_START_DATE, PROPOSED_END_DATE,
ACTUAL_START_DATE, ACTUAL_END_DATE,
UPDATEDBY, STATUS, STATUSDATE, TASKNAME,
TRUG_ID, TROT_NUMBER, PLET_ID, PETW_ID,
PETF_ID, AREA_CODE and EMPE_ID.
WORKORDERDETAILSRESULT
An object that contains all the information returned by web services call getWorkOrder and
updateWorkOrderDetails.
myDetails workOrderDetail Contain work order details.

s
mycallStatus returnStatus Contains return status of a web service

call.
WORKORDERCOMMENT
An object contains all information to define a work order comment.
myworkOrderId STRING(maximum 20 The Work Order ID that this

characters) comment belongs to.
mycomment STRING(maximum 1000 The comment text.

characters)
mycommentDate DATE The date the comment was added.
myuserName STRING(maximum 40 The Username of the employee

characters) inserting the comment.
mydetails wsAttribute Unused: This is present for

future use if required. Null
allowed.
INSERTWORKORDERCOMMENTRESULT
An object represents the result of web service calls insertWorkOrderComment.
myworkOrderCommentID STRING An ID created for the newly created

Work Order comment.

service call.
117
WORKORDERACTIVITY
A data object contains details of the work order activity.
myWorkOrderId STRING (maximum The Work Order ID that this

20 characters) activity belongs to.
myActivityName STRING (maximum The Work Order Activity Name

20 characters)
myWorkGroup STRING (maximum The Work Group assigned to the Work

20 characters) Order Activity.
myAssignedDate DATE The date that the workorder is

assigned.
myDetails wsAttribute An array of wsAttribute object.

Contains supplementary data about
the work order activity. NULL is
allowed. The allowed work order
activity details are: SEQUENCE,
TIMING, STATUS, STATUSDATE,
USERNAME, PROPOSED_START_DATE,
PROPOSED_END_DATE,
ACTUAL_START_DATE, ACTUAL_END_DATE,
EMPE_ID and ACLN_NAME.
GETWORKORDERACTIVITYRESULT
An object represents the result of web service calls getWorkOrderActivity.
myworkOrderActivity workOrderActivity An object containing details in

work order activity.

service call.
WSSERVICEMANAGERID
An object describing Service Manager ID values associated with a Job Ticket.

ServiceOrderID STRING A unique identifier for the

service orders.
taskID STRING The ID of the Service

Implementation Task that the Work
Order is associated with.
serviceName STRING The service name
118
workOrderID STRING The Work Order ID that this
comment belongs to.
workOrderActivityID STRING The Work Order Activity ID that

this comment belongs to.
SERVICEMANAGERIDRESULT
An object represents the result of web service calls getServiceManagerIDbyJobTicket.
ServiceManagerID wsServiceManagerID A list of job tickets associated

with the service order.

service call.
WORKORDERAPPROVAL
A data object contains details of the work order approval.
myReviewedBy STRING (maximum The name of the user who reviewed the
80 characters) work order. The name can be NULL,
however once entered, it must be an
valid reference to Employee database
table. If there is an existing entry,
any later value will be ignored.
myReviewedDate DATE The date when the work order was

reviewed. NULL is allowed. If NULL is
provided, sysdate will be used by
default.
myApprovedBy STRING (maximum The name of the user who approved

80 characters) the work order. The name can be NULL,
however once entered, it must be a
valid reference to Employee database
table. If there is an existing entry,
any later value will be ignored.
myApprovedDate DATE The date when the work order was

approved. NULL is allowed. If NULL is
provided, sysdate will be used by
default.
WORKORDERSTATUS
A data object contains status of the work order.
myworkGroup STRING (maximum The work group which the work order
20 characters) associates.
mystatus STRING (maximum The status of a work order. The

20 characters) number of status varies and is
119
configurable; refer to Clarity form

Status to get a list of valid status
configured in your site.
mystatusDate DATE The date that the Status was last

changed for the Work Order. NULL is
allowed. If NULL is provided, sysdate
will be used by default.
myuserName STRING (maximum The name of the user updating the

40 characters) work order.
GETAREASERVICETYPEWORKGROUPRESULT
An object represents the result of web service calls getAreaServiceTypeWorkGroup.
workGroup STRING A unique identifier for the Work

Group.

service call.
GETALLOWEDSERVICETYPESRESULT (FOR PLDT)

An object represents the result of web service calls getAllowedServiceTypes.
serviceType STRING A unique identifier for the service

orders.

service call.
120
Service Management Web Methods
This section explains the Service Management web services in detail.
CREATESERVICEORDER
Purpose
This web service is used to create a service order for a service. Renew and reconnect orders are
supported but the order type must be RENEW OR RECONNECT.
Input Parameters
Name Type Comment
serviceOrder* wsServiceOrder An instance of a
ServiceOrder object. *Refer
to the table below that
shows the optionality of
the individual fields.
serviceID STRING (maximum 25 The service ID. Optional
characters) when the request is for a
new service (orderType =
„CREATE‟). If provided, it
will be used as the service
ID for the new service;
otherwise, the system will
generate a unique ID
automatically.
For other order types, it
identifies the service id
that the new service order
will be associated with. An
Invalid Service ID error
will be raised if it is
NULL or does not exist.
parentServiceId STRING (maximum 25 Service ID of the parent

characters) service for this service
order.
linkAddressList wsLinkAddress Contains the list of
addresses to be linked to
this service order.
parentServiceOrder STRING Optional. The service order

ID id of the parent. This is
to group the service orders
only. This must not be used
where the service types are
not defined as parent/child
service definition screen.
* The following table shows which components of the “Service Order” data type are optional and
which are mandatory.
Attribute When orderType = ‘CREATE’ Other order types
customerId Mandatory Optional
accountId Optional Optional
121
seviceType Mandatory Optional
serviceSpeed Mandatory Optional
addressIda Optional Optional
addressIdb Optional Optional
projected Optional Optional
servicePriority Mandatory Mandatory
orderType Mandatory. See Note Mandatory. See Note
orderSubtype Optional Optional
externalId Optional Optional
slaClass Optional Optional
areaCode Specific to service type Optional
workGroup Mandatory Mandatory
finishDate Optional Optional
comments Optional Optional
attributes Specific to service definition Specific to service definition
features Optional Optional
Service Order Components Table

Returns
Type Comment
createServiceOrderResult The service order ID of the newly created
order will returned if it succeeds; otherwise
NULL will be returned.
Note
 If a new service needs to be created as a result of this service order, the ServiceID passed by
the caller will be used, if available, otherwise a new ServiceID will be created automatically. In
both cases, the serviceID used is returned in the out ServiceID parameter. Data requirements
of attributes and features may differ according to the type of the order and service.
 Order types: There are currently 3 distinct classes of order type that are treated differently:
„CREATE%‟: service order is created with only basic validation against reference
values in service definition. Values are either copied as is from the service order or
derived from the service definition template. The service itself should not exist and
will be created by this order. An error will be raised if the service already exist (i.e.
service ID already in use if specified)
Any other except „DELETE‟: A service ID must be specified in this order type and must
be a pre-existing service. Compatibility checks will be performed between the
service order and existing service, in addition to basic checks mentioned above.
„DELETE‟: Similar to the above, except all feature values will be converted to N
automatically. The generated service order record will also contain all features that
122
are contained in the existing service, even if they are not specified in the service
order itself. Essentially feature actions are ignored for a DELETE service order.
 Invalid Feature Requested error: Arbitrary feature name will be accepted if the service type is
configured to allow extra features. However, the parent child structure in the feature list must
always be maintained so that there are no orphaned child features.
 Incompatible Feature Action: this error applies only to service order whose order type is not
like „CREATE%‟ or „DELETE‟ and may occur if the action of a feature specified in the service
order object is the same as the current feature action value. CREATE is exempt because
there is no previous values to compare to, DELETE is also exempt because all feature action
will automatically be converted to N.
Error Conditions
Code
Invalid Service ID
Invalid Customer ID
Invalid Account ID
Invalid Service Type
Invalid Address ID
Invalid Order Type
Invalid Attribute Name
Invalid Speed For Service Type
Invalid finish Date
Service Order Already Exists
Missing Attribute
Invalid Workgroup
Invalid Area code
Invalid Service Priority
Invalid Duration Class
Invalid Parent Service
Invalid Link Address
Invalid Link Address Action
Invalid Feature Requested
Invalid Feature Action
Invalid Child Feature Action
Feature Not Found For Update
Incompatible Feature Action
123
CREATEWAITLISTSERVICEORDER
Purpose
This web service is used to add a service order to a wait list.
Input Parameters
Name Type Comment
serviceOrder wsServiceOrder An instance of the service
order object. See the Service
Order Components table in the
previous section for the
optionality of individual
fields.
serviceId STRING (maximum 25 The service Identifier. It is
characters) optional when the request is
for a new service (orderType =
„CREATE‟). If provided, it will
be used as the service ID for
the new service; otherwise, the
system will generate a unique
ID automatically.
For other order types, it
identifies the service id that
the new service order should be
associated with. An Invalid
Service ID error will be raised
if it is NULL or does not
exist.
comment STRING (maximum 1000 These comments will be shown on

characters) the Service Orders Waiters
window in the Clarity
application.
Returns
Type Comment
createWaitListServiceOrderR The waiter identifier that identifies the
esult waiter entry created. If the operation fails
it will contain NULL.
Note
Any error conditions and notes from createServiceOrder() will also apply to this web service.
Error Conditions
Code
InvalidServiceID
InvalidCustomerID
Invalid Account ID
Invalid Speed For Service Type
Invalid Address ID
Invalid Order Type
124
Invalid finish Date
Missing Attribute
Invalid Workgroup
Invalid Area code
Invalid Service Priority
Invalid Duration Class
Invalid Feature Action
Invalid Child Feature
Action Feature Not Found For Update
Incompatible Feature Action
ADDEXISTINGSOTOWAITERS
Purpose
This web service cancels the processing of a service order and moves it to the waiters list.
Input Parameters
Name Type Comment
serviceOrderID STRING Mandatory. Refers to the
Service Identifier that
identifies the Service Order
that will be moved to waiter
management.
comments STRING(maximum 1000 Optional. These comments will

characters) be shown on the Service Orders
Waiters window in the Clarity
application.
Returns
Type Comment
addExistingSOToWaitersResul Returned results for the web service call
Waiter ID of the waiter that has been
created. If the operation fails it will
contain NULL.
Note
Error Conditions
Code
Invalid Service Order ID
WaiterForSOExists
DuplicateWaiterRequest
125
CANCELSERVICEORDER
Purpose
This web service is used to cancel an existing service order.
Input Parameters
Name Type Comment
serviceOrderId STRING (maximum 20 Mandatory. Refers to the
characters) service order ID that
identifies the order to be
cancelled.
comments wsComment Mandatory. The user must

enter a reason for the
cancellation to occur.
Returns
Type Comment
cancelServiceOrderResult Returned result for the web service call
The result of web service call.
Note
Two service order comments will be added after this call:
1.A message that signifies the service order was closed by means of an API call.
2.The user comment passed to this call.
Error Conditions
Code
Invalid ServiceOrderID
No Cancellation Reason
CANCELWAITERORDER
Purpose
This web service cancels the processing of an existing waiter order.
Input Parameters
Name Type Comment
waiterID STRING (maximum 20 Mandatory. Specifies the
characters) waiter ID of the order to
cancel.
Returns
Type Comment
cancelWaiterOrderResult Returned results for the web service call
Note
Error Conditions
126
Code
InvalidWaiterID
TRANSFERSERVICE
Purpose
This web service transfers a service from one customer to another.
Input Parameters
Name Type Comment
serviceID STRING (maximum 25 Mandatory. Specifies the
characters) service ID that identifies the
service to be transferred.
customerId STRING (maximum 15 Mandatory. Specifies the new

character) customer that will receive the
service.
accountId STRING (maximum 20 Optional. The new customer‟s
characters) account ID to which the
service is moved.
It is only optional if the
service did not have an
account ID assigned to it. The
overall effect of this
condition is that as soon as
an account ID is assigned, it
cannot be nullified anymore.
Returns
Type Comment
transferServiceResult Returned results for the web service call
containing the following information
Error Conditions
Code
Invalid Customer ID
Invalid Account ID
Invalid Service ID
127
SETTASKSTATUS
Purpose
This web service sets the status for an external task. The external task must be in the „IN
PROGRESS‟ status, otherwise the procedure will fail.
Input Parameters
Name Type Comment
ServiceOrderId STRING Mandatory. The service order
ID requiring the task status
change.
ImplementationTa STRING (maximum 20 Mandatory. The name of the

sk characters) implementation task whose
status will be changed.
taskStatus STRING Mandatory. The task status
that is requested. It can
only be “COMPLETED”.
comments STRING (maximum 1000 Comments/reason for changing
characters) the status.
Returns
Type Comment
setTaskStatusResult Returned results for the web service call
Error Conditions
Code
Invalid SetTaskStatusRequest
Invalid taskStatus
ADDSERVICEORDERCOMMENTS
Purpose
This web service appends a comment to a service order.
Input Parameters
Name Type Comment
ServiceOrderId STRING (maximum 20 Mandatory. This refers to the
characters) service order ID requiring an
appended comment.
comment wsComment It is mandatory to add

comments to the service
order. If the comment text
body is NULL, the comment
will not be inserted.
Returns
Type Comment
128
CommonResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidServiceOrderID
GETSERVICEORDER
Purpose
This web service retrieves the details of a Service Order during or on completion of processing by the
Service Manager.
Input Parameters
Name Type Comment
serviceOrderId STRING Mandatory. The Service Order
ID for the Service Order to
be retrieved.
Returns
Type Comment
getServiceOrderResult Returned results for the web service call
The Service Order.
Note
This function can be used to monitor the status of the service order during processing by Service
Manager. Normally, this function is used in conjunction with the Service Manager Callback API when
a callback to that web service indicates that the service order status has changed.
Error Conditions
Code
GETACTIVESERVICEORDERID
Purpose
This web service returns the service order ID of the active service order for the given service ID.
Input Parameters
Name Type Comment
serviceId STRING (maximum 25 Mandatory. Identifies the
characters) service to retrieve a service
order from.
Returns
Type Comment
getServiceOrderIdResult Returned result for the web service call
The service order ID that identifies the
129
service order currently being processed for

the specified service. NULL if no such order
exists.
Error Conditions
Code
Invalid ServiceID
GETSERVICEORDERID
Purpose
This web service returns the last service order ID for the given service ID identified by the external ID.
If a service ID is not given, the service order ID identified by the external ID will be returned.
Input Parameters
Name Type Comment
serviceId STRING (maximum 25 Optional if the externalID
characters) value is not null. ServiceId
identifies the service to
retrieve a service order
from.
externalId STRING (maximum 20 Optional if the serviceID

characters) value is not null and
identifies the service to
retrieve a service order
from.
Returns
Type Comment
getServiceOrderIdResult Returned result for the web service call
The service order ID for the specified
Service Order identified by the Service ID or
External ID.
Error Conditions
Code
Invalid Argument
Invalid ServiceID
Alias Not Found
GETSERVICEORDERSTATUS
Purpose
This web service reports on the status of the execution of a service order.
Input Parameters
Name Type Comment
ServiceOrderId STRING (maximum 20 Mandatory. Identifying the
130
characters) required service order.
Returns
Type Comment
getServiceOrderStatusResult Returned result for the web service call
The current Order status.
A list of all the tasks.
Error Conditions
Code
GETSERVICEORDERATTRIBUTE
Purpose
This web service retrieves the value of a single attribute of a service order.
Input Parameters
Name Type Comment
ServiceOrderId STRING Mandatory. The service order
ID of the service order.
attributeName STRING (maximum 100 Mandatory. The name of the

characters) requested attribute.
Returns
Type Comment
getServiceOrderAttributeRes Returned results for the web service call
ult containing the following information:
The attribute value. If there is an error
this field will contain NULL.
Error Conditions
Code
131
GETSERVICEORDERATTRIBUTES
Purpose
This web service can be used to retrieve attributes associated with a Service Order during or on
completion of its processing by the Service Manager.
Input Parameters
Name Type Comment
ID that identifies a Service
Order to gather the attribute
list from.
Returns
Type Comment
getServiceOrderAttributesRe Returned results for the web service call
sult containing the following information:
The list of attribute associated with the
service order. An empty list if there is an
error
Error Conditions
Code
GETSERVICEORDERFEATURE
Purpose
This web service retrieves the value of a single feature for a service order.
Input Parameters
Name Type Comment
serviceOrderId STRING (maximum 20 Mandatory. The Service Order
characters) ID that identifies a Service
Order.
featureName STRING (maximum 240 Mandatory. The name of the

characters) requested feature.
Returns
Type Comment
getServiceOrderFeatureResul Returned result for the web service call
The feature value.
Error Conditions
Code
132
GETSERVICEORDERFEATURES
Purpose
This web service retrieves the features associated with a service order.
Input Parameters
Name Type Comment
ID identifies a Service Order
to gather the attribute list
from.
Returns
Type Comment
getServiceOrderFeaturesResu Returned result for the web service call
lt containing the following information:
The list of features associated with the
specified service order.
Error Conditions
Code
GETSERVICEORDERMILESTONES
Purpose
This web service reports on the status of the execution of a service order by providing a history of
milestone tasks.
Input Parameters
Name Type Comment
ServiceOrderId STRING (maximum 20 Mandatory. The service order
characters) ID that identifies the
Service Order to gather
milestone information from.
Returns
Type Comment
getServiceOrderMilestoneRes Returned result for the web service call
A list of milestones reached so far.
Error Conditions
Code
133
GETSERVICEORDERSERVICEID
Purpose
This web service returns the Service ID of a given service order already submitted to the Service
Manager module.
Input Parameters
Name Type Comment
serviceOrderId STRING (maximum 20 Mandatory. The Service ID
characters) identifies with the specified
Service Order.
Returns
Type Comment
getServiceOrderServiceIdRes Returned result for the web service call
The service ID that identifies the service
associated with the specified Service Order.
Error Conditions
Code
GETSERVICEORDERIDLIST
Purpose
This web service returns a list of Service Orders with their service type and statuses where the
Service Order has either the specified Parent Service Order ID or External ID. The output can be
refined by specifying a specific service order status to retrieve.
Input Parameters
Name Type Comment
parentServiceOrder STRING Optional. The input Service

ID Order Parent Order ID.
externalID STRING Optional. The input Service

Order External ID.
status STRING Optional. The input Service

Order Status filter
Returns
Type Comment
serviceOrderIDExtendedResul Returned results for the web service call
A list of Service Order ID‟s service types
and statuses.
Note:
134
One of either Parent Service Order ID or External ID must be provided.
Error Conditions
Code
Invalid Argument
LINKFACILITYTOSOWAITER
Purpose
This web service linked facility to a service order waiter.
Input Parameters
Name Type Comment
serviceOrderWait STRING Mandatory. The service order
erId ID requiring an appended
comment.
facilityType STRING The type of facility.
facilityFracEqup STRING The Frame Container Equipment

Type Type.

Locn Location.

Index Index
Returns
Type Comment
web service call
Error Conditions
Code
SETSERVICEORDERATTRIBUTE
Purpose
This web service sets the value of a service order attribute of an existing and active service order.
Input Parameters
Name Type Comment
serviceOrderId STRING Mandatory. The service order
id to which the service order
attribute is set.
attributeName STRING Mandatory. The name of the

attribute to set.
attributeValue STRING Optional. The value to set.
Returns
Type Comment
135
web service call.
Error Conditions
Code
SETSERVICEORDERATTRIBUTES
Purpose
This web service sets the values of multiple service order attributes of an existing and active service
order.
Input Parameters
Name Type Comment
serviceOrderId STRING Mandatory. The service order
id to which the service order
attribute is set.
attributeList wsAttribute Mandatory. An AttributesList

containing the attribute and
value pair to set.
Returns
Type Comment
commonResult Returned results for the web service call
The attribute and value pair to set.
Error Conditions
Code
GETSERVICELIST
Purpose
This web service gets a list of services for a particular service number (phone number).
Input Parameters
Name Type Comment
serviceNumber STRING Mandatory. The service number
for which a list of services
is to be retrieved.
Returns
Type Comment
getServiceListResult Returned results for the web service call
A list of services which the object
attributes such as Service Type, Service ID,
136
Status, Speed or Circuit Display Name.
Error Conditions
Code
Invalid Service Number
Service Number Does Not Exist
GETSERVICE
Purpose
This web service is used to retrieve the details of an existing Service.
Input Parameters
Name Type Comment
serviceId STRING Mandatory. The service id for
the Service to be retrieved.
Returns
Type Comment
getServiceResult Returned result for the web service call
The Service object.
Error Conditions
Code
Invalid ServiceID
GETSERVICEDETAILS
Purpose
This web service is used to retrieve the details of an existing Service.
Input Parameters
Name Type Comment
serviceId STRING Mandatory. The Service ID for
the Service to be retrieved.
Note
getServiceDetails returns the full service record unlike getService.
Returns
Type Comment
getServiceDetailsResult Returned results for the web service call
The retrieved full service record unlike
getService.
137
Error Conditions
Code
Invalid ServiceID
GETSERVICEHIERARCHY
Purpose
This web service will return all the related services for a given service.
Input Parameters
Name Type Comment
serviceID STRING Mandatory. The Service ID.
Returns
Type Comment
getServiceHierarchyResult Returned results for the web service call
List of related service.
Error Conditions
Code
Invalid ServiceID
GETSERVICEIDSBYNAME
Purpose
This web service returns a list of services with their service type and statuses where the service has
the specified display name.
Input Parameters
Name Type Comment
servicename STRING Mandatory. The input Service

Display Name.
Returns
Type Comment
serviceIDExtendedResult Returned results for the web service call
A list of Service ID‟s service types and
statuses.
Error Conditions
Code
Invalid Argument
138
GETSERVICENODEBYADDRESS
Purpose
This web service returns Frame (DP) if input element_type is “FRAME” or Equipment (BTS) if input
element type is “NE” from address serviceability.
Input Parameters
Name Type Comment
addressID LONG Mandatory. The input address ID.

Either this or the p_elementType.
address wsAddress An object containing details

related to an address.
elementType STRING (maximum 40 To indicate whether “NE” or

characters) “FRAME‟ list to be returned.
Returns
Type Comment
getServiceNodeByAddressResu Returned result for the web service call
lt containing the following information:
The node list.
Note
The Invalid Address error condition is only raised for invalid input addresses, it does not verify if the
address physically exists in the system.
Error Conditions
Code
False/Not found
Invalid Address
GETADDRESSBYLOCATION
Purpose
This web service returns a list of address that is serviceable from a location by either a frame or
equipment. The returned list of address can be further filtered by specifying the type of equipment or
frame and index of the element from the location.
Input Parameters
Name Type Comment
location STRING Mandatory. The location from

which the address look-up should
be based on.
type STRING Optional. The type of the

element.
index STRING Optional. The index of the

element.
This parameter specifies the node
elementType STRING
type. This can either be an “NE”
139
for a network element or “FRAME‟

for a frame.
Returns
Type Comment
getAddressByLocationResult Returned result for the web service call
containing the following inforamtion:
List of addresses.
Note
The Invalid Address error condition is only raised for invalid input addresses, it does not verify if the
address physically exists in the system.
Error Conditions
Code
False/Not found
Invalid Element
GETWORKORDER
Purpose
The web service returns the Work Order record for a given Work Order ID.
Input Parameters
Name Type Comment
workOrderId STRING (maximum 20 Mandatory. The input Work Order

characters) ID.
Returns
Type Comment
workOrderDetailsResult Returned results for the web service call
Error Conditions
Code
Invalid Work Order ID
140
UPDATEWORKORDERDETAILS
Purpose
The web service returns the Work Order record for a given Work Order ID.
Input Parameters
Name Type Comment
workOrderId STRING (maximum 20 Mandatory. The input Work Order

characters) ID.
workOrderDetails workOrderDetails The work order record will be

submitted and returned to this
parameter.
source STRING For the “identified” procedure

this permits the calling system
to identify itself to Clarity.
Returns
Type Comment
workOrderDetailsResult Returned results for the web service call
Expects a full Work Order record to be
supplied. Therefore it may be necessary to
retrieve the existing work order record first
and performing changes upon it before
submitting the record for update.
Error Conditions
Code
Invalid Status
Invalid Employee ID
Invalid Parameter
Open Activites Present
141
UPDATEWORKORDERSTATUS
Purpose
This web service is used to update the status of a work order.
Input Parameters
Name Type Comment
workOrderId STRING A work order ID. This must be a

valid Work Order ID existing in
Clarity database.
workOrderStatus workOrderStatus The Work Order status.

this permits the calling system to
identify itself to Clarity.
Returns
Type Comment
web service call.
Error Conditions
Code
Invalid Status
Invalid Employee ID
Invalid Parameter
Open Activities Present
UPDATEWORKORDERAPPROVAL
Purpose
This web service is used to update the approval information of a work order.
Input Parameters
Name Type Comment
workOrderId STRING A work order ID.
workOrderApproval workOrderApproval An object containing work order

approval details to be submitted.

this permits the calling system to
Returns
Type Comment
web service call.
142
Error Conditions
Code
Invalid Employee ID
INSERTWORKORDERCOMMENT
Purpose
This web service appends a comment to a given work order.
Input Parameters
Name Type Comment
workOrderComment WorkOrderComment The work order comment

information.
source STRING (maximum 40 For the “identified” procedure

characters) this permits the calling system
Returns
Type Comment
insertWorkOrderCommentResul Returned results for the web service call
Error Conditions
Code
Invalid Employee ID
Invalid Argument
GETWORKORDERACTIVITY
Purpose
This web service returns a Work Order Activity record.
Input Parameters
Name Type Comment
woActivityId STRING The work order activity ID.
Returns
Type Comment
getWorkOrderActivityResult Returned results for the web service call
The Work Order Activity record.
Error Conditions
143
Code
Invalid Work Order Activity ID
UPDATEWORKORDERACTIVITYSTATUS
Purpose
This web service updates the status of a work order activity record.
Input Parameters
Name Type Comment
worActivityId STRING Mandatory. The input Work Order

Activity ID.
workOrderActivity workOrderActivity The work order activity status

information.

Returns
Type Comment
web service call.
Note
The activityName and workGroup fields contained in workOrderActivity are not actually updated and
any values will be ignored.
Error Conditions
Code
Invalid Work Order Activity ID
Invalid Employee ID
Invalid Argument
144
GETSERVICEMANAGERIDBYJOBTICKET
Purpose
This web service is used to obtain the Service Manager ID values associated with a Job Ticket. The
ID values include:
 Service Order ID
 Service ID
 Service Implementation Task ID
 Work Order ID
 Work Order Activity ID
If any of the fields is null it indicates that such a linked record does not exist.
Input Parameters
Name Type Comment
jobTicketId LONG A numeric input variable

containing the Job Ticket ID.
Returns
Type Comment
serviceManagerIDResult Returned results for the web service call
Error Conditions
Code
Invalid Argument Job Ticket ID cannot be null
GETAREASERVICETYPEWORKGROUP
Purpose
This web service is to obtain the Work Group given the valid service type and specified area.
Input Parameters
All input parameters are mandatory.
Name Type Comment
workGroupType STRING Optional. The Work Group

associated with an area.If it is
not passed then work group type
is determined based on service
type configuration.
areaCode STRING Mandatory. The area code for

which the work group is required.
serviceType STRING Mandatory. The service type for

which the work group is reuiqred.
Returns
145
Type Comment
getAreaServiceTypeWorkGroup Returned results for the web service call
Result containing the following information:
The work group.
Error Conditions
Code
Invalid Area Code
WorkGroup Not Found
GETALLOWEDSERVICETYPES (FOR PLDT)

Purpose
This web service can be used to obtain a valid service type to which a service can be changed based
on order type and the CRM Service Type.
Input Parameters
All input parameters are mandatory.
Name Type Comment
ServiceID STRING The Service ID of the service

intended to be changed by a
service order.
OrderType STRING The order type of the proposed

service order.
CRMServiceType STRING The Service Type as defined in

the CRM for the proposed service
order.
ServiceType STRING The return value being a

permitted service type.
Returns
Type Comment
getAllowedServiceTypesResul Returned results for the web service call
The retrieved Service Type.
Error Conditions
Code
Invalid Argument
146
Service Provisioning API
Provisioning requests are sent to the external system using the SOP_REQUEST queue. The
SOP_REQUEST queue is implemented as two Oracle views: SOP_REQUEST_VIEW and
SOP_REQUEST_DATA_VIEW.
At the time of provisioning task execution, Service Manger will add the requests in
SOP_REQUEST_VIEW. The attributes associated with this request will be stored as name-value
pairs in SOP_REQUEST_DATA_VIEW. For one record in SOP_REQUEST_VIEW there will be zero
or more records in SOP_REQUEST_DATA_VIEW.
PROVISIONING REQUEST HEADER (VIEW NAME SOP_REQUEST_VIEW)

For every provisioning request that must be sent to the equipment a record is inserted in
SOP_REQUEST_VIEW. The view contains the following information:
FIELD NAME TYPE DESCRIPTION
REQUEST_ID NUMBER A unique ID for the request.
TASK_ID DATE The task Id for which the command is added
CUSR_ABBREVIATION VARCHAR2 Customer Abbreviation
COMMAND_ID NUMBER ID that uniquely identifies the command that
must be sent to the equipment.
COMMAND_NAME VARCHAR2 The command that will be sent to the
equipment.
STATUS VARCHAR2 Status of the command. The first command
within the task is set to “ACTION” and the
rest of the commands are set to „HOLD”.
MANS_NAME DATE Management System
ERROR_CODE DATE Error Code
ERRORMESSAGE DATE Error Message
PRIORITY DATE Priority
PROVISIONING_DATE DATE The date when the provisioning request needs
to be executed.
The Clarity system sets the first command within the task to “ACTION” and the rest of the commands
to „HOLD”. Then the external system selects all the commands for a task and provisions them as
required. Once the commands are provisioned, a call to the setRequestStatus status web service is
made, with the status being either „ERROR‟ or „COMPLETE‟. The setRequestStatus web service then
updates the command status.
PROVISIONING REQUEST HEADER (VIEW NAME SOP_REQUEST_DATA_VIEW)

Provisioning request data are stored as name-value pairs. It contains the data to be associated with a
request. It contains OSS data required by an external system in order to execute a provisioning
request.
FIELD NAME TYPE DESCRIPTION
REQUEST_ID NUMBER Link to the requestID.
GROUP NUMBER Allows a set of name-value pairs to be
grouped together.
NAME VARCHAR2 The name of the attribute.
VALUE VARCHAR2 The value of the attribute.
External systems have only READ access to the SOP_REQUEST queue.
147
SETREQUESTSTATUS
Purpose
This web service sends the result of the provisioning request back to the Clarity Service Manager.
Input Parameters
Name Type Comment
requestID STRING The unique identifier for the
request.
requestStatus STRING Mandatory. The status of the

request. It will be validated
against the reference data.
Typical statuses includes:
COMPLETED, ERROR, READ.
errorCode STRING Optional. The error code of

the error.
errorDescription STRING Optional. User friendly

description of the error
which occurred during
provisioning.
attributeList wsAttribute Optional. Supplementary data

associated with the reply.
The following state chart diagram shows the lifecycle of a request in the SOP_REQUEST_VIEW.
The state-transition of a request is can be done by calling setRequestData() with the corresponding
status codes. The list below summarises the meaning of individual states:
 Initial State: All requests will start at the initial state in the SOP_REQUEST_VIEW. Only request
in this status will be available in SOP_REQUEST_VIEW.
 READ: The request has been discovered in SOP_REQUEST_VIEW and being processed.
 COMPLETED: The request has been provisioned successfully.
 ERROR: An unrecoverable error occurred during provision of the request. The request may be reset
and made available in SOP_REQUEST_VIEW again internally.
Returns
Type Comment
web service call
Error Conditions
Code
148
Invalid Request Status
Invalid Request ID
149
Chapter 6 Inventory Manager

Summary of Inventory Management Web Methods and Data Objects available in this document.
reserveFacility reserveFacilityResult
reserveFacilityStartingAt reserveFacilityResult
reserveFacilityNGN reserveFacilityResult
reserveFacilityNGNStartingAt reserveFacilityResult
reserveFacilityForRelocation reserveFacilityForRelocationResult
reserveFacilityRelocationNGN reserveFacilityForRelocationResult
reservePort reservePortResult
cancelReservation cancelReservationResult
getCircuitByReservationID getCircuitByReservationIDResult
getDPList getDpListResult
getSupportedFeaturesInLocation getSupportedFeaturesInLocationResult
createAddressServiceability commonResult
getCableDistanceForCircuit getCableDistanceForCircuitResult
extendReservation commonResult
getPortListByCard getPortListByCardResult
reserveFacilityNeighborsNo reserveFacilityNeighborsNoResult
getCircuit getCircuitResult
checkCapacity checkCapacityResult
dropWireExists
getDropWireFrameAppearance commonResult
addDropWire commonResult
removeDropWire commonResult
getDPFrameAppearance commonResult
getIntactCircuit intactCircuitResult
findPortForNumber findPortForNumberResult
reserveIntactCircuit commonResult
150
TM_getCASSCV (for TM) TM_getCASSCVResult (for TM)
TM_getCircuitDetails (for TM) TM_getCircuitDetailsResult (for TM)
TM_getServiceNumbers (for TM) getServiceNumbersResult (for TM)
TM_updateFrameAppearanceStatus (for TM) commonResult
TM_updateFrameAppearanceJumper (for TM) updateFrameAppearanceJumperResult (for TM)
TM_countAvailLinesForAddress (for TM) countAvailLinesForAddressResult (for TM)
TM_getDslamDistanceFromDp (for TM) getDslamDistanceFromDpResult (for TM)
getAllowedServiceTypes (for PLDT) getAllowedServiceTypesResult (for PLDT)
reserveFacilityPLDT (for PLDT) reserveFacilityPLDTResult (for PLDT)
cancelReservationPLDT (for PLDT) commonResult
151
Inventory Management Data Objects

This section lists the data objects used by the Inventory Management web services.

The following are the generic objects used by the Inventory Manager web services.
 ReturnStatus
 CommonResult
 AppConstant
 wsAttribute
WSATTRIBUTE

(maximum 240
characters)

(maximum 1000
characters)
WSCIRCUITATTR
A data object that containing additional circuit information.
attributes wsAttribute A list of the circuit that make up the

circuit.
WSADDRESS

suiteNumber STRING The suite number of the address. NULL

characters)
levelNumber STRING The level number of the address. NULL

characters)
152
streetNumber STRING The street number of the address. NULL
characters)
streetName STRING A reference to a valid street name. NULL

characters)
postCode STRING The postal code of the area containing this

characters)
suburb STRING The name of the suburb/town containing this

characters)
city STRING The name of the city containing this address.

characters)
stateCode STRING A reference to a valid state.

(maximum 40
characters)
country STRING The name of the country containing this

characters)
attributes wsAttribute An array of wsAttribute.Supplementary data

about the address. NULL allowed.
interface.
Attributes:
WSTERMINATIONPOINT
A data object holds the Connection End Point for a wsCrossConnect.
pointID STRING This parameter holds a representation of

the Frame Container or Network Element
Location Type Index.
153
pointUnitOrCard STRING This parameter holds a representation of

the Frame Unit or Card Slot (Card or Frame
Unit Name).
pointPortOrFrame STRING This parameter holds a representation of

the Frame Appearance or the Port (Frame
Side and Position or Port Name).
portID LONG Holds the Port ID if it exists.
fraaID LONG Holds the Frame Appearance ID if it exists.
cabsID LONG Holds the ID of the cable sheath (if any)

that is terminated to the frame appearance
or port.
cabsName STRING Holds the name of the cable sheath (if any)
that is terminated to the frame appearnce
or port.
cabsType STRING Holds the type of the cable sheath.
cabcID LONG Holds the ID of the cable core (if any)

or port.
cabcNumber LONG Holds the number of the cable core (if any)
or port.
WSCROSSCONNECT
A data object represents a link of a circuit. It contains two Termination Points A and B, and a
connectionType. The directionality of the wsCrossConnect is always from A to B.
terminationPointA wsTerminationPoint A-end termination point.
terminationPointB wsTerminationPoint B-end termination point.
connectionType STRING The type of connection.
WSCIRCUIT
A data object contains circuit information.
circuitID STRING A unique identifier for the circuit and

it is internally generated.
locationAEnd STRING Circuit A end location.
locationBEnd STRING Circuit B end location.
154
inServiceDate DATE In service date of the circuit.
customerId STRING A unique identifier for the Customer

ID.
speed STRING Speed.
status STRING Circuit status.
expiryDate DATE Circuit expiry date.
circuitType STRING Circuit type.
aRing STRING Circuit A Ring Abbreviation.
bRing STRING Circuit B Ring Abbreviation.
employeeID STRING Circuit Employee ID.
comments STRING Circuit comments.
decommissionedDate DATE Circuit decommissioned date.
serviceType STRING Circuit service type.
accountName STRING Circuit account number.
compliance STRING Circuit compliance.
displayName STRING Circuit display name.
notifyDate DATE Circuit notify date.
serviceID STRING Circuit Service ID.
crossConnections wsCrossConnect A list of the cross connections that

make up the circuit.
bearers STRING A list of the bearers of this circuit

if it is a tributary.
WSFRAMECONTAINER
A data object contains information about the frame container.
entityType STRING Type of a frame container (e.g. „DP‟,

„CABINET‟).
entityLocation STRING Location at which a frame container resides.
entityIndex STRING Instance of a frame container type at a

particular location. (The concatenation of
the frame container location, type and index
is always unique).
155
WSEQUIPMENTFEATURES
A data object contains information about the equipment features.
equpID LONG A unique identifier of a network element

within a telephone exchange.
exchangeID STRING A unique identifier of a telephone

exchange.
cardslot STRING Identifier of a card on a network element.
featureName STRING Name of a feature that a network element

supports.
totalCapacity LONG Total number of ports on a card.
currentCapacity LONG Number of available ports on a card.
WSNETWORKELEMENT
A data object contains information about the equipment.
entityID LONG A unique identifier of equipment.
entityType STRING Type of equipment.
entityLocation STRING Location at which equipment resides.
entityIndex STRING Instance of equipment type at a particular

location. (The concatenation of the
equipment location, type and index is always
unique).
WSPORTSERVICETYPE
A data object contains information about the Port‟s service type.
stValue STRING (maximum The Service Type abbreviation; e.g. ADSL,

50 characters). PSTN and etc.
stPriority LONG The Priority of the service type for

Port, Card or Network Element.
stBatchID STRING (maximum The Batch ID of the service type for

50 characters). Port, Card or Network Element.
stLevel STRING (maximum The Level (either „NE‟,‟CARD‟ or ‟PORT‟)

50 characters). at which the service type exists.
156
WSPORT
A data object contains information about the port.
portID LONG A unique identifier for the port.
cardSlot STRING (maximum The ID of the card‟s slot containing

50 characters) the port.
networkElementID STRING (maximum The ID of the NE containing the port.

50 characters) It has the format <Location>-<Type>-
<Index>
portName STRING (maximum Mandatory. Constant Clarity port name.

50 characters) The port name is unique in context of
network element instance.
circuitName STRING (maximum Optional. The circuit which the port

50 characters) belongs.
usage STRING (maximum Port usage.

50 characters)
relation STRING (maximum Values include

50 characters) „NEITHER‟,‟BOTH‟,‟PARENT‟ or ‟CHILD‟.
status STRING (maximum The port status.

50 characters)
physical STRING (maximum Indicate if the Port ID a physical or

50 characters) logival port.
speed STRING (maximum Optional. Indicate the read/write

50 characters) capacity, speed or bandwidth for the
selected port.
portAttributes wsAttribute Additional information about port.
serviceTypes wsPortServiceType A list of service types associated

with the port.
RESERVEFACILITYRESULT
An object representing the return result of web services call reserveFacility, reserveFacilityStartingAt,
reserveFacilityNGN, reserveFacilityNGNStartingAt.
phoneNumber STRING Optional. The phone number associated with

the service. Note the following:
- If the phone number is specified and the
number is associated with a port in a
switch the reserveFacility will try to use
the port associated with that phone number.
The number status will be set to
“reserved”.
157
- If no phone number is specified and there

is a phone number associate with the
allocated resources the phone number will
be returned as out parameter and the number
status will be set to “reserved”.
- If the phone number has been specfied by
the caller or a phone number has been
returned by implemenation this API will
also reserve the number using Number
manager reserveNumber API.
- The phone number that is specified must
contain a city code which is concatenated
to the front of the number with no space
character.
exchangeCode STRING Optional. The exchange code on to which the

voice service need to be provision. Reserve
Facility will only terminate the service on
a network element with the same exchange
code.
exchangeLocation STRING Attribute which contains the location of

the terminating equipement.
exchangeType STRING Attribute which contains the equipment type

of the terminating equipment.
exchangeIndex STRING Attribute which contains the equipment

index of the terminating equipment.
ipRegion STRING Attribute which displays the ipRegion

attribute of the terminating equipment.
dslamDistance LONG Attribute which display the total cable

distance between the serving DP and the
DSLAM.
Contains return status of a web service
call.
RESERVEFACILITYFORRELOCATIONRESULT
An object representing the return result of web services call reserveFacilityForRelocation and
reserveFacilityForRelocationNGN.
exchangeCode STRING Optional. The exchange code on to which the

voice service need to be provision. Reserve
Facility will only terminate the service on
a network element with the same exchange
code.
exchangeLocation STRING Attribute which contains the location of

the terminating equipement.
exchangeType STRING Attribute which contains the equipment type

of the terminating equipment.
exchangeIndex STRING Attribute which contains the equipment
158
index of the terminating equipment.
ipRegion STRING Attribute which displays the ipRegion

attribute of the terminating equipment.
dslamDistance LONG Attribute which display the total cable

distance between the serving DP and the
DSLAM.
Contains return status of a web service
call.
RESERVEPORTRESULT
An object representing the return result of web service call reservePort.
returnStatus returnStatus Contains return status of a web service

call.
CANCELRESERVATIONRESULT
An object representing the return result of web service call cancelReservation.

call.
GETCIRCUITBYRESERVATIONIDRESULT
An object representing the return result of web service call getCircuitByReservationID.
wsCircuit wsCircuit A list of circuits associated with the

supplied parameter (Reservation ID).

call.
GETDPLISTRESULT
An object representing the return result of web service call getDPList.
FCList wsFrameContainer A list of frame containers associated

with the supplied parameters.

call.
GETSUPPORTEDFEATURESINLOCATIONRESULT
An object representing the return result of web service call getSupportedFeaturesInLocation.
159
featureList wsEquipmentFeatures A list of telephone exchanges and

supported features that service the
supplied service address.

call.
GETCABLEDISTANCEFORCIRCUITRESULT
An object representing the return result of web service call getCableDistanceForCircuit.
cableLength LONG The total length of cables used in

the circuit.
serviceAddressDistance LONG The service addresses distance. This

value is calculated by comparing the
first and last frame units in the
ciruit. The distance from the
exchange attribute is compared and
the maximum is chosen.

service call.
GETPORTLISTBYCARDRESULT
An object representing the return result of web service call getPortListByCard.
portList wsPort A list of ports associated with the

supplied parameter.

call.
RESERVEFACILITYNEIGHBORSNORESULT
An object representing the return result of web service call reserveFacilityNeighborsNo.
utilisedRule STRING Rule that was applied to reserve the

facilities for the new circuit.

call.
GETCIRCUITRESULT
An object representing the return result of web service call getCircuit.
160
wsCircuit wsCircuit A list of circuits associated with the
circuit name (a circuit‟s unique
identifier).

call.
CHECKCAPACITYRESULT
An object representing the return result of web service call checkCapacity.

call.
INTACTCIRCUITRESULT
An object representing the return result of web service call getIntactCircuit.
servType STRING The service type; e.g. ADSL.

call.
FINDPORTFORNUMBERRESULT
An object representing the return result of web service call findPortForNumber.
portID LONG Mandatory. Identifier of the port that

has been pre-provisioned with the given
phone number.

call.
TM_GETCASSCVRESULT (FOR TM)

An object representing the return result of web service call TM_getCASSCV.
cvNumber STRING A unique identifier CASSCV number.

call.
TM_GETCIRCUITDETAILSRESULT (FOR TM)

An object representing the return result of web service call TM_getCircuitDetails.
161
attributes wsAttribute A list of attributes associated with the

circuit.

call.
GETSERVICENUMBERSRESULT (FOR TM)

An object representing the return result of web service call TM_getServiceNumbers.
serviceNumberList STRING A list of service associated to the cable

name and frame container.

call.
UPDATEFRAMEAPPEARANCEJUMPERRESULT (FOR TM)

An object representing the return result of web service call TM_updateFrameAppearanceJumper.
seqNo LONG The sequence number.

call.
WSAVAILLINESFORADDRESS (FOR TM)

An object contains Frame Container and the number of available lines for the address.
frameContainer wsFrameContainer A list of frame containers associated

with the the supplied parameters.
numAvailLines LONG Number of available lines for the

address.
COUNTAVAILLINESFORADDRESSRESULT (FOR TM)

An object representing the return result of web service call TM_countAvailLinesForAddress.
availableLines wsAvailLinesForAddress A list of Frame Container and the

number of available lines for the
address associate to the frame
container.
migratedFlag STRING Y/N flag (default N). Whether

migration is permitted on the frame
container
162
service call.
WSDSLAMDISTANCEFROMDP (FOR TM)

An object contains information about the dslam distance from Distribution Point.
networkElement wsNetworkElement A list of equipment associated with the

distribution point.
distance LONG The distance from the distribution point.
GETDSLAMDISTANCEFROMDPRESULT (FOR TM)

An object representing the return result of web service call TM_getDslamDistanceFromDP.
dslam wsDslamDistanceFromDp A list of dslam distance from

Distribution Point.
migratedFlag STRING Y/N flag (default N). Whether

migration is permitted on dslam.

service call.
GETALLOWEDSERVICETYPESRESULT (FOR PLDT)

An object represents the result of web service calls getAllowedServiceTypes.
serviceType STRING A unique identifier for the service

orders.

service call.
RESERVEFACILITYPLDTRESULT (FOR PLDT)

An object representing the return result of web service call reserveFacilityPLDT.
phoneNumber STRING Optional parameter indicating the phone

(maximum 20 number associated with the service.
characters)
- If the phone number is specified and the
number is associated with a port in a
switch the reserveFacility will try to use
the port associated with that phone number.
The number status will be set to
“reserved”.
- If no phone number is specified and there
is a phone number associate with the
allocated resources the phone number will
163
be returned as out parameter and the number

status will be set to “reserved”.
- If the phone number has been specfied by
the caller or a phone number has been
returned by implemenation this API will
also reserve the number using Number
- The phone number that is specified must
contain a city code which is concatenated
to the front of the number with no space
character.
serviceType STRING Mandatory. The service that the customer is

(maximum 50 requesting. Only PSTN and ADSL service
characters) types are supported.
serviceCatag STRING The service category.

(maximum 50
characters)

call.
Inventory Management Web Methods

This section explains the Inventory Management web services in detail.
RESERVEFACILITY
Purpose
This web service can be used to reserve the facilities for a service based on service address.
Input Parameters
Name Type Comment
phoneNumber STRING Optional. The phone number

associated with the service. Note
the following:
- If the phone number is
specified and the number is
associated with a port in a
switch the reserveFacility will
try to use the port associated
with that phone number. The
number status will be set to
“reserved”.
- If no phone number is specified
and there is a phone number
associate with the allocated
resources the phone number will
be returned as out parameter and
the number status will be set to
“reserved”.
- If the phone number has been
specfied by the caller or a phone
number has been returned by
implemenation this API will also
reserve the number using Number
164
- The phone number that is
specified must contain a city
code which is concatenated to the
front of the number with no space
character.
serviceAddress wsAddress Mandatory. The service address to

which the requested service needs
to be delivered. Uusally the
customer address.
serviceType STRING Mandatory. The service that the

customer is requesting. Only PSTN
and ADSL service types are
supported.
reservationID STRING Mandatory. The unique ID for the

reservation. More than one
circuit can be requested for a
certain service. All the circuits
associated with a service need to
be reserved using the same
reservation id.
serviceID STRING Optional. Use either serviceID or

existingNumber. The unique ID for
the service. Reserve Facility
will attempt to find the existing
service and re-use the facilities
that it provided. User serviceID
if attempting to either add PSTN
to an existing ADSL service or
attempting to add ADSL to an
existing PSTN service.
existingNumber STRING Optional. Use either serviceID or

existingNumber. The existing
phone number of a PSTN service.
Reserve Facility will attempt to
find an existing service based on
the phone number and re-use its
facilities. Use existingNumber if
exchangeCode STRING Optional. The exchange code on to

which the voice service need to
be provision. Reserve Facility
will only terminate the service
on a network element with the
same exchange code.
circuitSpeed STRING Mandatory.The requested bandwidth

of the service to be reserved.
The speed must be one of the
service definition speeds for the
requested service type.
serviceFeatures STRING Optional. The feature that need

to be supply as part of the
165
requested service. The features

must be available on the
terminating equipment or on
server network element that is
providing the service features to
the terminating equipment.
Returns
Type Comment
reserveFacilityResult Returned result for the web service call
Note
The following data needs to be set up prior to using this web service:
In the Service Definitions screen, the Service Type Section should be set up as follows:
Type Description Group
PSTN VOICE
ADSL DATA
You need to Map an Address to the DP you intend to use.

You need to set up a Cable between the DP and the MDF.
You need to set up Unnamed Connections between the NE and the MDF.
For an Network Element (NE):
The Port Usage: A port can be set up as a
SERVICE_SWITCHING_POINT: For any NE that is involved in terminating traffic or
TRANSFER_ACCESS_POINT: For any NE that transports traffic.
You will need to create unnamed connections between the relevant ports and the MDF.
You will need to Pre Provision the number used in the Facility Reservation web service to a port in the
terminating switch. Fill in the relevant details in the Network Element screen -> tool pallet -> Pre
Provision Ports window. After the Port(s) are provisioned, the details can be seen in the Additional
Port Details TAB in the Telephone Number field.
Network Element Parameters: (Accessed via tool pallet -> Network Element Parameters) There
needs to be a NE parameter of SERVICE_TYPE with, for example, a value of PSTN. This needs to be
defined for each service the NE supports.
Card Parameters: (accessed via the button next to the card slot name) There needs to be a Card
parameter of SERVICE_TYPE with for example a value of PSTN, this needs to be defined for each
service the Card supports
For a FRAME_UNIT
Direction: This needs to be defined as a sequence of IN‟s and OUT‟s so that the application can work
its way back to an originating point. The values need to alternate from IN to OUT etc.
For Frame Appearances
Set the Usage: VOICE for a PSTN service or DATA for ADSL
For setting up an Address
Create an address. To Map an address to the above DP, go to Address Serviceability (Inventory ->
Reference -> Address Serviceability)
For the fields Location, Type, Index you need to fill in the DP details followed by the address details.
166
For setting up an UnNamed Connection
NE – MDF
Use the form UnNamed Connection to connect X Ports (NE) to X REAR Frame Appearances
For setting up a Cable
MDF - DP
Use the Cable Form to terminate REAR Frame Appearances (MDF) to REAR Frame Appearances
(DP)
NOTE: The MDF and DP need to be at 2 different locations otherwise the cable will not work
Error Conditions
Code
Invalid Phone Number

Invalid Address Name attribute
Invalid Address Value attribute
RESERVEFACILITYSTARTINGAT
Purpose
This web service force using to define the starting point of reserve the facilities for a service based on
service address.
Input Parameters
Name Type Comment
associated with the service.
Note the following:
“reserved”.
- If no phone number is
specified and there is a phone
number associate with the
allocated resources the phone
number will be returned as out
parameter and the number status
will be set to “reserved”.
specfied by the caller or a
phone number has been returned
by implemenation this API will
also reserve the number using
Number manager reserveNumber
API.
code which is concatenated to
167
the front of the number with no

space character.
serviceAddress wsAddress Mandatory. The service address

to which the requested service
needs to be delivered. Usually
the customer address.
serviceType STRING Mandatory. The service that

the customer is requesting.
Only PSTN and ADSL service
types are supported.
reservationID STRING Mandatory. The unique ID for

the reservation. More than one
certain service. All the
circuits associated with a
service need to be reserved
using the same reservation id.
serviceID STRING Optional. Use either serviceID

or existingNumber. The unique
ID for the service. Reserve
Facility will attempt to find
the existing service and re-use
the facilities that it
provided. User serviceID if
attempting to either add PSTN
existingNumber STRING Optional. Use either serviceID

or existingNumber. The existing
Reserve Facility will attempt
to find an existing service
based on the phone number and
re-use its facilities. Use
existingNumber if attempting to
add ADSL to an existing PSTN
service.
exchangeCode STRING Optional. The exchange code on

to which the voice service need
to be provision. Reserve
Facility will only terminate
the service on a network
element with the same exchange
code.
circuitSpeed STRING Mandatory.The requested

bandwidth of the service to be
reserved. The speed must be one
of the service definition
speeds for the requested
service type.
serviceFeatures STRING Optional. The feature that

need to be supply as part of
168
the requested service. The
features must be available on
the terminating equipment or on
providing the service features
to the terminating equipment.
entityType STRING Optional. entityType and

entityID can be used to force
reserve facility to ignore the
address serviceability priority
and start from a specific
“entity”. Valid entity types
are: “FRAME CONTAINER”, “FRAME
APPEARANCE”, “NETWORK ELEMENT”,
“PORT”
entityID STRING Optional. entityType and

“entity”. It needs to be used
in conjunction with entityType
and it represents the unique
identifier of the object. The
object (or its parent) is still
required to be in the address
serviceability table.
Returns
Type Comment
Error Conditions
Code
RESERVEFACILITYNGN
Purpose
This web service is used to reserve the facility for NGN service based.
Input Parameters
Name Type Comment
Note the following:
169

“reserved”.
API.
space character.

serviceTypes STRING Mandatory. The service that




170
service.

code.

service type.

portID LONG Optional. A service can

reserved against a particular
port. PortID and exchangeCode
are mutually exclusive.
outOfArea STRING Optional. Y/N flag (default

N). This can only be used in
conjuction with exchCode. If
the flag is set to Y then
Reserve Facility will ignore
the exchange building location
and creates a jumper between
the VMDF to the exchange
specified, regardless of the
location of the equipment. The
functionality usually required
for remote units and it may
involve some manual re-
jumpering.
Returns
Type Comment
Error Conditions
171
Code
RESERVEFACILITYNGNSTARTINGAT
Purpose
This web service force user to define the starting point to reserves based on service address and up
to two service types. Each service type will result in a separate call to the reserverFacility web service.
The VOICE service will be created before DATA service. At present the web service expects that the
service types will be unique. The VOICE reservation if successful will be placed into a
COMMISSIONED state and the DATA reservation will remain in a RESERVED state. It will be up to
Service Manager to handle the correct processing and status change for these services.
Input Parameters
Name Type Comment
Note the following:
“reserved”.
API.
space character.

serviceTypes STRING Mandatory. The service that
172



service.

code.

service type.

portID LONG Optional. A service can

reserved against a particular
173
port. PortID and exchangeCode

are mutually exclusive.
outOfArea STRING Optional. Y/N flag (default

N). This can only be used in
conjuction with exchCode. If
the flag is set to Y then
Reserve Facility will ignore
the exchange building location
and creates a jumper between
the VMDF to the exchange
specified, regardless of the
location of the equipment. The
functionality usually required
for remote units and it may
involve some manual re-
jumpering.
entityType STRING Optional. entityType and

“entity”. Valid entity types
are: “FRAME CONTAINER”, “FRAME
APPEARANCE”, “NETWORK ELEMENT”,
“PORT”
entityID STRING Optional. entityType and

“entity”. It needs to be used
in conjunction with entityType
and it represents the unique
identifier of the object. The
object (or its parent) is still
required to be in the address
serviceability table.
Returns
Type Comment
Error Conditions
Code
174
RESERVEFACILITYFORRELOCATION
Purpose
This web service can be used to reserve facilities for a new address. In relocation, if part of the new
circuit is overlapping with the old circuit, the new circuit will reuse facilities already allocated. This
function can be used only for services which have only one circuit and if the new address is within the
same switch area; the current phone number is preserved.
Input Parameters
Name Type Comment
serviceID STRING The unique ID for the service

which requires relocation.

reservation.
address wsAddress Mandatory. The new service

address.
Returns
Type Comment
reserveFacilityForRelocatio The return object containing the result of
nResult the call.
If the facilities are not available the call
status will return which types of facilities
are not available.
Error Conditions
Code
RESERVEFACILITYRELOCATIONNGN
Purpose
This web service can be used to reserve facilities for a new address. In relocation, if part of the new
circuit is overlapping with the old circuit, the new circuit will reuse facilities already allocated. This
function can be used only for services which have only one circuit and if the new address is within the
same switch area; the current phone number is preserved.
Input Parameters
Name Type Comment
serviceID STRING The unique ID for the service

which requires relocation.

reservation.
address wsAddress Mandatory. The new service

address.
175
exchangeCode STRING The requested bandwidth of the

data service to be reserved.
Returns
Type Comment
reserveFacilityForRelocatio The return object containing the result of
nResult the call.
If the facilities are not available the call
status will return which types of facilities
are not available.
Error Conditions
Code
Invalid Exchange Code
RESERVEPORT
Purpose
This web service reserves a port given a reservation ID and the port‟s name. The port, its card or its
network element must support the service type defined in the service type parameter.
The web service is to be used exclusively for the reservation of IMSI ports since it assumes that the
port name must be unique.
It is a leftover from when IMSIs identifiers were modelled as ports. IMISs should be modelled as
numbers and not ports.
Input Parameters
Name Type Comment
reservationID STRING Mandatory. Indicates the
reservation ID.
portName STRING (maximum 20 Mandatory. This is the name of

characters) the port to be reserved. It is a
unique name and the port name
should be IMSI identifier that
is being reserved.
serviceType STRING (maximum 20 Mandatory. This indicates the

characters) service type that must be
supported by the port, its card
or its network element.
Returns
Type Comment
reservePortResult Returned result for the web service call
Error Conditions
176
Code
Invalid Port ID
CANCELRESERVATION
Purpose
This web service can be used to cancel a reservation. All the facilities that are part of the reserved
circuit should be returned to their former state. If the circuit was “intact” before reservation, then it
should be returned to its intact status (so that next time a reservation request is made, it will be
selected first).
Input Parameters
Name Type Comment
reservationID STRING (maximum 50 Mandatory. The unique
characters) reservationID used by Reserve
Facility.
Returns
Type Comment
cancelReservationResult Returned result of the web service call
Error Conditions
Code
GETCIRCUITBYRESERVATIONID
Purpose
This web service can be used to retrieve a circuit based on a Reservation ID.
Input Parameters
Name Type Comment
reservationID STRING The ID of the reservation.
Returns
Type Comment
getCircuitByReservationIDRe Returned result for the web service call
A populated circuit object if successful,
otherwise NULL. If more than one circuit is
found for the reservation, the „child‟
circuit will be returned (which will include
a list if its bearers).
Error Conditions
Code
177
GETDPLIST
Purpose
This web service can be used to retrieve the details of the frame containers that reside at a particular
address, or which correspond with a frame unit alias.
Input Parameters
Name Type Comment
frameType STRING Mandatory. Type of frame
container of interest (e.g.
„DP‟, „CABINET‟).
streetName STRING (maximum 80 Mandatory if no value is

characters) supplied for frameAlias. Name
and type of the street of
interest.
suburb STRING (maximum 40 Mandatory if no value is
characters) supplied for frameAlias. Suburb
of interest.
city STRING (maximum 40 Mandatory if no value is
characters) supplied for frameAlias. City
of interest.
postcode STRING (maximum 40 Optional. Postcode of interest.
characters)
frameAlias STRING Mandatory if no value is
supplied for streetName, suburb
and city. Frame unit alias of
interest.
Returns
Type Comment
getDPListResult Returned result for the web service call
List of frame containers.
Error Conditions
Code
No Frame Containers exist for supplied address
Address does not exist
Address and Frame Alias are null
Frame Type is null
Frame Type does not exist
Frame Alias does not exist
Unhandled error
GETSUPPORTEDFEATURESINLOCATION
Purpose
This web service can be used to retrieve the features that are supported by the telephone
exchange(s) that service a service address.
178
Input Parameters
Name Type Comment
serviceAddress wsAddress Mandatory. Service address of
interest.
Returns
Type Comment
getSupportedFeaturesInLocat Returned result for the web service call
ionResult containing the following information:
A list of feature.
Error Conditions
Code
Address ID does not exist
Unhandled error
CREATEADDRESSSERVICEABILITY
Purpose
This web service can be used to associate a frame or network element with a service address. This
mapping is used by the Reserve Facility process to determine whether or not an address can be
serviced by a particular frame or network element.
Input Parameters
Name Type Comment
addeID LONG Mandatory. The identifier of
the service address.
entityID LONG Mandatory. The identifier of

the frame or network element
that is to be mapped to the
service address.
entityType STRING Optional. FRAME_CONTAINERS by
defaults. The type of the
network component (i.e.
„FRAME_CONTAINERS‟ or
„EQUIPMENT‟) that is to be
mapped to the service address.
Returns
Type Comment
commonResult Returned object containing the result of the
web service call.
Error Conditions
Code
Address ID is null
Entity ID is null
Address ID does not exist
179
Entity ID does not exist

Invalid Entity Type
Address serviceability record already exists
Unhandled error
GETCABLEDISTANCEFORCIRCUIT
Purpose
This web service can be used to retrieve the total length of cables used by a circuit as well as the
service address distance based on a Reservation ID.
Input Parameters
Name Type Comment
reservationID STRING The ID of the reservation.
Returns
Type Comment
getCableDistanceForCircuitR Returned result for the web result call
Cable length.
Service address distance.
Error Conditions
Code
EXTENDRESERVATION
Purpose
This web service can be used to extend a reservation. The reservation will be extended for all the
circuits reserved with the reservation ID.
Input Parameters
Name Type Comment
reservationID STRING (maximum 50 Mandatory. This refers to the
characters) unique reservationID used by
Reserve Facility.
newExpiryDate DATE Mandatory. The new expiry date

for the reservation. Note that
this date should be in the
future, but not necessarily
later than the original expiry
date (i.e. this can be used to
shorten the reservation as
well).
Returns
Type Comment
180
web service call.
Error Conditions
Code
Invalid Date
GETPORTLISTBYCARD
Purpose
This web service retrieves the ports on a card.
Input Parameters
Name Type Comment
neLocation STRING (maximum 50 Indicates the location at which
characters) the network element and card
are located.
neType STRING (maximum 50 The type of network element on

characters) which the card is located.
neIndex STRING (maximum 50 The index of the network

characters) element on which the card is
located.
cardSlot STRING (maximum 50 The name of the card slot.

characters)
Returns
Type Comment
getPortListByCardResult Returned result for the web service call
A populated PortList table of Port objects if
successful, otherwise NULL.
Error Conditions
Code
Invalid Card Details
RESERVEFACILITYNEIGHBORSNO
Purpose
This overloaded version of the reserveFacilityNeighborsNo web service can be used to reserve the
appropriate facilities for a new PSTN customer based on the circuit that corresponds with the
telephone number at a neighbouring service address. This web service would be called if the new
service address is unknown and the „NEXTAVAILABLE‟ allocation rule is to be applied if the facilities
could not be reserved using the „NEXTAVAILSAMECABLE‟ allocation rule.
Input Parameters
Name Type Comment
phoneNumber STRING Mandatory. Telephone number
that corresponds with the
181
neighbouring service address.
reservationID STRING Mandatory. Name that is to be

given to the circuit for which
facilities are being reserved.
Returns
Type Comment
reserveFacilityNeighborsNoR Returned result for the web service call
Error Conditions
Code
Reservation ID is null
Neighbour‟s telephone number is null
Neighbour‟s telephone number not associated with an in-service circuit
Reservation ID already exists
Neighbour‟s service is not PSTN
Unhandled error
GETCIRCUIT
Purpose
The web service is used to retrieve the details of a circuit based on a circuit name (a circuit‟s unique
identifier).
Input Parameters
Name Type Comment
circuitName STRING The name of the circuit, which
is its unique identifier.
Returns
Type Comment
getCircuitResult Returned result for the web service call
Contains circuit information.
Error Conditions
Code
Invalid Circuit Name
CHECKCAPACITY
Purpose
For each Distribution Point to address mapping entered into the address serviceability table ordered
by priority, fetch the details of the serving Exchange or DSLAM and report on the total spare
frame/cable capacity on the DP (DSIDE) and the total spare frame/cable capacity on the Exchange
side (ESIDE). For each NE that is capable of providing the requested service and features, return the
NE detail and its spare port capacity.
182
Input Parameters
Name Type Comment
serviceAddress wsAddress The service address.
serviceType STRING Mandatory. The service that the

customer is requesting. Only PSTN
and ADSL service types are
supported.
serviceID STRING Unique ID for the service which

requires relocation.
existingNumber STRING The existing phone number.
circuitSpeed STRING The requested bandwidth of the

data service to be reserved.
serviceFeatures STRING The feature that need to be

supply as part of the requested
service.
Returns
Type Comment
checkCapacityResult Returned result for the web service call
Capacity information: Ttotal spare
frame/cable on the DP (DSIDE) or Exchange
(ESIDE)
Maximum Circuits: the lowest count of either
the ESIDE/DSIDE or Port capacity.
Error Conditions
Code
Invalid Address Name Attribute
Invalid Address Value Attribute
Invalid Service Feature
183
DROPWIREEXISTS
Purpose
This web service can be used to determine whether or not a drop wire is associated with a service
address. In addition, it can also be used to determine whether or not a drop wire exists between a
service address and a frame appearance. (Note that the identifier of the service address and not the
physical address must be supplied to the function. Also note that the identifier of a front or rear frame
appearance may be supplied to the web service).
Input Parameters
Name Type Comment
addressID LONG Mandatory. Identifier of a
service address.
frameAppearanceID LONG Optional. Identifier of a frame

appearance.
Returns
Type Comment
String „TRUE‟ if a drop wire is associated with the supplied service address or supplied service
address and frame appearance;
String „FALSE‟ if no drop wire is associated with the supplied service address or supplied service
address and frame appearance.
Error Conditions
Code
Unhandled error
GETDROPWIREFRAMEAPPEARANCE
Purpose
This web service supplied a service address and returns the identifier of the associated frame
appearance (if any). Thus, it shall be possible to determine whether or not a dropwire exists for a
service address.
Input Parameters
Name Type Comment
addressID LONG Mandatory. Identifier of a
service address.
Returns
Type Comment
web service call.
Error Conditions
Code
Unhandled error
184
ADDDROPWIRE
Purpose
This web service shall create a dropwire by associating the identifier of the supplied service address
with the identifier of the supplied frame appearance. Note that the identifier of the front or rear of a
frame appearance position may be supplied to the web service.
Input Parameters
Name Type Comment
frameAppearanceID LONG Identifier of a frame
appearance.
addressID LONG Service Address ID.
Returns
Type Comment
web service call.
String „TRUE‟ if a drop wire is associated with the supplied service address or supplied service
address and frame appearance;
String „FALSE‟ if no drop wire is associated with the supplied service address or supplied service
address and frame appearance.
Error Conditions
Code
Unhandled error
REMOVEDROPWIRE
Purpose
This web service shall disassociate the existing dropwire from the frame appearance. Note that the
identifier of the front or rear of a frame appearance position may be supplied to the web service.
Input Parameters
Name Type Comment
frameAppearanceID LONG Identifier of a frame
appearance.
Returns
Type Comment
web service call.
Error Conditions
Code
Unhandled error
185
GETDPFRAMEAPPEARANCE
Purpose
This web service determines the identifier of the frame appearance on the distribution point that a
circuit (or its bearer) utilises. This web service should be called for non-point-to-point circuits only.
Input Parameters
Name Type Comment
cirtName LONG Circuit ID for which you are
looking for the Frame
Appearance.
Returns
Type Comment
web service call.
Error Conditions
Code
Unhandled error
GETINTACTCIRCUIT
Purpose
The web service accepts a service address ID and/or a frame appearance ID and return the circuit ID
(or NULL) and the service type of the INTACT service. This web service is used to determine if a
given service address or frame appearance ID has an INTACT service associated with it.
Input Parameters
Name Type Comment
addressID LONG Optional.Identifier of a
service address.
frameAppearanceID LONG Optional. Identifier of a frame

appearance.
Returns
Type Comment
intactCircuitResult Returned result for the web service call
Circuit ID of the INTACT circuit.
Service Type; i.e.ADSL.
Error Conditions
Code
Unhandled error
186
FINDPORTFORNUMBER
Purpose
The web service accepts a phone number and returns the unique identifier of a port that is pre-
provisioned with the given number.
Input Parameters
Name Type Comment
phoneNumber STRING Mandatory. The phone number which is
pre-provisioned to a port. If the phone
number has a city code then the
concatenation of city code and phone
number must be passed in the phone
number.
Returns
Type Comment
findPortForNumberResult Returned result for the web service call
Error Conditions
Code
Number is not assigned to any port or the port is not available
RESERVEINTACTCIRCUIT
Purpose
This web service reserves an intact circuit by associating the supplied reservation identifier with the
supplied circuit identifier.
Input Parameters
Name Type Comment
cirtName STRING Mandatory. The identifier of
the intact circuit that is to
be reserved.
reservationID STRING Mandatory. The identifier of

the reservation that is to be
associated with the supplied
circuit identifier.
Returns
Type Comment
web service call.
Error Conditions
Code
Unhandled error
Parameter cirtName is null
187
Parameter reservationID is null

Circuit cirtName does not exist
Status of cirtName is not „INTECT‟
A reserved circuit whose display name matches parameter reservationID
already exists.
Application variable „COMPANY_NAME‟ does not exist
TM_GETCASSCV (FOR TM)

Purpose
The web service retrieve the CV Number stored against a specific service address.
Input Parameters
Name Type Comment
p_addressId LONG Mandatory. Indicates the address
ID.
Returns
Type Comment
TM_getCASSCVResult Containing the following information:
Building code associated with a service
address
CV number associated with the service address
The status of the web service call
Error Conditions
Code
TM_GETCIRCUITDETAILS (FOR TM)

Purpose
This web service retrieves various attributes about the network components that are utilised by a
circuit.
Input Parameters
Name Type Comment
p_serviceNumber STRING Service number
p_serviceType STRING Circuit service name.
p_circuitDisplayN STRING Circuit display name.

ame
p_circuitStatus STRING Circuit status.
Returns
Type Comment
TM_getCircuitDetailsResult Returned result for the web service call
188
Error Conditions
Code
TM_GETSERVICENUMBERS (FOR TM)

Purpose
This web service determines the service numbers that are associated with a cable, cabinet or
distribution point.
Input Parameters
Name Type Comment
cableName STRING The name of the cable, which is
its unique identifier.
frameContainer wsFrameContainer A list of Frame Containers that

correspond with the cable.
Returns
Type Comment
getServiceNumbersResult Returned result for the web service call
Error Conditions
Code
TM_UPDATEFRAMEAPPEARANCESTATUS (FOR TM)

Purpose
This web service updates the status of a frame appearance.
Input Parameters
Name Type Comment
fraaId LONG This is a unique identifier of a
frame appearance.
newStatus STRING New status on the frame

appearance.
Returns
Type Comment
web service call
Error Conditions
Code
189
TM_UPDATEFRAMEAPPEARANCEJUMPER (FOR TM)

Purpose
This web service updates the cross connections in a circuit when a jumper is moved to a different
frame appearance.
Input Parameters
Name Type Comment
cirtName STRING Circuit name.
fromFraaId LONG Frame Appearance A end location.
toFraaId LONG Frame Apprerance B end location.
Returns
Type Comment
updateFrameAppearanceJumper Returned result for the web service call
Result containing the following information:
Error Conditions
Code
TM_COUNTAVAILLINESFORADDRESS (FOR TM)

Purpose
The web service determines the number of lines that are currently available at each Distribution Point
that may service a given address.
For VOICE only services:
a)Provide the number of available pairs on the DSIDE (Distribution Side or Customer Side or
Secondary Side) that can be served on the specified address.
b)Provide the number of available pairs on the ESIDE (Equipment Side or Primary Side) that
can be served on the specified address.
For ADSL service:
a)Provide the number of available DSLAM ports that can serve the specified address or existing
service number.
Input Parameters
Name Type Comment
address wsAddress Service address.
Returns
Type Comment
countAvailLinesForAddressRe Returned result for the web service call
Error Conditions
Code
190
TM_GETDSLAMDISTANCEFROMDP (FOR TM)
Purpose
This web service determines the distance between a distribution point that may service an address,
and the DSLAM that may be used to provide DSL service to the address.
Input Parameters
Name Type Comment
address wsAddress Service address.
Returns
Type Comment
getDslamDistanceFromDpResul Returned result for the web service call
Error Conditions
Code
GETALLOWEDSERVICETYPES (FOR PLDT)

Purpose
This web service is used to cancel a reservation.
Input Parameters
Name Type Comment
serviceID STRING Mandatory. The unique Service
ID of the service intended to
be changed by a service order.
orderType STRING The order type of the proposed

service order
crmServiceType STRING The service type as defined in

the CRM for the proposed
service order
Returns
Type Comment
getAllowedServiceTypesResul Returned result for the web service call
Error Conditions
Code
Invalid Service ID
Invalid Order Type
191
RESERVEFACILITYPLDT (FOR PLDT)

Purpose
This web service reserves the facilities for a service based on service address.
Input Parameters
Name Type Comment
Optional. The phone number
phoneNumber STRING (maximum 20
characters)
− If the phone number is
switch the reserveFacility
will try to use the port
associated with that phone
number. The number status
will be set to “reserved”
− If no phone number is
specified and there is a
phone number associate with
the allocated resources the
phone number will be returned
as out parameter and the
“reserved”.
− If the phone number has been
specified by the caller or a
phone number has been
returned by implementation
this web service will also
reserve the number.
Please note the phone number
that is specified must contain a
city code which is concatenated
to the front of the number with
no space character
serviceAddress wsAddress Optional. The service address to

which the requested service
serviceType STRING (maximum 50 Mandatory. The service that the

characters) customer is requesting. Only
PSTN and ADSL service types are
supported.
Mandatory. The unique ID for the

reservation. More than one
STRING (maximum 50
reservationId certain service. All the
characters)
192
serviceId STRING (maximum 50 Optional. Mandatory for
characters) relocation scenario.
pstnServiceId Optional. Mandatory for Data

STRING (maximum 20
Services created on existing
characters)
PSTN service.
pstnExistingNumb Optional. The existing phone

er number.
Mandatory for Data Services
STRING created on existing PSTN
service.
Mandatory if pstnServiceID is
null.
pstnReservationI Optional. The unique ID for the

D voice reservation. More than one
STRING circuits associated with a
Mandatory for simultaneous or
bundle Voice/Data scenarios.
circuitSpeed Optional. The requested

STRING (maximum 50
bandwidth of the data service to
characters)
be reserved.
ServiceFeatures STRING Optional. The features that need

to be supply as part of the
requested service.
Returns
Type Comment
reserveFacilityPLDTResult Returned result for the web service call
Error Conditions
Code
Reservation ID is null Neighbour‟s telephone number is null
Neighbour‟s telephone number not associated with an in-service circuit
Reservation ID already exists
Neighbour‟s service is not PSTN
Unhandled error
193
CANCELRESERVATIONPLDT (FOR PLDT)

Purpose
This web service is used to cancel a reservation.
Input Parameters
Name Type Comment
reservationID STRING (maximum 50 Mandatory. This refers to the
characters) unique reservationID used by
Reserve Facility.
Returns
Type Comment
web service call.
Error Conditions
Code
194
Chapter 7 Fault Manager
Summary of Fault Management Web Methods and Data Objects available in this document.
getFaultDetails faultDetailResult
getLinks getLinksResult
acknowledgeFault commonResult
createFault faultIDResult
addComment commonResult
confirmFault commonResult
clearFault commonResult
reassignFault commonResult
classifyFault commonResult
setParent commonResult
linkEntity commonResult
getLinkedFaults NumberListResult
getChildFaults NumberListResult
getLinksOfType StringListResult
getParentFault faultIDResult
getFaultID faultIDResult
createAlias commonResult
getCustomFaultAttributeValue customAttributeValueResult
setCustomFaultAttributeValue commonResult
195
Fault Management Data Objects

This section lists the data objects used by the Fault Management web services.

The following are the generic objects used by the Fault Manager web services.
 ReturnStatus
 CommonResult
 AppConstant
 wsAttribute
WSATTRIBUTE

(maximum 240
characters)

(maximum 1000
characters)
WSALIAS
A data object that containing alias (alternate name).
aliasID STRING (maximum 40 An alias (alternate name). NULL

characters) allowed.
domain STRING (maximum 40 The domain.

characters)
FAULTDETAIL
A data object encapsulates the details of a fault ticket.
myfault LONG A unique ID for a fault ticket. This is a

system generated ID that is generated at
the time a fault is created and can not be
specified by external system at creation
time.
mystatus STRING The status of the fault.

(maximum 20
characters)
mycreatedBy STRING The UserID of the employee that created

(maximum 40 the fault ticket.
196
characters)
mycreatedDate DATE The date and time the fault ticket was
entered into the Clarity system.
myreportedBy STRING The name of the person reporting the

(maximum 40 fault.
characters)
myreportedDate DATE The date and time the fault was reported.
This will usually be the same as the
createdTime, but in some circumstances it
may differ.
mydescription STRING A brief description of the fault.

(maximum 80
characters)
mypriority LONG The priority of the fault ticket. This is

a system-wide standardised value for
ranking fault ticket priorities.
myworkGroup STRING The ID of the workgroup to which the fault

(maximum 20 ticket is assigned.
characters)
myfaultAttribute wsAttribute An array of Attribute objects containing

s additional optional attributes of the
fault ticket. The currently available
attributes are:
●NEMS- The Network Element Management
System that manages the equipment to which
the fault ticket is linked as the cause of
the fault.
●REGION - The region in which the fault
exists, for the purposes of assigning work
crews to repair the fault.
●REPORTED_CONTACT- Contact of the person
who reported the fault.
myclassification wsAttribute An array of Attribute objects containing

s classifications and their types given to
the fault ticket.
FAULTDETAILRESULT
An object representing the return result of web service call getFaultDetails.
faultDetail faultDetail A list of faultDetails associated with a

fault ticket.
callStatus returnStatus Containing information about a web service

call status.
197
FAULTLINK
A data object holds a fault ticket reference to a linked entity.
myEntityType STRING A type of an entity.

(maximum 40
characters)
myEntityID STRING An ID of an entity.

(maximum 55
characters)
GETLINKSRESULT
An object representing the return result of web service call getLinks.
myfaultLinks faultLink A list of faultLink objects.
mycallStatus returnStatus Containing information about a web service

call status.
NUMBERLISTRESULT
An object representing the return result of web service calls getLinkedFaults and getChildFaults.
Attribute Value
ID LONG The ID of the entity to which

fault tickets are linked that
are to be retrieved, encoded
as a string.
Contains return status of a
web service call.
STRINGLISTRESULT
An object representing the return result of web service call getLinksOfType.
Attribute Value
ID STRING The ID of the fault ticket

for which the entity links
are to be retrieved.
web service call.
FAULTIDRESULT
An object representing the return result of web service calls getParentFault and getFaultID.
198
faultID INT A unique identifier to reference a
fault ticket. Values of this type
come from the creation of a fault
ticket, or looking up a fault
ticket by various means.

service call.
CUSTOMATTRIBUTEVALUERESULT
An object representing the return result of web service calls getCustomFaultAttributeValue and
setCustomAttributeValue.
Attribute Value
customAttributeValue STRING Value of an attribute.

web service call.
Fault Management Web Methods

This section explains the Fault Management web services in detail.
GETFAULTDETAILS
Purpose
This web service is used to retrieve a faultDetail object that contains the details of a fault ticket.
Input Parameters
Name Type Comment
fault INT The ID of the fault ticket for
which the details are to be
returned.
Returns
Type Comment
faultDetailResult An object that contains the data detailing
the fault ticket and web service call status.
The definition of the faultDetailResult type
is given in the Data object section of this
document.
Error Conditions
Code
InvalidFaultID
199
GETLINKS
Purpose
This web service returns a list of entities to which a particular fault ticket is linked.
Input Parameters
Name Type Comment
which the links are to be
returned.
Returns
Type Comment
getLinksResult An object type representing a result for
getLinks web service call.
Error Conditions
Code
InvalidFaultID
ACKNOWLEDGEFAULT
Purpose
This web service marks a fault ticket as acknowledged, recording the date and time it was
acknowledged and the user that acknowledged it.
Input Parameters
Name Type Comment
fault INT The ID of the fault ticket to
be acknowledged. A fault ID
must pre-exist in Clarity
database.
username STRING (maximum 40 The username of the user
characters) acknowledging the fault
ticket. It must reference an
employee via their username.
dateAcknowledged DATE The time and date to be
recorded for the
acknowledgment. The date can
not be NULL, and shall be
later than the date when the
fault was created.
source STRING (maximum 40 A string identifying a calling
characters) system. It is recommended to
give the calling system an
unique name, and use this name
for all web service calls when
applicable.
Returns
Type Comment
200
web service call
Error Conditions
Code
InvalidFaultID
InvalidUserID
AlreadyAcknowledged
FaultClosed
InvalidAcknowledgeDate
InvalidUserWorkGroup
CREATEFAULT
Purpose
This web service is used to create a new fault ticket in the Clarity OSS database.
Input Parameters
Name Type Comment
reportedBy STRING(maximum 40 The name of the entity
characters) reporting the fault. This
value is a free-form text
field with a maximum length of
40 characters. This field must
not be NULL, but is otherwise
not validated.
reportedDate DATE The date and time that the
fault was reported. If a NULL
is supplied, the date and time
when the procedure was called
is used.
description STRING (maximum 80 A short description of the
characters) fault. This value is a free-
form text field with a maximum
length of 80 characters. The
field must not be NULL, but is
otherwise not validated.
Information that will not fit
in the description may be
added as comments.
priority INT The priority of the fault.
This must match one of the
priorities defined as a
standard fault priority. The
field must not be NULL.
workgroup STRING(maximum 20 The workgroup to which this
characters) fault ticket to be assigned.
This field will be validated
against the workgroups defined
in the system. It must not be
NULL. If not supplied, the
system will set the value for
the workgroup based of the
business rules for the current
implementation.
201
creatingUser STRING The UserID of the employee

that created the fault ticket.
This field will be validated
against the employees defined
in the system. It must not be
NULL.
faultAttributes wsAttribute An attribute list containing
additional optional attributes
for the fault ticket. If may
be NULL if there are no
additional attributes
initialClassifica wsAttribute A list of classifications to
tions be added to this fault. For
createFault this list must
contain CAUSE and TYPE which
are mandatory for fault
creation. Note: Also refer to
the section on classifyFault.
applicable.
Returns
Type Comment
faultIDResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidPriority
InvalidWorkgroupID
InvalidUserID
InvalidReportedUser
InvalidReportedDate
InvalidDescription
InvalidAttributeValue
InvalidClassificationType
InvalidClassification
202
ADDCOMMENT
Purpose
This web service is used to add a comment to a fault ticket. Comments contain additional free-form
adhoc information that may be useful to an operator or engineer to help resolve the fault. The text of a
comment is limited to 1000 characters.
Input Parameters
Name Type Comment
fault INT The fault ticket ID of the
fault ticket to which the
comment is to be appended.
comment STRING (maximum 1000 The text of the comment to be
characters) added to the fault ticket.
This must not be NULL and must
be no longer than 1000
characters.
username STRING (maximum 40 The username to which the
characters) comment is ascribed. This must
be a valid reference to an
Employee via its user ID.
dateEntered DATE The time and date that the
comment was recorded.
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidComment
InvalidUserID
FaultClosed
203
CONFIRMFAULT
Purpose
This web service is used to mark a fault ticket as confirmed, recording the date and time it was
confirmed as well as the user confirming it. A fault ticket is confirmed when the reporter of the fault
confirms that the fault reported is fixed.
Input Parameters
Name Type Comment
fault INT The fault ticket ID of the
fault ticket to be confirmed.
characters) recording the confirmation of
the fault ticket. It must
reference an employee via
their username.
dateConfirmed DATE The time and date to be
recorded.
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidUserID
OpenStatusFound
InvalidDate
FaultHaveOpenAlarm
FaultRecordLocked
ColumnsNotPopulated
FaultHasOpenWorkOrder
FaultClosed
204
CLEARFAULT
Purpose
This web service is used to mark a fault ticket as cleared, recording the date and time it was cleared
as well as the user clearing it. A fault ticket is cleared when it is believed that the fault has been fixed.
Input Parameters
Name Type Comment
fault INT The fault ticked ID of the
fault ticket to be cleared.
characters) clearing the fault ticket. It
must reference an employee via
their username.
dateCleared DATE The time and date to be
recorded for the clear time.
The date can not be NULL, and
shall be later then the date
when the fault was created.
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidUserID
OpenStatusFound
InvalidDate
FaultHaveOpenAlarm
FaultRecordLocked
ColumnsNotPopulated
FaultClosed
205
REASSIGNFAULT
Purpose
This web service is used to assign a fault ticket to another workgroup.
Input Parameters
Name Type Comment
fault INT The ID of the fault ticket to
be reassigned to another
workgroup.
workgroup STRING (maximum 20 The ID of the workgroup to
characters) which the fault ticket is to
be reassigned.
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidWorkgroupID
FaultClosed
CLASSIFYFAULT
Purpose
This web service attaches one or more classifications to a fault. A classification is an organisation-
dependent way of organising faults. Many classifications types may be defined.
The standard classification types for Clarity Fault Management are:
 CAUSE
 ENTITY
 IMPACT
 PLATFORM
 CATEGORY
 TYPE
 SUBCATEGORY
Input Parameters
Name Type Comment
which classifications are to
206
be attached.
classifications wsAttribute An array of wsAttribute where
the name is the classification
type and the value is the
classification for that type.
If a NULL value is supplied,
the classification is removed
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidClassificationType
InvalidClassification
FaultClosed
SETPARENT
Purpose
This web service is used to create or remove a parent-child relationship between two fault tickets.
The parent-child fault ticket hierarchy is limited to a depth of two levels. For example, a fault ticket
may be a parent of many fault tickets, or it may be a child of one parent, but not both. Alternatively a
fault ticket may have no parent-child relationship.
Input Parameters
Name Type Comment
faultID INT The fault ticket ID that is to
have its parent set. This is
the child fault ticket ID that
is either being added to or
removed from a parent.
parentFaultID INT The fault ticket ID of the
parent fault ticket if the
child is being linked to a
parent, or NULL if the child
is being unlinked from a
parent.
applicable.
207
Returns
Type Comment
web service call
Error Conditions
Code
InvalidFaultID
InvaludParentFaultID
ParentIsAChild
ChildIsAParent
ChildIsAChild
ChildIsNotAChild
FaultRecordLocked
FaultClosed
LINKENTITY
Purpose
This web service is used to link Clarity OSS entity to a fault ticket, usually to indicate the network
element at fault, impacted services or affected customers.
The specific entities that can be linked to a fault ticket are:
 ALARMS
 CABLE_CORES
 CABLE_SHEATHS
 CARDS
 CIRCUITS
 CUSTOMER
 EQUIPMENT
 FRAME_APPEARANCES
 FRAME_CONTAINERS
 FRAME_UNITS
 LOCATIONS
 PORTS
 SERVICES
Input Parameters
Name Type Comment
faultID INT The fault ticket ID of the
fault ticket to which the
entity is to be linked.
entityType STRING The type of entity to be
linked to the fault ticket.
The non-definitive list of
entity types is listed above,
but others may be added as
208
customisations.
entityID STRING The ID of the entity to be
linked encoded as a string.
The ID must be valid for the
given entity type.
give the calling system a
applicable.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
InvalidEntityType
InvalidEntityID
LinkNotPermitted
FaultClosed
GETLINKEDFAULTS
Purpose
This web service is used to get a list of open fault tickets that are linked to a specific entity. This
function will return only fault tickets that are open.
Input Parameters
Name Type Comment
entityType STRING The entity type of the
entityID parameter.
entityID STRING The ID of the entity to which
fault tickets are linked that
are to be retrieved, encoded
as a string. The ID must be
valid for the given entity
type.
Returns
Type Comment
numberListResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidEntityType
InvalidEntityID
209
GETCHILDFAULTS
Purpose
This web service is used to get a list of fault tickets that are children of a given fault ticket.
Input Parameters
Name Type Comment
faultID INT The ID of the fault ticket of
which the children are to be
retrieved.
Returns
Type Comment
numberListResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidFaultID
GETLINKSOFTYPE
Purpose
This web service returns a list of entities of specified entity type to which a particular fault ticket is
linked
Input Parameters
Name Type Comment
faultID INT The ID of the fault ticket for
which the entity links are to
be retrieved.
entityType STRING The entity type of the links
that are to be retrieved.
Returns
Type Comment
stringListResult Return object containing the result of the
web service call.
Error Conditions
Code
InvalidFaultID
InvalidEntityType
210
GETPARENTFAULT
Purpose
This web service is used to retrieve the parent fault id of a child fault.
Input Parameters
Name Type Comment
fault INT The ID of the child fault ticket

for which the parent fault id is
to be retrieved.
Returns
Type Comment
web service call.
If there is no parent there will not be any
exception and the faultId will be set to 0.
Error Conditions
Code
InvalidFaultID
GETFAULTID
Purpose
This web service is used to find a FaultID for a fault ticket given an alias (an identifier used by another
system).
Input Parameters
Name Type Comment
faultAlias wsAlias ID of the fault ticket for which

attributes value is to be
retrieved.
Returns
Type Comment
web service call.
Error Conditions
Code
211
CREATEALIAS
Purpose
This web service is used to map an external system indentifier for a fault ticket to the Clarity Fault
Ticket identifier. It is used when there is a one-to-one mapping between fault tickets.
Input Parameters
Name Type Comment
faultID INT The ID of the fault ticket for

which an alias should be created.
faultAlias wsAlias The external identifier for the
fault ticket.
Returns
Type Comment
web service call.
Error Conditions
Code
InvalidFaultID
DuplicateAlias
GETCUSTOMFAULTATTRIBUTEVALUE
Purpose
This web service is used to retrieve the value of an attribute for a given fault.
Input Parameters
Name Type Comment
faultID INT The external identifier for the

fault ticket.
attibuteName STRING Valid attribute name as defined
in Fault Attributes Definition
screen.
Returns
Type Comment
customAttributeValueResult Return object containing the result of the
web service call.
Error Conditions
Code
212
SETCUSTOMFAULTATTRIBUTEVALUE
Purpose
This web service is used to set the value of an attribute for a given fault. If attribute name is a valid
attribute defined in screen Fault Attributes Definition then the attribute will be added to the fault and
attribute value set.
Input Parameters
Name Type Comment
faultID INT The external identifier for the

fault ticket.
attributeName STRING Valid attribute name as defined
in Fault Attributes Definition
screen.
attributeValue STRING Value of the attribute.
source STRING Permits the calling system to

Returns
Type Comment
web service call.
Error Conditions
Code
213
Appendix A WSDL File and Schema
MODULE WSDL File and Schema
Customer Management CustomerManagementAPIService.xml
CustomerManagementAPIService_schema.xsd
Address Management AddressManagementAPIService.xml
AddressManagementAPIService_schema.xsd
Area Management AreaManagementAPIService.xml
AreaManagementAPIService_schema.xsd
Account Management AccountManagementAPIService.xml
AccountManagementAPIService_schema.xsd
Identity (Number) NumberManagementAPIService.xml

Management
NumberAPIService_schema.xsd
Inventory Management InventoryManagementAPIService.xml
InventoryManagementAPIService_schema.xsd
Fault Management FaultManagementAPIService.xml
FaultManagementAPIService_schema.xsd
Service Management ServiceManagementAPIService.xml
ServiceManagementAPIService_schema.xsd
214
Appendix B Error Codes
Corporate Manager
CODE ERROR CONDITION DESCRIPTION
000 SUCCESS/TRUE/EXISTS A zero status will be returned for success operations.

For a procedure testing for exists; then 0 = TRUE
U U
001 FALSE/NOT EXISTS A code = 1 will be returned to indicate failure.

For a procedure testing for exists; then 1 = FALSE/NOT
U U
EXISTS
Any other code will indicate a specific error
002 Invalid CustomerType The "customerType" is not valid.
003 Invalid CustomerStatus The "customerStatus" is not a valid status.
004 Unknown Alias The specified alias does not exist for record in the specified
naming domain.
The accountID parameter does not reference a valid account
005 Invalid AccountID
006 Invalid Account Status The accountStatus parameter is not a valid status.
The addressStatus parameter does not reference a valid
007 Invalid Address Status
status.
008 Invalid Street Name The streetName parameter does not reference a valid street.
009 Invalid Post Code The postCode parameter does not reference a valid Postal
Code.
addressID parameter does not reference a valid Address.
010 Invalid AddressID
011 Invalid State stateCode parameter does not reference a valid State.
ttname field is invalid
012 Invalid TTName
013 Duplicate TTName The ttname field is already used by another location record
014 Unused
015 Invalid LocationType The "locationType" parameter does not reference a valid
location type
016 Invalid TTNameDesc The "description" parameter is not valid (probably null)
017 Invalid LocationID The "location" parameter does not reference an existing
location record.
018 Invalid ContactPointID The contactPointID parameter is not a valid reference to a

valid Contact Point.
019 Contact Point Cannot be The contact Point has other child and can not be deleted.
215
Deleted
020 Invalid CustomerLocation The customer has already been added to this location
021 Invalid CustomerAddress No addresses exist for this customer
022 Invalid AccountMgr Account Manager does not exist
023 Unused
024 Invalid ContactPointType The Contact Point Type is not defined
025 Invalid Contact The Contact is not defined
026 Invalid AreaCode The Area Code is not defined
027 Duplicate Alias The Alias is already in use
028 Invalid Address The address is not defined
030 Invalid IndustryCode
031 Invalid MarketSegment The Market Segment does not reference a valid Market
Segment
032 Invalid CusrMegaID
033 Invalid Area Code Area Code is valid
034 Too Many AreaCodes Deprecated. More than one Area Code matches the criteria.
035 Hours Must be Specified Contact Point Hours must be specified
036 Post Code Must be Post Code must be specified

Specified
037 State Must be Specified State must be specified
038 Suburb Must be Specified Suburb must be specified
039 Street Name Must be Street Name must be specified

Specified
040 Child Locations Exist Child Locations are linked to this Location
041 Malformed Attribute Attribute is either unrecognised or of incorrect type
042 Invalid LocationNode The Location Node value has to be either Y or N
043 Invalid Source Type “source type” is not a recognised source type
044 Invalid Service ID The service ID does not exist
045 Invalid Reservation ID No circuit/facility is reserved under this reservation ID
046 Invalid Service Type Invalid Service Type
216
047 Address Serviceability If an identical address serviceability record already exists.
already exists
048 Invalid Entity If the entity does not exist.
049 Updated Address already Updated address is a duplicate of another address

exists
060 Area Code is Mandatory Area Code is mandatory to get the child areas.
061 No child Area found for This is returned when there are no child areas found, for the
the area. entered area code.
Identity (Number) Manager

VOICE NUMBER MANAGER
1 Number Already exists The number range already exists
Range too large The maximum processing limit has been exceeded for
2
this BATCH PROCESS
Numbers in Range already The numbers cannot be created because some or more
3
exist already were.
Invalid service Type The serviceType does not reference a valid serviced
4
type
Invalid country Code The countryCode does not reference a valid country
5
code
Invalid Service Type Priority The Service Type priority is invalid either because it was
6
duplicated or because it is not between 1 and 99
7 Invalid City Code The city code does not reference a valid city code
The explode flag is not valid, valid values can be either

8
'Y'OR 'N'
9 Invalid userID UserID does not reference a valid employee
Insufficient privileges The user does not have required permission to execute
10
the operation
Invalid NumberRange The specified rangeID does not reference a valid

12
number range
13 Invalid Attribute Name At least one name from the AttributeList is invalid
14 Invalid Attribute Value At least one value for an attribute is invalid
Invalid start Number Specified starting number does not exist in the numbers
15
table
16 Invalid end Number Specified ending number does not exist in the numbers
217
table
17 Invalid numberStatus The status specified does not reference a valid status
18 Invalid serviceID Invalid service type
19 Invalid number Type The number type is invalid
Invalid entityType The entity type specified is not valid, valid types are
20
Service, or External
21 Invalid entityID The entity id specified does not exist
Invalid reservationFlag The reservation flag value is invalid, valid values are
22
RESERVE and UNRESERVE
Invalid Number The number id specified does not exist as a valid

23
number
Number already in service The number cannot be changed because it is currently

24
active and in service
Number or Numbers not

Number Reservation not possible for this number
25 available for reservation but
because of other than quarantined status transition rules
not Quarantined
30 Number Is Not A Number Either the Start or End Numbers are invalid.
InvalidRangeUnequalLengths The Start Number and End Number are of unequal

31
length.
32 InvalidRangeEndNumLowest The End number is LESS than the start number.
Business rules violation for The new number status violates the business rules.
35
status
43 Missing numbers Not all numbers within the number range given exist
Starting number is not a valid

44 Starting number is not a valid number
number
Ending number is not a valid

45 Ending number is not a valid number
number.
46 No numbers meet criteria There are no numbers with the number criteria
Country Code needs to be

47 The SYSTEM is not set up with a valid Country Code
selected and configured
48 Invalid Value An invalid value has been entered
Number Not Available for

49 The Number/IP Address is not available for use
Use
Invalid Foreign Type Value provided is not CARDS or PORTS or

50
EQUIPMENT
51 Invalid Foreign ID The Foreign ID cannot be found in the CLARITY system
218
Invalid Network Name The Network Name cannot be found in the CLARITY
52
system
Invalid Consecutive Flag The Consecutive Flag is not valid, valid values are [0|1].
53
"1" - True, "0" – False
54 Invalid Number ID The Number ID does not exist
55 Duplicate Attribute Name One or more of the Attributes already exist
56 Invalid Number of Days The number of days needs to be positive
57 Missing Attribute At least one attribute needs to be specified
58 Invalid Attribute Not all attributes are associated with the number
59 Missing Reservation ID Missing mandatory parameter - Reservation ID
IPV4 NUMBER MANAGER
0 Successfully Completed API Operation Completed Successfully
2 Invalid HowMany The HowMany parameter is invalid
4 Invalid Service Type The serviceType does not reference a valid serviced type
Invalid userID User is not a Valid employee or not assigned to the

9
necessary workgroup
10 Insufficient Privileges The USER is not assigned the Required role(s)
17 Invalid Number Status The status specified does not reference a valid status
19 Invalid Number Type The number type is invalid
Invalid entity Type The entity type specified is not valid, valid types are Service,
20
or External.
21 Invalid entity ID The entity id specified does not exist Or is invalid
27 Invalid Area Code The Area is invalid
Address is Outside the

32 IP_ADDR_IN is not contained in the Address Block
Block
Number Reserved For The number or numbers were previously reserved for the
33
Service service.
39 Invalid IP Control The IP Control is invalid
Starting Number is
44 IP_ADDR_IN or BLOCK_ADDR_IN not a valid IP Address
Invalid
Invalid Block Size The BLOCK_ADDR_IN is not between 255.255.255.0 and

45
255.255.255 or CIDR /16 and /32
219
Issues with the Country The database is configured incorrectly, with none or more
46
Code one Country Code
47 Invalid Area Flag The area flag is invalid
48 Invalid Value An invalid value has been entered
49 Number Not Available The Number/IP Address is not available for use
50 Invalid Foreign Type Value provided is not CARDS or PORTS or EQUIPMENT
51 Invalid Foreign ID The Foreign ID cannot be found in the CLARITY system
52 Invalid Network Name The Network Name cannot be found in the CLARITY system
53 Invalid CIDR The Subnet Mask or CIDR must be between 5 and 32
Network Name Required A Network Name is required if the IP control is "I" - Private
54
Network
Number is already The IP Number(s) is already associated with a Service, and

55
assigned to a Service can not be changed
Numbers have Multiple

56 The IP Number(s) has multiple status
Status
Numbers have Multiple

57 The IP Number(s) has multiple Reserve IDs
Reserve IDs
58 No Numbers There are no numbers with the number criteria.
IP Invalid All Associated The All Associated flag is not valid, valid values can be
59
Flag either 'Y' OR 'N'
60 IP Null IP Address IP Address is a mandatory field.
61 IP Invalid Address The IP Address is invalid
Service Manager
000 OK No error has occurred.
001 False/Not found The operation has completed successfully but no records can be
found or the result is false.
002 Invalid AccountID accountID does not reference a valid account ID.
003 Invalid CustomerID customerID does not reference a valid customer ID.
004 Invalid Service Type ServiceType does not reference a valid service type.
005 Invalid LocationID The "aLocationID" or "bLocationID" does not reference a valid
location.
006 Invalid Attribute Name One of the attribute‟s names is not a valid attribute name for the
220
specified request. Refer to Reference Data Document.
007 Invalid Speed For Service The specified speed is not a valid speed for the given service type.
Type
008 Invalid Finish Date finishDate does not reference a valid date.
009 Invalid ServiceOrderID The serviceOrderID does not reference a valid Service Order.
010 Invalid ServiceID The serviceID does not reference a valid service.
011 Alias Not Found The specified alias has not been found.
012 Invalid Service Identifier The specified service identifier is not found or invalid.
013 Invalid Task Name Task Name is not valid. Refer to Reference Data Document.
014 Invalid Task Status Task Status is not valid. Refer to Reference Data Document.
015 Invalid Condition Unused.
016 Invalid Feature(s) The features requested are not applicable for the service or NULL.
Requested
017 Invalid Service Status Operation not allowed on the service in its current status.
018 Service Order Already Another service order is already submitted for the specified service
Exists
019 Invalid Order Type The order type specified is not allowed in this context.
020 Invalid Waiter ID The specified waiter ID is invalid.
021 Invalid Duration Class The duration class specified is invalid.
022 Invalid Service Type The service type specified is valid
023 Missing Attribute A required attribute is missing when creating a service order
024 Invalid Address ID The address supplied is invalid
025 Invalid Service Priority The service priority is invalid.
026 Invalid Argument The parameters passed to a web serviceis malformed
027 InvalidFilePath The file path specified is invalid
028 InvalidFileName The file name specified is invalid
029 InvalidAreaCode The area code specified is invalid
030 InvalidWorkgroup The workgroup specified is invalid
031 Invalid Waiter Order The waiter order does not exist or is invalid
032 No cancellation reason Required cancellation reason not found or is NULL.
221
033 Invalid If task prior to the external task are not yet completed or the
SetTaskStatusRequest external task is not due to complete.
034 InvalidTaskStatus The specified task is not a valid status for an implementation task.
035 WaiterForSOExists The Service Order already exists as a waiter record
036 DuplicateWaiterRequest A waiter record already exists for Service Order, Service Type,
Address and Customer
037 Invalid Request Status The status of the task disallows this change.
038 Invalid Parent Service An invalid service ID is specified for a parent service ID
039 Invalid Link Address An invalid link address is specified
040 Invalid Request ID The specified request is not found
041 Invalid Feature Action An invalid feature action is specified
042 Invalid Child Feature Child feature action is incompatible with parent. Child action must
Action be N if parent is N
043 Feature Not Found For Feature cannot be found for a feature update request.
Update
044 Incompatible Feature Feature action must be different from its previous action value
Action
045 Invalid Link Address If the specified link address action is invalid.
Action
046 Invalid Service Order If the service order waiter ID specified is not found or invalid.
Waiter ID
047 Invalid Facility Type If the facility type is invalid.
048 Invalid Facility ID If the facility ID is not found or invalid.
049 Null Service Number If a Service Number parameter is passed as NULL when a value is
required.
050 Service Number Does Not If the specified service number does not exist.
Exist
051 Invalid Address If an invalid address is specified where it is required.
052 Invalid Element If an invalid element is specified where it is required.
053 Invalid Set Task Status Returned when an attempt is made to change the status of an
Comp implementation task that has already been completed.
054 Invalid Set Task Status SO Returned when an attempt is made to change the status of an
Close implementation task that belongs to a service order that is either
Closed, Cancelled or in Waiters.
055 Service Type Does Not If the specified service type does not exist.
Exist
222
056 Invalid Work Order ID If the specified work order id does not exist.
057 Invalid Work Order If the specified work order comment id does not exist.
Comment ID
058 Invalid Work Order If the specified work order activity id does not exist.
Activity ID
059 Invalid Employee ID If the specified employee id does not exist.
060 Open Activities Present An attempt was made to close a work order which still has open
activities
061 Invalid Status A status was provided which is invalid for the record in question.
Please review the error message in full to determine the exact
cause.
062 Invalid Parameter An error was found with one of the input values. Please review the
error message in full to determine the exact cause.
Configuration/Inventory Manager
000 No Error Successful completion.
001 Invalid Address Attribute name The address name attribute specified is not valid.
002 Invalid Address Attribute value The address value attribute specified is not valid.
The service type specified was not valid.
003 Invalid Service Type
The phone number specified is not valid.
004 Invalid Phone Number
The application was unable to find or reserve
005 No Facilities
facilities for the supplied address.
The reservation ID does not exist as part of a circuit
006 Invalid Reservation ID
design.
The date specified is invalid.
007 Invalid Date
No circuit is carrying a service with this ID.
008 Invalid Service ID
The circuit name does not exist.
009 Invalid Circuit Name
The port ID does not exist.
010 Invalid Port ID
The Card or Network Element details are invalid.
011 Invalid Card Details
The package completed with an error that was
100 Unhandled Error
unexpected.
The Planned Event Number is invalid.
001 InvalidPlannedEventNumber
The Customer ID is invalid.
002 InvalidCustomerID
223
Inventory Manager (Reserve Facility)

As of version release c10.7.3 the following error codes apply to Reserve Facility.
000 No Error Successful completion
001 Service address is not valid The service address specified was not valid
002 Service ID is a mandatory

parameter and cannot be null
003 Service Type is not valid The service type specified was not valid
004 Phone number is not valid The phone number specified is not valid
005 Could not reserve specified

phone number
006 Reservation ID is a mandatory

parameter and cannot be null
007 Service speed is not valid The service speed specified was not valid
008 Service feature is invalid The service feature specified was not valid
009 Could not find a circuit for the

specified service id
010 Could not find a service speed

for the specified service
011 The status of the existing service

is not valid for a relocation
request
012 Service type group does not

exist
013 No existing service found
014 Passing an existing Service

Phone Number and a Service ID
is not valid
015 Facility Reservation requires that

a Service Address be specified
016 Service ID is not valid The Service ID specified is not valid
017 Could not create the circuit

header record
018 Could not change the status of

the specified circuit from a
PROPOSED to RESERVED
status
224
019 No Free facilities for Relocation
020 Neighbours phone number

cannot be NULL
021 The specified number if not

associated with an INSERVICE
circuit
022 The current reservation id is not

unique or has already been used
for another reservation
023 The neighbours service uses

xDSL infrastructure which
cannot be copied to create a
simple PSTN service
024 Could not create a service based

on a copy of the neighbours
specified phone number
025 The specified reservation exists

for more than one circuit
026 Invalid port id specified The port ID does not exist
027 Invalid card details The Card or Network Element details are invalid.
028 The service type is not

supported at the Port, Card or
NE level
050 Service Address does not exist
051 Distribution Point to Service

Address mapping has not been
defined in this area
052 No free facilities on the

Distribution Point
053 No free facilities in the Cabinet
054 The status of the Distribution

Point is not INSERVICE
055 Exchange code is invalid
056 There is no entry in Address

Serviceability
057 Relocation to a different switch

configuration is not supported
058 Cannot use Frame Appearance

flagged with a Status of BAD
225
066 Frame Usage or Service Type is

not valid or No Free Facilities are
available on Frame Container
067 Frame Usage or Service Type is

not valid or No Free facilities are
available on Frame Container
092 RT equipment cannot be

allocated
093 COT equipment cannot be

allocated
094 Swithc of BTS status must be

INSERVICE
095 No capacity at Switch or BTS
100 Generic error code
101 The DSL service already exist
102 The specified address already

supports a DSL service
103 A DSL child service already

exists on the current bearer
104 Cannot find specified circuit
105 Unable to revert the PSTN

service to its original state
106 Upgrade service error
107 Could not create a copy of the

specified circuit as it already
exists
108 Could not remove Splitter ports
109 Could not upgrade splitter from

DSL to NGN
110 Could not update circuit end

point locations
111 Could not create DSL bearer for

existing service
112 Could not add child service to

the DSL bearer hierarchy
113 Could not find a NGN Bearer for

the existing service
114 More than one bearer exists for
226
the specified service
1215 Could not relocate service in

Building
116 Could not create service in

Building
117 Could not relocated the specified

Voice over DSL service
118 Could not extend the service

reservation
119 The specified reservation is not

part of a multiple reservation
scenario and cannot be
cancelled
120 Cannot delete the circuits

associated with this multiple
reservation id
121 Unable to delete circuit with the

specified reservation id
200 Reservation Sceanario

Unknown, please contact your
administrator
Fault Manager
001 InvalidPriority The priority parameter is not a valid reference to a

Priority
002 InvalidWorkgroupID The workgroup parameter is not a valid reference to

a Workgroup
003 InvalidUserID The creatingUser parameter is not a valid reference

to an Employee
004 InvalidReportedUser If null value is supplied for reportedBy parameter
005 InvalidReportedDate If null value is supplied for ReportedDate parameter
006 InvalidDescription If null value is supplied for description parameter
007 InvalidAttributeName One of the attribute names in the faultAttributes list

parameter is not a valid attribute name for a fault
ticket
008 InvalidAttributeValue One of the attribute values in the faultAttributes list

parameter is not a valid attribute value for the
specified attribute name
009 InvalidClassificationType One of the classification types in the
227
initialClassifications list parameter is not a valid

classification type
010 InvalidClassification One of the classifications in the initialClassifications

list parameter is not a valid classification value for its
type
011 InvalidFaultID The fault parameter is not a valid reference to a fault

ticket
012 DuplicateAlias The fault ticket alias is used by another fault ticket
013 InvalidAlias The faultAlias does not exist for the given fault (or
any fault if the fault ID is not given)
014 FaultClosed The fault ticket is closed and no modifications may

be made to it
015 InvalidEntityType The entityType parameter is not a valid entity type
016 InvalidEntityID The entityID parameter is not a valid reference to an

entity of the given entity type
017 LinkNotPermitted If the validations as specified in the Function

linkPermitted fails
018 InvalidComment The comment parameter is NULL or greater than its

maximum allowed size
019 InvalidParentFaultID The parentFault parameter is not a valid reference

to a fault ticket
020 ParentIsAChild The fault ticket referenced by the parentFault

parameter is already a child of another fault ticket
and cannot be made a parent
021 ChildIsAParent The fault ticket referenced by fault is already a

parent of another fault ticket and cannot be made a
child
022 ChildIsAChild The fault ticket referenced by fault is already a child

of another fault
023 ChildIsNotAChild when parentFault is null, then fault is expected to be

a child already. If not, this exception will be raised
024 FaultRecordLocked If either child record or parent records are locked by

some other user
025 AlreadyAcknowledged The fault ticket to be acknowledged is already

acknowledged
026 InvalidAcknowledgeDate If the supplied acknowledged date is less than the

fault creation or reported dates
027 InvalidUserWorkGroup If the Work Group of the supplied user is not the
current workgroup of the supplied fault
028 OpenStatusFound If fault has an open Status
228
029 InvalidDate If clear date is less than status end-date, reported
date or created dates
030 FaultHaveOpenAlarm If fault has an open alarm
031 ColumnsNotPopulated If columns that are mandatory to be filled-in before

clearing a fault are not filled-up
032 FaultHasOpenWorkOrder If there is an open Work Order attached to the fault
033 StatusRecordLocked If previous end-time was null and if that record is

locked
034 InvalidStatusCode The statusCode parameter is not a valid status code
035 NoCurrentStatus There is no current status on the referenced fault

ticket. Either the fault ticket has not yet been
assigned a status, or the last status has already
been ended
036 InvalidFilePath The filePath parameter is NULL or longer than 180

characters
037 InvalidFileName The fileName parameter is NULL or longer that 180

characters
038 FaultHasOpenWorkflow A workflow is still open for this fault. It must be

closed first
229
Document Information
Version Date Amendment Name Role
2.0 23/Apr/2010 Added new web services for Number Swati Mohanty Technical Writer
Manager (VIVACOMIA-223), Fault
Manager (VIVACOMIA-278), Inventory
Manager (VIVACOMIA-297), and also
updated a web service for Service
Manager (VIVACOMIA-370).
Version released in C10.6.6
2.1 17/May/2010 Added new Contact Point web services Swati Mohanty Technical Writer
2.2 02/Jun/2010 Added new web services: getAddressList, Swati Mohanty Technical Writer
getServiceHierarchy,
reserve_Agent_Timeslot, and
get_Agent_Available
2.3 02/Jun/2010 Added new web services: Swati Mohanty Technical Writer
getFullContactPoints,
getServiceOrderIDList,getServiceIDsbyN
ame, and
getServiceManagerIDbyJobTicket
2.4 09/Jul/2010 Updated the SetTaskStatus and Swati Mohanty Technical Writer
getAddressList webservices. Added new
webservices FindPortForNumber,
createAlias, getFaultID, getParentFault,
addContact, deleteContact, and
reserveIntactCircuit.
Added new PLDT webservices
getAllowedServiceTypes and
getAreaForServiceNoRelocate.
2.5 20/Aug/2010 Add new Fault web services Wendy Khoo Business Analyst
(VIVACOMIA-555):
setCustomFaultAttributeValue,
GetCustomFaultAttributeValue
Add new Inventory (RF) web services
(VIVACOMIB-173):
reserveFacilityNGNStartingAt,
reserveFacilityStartingAt
2.6 21/Oct/2010 Revised the entire document. Add, Wendy Khoo Business Analyst
modify and delete to reflect the available
web services upto c10.7.8
SLTSPT-399,400,401,405:
createAccountManager
getAccountManagerID
updateAccountManager
setAddressCustomerID
230
getAreaServiceTypeWorkGroup
Added Appendix A: WSDL File and
Schema
2.7 04/Nov/2010 Continue to edit the document in the Wendy Khoo Business Analyst
following sections: Service Manager,
Inventory Manager and Fault Manager.
Appendix B: added Error Codes for
Reserve Facility. Unable to locate/find
Description for all the error codes.
Rename “Number”
Management/Manager to Identity
(Number) Management/Manager.
Removed word
„PROCEDURE/FUNCTION/ from
headings.
2.8 22/Nov/2010 Updated Chapter 7- CREATEFAULT Jeevanthi Technical Writer

table to incorporate missing information Dharmasena
as explained in SLTSPT-412.
2.9 06/Dec/2010 Updated chapter 4 with 3 new web Jeevanthi Technical Writer
services added for VIVACOMIB-159. Dharmasena
Added web Services are as follows:
setAttributesByNumbers
updateAttributesByNumbers
deleteAttributesByNumbers
3.0 31/01/2011 Updated the document with the new logo\ Jeevanthi Technical Writer
Dharmasena
Also removed the service manager call
back API from the document and
included it in a new document called
Clarity Callback Web Services Guide
1.0..
Version Released in C11.0.0
231

Clarity System Connect Web Services Guide PDF

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Clarity System Connect Web Services Guide PDF

Uploaded by

Copyright:

Available Formats

System Connect Web Services Guide

Document Version 3.0

Field Type Description

Msg string The human-readable description of the error.

Web Services Guidelines

Chapter 2 Common Data Types

aliasID STRING (maximum 40 characters)

domain STRING (maximum 40 characters)

name STRING (maximum 100 characters)

value STRING (maximum 1000 characters)

name STRING (maximum 100 characters)

value STRING (maximum 1000 characters)

type STRING (maximum 20 characters)

entityID STRING (maximum 100 characters)

entityType STRING (maximum 100 characters)

createdby STRING (maximum 20 characters)

commentText STRING (maximum 1000 characters)

parent STRING (Maximum 400 characters)

action STRING (Maximum 20 characters)

featureName STRING (Maximum 20 characters)

codeType STRING (Maximum 400 characters)

message STRING (Maximum 40 characters)

Web Methods Data Objects

COMMON BUSINESS OBJECTS

Attribute Value Description

aliasID STRING (maximum 40 An alias (alternate name). NULL

domain STRING (maximum 40 The domain.

Attribute Value Description

name STRING An attribute name.

value STRING Value of an attribute.

o An address may have zero or more contact points

Customer Management Data Objects

Attribute Value Description

id STRING Optional. This is the unique identifier for

name STRING Mandatory. The name of the customer.

type STRING Optional. The type of customer. If no value

status STRING Optional. The current status of the customer.

marketseg STRING Optional. The market segment of the customer

comments STRING Optional. This is a free text field. If no

attributes wsAttribute Optional. An array of wsAttribute.

Attribute Value Description

customerDetail wsCustomerDetail Mandatory. An instance of the

returnStatus returnStatus Return the status of the web service

Attribute Value Description

returnStatus returnStatus Return the status of the web service call.

Attribute Value Description

returnStatus returnStatus Return the status of the web service call.

Attribute Value Description

customerID STRING This is the unique identifier for the

regardless of whether it was supplied or

returnStatus returnStatus Return the status of the web service call.

Attribute Value Description

myCustomerDetail wsCustomerDetail Details of a customer

returnStatus returnStatus Return the status of the web service

Attribute Value Description

contactName STRING Customer contact name.

contactClassification STRING Customer contact classification.

Attribute Value Description

contactName STRING The name of the contact.

contactClassification STRING The classification of the contact.

contactPointID LONG This is a unique identifier for the

locationID LONG A location ID for selecting location