campaignpool-be/docs/swagger/swagger.yaml

3162 lines
79 KiB
YAML
Raw Normal View History

2025-11-11 03:36:59 +00:00
definitions:
paginator.Pagination:
properties:
count:
type: integer
limit:
type: integer
nextPage:
type: integer
page:
type: integer
previousPage:
type: integer
sort:
type: string
sortBy:
type: string
totalPage:
type: integer
type: object
request.ActivityLogsCreateRequest:
properties:
activityTypeId:
type: integer
articleId:
type: integer
url:
type: string
userId:
type: integer
visitorIp:
type: string
required:
- activityTypeId
- url
type: object
request.ActivityLogsUpdateRequest:
properties:
activityTypeId:
type: integer
articleId:
type: integer
id:
type: integer
url:
type: string
userId:
type: integer
required:
- activityTypeId
- id
- url
type: object
request.CampaignDestinationsCreateRequest:
properties:
campaignTypeId:
2025-11-11 03:36:59 +00:00
type: integer
createdById:
type: integer
description:
type: string
isActive:
type: boolean
name:
type: string
subType:
2025-11-11 03:36:59 +00:00
type: string
url:
type: string
required:
- campaignTypeId
2025-11-11 03:36:59 +00:00
- name
type: object
request.CampaignDestinationsUpdateRequest:
properties:
campaignTypeId:
2025-11-11 03:36:59 +00:00
type: integer
description:
type: string
isActive:
type: boolean
name:
type: string
subType:
2025-11-11 03:36:59 +00:00
type: string
url:
type: string
required:
- campaignTypeId
2025-11-11 03:36:59 +00:00
- name
type: object
request.CampaignTypesCreateRequest:
properties:
createdById:
type: integer
description:
type: string
name:
type: string
required:
- name
type: object
request.CampaignTypesUpdateRequest:
properties:
description:
type: string
name:
type: string
required:
- name
type: object
request.CampaignsCreateRequest:
properties:
campaignTypeId:
2025-11-11 03:36:59 +00:00
type: integer
creatorId:
2025-11-11 03:36:59 +00:00
type: integer
description:
type: string
endDate:
2025-11-11 03:36:59 +00:00
type: string
mediaItemSelected:
2025-11-11 03:36:59 +00:00
type: string
mediaPromote:
2025-11-11 03:36:59 +00:00
type: boolean
mediaTypeSelected:
2025-11-11 03:36:59 +00:00
type: string
purpose:
type: string
startDate:
2025-11-11 03:36:59 +00:00
type: string
status:
type: string
title:
type: string
required:
- campaignTypeId
2025-11-11 03:36:59 +00:00
- title
type: object
request.CampaignsUpdateRequest:
properties:
campaignTypeId:
2025-11-11 03:36:59 +00:00
type: integer
description:
type: string
endDate:
2025-11-11 03:36:59 +00:00
type: string
mediaItemSelected:
2025-11-11 03:36:59 +00:00
type: string
mediaPromote:
2025-11-11 03:36:59 +00:00
type: boolean
mediaTypeSelected:
2025-11-11 03:36:59 +00:00
type: string
purpose:
type: string
startDate:
2025-11-11 03:36:59 +00:00
type: string
status:
type: string
title:
type: string
required:
- campaignTypeId
2025-11-11 03:36:59 +00:00
- title
type: object
2025-11-15 12:09:48 +00:00
request.CustomStaticPagesCreateRequest:
2025-11-11 03:36:59 +00:00
properties:
description:
type: string
2025-11-15 12:09:48 +00:00
htmlBody:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
slug:
2025-11-11 03:36:59 +00:00
type: string
title:
type: string
required:
2025-11-15 12:09:48 +00:00
- htmlBody
- slug
2025-11-11 03:36:59 +00:00
- title
type: object
2025-11-15 12:09:48 +00:00
request.CustomStaticPagesUpdateRequest:
2025-11-11 03:36:59 +00:00
properties:
description:
type: string
2025-11-15 12:09:48 +00:00
htmlBody:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
id:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
slug:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
title:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
updatedAt:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
required:
- htmlBody
- id
- slug
- title
type: object
request.UserEmailValidationRequest:
properties:
newEmail:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
oldEmail:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
password:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
type: object
2025-11-15 12:09:48 +00:00
request.UserForgotPassword:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
type: object
2025-11-15 12:09:48 +00:00
request.UserLevelsApprovalRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
ids:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
isApprovalActive:
type: boolean
required:
- ids
- isApprovalActive
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserLevelsCreateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
aliasName:
type: string
group:
type: string
isActive:
type: boolean
isApprovalActive:
type: boolean
levelNumber:
type: integer
name:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
parentLevelId:
type: integer
provinceId:
2025-11-11 03:36:59 +00:00
type: integer
required:
2025-11-15 12:09:48 +00:00
- aliasName
- levelNumber
- name
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserLevelsUpdateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
aliasName:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
group:
type: string
isApprovalActive:
type: boolean
levelNumber:
type: integer
name:
type: string
parentLevelId:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
provinceId:
2025-11-11 03:36:59 +00:00
type: integer
required:
2025-11-15 12:09:48 +00:00
- aliasName
- levelNumber
- name
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserLogin:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
password:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
refreshToken:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
type: object
request.UserOtpRequest:
properties:
email:
type: string
name:
2025-11-11 03:36:59 +00:00
type: string
required:
2025-11-15 12:09:48 +00:00
- email
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserOtpValidation:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
email:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
otpCode:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
type: object
request.UserResetPassword:
properties:
codeRequest:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
confirmPassword:
type: string
password:
type: string
userId:
2025-11-11 03:36:59 +00:00
type: string
type: object
2025-11-15 12:09:48 +00:00
request.UserRoleAccessesCreateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
isAdminEnabled:
2025-11-11 03:36:59 +00:00
type: boolean
2025-11-15 12:09:48 +00:00
isApprovalEnabled:
type: boolean
isDeleteEnabled:
type: boolean
isInsertEnabled:
type: boolean
isUpdateEnabled:
type: boolean
isViewEnabled:
type: boolean
menuId:
2025-11-11 03:36:59 +00:00
type: integer
required:
2025-11-15 12:09:48 +00:00
- isAdminEnabled
- isApprovalEnabled
- isDeleteEnabled
- isInsertEnabled
- isUpdateEnabled
- isViewEnabled
- menuId
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserRoleAccessesUpdateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
id:
type: integer
isAdminEnabled:
type: boolean
isApprovalEnabled:
type: boolean
isDeleteEnabled:
type: boolean
isInsertEnabled:
type: boolean
isUpdateEnabled:
type: boolean
isViewEnabled:
2025-11-11 03:36:59 +00:00
type: boolean
2025-11-15 12:09:48 +00:00
menuId:
type: integer
userRoleId:
2025-11-11 03:36:59 +00:00
type: integer
required:
2025-11-15 12:09:48 +00:00
- id
- isAdminEnabled
- isApprovalEnabled
- isDeleteEnabled
- isInsertEnabled
- isUpdateEnabled
- isViewEnabled
- menuId
- userRoleId
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserRolesCreateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
2025-11-11 03:36:59 +00:00
type: string
description:
type: string
2025-11-15 12:09:48 +00:00
name:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
statusId:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
userLevelIds:
items:
type: integer
type: array
userRoleAccess:
items:
$ref: '#/definitions/request.UserRoleAccessesCreateRequest'
type: array
2025-11-11 03:36:59 +00:00
required:
2025-11-15 12:09:48 +00:00
- code
2025-11-11 03:36:59 +00:00
- description
2025-11-15 12:09:48 +00:00
- name
- statusId
- userLevelIds
- userRoleAccess
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserRolesUpdateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
2025-11-11 03:36:59 +00:00
type: string
description:
type: string
2025-11-15 12:09:48 +00:00
levelNumber:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
name:
2025-11-11 03:36:59 +00:00
type: string
statusId:
type: integer
2025-11-15 12:09:48 +00:00
userLevelIds:
items:
type: integer
type: array
2025-11-11 03:36:59 +00:00
required:
2025-11-15 12:09:48 +00:00
- code
2025-11-11 03:36:59 +00:00
- description
2025-11-15 12:09:48 +00:00
- levelNumber
- name
- statusId
- userLevelIds
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UserSavePassword:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
confirmPassword:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
password:
2025-11-11 03:36:59 +00:00
type: string
type: object
2025-11-15 12:09:48 +00:00
request.UsersCreateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
address:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
dateOfBirth:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
degree:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
email:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
fullname:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
genderType:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityGroup:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityGroupNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityType:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
lastEducation:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
lastJobTitle:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
password:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
phoneNumber:
type: string
userLevelId:
type: integer
userRoleId:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
whatsappNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
workType:
2025-11-11 03:36:59 +00:00
type: string
required:
2025-11-15 12:09:48 +00:00
- email
- fullname
- password
- userLevelId
- userRoleId
- username
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
request.UsersUpdateRequest:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
address:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
dateOfBirth:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
degree:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
email:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
fullname:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
genderType:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityGroup:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityGroupNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
identityType:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
lastEducation:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
lastJobTitle:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
phoneNumber:
2025-11-11 03:36:59 +00:00
type: string
statusId:
type: integer
2025-11-15 12:09:48 +00:00
userLevelId:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
userRoleId:
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
username:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
whatsappNumber:
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
workType:
2025-11-11 03:36:59 +00:00
type: string
required:
- email
2025-11-15 12:09:48 +00:00
- fullname
- userLevelId
- userRoleId
- username
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
response.BadRequestError:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
example: 400
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
message:
example: bad request
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
success:
example: false
2025-11-11 03:36:59 +00:00
type: boolean
type: object
2025-11-15 12:09:48 +00:00
response.InternalServerError:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
example: 500
2025-11-11 03:36:59 +00:00
type: integer
2025-11-15 12:09:48 +00:00
message:
example: internal server error
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
success:
example: false
2025-11-11 03:36:59 +00:00
type: boolean
type: object
2025-11-15 12:09:48 +00:00
response.Response:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
example: 200
type: integer
data: {}
messages:
items: {}
type: array
meta: {}
success:
example: true
type: boolean
2025-11-11 03:36:59 +00:00
type: object
2025-11-15 12:09:48 +00:00
response.UnauthorizedError:
2025-11-11 03:36:59 +00:00
properties:
2025-11-15 12:09:48 +00:00
code:
example: 401
type: integer
message:
example: unauthorized access
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
success:
example: false
2025-11-11 03:36:59 +00:00
type: boolean
2025-11-15 12:09:48 +00:00
type: object
info:
contact: {}
paths:
/activity-logs:
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting all ActivityLogs
2025-11-11 03:36:59 +00:00
parameters:
- in: query
2025-11-15 12:09:48 +00:00
name: activityTypeId
type: integer
2025-11-11 03:36:59 +00:00
- in: query
2025-11-15 12:09:48 +00:00
name: articleId
2025-11-11 03:36:59 +00:00
type: integer
- in: query
2025-11-15 12:09:48 +00:00
name: url
2025-11-11 03:36:59 +00:00
type: string
- in: query
2025-11-15 12:09:48 +00:00
name: userId
2025-11-11 03:36:59 +00:00
type: integer
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get all ActivityLogs
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- ActivityLogs
2025-11-11 03:36:59 +00:00
post:
2025-11-15 12:09:48 +00:00
description: API for create ActivityLogs
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
2025-11-15 12:09:48 +00:00
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
2025-11-11 03:36:59 +00:00
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.ActivityLogsCreateRequest'
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Create ActivityLogs
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- ActivityLogs
/activity-logs/{id}:
2025-11-11 03:36:59 +00:00
delete:
2025-11-15 12:09:48 +00:00
description: API for delete ActivityLogs
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
2025-11-15 12:09:48 +00:00
- description: ActivityLogs ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: delete ActivityLogs
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- ActivityLogs
put:
description: API for update ActivityLogs
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.ActivityLogsUpdateRequest'
- description: ActivityLogs ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: update ActivityLogs
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- ActivityLogs
/activity-logs/detail/{id}:
get:
description: API for getting one ActivityLogs
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: ActivityLogs ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
2025-11-11 03:36:59 +00:00
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one ActivityLogs
tags:
- ActivityLogs
/activity-logs/statistics:
get:
description: API for get activity stats ActivityLogs
responses:
"200":
description: OK
2025-11-11 03:36:59 +00:00
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get activity stats ActivityLogs
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- ActivityLogs
/campaign-destinations:
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting all CampaignDestinations
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Client-Key
in: header
name: X-Client-Key
required: true
2025-11-11 03:36:59 +00:00
type: string
2025-11-15 12:09:48 +00:00
- in: query
name: campaignTypeId
type: integer
- in: query
name: isActive
type: boolean
2025-11-11 03:36:59 +00:00
- in: query
name: name
type: string
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get all CampaignDestinations
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignDestinations
2025-11-11 03:36:59 +00:00
post:
2025-11-15 12:09:48 +00:00
description: API for create CampaignDestinations
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
type: string
2025-11-15 12:09:48 +00:00
- default: Bearer <Add access token here>
description: Insert your access token
2025-11-11 03:36:59 +00:00
in: header
2025-11-15 12:09:48 +00:00
name: Authorization
2025-11-11 03:36:59 +00:00
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.CampaignDestinationsCreateRequest'
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Create CampaignDestinations
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignDestinations
/campaign-destinations/{id}:
2025-11-11 03:36:59 +00:00
delete:
2025-11-15 12:09:48 +00:00
description: API for delete CampaignDestinations
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: CampaignDestinations ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Delete CampaignDestinations
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignDestinations
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting one CampaignDestinations
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: CampaignDestinations ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get one CampaignDestinations
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignDestinations
2025-11-11 03:36:59 +00:00
put:
2025-11-15 12:09:48 +00:00
description: API for update CampaignDestinations
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.CampaignDestinationsUpdateRequest'
- description: CampaignDestinations ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Update CampaignDestinations
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignDestinations
/campaign-types:
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting all CampaignTypes
parameters:
- description: Insert the X-Client-Key
in: header
name: X-Client-Key
required: true
type: string
- in: query
name: name
type: string
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get all CampaignTypes
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignTypes
2025-11-11 03:36:59 +00:00
post:
2025-11-15 12:09:48 +00:00
description: API for create CampaignTypes
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.CampaignTypesCreateRequest'
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Create CampaignTypes
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignTypes
/campaign-types/{id}:
2025-11-11 03:36:59 +00:00
delete:
2025-11-15 12:09:48 +00:00
description: API for delete CampaignTypes
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: CampaignTypes ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Delete CampaignTypes
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignTypes
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting one CampaignTypes
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: CampaignTypes ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get one CampaignTypes
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignTypes
2025-11-11 03:36:59 +00:00
put:
2025-11-15 12:09:48 +00:00
description: API for update CampaignTypes
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.CampaignTypesUpdateRequest'
- description: CampaignTypes ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
2025-11-15 12:09:48 +00:00
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
2025-11-11 03:36:59 +00:00
"401":
description: Unauthorized
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.UnauthorizedError'
2025-11-11 03:36:59 +00:00
"500":
description: Internal Server Error
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/response.InternalServerError'
2025-11-11 03:36:59 +00:00
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Update CampaignTypes
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CampaignTypes
/campaigns:
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting all Campaigns
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Insert the X-Client-Key
in: header
name: X-Client-Key
required: true
2025-11-11 03:36:59 +00:00
type: string
- in: query
2025-11-15 12:09:48 +00:00
name: campaignTypeId
type: integer
- in: query
name: creatorId
2025-11-11 03:36:59 +00:00
type: integer
- in: query
2025-11-15 12:09:48 +00:00
name: status
type: string
- in: query
name: title
2025-11-11 03:36:59 +00:00
type: string
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get all Campaigns
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- Campaigns
2025-11-11 03:36:59 +00:00
post:
2025-11-15 12:09:48 +00:00
description: API for create Campaigns
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.CampaignsCreateRequest'
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Create Campaigns
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- Campaigns
/campaigns/{id}:
2025-11-11 03:36:59 +00:00
delete:
2025-11-15 12:09:48 +00:00
description: API for delete Campaigns
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
2025-11-15 12:09:48 +00:00
- description: Campaigns ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Delete Campaigns
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- Campaigns
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting one Campaigns
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: Campaigns ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get one Campaigns
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- Campaigns
2025-11-11 03:36:59 +00:00
put:
2025-11-15 12:09:48 +00:00
description: API for update Campaigns
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.CampaignsUpdateRequest'
- description: Campaigns ID
in: path
name: id
required: true
type: integer
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Update Campaigns
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- Campaigns
/custom-static-pages:
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting all CustomStaticPages
2025-11-11 03:36:59 +00:00
parameters:
- in: query
2025-11-15 12:09:48 +00:00
name: description
type: string
- in: query
name: htmlBody
type: string
- in: query
name: slug
type: string
- in: query
name: title
2025-11-11 03:36:59 +00:00
type: string
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get all CustomStaticPages
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CustomStaticPages
2025-11-11 03:36:59 +00:00
post:
2025-11-15 12:09:48 +00:00
description: API for create CustomStaticPages
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.CustomStaticPagesCreateRequest'
2025-11-11 03:36:59 +00:00
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Create CustomStaticPages
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CustomStaticPages
/custom-static-pages/{id}:
2025-11-11 03:36:59 +00:00
delete:
2025-11-15 12:09:48 +00:00
description: API for delete CustomStaticPages
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
2025-11-15 12:09:48 +00:00
- description: CustomStaticPages ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: delete CustomStaticPages
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CustomStaticPages
2025-11-11 03:36:59 +00:00
get:
2025-11-15 12:09:48 +00:00
description: API for getting one CustomStaticPages
2025-11-11 03:36:59 +00:00
parameters:
2025-11-15 12:09:48 +00:00
- description: CustomStaticPages ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: Get one CustomStaticPages
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CustomStaticPages
2025-11-11 03:36:59 +00:00
put:
2025-11-15 12:09:48 +00:00
description: API for update CustomStaticPages
2025-11-11 03:36:59 +00:00
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
2025-11-15 12:09:48 +00:00
$ref: '#/definitions/request.CustomStaticPagesUpdateRequest'
- description: CustomStaticPages ID
2025-11-11 03:36:59 +00:00
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
2025-11-15 12:09:48 +00:00
summary: update CustomStaticPages
tags:
- CustomStaticPages
/custom-static-pages/slug/{slug}:
get:
description: API for getting one CustomStaticPages
parameters:
- description: CustomStaticPages Slug
in: path
name: slug
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one CustomStaticPages
2025-11-11 03:36:59 +00:00
tags:
2025-11-15 12:09:48 +00:00
- CustomStaticPages
2025-11-11 03:36:59 +00:00
/user-levels:
get:
description: API for getting all UserLevels
parameters:
- in: query
name: levelNumber
type: integer
- in: query
name: name
type: string
- in: query
name: parentLevelId
type: integer
- in: query
name: provinceId
type: integer
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get all UserLevels
tags:
- UserLevels
post:
description: API for create UserLevels
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserLevelsCreateRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Create UserLevels
tags:
- UserLevels
/user-levels/{id}:
delete:
description: API for delete UserLevels
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: UserLevels ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: delete UserLevels
tags:
- UserLevels
get:
description: API for getting one UserLevels
parameters:
- description: UserLevels ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one UserLevels
tags:
- UserLevels
put:
description: API for update UserLevels
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserLevelsUpdateRequest'
- description: UserLevels ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: update UserLevels
tags:
- UserLevels
/user-levels/alias/{alias}:
get:
description: API for getting one UserLevels
parameters:
- description: UserLevels Alias
in: path
name: alias
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one UserLevels
tags:
- UserLevels
/user-levels/enable-approval:
post:
description: API for Enable Approval of Article
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserLevelsApprovalRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: EnableApproval Articles
tags:
- UserLevels
/user-role-accesses:
get:
description: API for getting all UserRoleAccesses
parameters:
- in: query
name: isActive
required: true
type: boolean
- in: query
name: menuId
required: true
type: integer
- in: query
name: userRoleId
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get all UserRoleAccesses
tags:
- UserRoleAccesses
post:
description: API for create UserRoleAccesses
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserRoleAccessesCreateRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Create UserRoleAccesses
tags:
- UserRoleAccesses
/user-role-accesses/{id}:
delete:
description: API for delete UserRoleAccesses
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: UserRoleAccesses ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: delete UserRoleAccesses
tags:
- UserRoleAccesses
get:
description: API for getting one UserRoleAccesses
parameters:
- description: UserRoleAccesses ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one UserRoleAccesses
tags:
- UserRoleAccesses
put:
description: API for update UserRoleAccesses
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserRoleAccessesUpdateRequest'
- description: UserRoleAccesses ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: update UserRoleAccesses
tags:
- UserRoleAccesses
/user-role-level-details:
get:
description: API for getting all UserRoleLevelDetails
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: Get all UserRoleLevelDetails
tags:
- Task
post:
description: API for create UserRoleLevelDetails
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: Create UserRoleLevelDetails
tags:
- Task
/user-role-level-details/{id}:
delete:
description: API for delete UserRoleLevelDetails
parameters:
- description: UserRoleLevelDetails ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: delete UserRoleLevelDetails
tags:
- Task
get:
description: API for getting one UserRoleLevelDetails
parameters:
- description: UserRoleLevelDetails ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: Get one UserRoleLevelDetails
tags:
- Task
put:
description: API for update UserRoleLevelDetails
parameters:
- description: UserRoleLevelDetails ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.Response'
"404":
description: Not Found
schema:
$ref: '#/definitions/response.Response'
"422":
description: Unprocessable Entity
schema:
$ref: '#/definitions/response.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: update UserRoleLevelDetails
tags:
- Task
/user-roles:
get:
description: API for getting all UserRoles
parameters:
- in: query
name: code
type: string
- in: query
name: description
type: string
- in: query
name: name
type: string
- in: query
name: statusId
type: integer
- in: query
name: userLevelId
type: integer
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get all UserRoles
tags:
- UserRoles
post:
description: API for create UserRoles
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserRolesCreateRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Create UserRoles
tags:
- UserRoles
/user-roles/{id}:
delete:
description: API for delete UserRoles
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: UserRoles ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: delete UserRoles
tags:
- UserRoles
get:
description: API for getting one UserRoles
parameters:
- description: UserRoles ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one UserRoles
tags:
- UserRoles
put:
description: API for update UserRoles
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserRolesUpdateRequest'
- description: UserRoles ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: update UserRoles
tags:
- UserRoles
/users:
get:
description: API for getting all Users
parameters:
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- in: query
name: degree
type: string
- in: query
name: email
type: string
- in: query
name: fullname
type: string
- in: query
name: genderType
type: string
- in: query
name: identityGroup
type: string
- in: query
name: identityGroupNumber
type: string
- in: query
name: identityNumber
type: string
- in: query
name: identityType
type: string
- in: query
name: phoneNumber
type: string
- in: query
name: statusId
type: integer
- in: query
name: userRoleId
type: integer
- in: query
name: username
type: string
- in: query
name: workType
type: string
- in: query
name: count
type: integer
- in: query
name: limit
type: integer
- in: query
name: nextPage
type: integer
- in: query
name: page
type: integer
- in: query
name: previousPage
type: integer
- in: query
name: sort
type: string
- in: query
name: sortBy
type: string
- in: query
name: totalPage
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get all Users
tags:
- Users
post:
description: API for create Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UsersCreateRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Create Users
tags:
- Users
/users/{id}:
delete:
description: API for delete Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Users ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: delete Users
tags:
- Users
put:
description: API for update Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Users ID
in: path
name: id
required: true
type: integer
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UsersUpdateRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: update Users
tags:
- Users
/users/detail/{id}:
get:
description: API for getting one Users
parameters:
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Users ID
in: path
name: id
required: true
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one Users
tags:
- Users
/users/email-validation:
post:
description: API for Email Validation Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserEmailValidationRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: EmailValidation Users
tags:
- Users
/users/forgot-password:
post:
description: API for ForgotPassword Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserForgotPassword'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: ForgotPassword Users
tags:
- Users
/users/info:
get:
description: API for ShowUserInfo
parameters:
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: ShowInfo Users
tags:
- Users
/users/login:
post:
description: API for Login Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserLogin'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Login Users
tags:
- Users
/users/otp-request:
post:
description: API for OtpRequest Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserOtpRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: OtpRequest Users
tags:
- Users
/users/otp-validation:
post:
description: API for OtpValidation Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserOtpValidation'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: OtpValidation Users
tags:
- Users
/users/pareto-login:
post:
description: API for ParetoLogin Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserLogin'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: ParetoLogin Users
tags:
- Users
/users/reset-password:
post:
description: API for ResetPassword Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserResetPassword'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: ResetPassword Users
tags:
- Users
/users/save-password:
post:
description: API for SavePassword Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- default: Bearer <Add access token here>
description: Insert your access token
in: header
name: Authorization
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserSavePassword'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: SavePassword Users
tags:
- Users
/users/setup-email:
post:
description: API for Setup Email Users
parameters:
- description: Insert the X-Csrf-Token
in: header
name: X-Csrf-Token
required: true
type: string
- description: Required payload
in: body
name: payload
required: true
schema:
$ref: '#/definitions/request.UserEmailValidationRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: SetupEmail Users
tags:
- Users
/users/username/{username}:
get:
description: API for getting one Users
parameters:
- description: Username
in: path
name: username
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
"400":
description: Bad Request
schema:
$ref: '#/definitions/response.BadRequestError'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/response.UnauthorizedError'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/response.InternalServerError'
security:
- Bearer: []
summary: Get one Users
tags:
- Users
swagger: "2.0"