This class is the data model for the Subscriber object. It may be used across services and ID defined in XSD format.
This class contains the following elements:
Table 85: Subscriber Element Details
Description Element Type
Element Name
Subscriber identifier. This value must be unique.
String (Optional) SubscriberID
Customer unique identifier that this subscriber is associated with. This String
(Optional) CustomerID
is blank for non-corporate customers.
Description Element Type
Element Name
Subscriber reference identifier for external systems.
String (Optional) SubscriberRef
Subscriber first name. String
(Mandatory) FirstName
Subscriber last name. String
(Mandatory) LastName
Subscriber address information. Type
(Optional) Address
Subscriber address line 1. String
(Mandatory) Address/AddressLine1
Subscriber address line 2. String
(Optional) Address/AddressLine2
Subscriber address locality. String
(Mandatory) Address/Locality
Subscriber address region. String
(Optional) Address/Region
Subscriber address post code. String
(Mandatory) Address/PostCode
Subscriber address country. String (Mandatory) Address/Country Subscriber segments. Type (Optional) Segments Subscriber channels. String (*) Segments/Channel Subscriber market. String (Optional) Segments/Market
Subscriber value rating. String
(Optional) Segments/Rating
Subscriber risk rating. String (Optional) Segments/Risk Subscriber status. String (Optional) Status
Description Element Type Element Name Subscriber notes. String (Optional) Notes
List of roles associated with this subscriber.
Type (Optional) Roles
Role data structure. Data model for Role is defined in XSD (refer section Type (*)
Roles/Role
Common Data Format Specifications on page 91). List of UDFs. Type (Optional) UDFs UDF type. Type (*) UDFs/UDF
Name of the attribute. String
(Mandatory) UDFs/UDF/Name
Value of the attribute. String
(Mandatory) UDFs/UDF/Value
Segment
This class is the data model for the Segment object. It may be used across services and ID defined in XSD format.
Table 86: Segment Details
Description Element Type Element Name Segment name. String (Mandatory) Name
Segment type. Valid values are: String (Mandatory) Type • Channel • Market • Rating • Risk
Role
This class is the data model for the Role object. It may be used across services and ID defined in XSD format.
Table 87: Role Details
Description Element Type Element Name Role identifier String (Mandatory) RoleID Role name String (Mandatory) RoleName
Order
This class is the data model for the Order object. It may be used across services and ID defined in XSD format.
Table 88: Order Element Details
Description Element Type
Element Name
Order ID. Not required during Submit Order but is returned by Get Order Details and Get Orders. String
(Optional) orderID
Order reference ID. If the orderRef element is sent as an empty element String
orderRef
in the SubmitOrder request, then OMS generates the orderRef element. If the orderRef element is not sent, then schema validation fails.
Description Element Type
Element Name
Order Header data structure. headerType
(Mandatory) header
Order Line data structure. lineType
OrderHeader
Table 89: OrderHeader Element Details Description Element Type Element Name Order description. String (Optional) OrderDescription
Current order status. String
(Optional) OrderStatus
Customer unique identifier. Omit for non-corporate orders. Either String
(Optional) CustomerID
CustomerID or SubscriberID is necessary.
Subscriber unique identifier. Omit for corporate orders. Either String
(Optional) SubscriberID
CustomerID or SubscriberID is necessary.
Date order was submitted. Date
(Optional) SubmittedDate
Time order was submitted. Time
(Optional) SubmittedTime
Date and time that a particular order is required to start on. DateTime
(Optional) RequiredByDate
The priority value assigned to order. The value ranges from 0-9. Integer(Optional)
orderPriority
To use orderPriority, schemas under
$AF_HOME/schemas\schema\oms
should only be used. Expiration date for the offer. Not relevant for orders.
Date (Optional) ExpirationDate
Date order is expected to be completed. DateTime (Optional) ExpectedCompletionDate Invoice address. Type (Optional) InvoiceAddress
Invoice address line 1. String
(Mandatory) InvoiceAddress/AddressLine1
Invoice address line 2. String
(Optional) InvoiceAddress/AddressLine2
Description Element Type
Element Name
Invoice address locality. String
(Mandatory) InvoiceAddress/Locality
Invoice address region. String
(Optional) InvoiceAddress/Region
Invoice address post code. String
(Mandatory) InvoiceAddress/PostCode
Invoice address country. String (Mandatory) InvoiceAddress/Country Delivery address. Type (Optional) DeliveryAddress
Delivery address line 1. String
(Mandatory) DeliveryAddress/AddressLine1
Delivery address line 2. String
(Optional) DeliveryAddress/AddressLine2
Delivery address locality. String
(Mandatory) DeliveryAddress/Locality
Delivery address region. String
(Optional) DeliveryAddress/Region
Delivery address post code. String
(Mandatory) DeliveryAddress/PostCode
Delivery address country. String (Mandatory) DeliveryAddress/Country Order notes. String (Optional) Notes
List of SLAs passed through to back-end systems. These SLAs do Type
(Optional) SLAs
not apply within the order management. SLA type. Type (*) SLAs/SLA SLA ID. String (Mandatory) SLAs/SLA/SLAID UDF type Type (*) UDF
Description Element Type
Element Name
Name of the attribute. String
(Mandatory) UDF/Name
Value of the attribute. String
(Mandatory) UDF/Value
OrderLine
This class is the data model for the OrderLine object. It may be used across services and ID defined in XSD format.
The following order line actions are supported: Install a new product or service. Provide
Update an existing product or service. Update
Terminate an existing product or service. Cease
Cancel an outstanding order currently in-flight. Cancel
Table 90: Line Element Details
Description Element Type
Element Name
Order line number. String
(Mandatory) lineNumber
Subscriber ID for this order line. Omit for orders for corporate customers not linked to an individual subscriber. String
(Optional) subscriberID
ID of the product being ordered. String
(Mandatory) productID
Version ID of the product being ordered.
String productVersion
Number of items required for each product in this line.
String (Mandatory) quantity Unit of measure. String (Mandatory) uom Delivery address. addressType (Mandatory) deliveryAddress
Action required. Valid values are: String (Mandatory) action • PROVIDE • UPDATE • CEASE • CANCEL
Action mode. This is optional supplemental information to go with OrderLineAction. Valid value is: String
(Optional) actionMode
• MOVE
Date and time that a particular order is required to start on.
DateTime (Mandatory) requiredByDate
Correlation ID used by order management to group order lines together for provisioning.
String (Optional) linkID
Inventory ID for this product. String
(Optional) inventoryID
Order line notes. String
(Optional) notes
SLA ID. (SLAs passed through to back-end systems. These SLAs do not apply within order management itself.) String
(Mandatory) slaID
Description Element Type
Element Name
Value of the attribute. This must be minimum of one character in length. String (Mandatory) udf List of characteristics. Type (Optional) characteristic
Customer item ID. String
(Optional) customerItemID
Current order status. String (Optional)
status
statusChanged extension
Product
This class is the data model for the Product object. It may be used across services and ID defined in XSD format.
Table 91: Product Element Details
Description Element Type
Element Name
Product identifier. This value must be unique.
String (Mandatory) ProductID
Product name as configured in the Product Catalogue.
String (Mandatory) ProductName
Product type as configured in the Product Catalogue.
String (Mandatory) ProductType
Product sub-type as configured in the Product Catalogue.
String (Optional) ProductSubType
Product description as configured in the Product Catalogue.
String (Mandatory) Description