A URL shortener for the CODEX community.
GET request for all registered URL and their corresponding short URL and ID
Requires Authentication
none
| Status Code | Message | Reason |
|---|---|---|
| 200 | All URI list | The list of URLs shortened/registered |
| 201 | No URI regisitred | No URLs has been shortened/registered |
| 202 | Error Occured | Error Occured while shortening the URL |
POST request to login to the bitsy admin portal
| Feild | Description | Required |
|---|---|---|
| username | The username of the CODEX admin | True |
| password | The password of the CODEX admin | True |
| Status Code | Message | Reason |
|---|---|---|
| 200 | Logged In Succesfully | User logged in successfully |
POST request to logout from the bitsy admin portal
Requires Authentication
none
| Status Code | Message | Reason |
|---|---|---|
| 200 | Logged Out Succesfully | User logged out successfully |
| 210 | Not Logged In | User is not logged in |
POST request to register new URL for shortening
Requires Authentication
| Feild | Description | Required |
|---|---|---|
| uri | The URL to be shortened | True |
| shortUri | The preferred short uri or empty string | False |
| Status Code | Message | Reason |
|---|---|---|
| 200 | URI Registered Successfully | User logged out successfully |
| 201 | URI/ShortURI already registered | The provided long URL alredy has a shortened URL |
| 202 | Error Occured | Error Occured while shortening the URL |
| 203 | Invalid URI | Invalid long URL was provided |
| 205 | Necessary Parameters Missing | One or More of the required/essential parameter is/are missing |
| 210 | Not Logged In | User is not logged in |
POST request for deleteing an obselete registered URL
Requires Authentication
| Feild | Description | Required |
|---|---|---|
| _id | The unique ID for the short URL | True |
| shortUri | The shortened URL | True |
| Status Code | Message | Reason |
|---|---|---|
| 200 | Deleted Successfully | The short URL was deleted successfully |
| 201 | URI not found | No such URL matches the provided ID and short URL |
| 202 | Error Occured | Error Occured while shortening the URL |
| 205 | Necessary Parameters Missing | One or More of the required/essential parameter is/are missing |
| 210 | Not Logged In | User is not logged in |