AccountRequestsController API Documentation
Introduction
The AccountRequestsController class handles operations related to account requests. Users can retrieve, create, update, and delete their account requests using this controller.
API Endpoints
1. Get Account Requests
Endpoint:
GET /api/profile/requests
Description:
Fetches the list of account requests associated with the authenticated user.
Request Example:
{}
Response Example (Success):
{
"status": true,
"message": "Account Requests Loaded Successfully",
"data": [
{
"id": 1,
"type": "Request Type",
"accountRequestMetas": [
{
"key": "Meta Key",
"value": "Meta Value"
}
]
}
]
}
Response Example (Failure):
{
"status": false,
"message": "No account requests found"
}
2. Create Account Request
Endpoint:
POST /api/profile/requests
Description:
Creates a new account request for the authenticated user.
Request Example:
{
"type": "Request Type",
"payload": {
"key1": "value1",
"key2": "value2"
}
}
Response Example (Success):
{
"status": true,
"message": "Account Request Created Successfully",
"data": {
"id": 1,
"type": "Request Type",
"accountRequestMetas": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
}
}
Response Example (Failure):
{
"status": false,
"message": "Validation failed"
}
3. Get Specific Account Request
Endpoint:
GET /api/profile/requests/{accountRequest}
Description:
Fetches a specific account request and its associated metadata for the authenticated user.
Request Example:
{}
Response Example (Success):
{
"status": true,
"message": "AccountRequest Loaded Successfully",
"data": {
"id": 1,
"type": "Request Type",
"accountRequestMetas": [
{
"key": "Meta Key",
"value": "Meta Value"
}
]
}
}
Response Example (Failure):
{
"status": false,
"message": "Sorry You do not have access to this request"
}
4. Update Account Request
Endpoint:
POST /api/profile/requests/{accountRequest}
Description:
Updates the specified account request and its metadata for the authenticated user.
Request Example:
{
"type": "Updated Request Type",
"payload": {
"key1": "updated value"
}
}
Response Example (Success):
{
"status": true,
"message": "Account Request Loaded Successfully",
"data": {
"id": 1,
"type": "Updated Request Type",
"accountRequestMetas": [
{
"key": "key1",
"value": "updated value"
}
]
}
}
Response Example (Failure):
{
"status": false,
"message": "Sorry You do not have access to this request"
}
5. Delete Account Request
Endpoint:
DELETE /api/profile/requests/{accountRequest}
Description:
Deletes a specific account request for the authenticated user.
Request Example:
{}
Response Example (Success):
{
"status": true,
"message": "Account Request Deleted Successfully"
}
Response Example (Failure):
{
"status": false,
"message": "Sorry You do not have access to this request"
}
Summary of Methods
- index() - Retrieves the list of account requests associated with the authenticated user.
- store() - Creates a new account request for the authenticated user.
- show() - Retrieves a specific account request for the authenticated user.
- update() - Updates an account request for the authenticated user.
- destroy() - Deletes an account request for the authenticated user.