This project creates a simple API for an imaginary telecoms provider.

1. Building
2. Running The Application
3. API Endpoints

Open a command window in the telecoms-api project and run: mvn package -Prunnable-war

This will create a jar which contains a standalone Tomcat 7 server with the Telecoms API WAR deployed to it.

Run the JAR that you either built from the previous step, or downloaded from the releases tab by running:

java -jar telecoms-api-1.0.jar

Open your internet browser and navigate to: http://localhost:8080/api/

1. Get All Phone Numbers - GET /api/numbers/
2. Get A Customer's Phone Numbers - GET /api/numbers/?customer=id
3. Activate A Phone Number - GET /api/numbers/?activate=phoneNumber

Get an array of all phone numbers.

URL : /api/numbers/

Method : GET

Auth Required : NO

Permissions Required : None

[
  {
    "number": "1",
    "activated": false
  },
  {
    "number": "2",
    "activated": false
  },
  {
    "number": "3",
    "activated": false
  },
  {
    "number": "4",
    "activated": false
  },
  {
    "number": "5",
    "activated": false
  },
  {
    "number": "6",
    "activated": false
  },
  {
    "number": "7",
    "activated": false
  },
  {
    "number": "8",
    "activated": false
  },
  {
    "number": "9",
    "activated": false
  },
  {
    "number": "10",
    "activated": false
  }
]

Get an array of all phone numbers associated with a given customer.

URL : /api/numbers/?customer=id

Method : GET

Auth Required : NO

Permissions Required : None

http://localhost:8080/api/numbers/?customer=1

[
  {
    "number": "1",
    "activated": false
  },
  {
    "number": "2",
    "activated": false
  },
  {
    "number": "3",
    "activated": false
  }
]

Activate a given phone number.

URL : /api/numbers/?activate=phoneNumber

Method : GET

Auth Required : NO

Permissions Required : None

http://localhost:8080/api/numbers/?activate=1

{
  "message": "Phone number was activated successfully."
}

{
  "message": "Phone number not found!"
}