nhance/public/assets/api.yaml
2024-09-13 09:00:09 +05:30

890 lines
27 KiB
YAML
Executable File

openapi: 3.0.0
paths:
'/nhance/employeeRest/verifyEmployeeNumber':
post:
tags:
- Login
summary: 'Add a new VerifyEmployeeNumber to the store'
operationId: VerifyEmployeeNumber
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
multipart/form-data:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
responses:
'201':
description: 'Upload VerifyEmployeeNumber'
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyEmployeeNumber'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getVerifiedUserData':
post:
tags:
- Login
summary: ' GetVerifiedUserData'
operationId: GetVerifiedUserData
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
otp:
type: string
description: otp
multipart/form-data:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
otp:
type: string
description: otp
responses:
'201':
description: 'GetVerifiedUserData'
content:
application/json:
schema:
$ref: '#/components/schemas/GetVerifiedUserData'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/verifyHrWithMobileNumber':
post:
tags:
- Login
summary: 'VerifyHrWithMobileNumber'
operationId: VerifyHrWithMobileNumber
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
multipart/form-data:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
responses:
'201':
description: 'VerifyHrWithMobileNumber'
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyHrWithMobileNumber'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getVerifiedHrData':
post:
tags:
- Login
summary: ' GetVerifiedHrData'
operationId: GetVerifiedHrData
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
otp:
type: string
description: otp
multipart/form-data:
schema:
type: object
properties:
mobile_number:
type: string
description: mobile_number
otp:
type: string
description: otp
responses:
'201':
description: 'GetVerifiedHrData'
content:
application/json:
schema:
$ref: '#/components/schemas/GetVerifiedHrData'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/employeeUpload':
post:
tags:
# - EmployeeUpload
summary: 'Add a new EmployeeUpload to the store'
operationId: EmployeeUpload
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
client_id:
type: integer
description: client_id
policy_id:
type: integer
description: policy_id
file:
type: string
format: binary
description: File to upload
application/json:
schema:
type: object
properties:
client_id:
type: integer
description: client_id
policy_id:
type: integer
description: policy_id
responses:
'201':
description: 'Upload EmployeeUpload'
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeUpload'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/getEmployeeProfile':
get:
tags:
# - EmployeeUpload
summary: 'GetEmployeeProfile'
operationId: GetEmployeeProfile
parameters:
- name: emp_code
in: query
description: an authorization header
required: true
type: string
responses:
'201':
description: 'GetEmployeeProfile'
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmployeeProfile'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/editEmployeeProfile':
post:
tags:
# - EmployeeUpload
summary: 'EditEmployeeProfile'
operationId: EditEmployeeProfile
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the employee.
client_id:
type: string
description: The ID of the client.
relationship:
type: string
description: The relationship of the employee.
relationship_code:
type: string
description: The code representing the relationship.
change_event:
type: string
description: The change event associated with the employee.
batch_id:
type: string
description: The ID of the batch.
emp_code:
type: string
description: The code of the employee.
name:
type: string
description: The name of the employee.
email_personal:
type: string
description: The personal email of the employee.
email_corporate:
type: string
description: The corporate email of the employee.
mobile:
type: string
description: The mobile number of the employee.
gender:
type: string
description: The gender of the employee.
dob:
type: string
format: date
description: The date of birth of the employee.
doj:
type: string
format: date
description: The date of joining of the employee.
basic_pay:
type: string
description: The basic pay of the employee.
band:
type: string
description: The band of the employee.
designation:
type: string
description: The designation of the employee.
emp_status:
type: string
description: The status of the employee.
is_active:
type: string
description: Indicates if the employee is active.
file_id:
type: string
description: The ID of the file associated with the employee.
responses:
'201':
description: 'EditEmployeeProfile'
content:
application/json:
schema:
$ref: '#/components/schemas/EditEmployeeProfile'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/relationshipList':
get:
tags:
# - EmployeeUpload
summary: 'RelationshipList'
operationId: RelationshipList
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
responses:
'201':
description: 'RelationshipList'
content:
application/json:
schema:
$ref: '#/components/schemas/RelationshipList'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getEmployeeAndDependence':
get:
tags:
# - EmployeeUpload
summary: 'GetEmployeeAndDependence'
operationId: GetEmployeeAndDependence
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: emp_code
in: query
description: an authorization header
required: true
type: string
responses:
'201':
description: 'GetEmployeeAndDependence'
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmployeeAndDependence'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/editEmployeeAndDependence':
post:
tags:
# - EmployeeUpload
summary: 'EditEmployeeAndDependence'
operationId: EditEmployeeAndDependence
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the employee.
client_id:
type: string
description: The ID of the client.
relationship:
type: string
description: The relationship of the employee.
relationship_code:
type: string
description: The code representing the relationship.
change_event:
type: string
description: The change event associated with the employee.
batch_id:
type: string
description: The ID of the batch.
emp_code:
type: string
description: The code of the employee.
name:
type: string
description: The name of the employee.
email_personal:
type: string
description: The personal email of the employee.
email_corporate:
type: string
description: The corporate email of the employee.
mobile:
type: string
description: The mobile number of the employee.
gender:
type: string
description: The gender of the employee.
dob:
type: string
format: date
description: The date of birth of the employee.
doj:
type: string
format: date
description: The date of joining of the employee.
basic_pay:
type: string
description: The basic pay of the employee.
band:
type: string
description: The band of the employee.
designation:
type: string
description: The designation of the employee.
emp_status:
type: string
description: The status of the employee.
is_active:
type: string
description: Indicates if the employee is active.
file_id:
type: string
description: The ID of the file associated with the employee.
responses:
'201':
description: 'EditEmployeeAndDependence'
content:
application/json:
schema:
$ref: '#/components/schemas/EditEmployeeAndDependence'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/addEmployeeAndDependence':
post:
tags:
# - EmployeeUpload
summary: 'AddEmployeeAndDependence'
operationId: AddEmployeeAndDependence
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
client_id:
type: string
description: The ID of the client.
relationship:
type: string
description: The relationship of the employee.
relationship_code:
type: string
description: The code representing the relationship.
change_event:
type: string
description: The change event associated with the employee.
batch_id:
type: string
description: The ID of the batch.
emp_code:
type: string
description: The code of the employee.
name:
type: string
description: The name of the employee.
email_personal:
type: string
description: The personal email of the employee.
email_corporate:
type: string
description: The corporate email of the employee.
mobile:
type: string
description: The mobile number of the employee.
gender:
type: string
description: The gender of the employee.
dob:
type: string
format: date
description: The date of birth of the employee.
doj:
type: string
format: date
description: The date of joining of the employee.
basic_pay:
type: string
description: The basic pay of the employee.
band:
type: string
description: The band of the employee.
designation:
type: string
description: The designation of the employee.
emp_status:
type: string
description: The status of the employee.
is_active:
type: string
description: Indicates if the employee is active.
file_id:
type: string
description: The ID of the file associated with the employee.
responses:
'201':
description: 'EditEmployeeAndDependence'
content:
application/json:
schema:
$ref: '#/components/schemas/AddEmployeeAndDependence'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getEmployeePolicy':
get:
tags:
# - EmployeeUpload
summary: 'GetEmployeePolicy'
operationId: GetEmployeePolicy
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: id
in: query
description: an authorization header
required: true
type: string
- name: emp_code
in: query
description: an authorization header
required: true
type: string
responses:
'201':
description: 'GetEmployeePolicy'
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmployeePolicy'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/createOrUpdateEmployeePolicySiAmount':
post:
tags:
# - EmployeeUpload
summary: 'CreateOrUpdateEmployeePolicySiAmount'
operationId: CreateOrUpdateEmployeePolicySiAmount
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
employee_id:
type: integer
description: The ID of the employee.
client_policy_id:
type: integer
description: The ID of the client.
basic_cover_si:
type: string
description: The Employee Policy.
premium:
type: string
description: The code representing the Employee Policy.
responses:
'201':
description: 'CreateOrUpdateEmployeePolicySiAmount'
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrUpdateEmployeePolicySiAmount'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/deleteDependence':
get:
tags:
# - EmployeeUpload
summary: 'DeleteDependence'
operationId: DeleteDependence
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: id
in: query
description: an authorization header
required: true
type: string
responses:
'201':
description: 'DeleteDependence'
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDependence'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getEmployeeAndDependenceByClientId':
get:
tags:
# - EmployeeUpload
summary: 'GetEmployeeAndDependenceByClientId'
operationId: GetEmployeeAndDependenceByClientId
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: client_id
in: query
description: an authorization header
required: true
type: string
- name: client_policy_id
in: query
description: an authorization header
required: true
type: string
responses:
'201':
description: 'GetEmployeeAndDependenceByClientId'
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmployeeAndDependenceByClientId'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
'/nhance/employeeRest/getClientPolicy':
get:
tags:
# - EmployeeUpload
summary: 'GetClientPolicy'
operationId: GetClientPolicy
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
responses:
'201':
description: 'GetClientPolicy'
content:
application/json:
schema:
$ref: '#/components/schemas/GetClientPolicy'
'405':
description: 'Invalid input'
security:
- bearer_auth: []
components:
schemas:
EmployeeUpload:
title: EmployeeUpload
description: EmployeeUpload
properties:
client_id:
title: client_id
description: client_id
type: integer
policy_id:
title: policy_id
description: policy_id
type: integer
file:
title: file
description: file
type: string
format: binary
type: object
GetVerifiedUserData:
title: GetVerifiedUserData
description: GetVerifiedUserData
properties:
mobile_number:
title: mobile_number
description: mobile_number
type: string
otp:
title: otp
description: otp
type: string
type: object
VerifyEmployeeNumber:
title: VerifyEmployeeNumber
description: VerifyEmployeeNumber
properties:
mobile_number:
title: mobile_number
description: mobile_number
type: string
type: object
GetVerifiedHrData:
title: GetVerifiedHrData
description: GetVerifiedHrData
properties:
mobile_number:
title: mobile_number
description: mobile_number
type: string
otp:
title: otp
description: otp
type: string
type: object
VerifyHrWithMobileNumber:
title: VerifyHrWithMobileNumber
description: VerifyHrWithMobileNumber
properties:
mobile_number:
title: mobile_number
description: mobile_number
type: string
type: object
GetEmployeeProfile:
title: GetEmployeeProfile
description: GetEmployeeProfile
properties:
emp_code:
title: emp_code
description: emp_code
type: string
type: object
EditEmployeeProfile:
title: EditEmployeeProfile
description: EditEmployeeProfile
properties:
emp_code:
title: emp_code
description: emp_code
type: string
type: object
RelationshipList:
title: RelationshipList
description: RelationshipList
type: object
EditEmployeeAndDependence:
title: EditEmployeeAndDependence
description: EditEmployeeAndDependence
properties:
emp_code:
title: emp_code
description: emp_code
type: string
type: object
GetEmployeeAndDependence:
title: EditEmployeeAndDependence
description: EditEmployeeAndDependence
properties:
emp_code:
title: emp_code
description: emp_code
type: string
type: object
AddEmployeeAndDependence:
title: AddEmployeeAndDependence
description: AddEmployeeAndDependence
properties:
emp_code:
title: emp_code
description: emp_code
type: string
type: object
GetEmployeePolicy:
title: GetEmployeePolicy
description: GetEmployeePolicy
properties:
id:
title: id
description: id
type: integer
emp_code:
title: emp_code
description: emp_code
type: string
type: object
CreateOrUpdateEmployeePolicySiAmount:
title: CreateOrUpdateEmployeePolicySiAmount
description: CreateOrUpdateEmployeePolicySiAmount
properties:
employee_id:
title: employee_id
description: employee_id
type: integer
client_policy_id:
title: client_policy_id
description: client_policy_id
type: integer
basic_cover_si:
title: basic_cover_si
description: basic_cover_si
type: string
premium:
title: premium
description: premium
type: string
type: object
DeleteDependence:
title: DeleteDependence
description: DeleteDependence
properties:
id:
title: id
description: id
type: integer
type: object
GetEmployeeAndDependenceByClientId:
title: GetEmployeeAndDependenceByClientId
description: GetEmployeeAndDependenceByClientId
properties:
client_id:
title: client_id
description: client_id
type: integer
client_policy_id:
title: client_policy_id
description: client_policy_id
type: integer
type: object
GetClientPolicy:
title: GetClientPolicy
description: GetClientPolicy
type: object
# securitySchemes:
# Authorization:
# type: http
# scheme: bearer
# bearerFormat: JWT