Create a web service that accepts work orders and provides a prioritized list to work.    

For an alternate approach based on Ticker ( Ticker is like a pendulum's movement in a clock. Appropriately, one cycle of the event loop is called a tick.), click here.

• WorkOrder REST API
  • Getting Started
  • Pre Dev Analysis
  • API Contract
  • License

This project is a Restful API for creating work order queue for Service Desk employee. The work order can be of four types normal, priority, VIP, and management override. Different request types have their own implementation for calculating the rank. The priority queue is sorted from highest ranked to lowest ranked requester ID.

This application is a written in java using Spring Boot and built using Maven.

• Git
• JDK 8 or later
• Maven 3.0 or later

To test the application, just follow the two simple steps mentioned below:

1. Download the fat jar of this application from bin folder. Now to start the application server, open command prompt and run the downloaded jar file,

        java -jar workorder-1.0.0.one-jar

2. Once the server gets started, download the postman collection form postman folder of the project. Import the collection in Postman client and you will be all set to play around with the API.

To get started you can simply clone this repository using git:

git clone https://github.com/Govind-jha/springboot-work-order-priority-queue.git
cd springboot-work-order-priority-queue

You can run the application from the command line using

        mvn spring-boot:run

Or you can build a single executable JAR file that contains all the necessary dependencies, classes, and resources with

        mvn clean package

Then you can run the JAR file with

        java -jar target/*.jar

Download the postman collection form postman folder. Import the collection in Postman client for smoke testing.

You can test these Micro Services using any tool or language that allows you to make a HTTP request. For example, removing an order using CURL:

curl -X DELETE \
  http:https://localhost:8080/workorder/remove/20 \
  -H 'Cache-Control: no-cache' 

Creating a work order in the queue using require module in Node.js,

var request = require("request");

var options = { 
    method: 'POST',
      url: 'http:https://localhost:8080/workorder/addOrder',
      headers: 
       { 
            'Cache-Control': 'no-cache',
            'Content-Type': 'application/json' 
        },
      body: { requesterId: 20, timeOfRequest: 5000000000 },
      json: true 
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

PriorityQueue<WorkOrder>[ 
    WorkOrder{
        requestorID, 
        requestType,
        requestTimestamp,
        requestDate
    }, ...   
]

There are 4 classes of IDs, normal, priority, VIP, and management override. You can determine the class of the ID using the following method,  

The table below lists the formulas for calculating the rank of different request types,  

The WorkOrder Api implements the requirement/rules described in the previous section. It is used to create a prioritized work order queue (a Priority Queue) for service request desk employee. It provides fetures like adding or removing an order from the queue based on priority, getting a sorted list of order etc.

If response status code is 204 NO CONTENT or 205 RESET CONTENT, the response will contain header x-app-diagnostic. HTTP status 205 RESET CONTENT means server successfully processed the request, but is not returning any content. Unlike a 204 NO CONTENT response, this response requires that the requester reset the document view (as the content might have changed).

Response header x-app-diagnostic will contain the cause of no content in the response body.

• Check the requests content type if you get HTTP Status 415.
• Check the requests Method(GET, POST, DELETE) if you get HTTP Status 405.

The Application will start on port 8080, you can change this port configuration in application.properties file of the project.

The package is Open Source Software released under the License. It's developed by Govind Jha.