Swagger EditorEmployee Registry
To create a new employee we can use POST and set all the required and non-mandatory parameters. When an employee is created, an user is also created along with it. Type value in object will be "EMPLOYEE".
Details for the new employee.
Numeric id of the employee, this is same as user id.
UUID of the employee, this is same as user uuid.
The unique code for an employee. This will autogenerated if there's no input otherwise user will have to input a unique code.
Status of the employee from the status master where object type is "Employee Master". Default value will be "EMPLOYED". Possible status list for employee are - EMPLOYED,RETIRED,SUSPENDED and DECEASED
Type of employment of the employee from the EmployeeType.
Epoch Date of appointment of the employee.
List of Jurisdictions for which this employee has access to. Currently we dont validate this
UUID of the jurisdiction - autogenerated
Hierarchy code from the boundary data
Boundary code from the boundary data
Boundary Type code from the boundary data
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of assignments for the employee.
UUID of the assignment.
Position Id associated with the assignment - autogenerated.
Designation code associated with the assignment.
Unique code of the Department associated with the assignment.
Epoch value of From Date of assignment period.
Epoch value of Till Date of assignment period.
The order number issued for any transfer, promotion, demotion or delegation of power.
Name of the employee who this employee reports to.
Value true means, this guy is the HOD under this assignment.
Value true means, This is the guy's current assignment.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of service history for the employee.
UUID of the service details.
Detail of the service that the employee has done.
Epoch date on which this service was applicable from.
Epoch date on which this service was applicable from.
The government order number passed for the service change.
The government order number passed for the service change.
Value signifies if this is the current working status.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Field to mark whether the employee is active
List of educational qualification for the employee.
UUID of the qualification details.
Name of the qualifying degree.
The main subject studies as part of the qualifying degree.
The year in which the employee has finished the qualification.
Name of the university/board from which the mentioned qualification was acquired.
Any remarks to be captured for this technical qualification.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of departmental tests qualified by the employee.
UUID of the departmental test details.
Name of the Test taken.
The year in which the employee has qualified this test.
Any general remarks.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Unique Identifier of which tenant this data is defined
List of deactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the deactivation is effective.
The government order number passed for the deactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of reactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the reactivation is effective.
The government order number passed for the reactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of all the documents associated with an employee.
The unique id of this object.
The unique id of employee.
The unique url for the document attached.
Name of the document attached.
Each details in Employee can have multiple documents attached. Based on the reference type we are differentiate which document is relevant from which details.
The unique id of the referenced objecy. (Assignment id, Service id etc).
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Employee request accepted for creation.
Numeric id of the employee, this is same as user id.
UUID of the employee, this is same as user uuid.
The unique code for an employee. This will autogenerated if there's no input otherwise user will have to input a unique code.
Status of the employee from the status master where object type is "Employee Master". Default value will be "EMPLOYED". Possible status list for employee are - EMPLOYED,RETIRED,SUSPENDED and DECEASED
Type of employment of the employee from the EmployeeType.
Epoch Date of appointment of the employee.
List of Jurisdictions for which this employee has access to. Currently we dont validate this
UUID of the jurisdiction - autogenerated
Hierarchy code from the boundary data
Boundary code from the boundary data
Boundary Type code from the boundary data
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of assignments for the employee.
UUID of the assignment.
Position Id associated with the assignment - autogenerated.
Designation code associated with the assignment.
Unique code of the Department associated with the assignment.
Epoch value of From Date of assignment period.
Epoch value of Till Date of assignment period.
The order number issued for any transfer, promotion, demotion or delegation of power.
Name of the employee who this employee reports to.
Value true means, this guy is the HOD under this assignment.
Value true means, This is the guy's current assignment.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of service history for the employee.
UUID of the service details.
Detail of the service that the employee has done.
Epoch date on which this service was applicable from.
Epoch date on which this service was applicable from.
The government order number passed for the service change.
The government order number passed for the service change.
Value signifies if this is the current working status.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Field to mark whether the employee is active
List of educational qualification for the employee.
UUID of the qualification details.
Name of the qualifying degree.
The main subject studies as part of the qualifying degree.
The year in which the employee has finished the qualification.
Name of the university/board from which the mentioned qualification was acquired.
Any remarks to be captured for this technical qualification.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of departmental tests qualified by the employee.
UUID of the departmental test details.
Name of the Test taken.
The year in which the employee has qualified this test.
Any general remarks.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Unique Identifier of which tenant this data is defined
List of deactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the deactivation is effective.
The government order number passed for the deactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of reactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the reactivation is effective.
The government order number passed for the reactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of all the documents associated with an employee.
The unique id of this object.
The unique id of employee.
The unique url for the document attached.
Name of the document attached.
Each details in Employee can have multiple documents attached. Based on the reference type we are differentiate which document is relevant from which details.
The unique id of the referenced objecy. (Assignment id, Service id etc).
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Get the employee list based on the input parameters. Response will give the minimum set of information related to the employee.
List of employee codes
List of employee names
List of Department codes for the employee assignment.
List of Designation codes for the employee assignment.
Epoch Date of assignment
List of Unique Id of employee
List of Unique codes of employee status
List of Unique codes of employee type
List of Unique uuid of employee
List of Unique Positions
List of Roles of employee
Phone Number
True will return active employees, False otherwise
Offset of the search result
No of records to be returned from the offset
Tenant id
Common request info for getting employee.
Successful response
Numeric id of the employee, this is same as user id.
UUID of the employee, this is same as user uuid.
The unique code for an employee. This will autogenerated if there's no input otherwise user will have to input a unique code.
Status of the employee from the status master where object type is "Employee Master". Default value will be "EMPLOYED". Possible status list for employee are - EMPLOYED,RETIRED,SUSPENDED and DECEASED
Type of employment of the employee from the EmployeeType.
Epoch Date of appointment of the employee.
List of Jurisdictions for which this employee has access to. Currently we dont validate this
UUID of the jurisdiction - autogenerated
Hierarchy code from the boundary data
Boundary code from the boundary data
Boundary Type code from the boundary data
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of assignments for the employee.
UUID of the assignment.
Position Id associated with the assignment - autogenerated.
Designation code associated with the assignment.
Unique code of the Department associated with the assignment.
Epoch value of From Date of assignment period.
Epoch value of Till Date of assignment period.
The order number issued for any transfer, promotion, demotion or delegation of power.
Name of the employee who this employee reports to.
Value true means, this guy is the HOD under this assignment.
Value true means, This is the guy's current assignment.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of service history for the employee.
UUID of the service details.
Detail of the service that the employee has done.
Epoch date on which this service was applicable from.
Epoch date on which this service was applicable from.
The government order number passed for the service change.
The government order number passed for the service change.
Value signifies if this is the current working status.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Field to mark whether the employee is active
List of educational qualification for the employee.
UUID of the qualification details.
Name of the qualifying degree.
The main subject studies as part of the qualifying degree.
The year in which the employee has finished the qualification.
Name of the university/board from which the mentioned qualification was acquired.
Any remarks to be captured for this technical qualification.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of departmental tests qualified by the employee.
UUID of the departmental test details.
Name of the Test taken.
The year in which the employee has qualified this test.
Any general remarks.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Unique Identifier of which tenant this data is defined
List of deactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the deactivation is effective.
The government order number passed for the deactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of reactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the reactivation is effective.
The government order number passed for the reactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of all the documents associated with an employee.
The unique id of this object.
The unique id of employee.
The unique url for the document attached.
Name of the document attached.
Each details in Employee can have multiple documents attached. Based on the reference type we are differentiate which document is relevant from which details.
The unique id of the referenced objecy. (Assignment id, Service id etc).
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Get the list of count of active and inactive employee for given tenant Id.
Unique id for a tenant.
Successful response, present the list of count of active and inactive employee for given tenant Id.
ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current ResponseHeader
Error object will be returned as a part of reponse body in conjunction with ResponseHeader as part of ErrorResponse whenever the request processing status in the ResponseHeader is FAILED. HTTP return in this scenario will usually be HTTP 400.
Error Code will be module specific error label/code to identiffy the error. All modules should also publish the Error codes with their specific localized values in localization service to ensure clients can print locale specific error messages. Example for error code would be User.NotFound to indicate User Not Found by User/Authentication service. All services must declare their possible Error Codes with brief description in the error response section of their API path.
English locale message of the error code. Clients should make a separate call to get the other locale description if configured with the service. Clients may choose to cache these locale specific messages to enhance performance with a reasonable TTL (May be defined by the localization service based on tenant + module combination).
Optional long description of the error to help clients take remedial action. This will not be available as part of localization service.
Some error messages may carry replaceable fields (say $1, $2) to provide more context to the message. E.g. Format related errors may want to indicate the actual field for which the format is invalid. Client's should use the values in the param array to replace those fields.
Additional information from API
Debug information when requested
Any additional information if required e.g. status url (to find out the current status of an asynchronous processing response), additional links to perform special functions like file uploads etc.
Capture the employee count details
Number of active employee present in the system
Number of inactive employee present in the system
Total number of employee present in the system
To update an existing employee's employee details and all other details like assignment, jurisdiction, qualification service details and porbation. This API will also be used for deactivating an employee
Request header for the employee with new of values.
Numeric id of the employee, this is same as user id.
UUID of the employee, this is same as user uuid.
The unique code for an employee. This will autogenerated if there's no input otherwise user will have to input a unique code.
Status of the employee from the status master where object type is "Employee Master". Default value will be "EMPLOYED". Possible status list for employee are - EMPLOYED,RETIRED,SUSPENDED and DECEASED
Type of employment of the employee from the EmployeeType.
Epoch Date of appointment of the employee.
List of Jurisdictions for which this employee has access to. Currently we dont validate this
UUID of the jurisdiction - autogenerated
Hierarchy code from the boundary data
Boundary code from the boundary data
Boundary Type code from the boundary data
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of assignments for the employee.
UUID of the assignment.
Position Id associated with the assignment - autogenerated.
Designation code associated with the assignment.
Unique code of the Department associated with the assignment.
Epoch value of From Date of assignment period.
Epoch value of Till Date of assignment period.
The order number issued for any transfer, promotion, demotion or delegation of power.
Name of the employee who this employee reports to.
Value true means, this guy is the HOD under this assignment.
Value true means, This is the guy's current assignment.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of service history for the employee.
UUID of the service details.
Detail of the service that the employee has done.
Epoch date on which this service was applicable from.
Epoch date on which this service was applicable from.
The government order number passed for the service change.
The government order number passed for the service change.
Value signifies if this is the current working status.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Field to mark whether the employee is active
List of educational qualification for the employee.
UUID of the qualification details.
Name of the qualifying degree.
The main subject studies as part of the qualifying degree.
The year in which the employee has finished the qualification.
Name of the university/board from which the mentioned qualification was acquired.
Any remarks to be captured for this technical qualification.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of departmental tests qualified by the employee.
UUID of the departmental test details.
Name of the Test taken.
The year in which the employee has qualified this test.
Any general remarks.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Unique Identifier of which tenant this data is defined
List of deactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the deactivation is effective.
The government order number passed for the deactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of reactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the reactivation is effective.
The government order number passed for the reactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of all the documents associated with an employee.
The unique id of this object.
The unique id of employee.
The unique url for the document attached.
Name of the document attached.
Each details in Employee can have multiple documents attached. Based on the reference type we are differentiate which document is relevant from which details.
The unique id of the referenced objecy. (Assignment id, Service id etc).
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Employee request accepted for update.
Numeric id of the employee, this is same as user id.
UUID of the employee, this is same as user uuid.
The unique code for an employee. This will autogenerated if there's no input otherwise user will have to input a unique code.
Status of the employee from the status master where object type is "Employee Master". Default value will be "EMPLOYED". Possible status list for employee are - EMPLOYED,RETIRED,SUSPENDED and DECEASED
Type of employment of the employee from the EmployeeType.
Epoch Date of appointment of the employee.
List of Jurisdictions for which this employee has access to. Currently we dont validate this
UUID of the jurisdiction - autogenerated
Hierarchy code from the boundary data
Boundary code from the boundary data
Boundary Type code from the boundary data
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of assignments for the employee.
UUID of the assignment.
Position Id associated with the assignment - autogenerated.
Designation code associated with the assignment.
Unique code of the Department associated with the assignment.
Epoch value of From Date of assignment period.
Epoch value of Till Date of assignment period.
The order number issued for any transfer, promotion, demotion or delegation of power.
Name of the employee who this employee reports to.
Value true means, this guy is the HOD under this assignment.
Value true means, This is the guy's current assignment.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of service history for the employee.
UUID of the service details.
Detail of the service that the employee has done.
Epoch date on which this service was applicable from.
Epoch date on which this service was applicable from.
The government order number passed for the service change.
The government order number passed for the service change.
Value signifies if this is the current working status.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Field to mark whether the employee is active
List of educational qualification for the employee.
UUID of the qualification details.
Name of the qualifying degree.
The main subject studies as part of the qualifying degree.
The year in which the employee has finished the qualification.
Name of the university/board from which the mentioned qualification was acquired.
Any remarks to be captured for this technical qualification.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of departmental tests qualified by the employee.
UUID of the departmental test details.
Name of the Test taken.
The year in which the employee has qualified this test.
Any general remarks.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Unique Identifier of which tenant this data is defined
List of deactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the deactivation is effective.
The government order number passed for the deactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of reactivation details for the employee.
UUID of the deactivation detail
UUID of the employee to whom this details belongs.
Reason for deactivation
Epoch date from which the reactivation is effective.
The government order number passed for the reactivation
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
List of all the documents associated with an employee.
The unique id of this object.
The unique id of employee.
The unique url for the document attached.
Name of the document attached.
Each details in Employee can have multiple documents attached. Based on the reference type we are differentiate which document is relevant from which details.
The unique id of the referenced objecy. (Assignment id, Service id etc).
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.
Id of the user who created the record.
Epoch Date on which the user master data was added into the system.
Id of the user who last modified the record.
Epoch Date on which the user master data was last modified.