The Customer Product Order API enables customers and API integrators to manage product orders seamlessly across various channels including web, telecom, and in-store. It facilitates the acceptance, validation, and initiation of orders for decomposition, supporting a wide range of order scenarios such as new orders, modifications (amendments), terminations, cancellations, suspensions, and resumptions. The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market. This API provide a task based resource to request order cancellation. The product order references the product offer and identifies any specific requests made by the customer. Product Order resource A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing account, related parties and order items. Main Order Items (aka order lines) attributes are the ordered offering and product characteristics with the related action to be performed (e.g. add or delete the products), state, location information for delivery, order item price and price alteration.

Product Order API performs the following operations on product order :

• Retrieval of a product order or a collection of product orders depending on filter criteria -Partial update of a product order (including updating rules)
• Creation of a product order (including default values and creation rules)
• Deletion of product order (for administration purposes) -Notification of events on product order.

Cancel Product Order

This resource is used to request a product order cancellation.

• Retrieval of a cancel product order or a collection of cancel product orders
• Creation of a cancel product order -Notification of events on cancel product order.

Key Features:

1. **Acceptance and Validation: The API allows for the acceptance and validation of orders against catalog offers, ensuring accuracy and compliance with business rules.
2. **Order Decomposition: Orders can be initiated for decomposition, streamlining the process for further processing and fulfillment.
3. **Order Scenarios: Handles diverse order scenarios including new orders, modifications, terminations, cancellations, suspensions, and resumptions, catering to various customer needs and requests.
4. **Data Structure: Utilizes the TMF622 data model for structured order entry and management, enhancing data consistency and interoperability.
5. **Order State Management: Manages order states based on order progress, providing visibility and control throughout the order lifecycle.

Usage Guidelines:

Authorization: Access to the API requires a JWT token with appropriate permissions, including the ability to manage orders and access catalog data. Customization: Developers can define business rules within the API for order validation, credit checks, and other customizations, influencing the API's response and behavior. Integration: Seamlessly integrates with external systems as part of the business fulfillment plan, supporting portfolio ID generation and external validations. Performance: The API is optimized for performance, ensuring efficient processing of orders and delivering a seamless user experience across channels.

The Customer Service / Resource Order (CSO) API provides a standardized mechanism for managing Service and Resource Orders, enabling seamless integration between internal Customer Order Management systems and Service Order Management systems. This API facilitates actions such as decomposing Customer Orders, validating Service and Resource Orders against catalog definitions, and supporting network activation and CLR creation.

The Service Order API provides a standardized mechanism for managing Service Order, a type of order which can be used to place an order between internal Customer Order management system to service order management system or between a service provider and a partner and vice versa.

Service Order resource: A service order will describe a list of service order items. A service order item references an action on an existing or future service. By service, we designed Customer Facing Service (CFS) as well as Resource Facing Service (RFS). From a component perspective, a service order should be available from:

• A Service Orchestration Component (and it could mix CFS and RFS)

• An Infrastructure Control & Management component (and it would have only RFS)

  Key Feature:

  • Decompose Customer Orders into Service and Resource Orders.

  • Validate Service and Resource Orders with catalog definitions.

  • Support network activation and CLR creation.

  • Enable actions including ADD, MODIFY, DELETE, CANCEL, and NOCHANGE.

  • Provide operations such as POST, PATCH, GET, and DELETE for order management.

  • Require a login token for authorization.

  • Compare Service and Resource Orders with catalog definitions.

  • Process applications in real-time.

  • Support order scenarios like New, Modification, Termination, Amendment, Cancel, Suspend, and Resume.

  • Integrate Network Operations Center (NOC) functionalities.

Usage Guidelines:

• Authorization: Access to the service requires a JWT token with appropriate permissions. Login tokens are necessary for secure authentication and authorization.

• Customization: Developers can influence the response of this component by defining business rules within the order creation process and catalog validation.

• Performance: The API is optimized for real-time processing, ensuring efficient handling of requests for a seamless user experience.

The Customer Product Inventory (CPI) API is designed to streamline customer product inventory management across various domains such as self-care, customer management, billing, and order entry systems. It provides a standardized mechanism for creating, updating, and retrieving product representations in the inventory, ensuring real-time updates and integration capabilities with other systems. The Product Inventory Management API provides standardized mechanism for product inventory management such as creation, update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.

Key Features:

1. Real-Time Updates: Maintain accurate and up-to-date customer inventory information through real-time updates.
2. Integration Capabilities: Seamlessly integrate with billing, self-care, reporting, and other systems for comprehensive inventory management.
3. Search and Filter Options: Utilize search and filter functionalities to easily locate specific products or services within the inventory.
4. Support for Change Order Requests: Facilitate the management of change order requests by leveraging real-time updates and integration capabilities.
5. Event Notification: Receive notifications for events related to product lifecycle changes, ensuring proactive management of inventory.
6. User Token Authorization: Access to the CPI API requires a user token with appropriate permissions, ensuring secure and authorized access.
7. Role-Based Access Control: Implement role-based access control to manage user permissions and data security effectively.
8. Scalability and Performance: Designed for scalability and optimized performance to handle large volumes of data and transactions efficiently.

Usage Guidelines:

Authorization: Access to the CPI API requires a user token with specific permissions, ensuring secure and authorized access. Integration: Integrate the CPI API with billing, self-care, reporting, and other systems for seamless inventory management across domains. Performance: The API is optimized for performance, enabling efficient processing of requests and delivering a seamless user experience.

The Customer Service and Resource Inventory (CSI) API is a powerful tool for managing real-time updates to customer inventories across self-care portals, customer interfaces, and network systems. It offers integration capabilities with billing, self-care functionalities, and reporting tools, providing a seamless experience for managing service instances, especially during change order requests. \n" The Service Inventory API can be called by the Service Order Management to create a new service instance/ update an existing service instance in the Service Inventory.\n" Service resource Service is an abstract base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.\n" Service Inventory API performs the following operations on service : Retrieve a service or a collection of services depending on filter criteria Partial update of a service (including updating rules) Create a service (including default values and creation rules and for administration users only) Delete a service (for administration users only) Notification of events on service\n"

Key Features:

1. Real-Time Inventory Updates: Maintain an accurate representation of customer inventories with real-time updates for services and resources.\n" +

2. Integration Capabilities: Integrate seamlessly with billing, self-care, and reporting systems to ensure data consistency and synchronization.\n" +

3. Search and Filter Options: Enable users to easily search and filter service instances for efficient inventory management.

4. Change Order Requests: Facilitate the process of raising change order requests by leveraging real-time updates and integration capabilities.

5. Event Notifications: Receive notifications for events related to the product lifecycle, enhancing proactive management of inventory changes.

6. User Token Authorization: Access to the CSI API requires a user token with appropriate permissions, ensuring secure and authorized access.

7. Scalability and Performance: Designed for scalability to handle large volumes of services and resources, with optimized performance for efficient processing.

8. Reporting Capabilities: Provide comprehensive reporting functionalities for monitoring inventory levels, trends, and usage patterns.

Usage Guidelines:

Authorization: Access to the CSI API requires a user token with specific permissions, ensuring secure and authorized access. Integration: Integrate the CSI API with billing, self-care, reporting, and other systems for seamless inventory management. Performance: The API is optimized for performance, ensuring efficient processing of requests to deliver a seamless user experience.

The Task Management Service provides a comprehensive set of REST APIs designed for effective task and process oversight. These APIs empower users to access vital information, including pending tasks, process instances, attribute details, and checklists. By offering dedicated endpoints for tasks retrieval, completion, attribute fetching, and dynamic updates, users can ensure smooth task execution and flexibility.

Moreover, the service enhances workflow visibility with APIs for task checklist display and management, facilitating organized task handling. Additionally, the ability to fetch flow trace details for the customer order view page provides users with a comprehensive view of order processing, supporting informed decision-making and streamlined order management workflows.

Key Features:

1. Task Viewing and Management: Users can view, edit, and complete tasks directly through the API, streamlining task management processes.
2. User Access Control: Access to the API is restricted to users with appropriate permissions, ensuring data security and authorized task handling.
3. Order Status and Flow Trace: In addition to task management, users can also view order status and flow trace details, gaining insights into order processing stages.
4. Manual Task Handling: The API supports manual task management, allowing users to assign tasks based on business rules and complete tasks assigned against orders.
5. IDP Integration: User identity and access management are seamlessly integrated, leveraging user IDP details for authentication and authorization.
6. Quick Response Time: The API is optimized for quick response times, ensuring a seamless user experience with efficient task handling and data retrieval.

Usage Guidelines:

• Authorization: Access to the Task Management API requires a JWT token with appropriate permissions, ensuring secure and authorized task handling.
• Customization: Developers can customize the API response by defining business rules within the application, enhancing task management capabilities.
• Performance: The API is optimized for performance, delivering quick response times for task viewing, editing, and completion, as well as order status and flow trace retrieval.

The Service Request Management API is a powerful tool for managing non-commercial orders and customer requests across self-care portals and customer interfaces. It allows users to create and update requests, integrates seamlessly with external systems, and facilitates the management of change order requests.

The Service Request API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking, and managing trouble tickets as a result of an issue or problem identified by a customer or another system.

The API supports the ability to send requests to create a new trouble ticket specifying the nature and severity of the trouble or issue as well as all necessary related information.The API also includes mechanisms to search for and update existing trouble tickets. Notifications are defined to provide information when a trouble ticket has been updated, including status changes. A basic set of states of a trouble ticket has been specified(as an example) to handle trouble ticket lifecycle management.

Trouble Ticketing API manages trouble ticket resource: A trouble ticket represents a record, or an issue raised by the requestor that needs to be solved, used for reporting and managing the resolution of problems, incidents, or requests. Main trouble ticket attributes are its description, severity, type, related dates (creation, expected resolution, resolution), state and related information (change reason and change date), related parties (originator, owner, reviser, etc.), related entities (product, product order, customer bill), and notes.

Key Features:

• Managing Non-Commercial Orders: The API supports the creation and management of non-commercial orders.

• Integration with External Systems: Integrate seamlessly with Northbound and Southbound applications for data synchronization and updates.

• Customer and Self-Care Interfaces: Provide a standardized client interface for customers and self-care portals to create and manage service requests.

• Change Order Requests: Facilitate the process of raising change order requests and managing their lifecycle.

• Business Process Management: Enable the creation and management of different customer requests through customizable business processes.

• Real-Time Updates: Capture each customer request in real-time, ensuring accurate and up-to-date information.

• Update Notifications: Receive notifications for events such as trouble ticket state changes or updates to keep users informed.

Usage Guidelines:

• Authorization: Access to the service requires a login token with specific permissions, ensuring secure and authorized access.

• Integration: Integrate the API with Northbound and Southbound applications for data synchronization and updates.

• Performance: The API is optimized for performance, ensuring efficient processing of requests to deliver a seamless user experience.

Description:

The Order Rule Service API manages, retrieves, and dynamically loads rules based on criteria, facilitating active rule management and integration with a RuleEngine for effective business logic implementation and decision-making. It enables real-time rule execution based on provided facts, ensuring rules are up to date and dynamically applied.

Key Features:

1. Rule Definition Input: Allows providing input parameters as per rule definitions.

2. Dynamic Rule Loading: Loads rules into a rule kia session, returning specific results based on facts.

3. REST API Access: Deployed rules can be accessed via a REST API.

4. Rule Engine Integration: Enables updating and deploying rules via the RuleEngine, accessible through the REST API.

5. Business Rule Types: Supports various rules like Task Allocation, Attribute Restrictions, and Portfolio ID definition.

6. Rule Versioning: Allows duplication of rules, defaulting to draft versions, and publishing modified rules as Active rules via the REST API.

7. Access Control: Requires login access for API usage.

8. Customization: Developers define rules based on business requirements, specifying conditions for rule execution.

9. Real-time Results: Provides results almost instantly, ensuring efficient decision-making.

Usage Guidelines:

• Authorization: Access to the service requires login credentials with appropriate permissions.

• Customization: Developers can define, update, and delete rules as needed for business logic customization.

• Performance: Optimized for real-time rule execution, delivering efficient processing and quick results.

This operation schedules a new version to be published and sets old jobs to CANCELLED based on a comparison between scheduleDate and schedulerDate after a POST operation.

This operation imports rules filtered for import from a specified source. You can provide the host parameter and optionally pass ruleName and version to retrieve a specific rule for a particular version, groupName to fetch all rules of a group, or provide no filtration parameter to fetch all the latest rules from the host.

This operation duplicate a rule for a particular version

This operation Create a new rule if does not exist or update existing rule

This operation updates the active version of a rule, setting its state to ACTIVE, and transitions the old active rule to INACTIVE. It also updates the state of scheduled jobs to Published and sets the state of the last published job to ARCHIVED.

This operation entails deleting a specific rule from a dataset or repository using its unique Row ID as a reference. Specific business errors related to the current operation will be encapsulated within.

Description:

The Rule Engine API serves as the decision-making core of our application, enabling automated and consistent application of business logic. It manages rules, evaluates data based on these rules, and guides application actions accordingly, reducing manual work and errors.

Key Responsibilities:

1. Rule Management: Manages rules and their definitions, ensuring availability and accessibility.

2. Dynamic Rule Application: Dynamically applies rules based on provided conditions, influencing decision-making.

3. Decision Guidance: Provides outputs based on rule evaluation, guiding application actions and processes.

Business Processes Supported:

• serviceOrderEditRules: This rule ensures that only relevant sections of a service/resource order are editable based on the current order status, enhancing data integrity and order management efficiency.

• enrichOrderCharacteristics: Automatically adds or deletes default characteristics in product order items, ensuring completeness, accuracy, and readiness for further processing.

• portfolioIdGenerationRules: Utilizes defined calculations and algorithms to generate unique portfolio IDs, facilitating bundled offer management and system efficiency.

• cancelOrderBusinessService: A key component in a customer-centric order management process, aligning business needs with customer expectations and operational efficiencies.

• omQuantityRules: Enhances order processing granularity and customer experience by converting offer items into multiple order line items.

• productOfferingQualificationService: Ensures efficient order processing and decision-making by correctly passing required data based on order type to the qualification service.

• jeopardyRules: Manages errors or exceptions during order processing, addressing and resolving issues efficiently.

• taskAllocationRule: Allocates tasks to users based on skill set, geography, and group criteria.

• dispatch: Identifies resource or service order items for dispatch, optimizing dispatch planning and execution.

• portability: Streamlines the portability process, enhancing customer experience and operational efficiency.

• bulkJeopardy: Automates recovery steps for bulk orders facing specific errors, improving fault recovery efficiency.

Key Features:

1. Rule Status Management: Rules are accessed via the Rule Engine once deployed or when their status is active.

2. Rule Definition: Developers define rules using "when" and "then" conditions.

3. Decision-Making Integration: Inputs are provided, and the Rule Engine outputs decisions based on rule evaluations.

4. Rule Deployment: Rules are deployed into the Rule Engine via REST API, changing their status to active upon deployment.

5. Authorization: Access requires a JWT token for authentication and authorization.

6. Customization: Developers can update rule conditions to customize rule behavior.

7. Real-time Updates: Rules and decisions are updated in real time, ensuring responsiveness and accuracy.

Usage Guidelines:

• Authorization: Access requires a JWT token with appropriate permissions.

• Customization: Developers can influence rule behavior by updating rule conditions.

• Performance: Optimized for real-time updates and efficient decision-making processes.

The Communication Management API is a powerful tool designed to facilitate efficient communication processes within your application. It enables users to define notification templates and send messages via SMS, WhatsApp, and email to both customers and internal teams. By leveraging event-based triggers and templates, users can streamline communication workflows, ensuring timely and targeted messaging.

Key Features:

• Notification Template Management: Define and manage notification templates for consistent messaging across different communication channels.

• Multi-Channel Messaging: Send messages via email, WhatsApp, and SMS to reach audiences effectively across various platforms.

• Template-Based Communication: Utilize predefined templates for communication creation, ensuring standardized and branded messaging.

• Event-Based Communication: Trigger communication events based on specific milestones or events, enhancing automation and targeted messaging.

• Real-Time Processing: Process communication requests in real time, ensuring timely delivery and responsiveness.\n" +

• Integration Capabilities: Integrate the API with other systems and services using event triggers or REST APIs for seamless communication management.

• Audience Targeting: Target communications to specific recipients, including customers, internal teams, and user groups, based on predefined criteria.

• Automation and Scheduling: Automate communication processes and schedule messages for optimal delivery and engagement.

• Reporting and Analytics: Track communication performance metrics, including delivery rates, open rates, and response rates, for analysis and optimization.

• Authorization and Security: Access to the API requires JWT token authentication with appropriate permissions, ensuring data security and authorized usage.

Usage Guidelines:

• Authorization: Access to the Communication Management API requires a JWT token with appropriate permissions, ensuring secure and authorized communication handling.

• Customization: Developers can customize communication templates and rules within the API to align with business requirements and branding guidelines.

• Performance: The API is optimized for real-time processing and performance, delivering efficient communication workflows and a seamless user experience.

The Project Plan API within the Order Management System enables the definition and communication of important milestones to customers, facilitating transparency, tracking, and timely delivery of complex orders. It integrates with master data configuration, compares flow trace data with major milestones, and generates project plans that can be shared online via email or offline in formats like Excel or PowerPoint.

Key Responsibilities:

1. Master Data Configuration: Defines project milestones and configurations in the master data setup.

2. Flow Trace Comparison: Compares Flow Trace data with major milestones to determine start and end times for activities.

3. Business Process Integration: Supports B2B business processes and allows manual initiation by agents.

4. Communication Channels: Sends project plans to customers online via email or offline in Excel or PowerPoint formats.

5. Authorization: Requires valid login permissions for access and usage.

6. Customization: Allows developers to define business rules and configurations for project planning.

7. Performance Optimization: Optimized for efficient processing and generation of project plans.

8. Async Generation: Generates project plans asynchronously, taking input data and generating plans in the background.

9. Output Formats: Supports output formats such as email, PowerPoint, and online viewing for project plans.

10. Transparency and Tracking: Enhances transparency and tracking of complex orders by communicating important milestones to customers.

Usage Guidelines:

• Authorization: Access requires valid login permissions.

• Input and Output Formats: Input data can be processed to generate project plans in various output formats.

• Integration: Integrates with master data, flow trace data, and business processes to generate accurate and informative project plans.

The Holiday Service provides functionality related to holiday calendars, allowing users to manage, retrieve, and interact with holiday data for various organizations and regions. It categorizes holidays based on different criteria, such as national holidays, religious holidays, or observances, providing accurate and up-to-date holiday information for applications and systems.

Key Features:

1. Define Holiday Calendars: Define holiday calendars based on organization, region, and weekend offs.
2. Retrieve Holiday Calendars: Get holiday calendar details based on organization and region.
3. Calculate End Date: Calculate end dates based on start dates and business Turnaround Time (TAT).
4. Delete Holiday Calendars: Remove holiday calendars as needed.

Usage Guidelines:

1. Authorization: Access requires a valid login token with appropriate permissions.
2. Customization: Developers can define holiday calendars and configure parameters such as TAT and holiday types within the API.
3. Performance: Optimized for efficient processing of requests, ensuring accurate calculation of end dates based on holiday calendars and TAT.