Commercial Rates Api
Commercial Rates
Description :
This API endpoint is used to get the Commercial Rates for a user. it provide commercial rats of the user whose token is sent in request, or if any user id is there in the request.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| category | string | Yes | service category name Get Service Category | |||
| offset | integer | 0 | No | number of records to skip before starting to return results. | ||
| limit | integer | 10 | No | determines the maximum number of records to return in the response. |
Request Example
Responses (JSON)
- Status Code 1: records fetched
- Description: records successfully fetched.
- 'status_code' (integer): 1
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
-
'data' (Array): "it contains array of object"
- 'id' (integer): "unique id of record"
- 'logo' (string): "image url that is logo of service provider"
- 'operator' (string): "name of the service"
- 'service' (string): "type of the service"
- 'operator_code' (string): "code of the service"
- 'status' (string): "status of the service"
- 'slab_id' (integer): "user slab id"
- 'online_comission' (array): "online commission detail"
- 'gst' (string): "gst applicable or not"
- 'tds' (string): "tds applicable or not"
- 'rate' (string): "rate of commission/surcharge"
- 'commission_type' (string): "commision type Percent or Flat"
- 'commission_surcharge' (string): "its commission or surcharge"
- 'offline_comission' (array): "offline_comission commission detail"
- 'gst' (string): "gst applicable or not"
- 'tds' (string): "tds applicable or not"
- 'rate' (string): "rate of commission/surcharge"
- 'commission_type' (string): "commision type Percent or Flat"
- 'commission_surcharge' (string): "its commission or surcharge"
- 'txn_mode_exist' (string): "value can be Yes or No"
- 'txn_mode' (string): "it can be ONLINE or OFFLINE"
{"status_code": 2, "message": "category field is required"}, 422
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "records not found"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "there is no data found"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.