DAN API TEST USING POSTMAN

Introduction

This template guides you through CRUD operations (GET, POST, PUT, DELETE) to test the API request for all the DAN modules.

How to use this template

1. Send requests

RESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, PATCH, and DELETE HTTP methods. This collection contains each of these request types. Open each request and click "Send" to see what happens.

2. View responses

Observe the Response tab for status code (200 OK), response time, and size. Once you send the API request, you can also view the responses in the Body tab, where you can see the responses in different predefined formats like Pretty, Raw, and Preview.

How to view this template

1. Viewing in Postman

• Open Postman.
• Click on the Import button (usually located in the top left corner).
• Select the Upload Files tab and choose the JSON file(DAN_API.json) from the directory where you have cloned this project.
• Click Open. Postman will create a collection with the same structure as in the JSON file.

2. Viewing in a Text Editor

You can view this template or JSON file using any text editor (like Notepad, Sublime Text, VS Code, etc.) to view the raw JSON structure. This can be helpful if you want to see the underlying data.

3. Using JSON Viewers

There are various online JSON viewers that can format the JSON data for easier reading. Some popular options include:

- JSON Formatter & Validator
- JSONLint

Modules

• Auth
• User
• Category
• Account
• Customer
• Application
• Application Form Field
• Comment
• Notification
• Form
• Form Template
• Form Template Field
• Line
• Client
  • Application
  • Application Form Field

Conclusion

This template contains API requests for all the above modules to test whether the responses are successful.

Points to Note

• The API has been tested using a local server (localhost).
• There are some parent tables that can store, update and delete their child table.
• Please log in before testing any other modules. Otherwise, you might get unauthorized response.
• Please be aware of the roles and permissions each user has. Some modules might not be accessible to certain users. For example, to access client's Application and Application Form Field modules, be sure to log in as a User with the role Client.
• There are requests for downloading documents. If the document field is empty, the response might show some JSON formatted empty data.