Feedback ResourceΒΆ

Submit FeedbackΒΆ

HTTP Request

POST /api/feedback/submit

πŸ“‹ Description: Submits user feedback to enhance service quality and customer satisfaction. This operation allows businesses to collect insights directly from users, facilitating continuous improvement.

Parameters

Name

In

Type

Required

Description

body

body

FeedbackDTO

true

Request body containing user feedback data, including comments, ratings, and user identification details for quality improvement initiatives.

Responses

Status

Meaning

Description

Schema

200

OK

OK

FeedbackDTO

Get All FeedbackΒΆ

HTTP Request

GET /api/feedback

πŸ“‹ Description: Fetches user feedback submissions, enabling businesses to analyze customer insights and improve service offerings.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[FeedbackDTO]

false

none

[Data transfer object representing customer feedback, including ratings and comments, to facilitate product improvement and enhance user satisfaction.]

Β» id

integer(int64)

false

none

Unique identifier for the resource

Β» createdBy

string

false

none

Username of who created this resource

Β» createdAt

string(date-time)

false

none

Timestamp when this resource was created

Β» requestId

integer(int64)

false

none

Unique identifier for the request

Β» requestDto

RequestDTO

false

none

Data transfer object representing a client request, encapsulating essential details such as request type, priority, and associated metadata to facilitate efficient processing and tracking within the business workflow.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» createdBy

string

false

none

Username of who created this resource

»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»» displayId

string

false

none

Unique identifier for the display

»» description

string

false

none

Description of the resource

»» imageId

integer(int64)

false

none

Unique identifier for the image

»» premiseId

integer(int64)

false

none

Unique identifier for the premise

»» premiseDto

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» createdBy

string

false

none

Username of who created this resource

»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»» displayId

string

false

none

Unique identifier for the display

»»» premiseName

string

false

none

Name of the premise

»»» description

string

false

none

Description of the resource

»»» address

string

true

none

Represents the physical location associated with the premise, essential for logistics and service delivery.

»»» internalTeamNames

[string]

false

none

List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization.

»»» internalTeamIds

[integer]

false

none

List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation.

»»» premiseAvailable

boolean

false

none

Indicates whether the premise is available for use within the specified context.

»»» premiseFromNrm

boolean

false

none

Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes.

»»» nlmId

integer(int64)

false

none

Unique identifier for the nlm

»»» nlmDisplayId

string

false

none

Unique identifier for the nlm display

»»» nlmUsed

boolean

false

none

Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process.

»»» manager

integer(int64)

false

none

Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management.

»»» managerName

string

false

none

Name of the manager

»»» imageId

integer(int64)

false

none

Unique identifier for the image

»»» area

string

false

none

Represents the geographic area associated with the premise, providing essential context for location-based services and analysis.

»»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»» premiseFromNrm

boolean

false

none

Indicates whether the premise is sourced from the National Resource Management (NRM) system, facilitating accurate data integration and reporting.

»» premiseDisplayId

string

false

none

Unique identifier for the premise display

»» name

string

false

none

Name of the resource

»» requestPriority

string

false

none

Priority of the request

»» requestPriorityType

string

false

none

Type of the request priority

»» requestPriorityId

integer(int64)

false

none

Unique identifier for the request priority

»» requestPriorityDisplayId

string

false

none

Unique identifier for the request priority display

»» requestDate

string(date)

false

none

Date of the request

»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»» requestCategory

string

false

none

Category of the request

»» requestCategoryId

integer(int64)

false

none

Unique identifier for the request category

»» requestCategoryDisplayId

string

false

none

Unique identifier for the request category display

»» requestStatus

string

false

none

Status of the request

»» requestStatusType

string

false

none

Type of the request status

»» requestStatusId

integer(int64)

false

none

Unique identifier for the request status

»» requestStatusDisplayId

string

false

none

Unique identifier for the request status display

»» mainAssetIds

[integer]

false

none

List of unique identifiers for the primary assets associated with the request, facilitating efficient tracking and management within the system.

»» mainAssetId

integer(int64)

false

none

Unique identifier for the main asset

»» mainAssetDto

MainAssetDTO

false

none

MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» createdBy

string

false

none

Username of who created this resource

»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»» displayId

string

false

none

Unique identifier for the display

»»» name

string

false

none

Name of the resource

»»» description

string

false

none

Description of the resource

»»» qrCode

string

false

none

Code for the qr

»»» barCode

string

false

none

Code for the bar

»»» imageId

integer(int64)

false

none

Unique identifier for the image

»»» model

string

false

none

Specifies the model associated with the main asset, providing essential context for asset classification and management.

»»» manufacturer

string

false

none

Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations.

»»» serialNumber

string

false

none

Unique identifier for the asset, used to track and manage inventory within the system.

»»» cost

string

false

none

Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation.

»»» premiseId

integer(int64)

false

none

Unique identifier for the premise

»»» premiseDisplayId

string

false

none

Unique identifier for the premise display

»»» premiseDto

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.

»»» acquisitionDate

string(date)

false

none

Date of the acquisition

»»» endOfLife

string(date)

false

none

Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning.

»»» assetStatusId

integer(int64)

false

none

Unique identifier for the asset status

»»» assetStatus

string

false

none

Status of the asset

»»» assetStatusType

string

false

none

Type of the asset status

»»» parentAssetId

integer(int64)

false

none

Unique identifier for the parent asset

»»» parentAssetDisplayId

string

false

none

Unique identifier for the parent asset display

»»» parentAsset

string

false

none

Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management.

»»» parentAssetDto

MainAssetDTO

false

none

MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.

»»» upcomingMaintenanceDate

string(date)

false

none

Date of the upcoming maintenance

»»» assetCategoryIds

[integer]

false

none

Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management.

»»» assetCategories

[string]

false

none

Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data.

»»» internalTeamIds

[integer]

false

none

Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation.

»»» internalTeamDtos

[InternalTeamDTO]

false

none

An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» createdBy

string

false

none

Username of who created this resource

»»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»»» displayId

string

false

none

Unique identifier for the display

»»»» name

string

false

none

Name of the resource

»»»» email

string

false

none

Email address of the internal team member, used for communication and notifications within the organization.

»»»» phone

string

false

none

Contact number for the internal team, facilitating communication and collaboration within the organization.

»»»» manager

string

false

none

Represents the name or identifier of the team manager responsible for overseeing the internal team.

»»»» requestCategoryName

[string]

false

none

Name of the request category

»»»» requestCategoryId

[integer]

false

none

Unique identifier for the request category

»»»» requestCategoryDisplayId

[string]

false

none

Unique identifier for the request category display

»»»» description

string

false

none

Description of the resource

»»»» internalTeamUser

[integer]

false

none

An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management.

»»»» members

integer(int32)

false

none

Represents the total number of members within the internal team, providing insight into team size for resource allocation and management.

»»»» mainAssets

[integer]

false

none

An array of internal team assets that represent the key resources and capabilities utilized within the organization.

»»»» premiseNames

[string]

false

none

List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization.

»»»» internalTeamAvailable

boolean

false

none

Indicates the availability of the internal team for project allocation and resource planning.

»»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the internal team.

»»» internalTeams

[string]

false

none

An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization.

»»» assignedUserIds

[integer]

false

none

Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability.

»»» assignedUserDtos

[UserDTO]

false

none

Array of user assignments associated with the main asset, providing insights into resource allocation and accountability.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» createdBy

string

false

none

Username of who created this resource

»»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»»» userName

string

false

none

Name of the user

»»»» firstName

string

false

none

Name of the first

»»»» lastName

string

false

none

Name of the last

»»»» email

string

false

none

Email address of the user, used for communication and account verification purposes within the system.

»»»» roleIds

[Role]

false

none

Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»»»» modifiedBy

string

false

none

Username of who last modified this resource

»»»»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»»»»» roleName

string

false

none

Name of the role

»»»»» entity

string

false

none

Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management.

»»»»» new

boolean

false

none

Indicates whether the role is newly created within the system, facilitating effective management of organizational changes.

»»»» internalTeamNames

[string]

false

none

List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization.

»»»» internalTeamIds

[integer]

false

none

An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization.

»»»» internalTeamDisplayIds

[string]

false

none

An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration.

»»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations.

»»»» premiseNames

[string]

false

none

List of names associated with the user’s premises, providing essential context for location-based services and operations.

»»»» userAvailable

boolean

false

none

Indicates whether the user is available for assignment or engagement within the system.

»»»» temporaryWorkload

integer(int32)

false

none

Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning.

»»»» preferredCultureCode

string

false

none

Code for the preferred culture

»»» assignedUsers

[string]

false

none

List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization.

»»» assetPriority

string

false

none

Priority of the asset

»»» assetPriorityId

integer(int64)

false

none

Unique identifier for the asset priority

»»» assetPriorityDisplayId

string

false

none

Unique identifier for the asset priority display

»»» assetPriorityType

string

false

none

Type of the asset priority

»»» assetAvailable

boolean

false

none

Indicates whether the asset is currently available for allocation or use within the system.

»»» exactPlacement

string

false

none

Specifies the precise location or context in which the main asset is intended to be utilized within the business framework.

»»» fosId

integer(int64)

false

none

Unique identifier for the fos

»»» downtimeStatus

string

false

none

Status of the downtime

»»» premiseFromNrm

boolean

false

none

Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking.

»»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»» mainAssetDisplayId

string

false

none

Unique identifier for the main asset display

»» assignedUserIds

[integer]

false

none

Array of unique identifiers representing the users assigned to the specific task or project within the system.

»» assignedUserDtos

[UserDTO]

false

none

Array of user assignments that delineates the individuals responsible for managing the associated tasks within the request.

»» assignedUsers

[string]

false

none

List of users assigned to the request, facilitating effective task management and collaboration within the organization.

»» internalTeamIds

[integer]

false

none

Array of unique identifiers representing the internal teams associated with the request, facilitating effective team management and collaboration.

»» internalTeamDtos

[InternalTeamDTO]

false

none

An array of RequestDTO objects representing the internal teams involved in the project, facilitating collaboration and resource allocation.

»» internalTeams

[string]

false

none

List of internal teams involved in the project, facilitating collaboration and resource allocation.

»» requestAvailable

boolean

false

none

Indicates whether the requested resource is available for allocation within the system.

»» exactPlacement

string

false

none

Specifies the precise location or context for the placement of resources within the operational framework.

»» requestType

string

false

none

Type of the request

»» closeDate

string(date)

false

none

Date of the close

»» requestFrom

string

false

none

Identifies the origin of the request, providing context for processing and tracking within the system.

Β» rating

integer(int32)

false

none

Represents the numerical evaluation of feedback provided, allowing for quantifiable assessment of performance or satisfaction.

Β» comment

string

false

none

User-provided feedback or observations related to the specific interaction or transaction, intended to enhance service quality and customer satisfaction.

Β» token

string

false

none

String representing the authentication token used to verify user identity and authorize access to the API.

Β» recipientUserId

integer(int64)

false

none

Unique identifier for the recipient user

Β» recipientEmail

string

false

none

Email address of the recipient to whom feedback will be sent, facilitating direct communication and response tracking.

Β» lastReminderSentAt

string(date-time)

false

none

Timestamp indicating the last date and time a reminder was sent, facilitating effective follow-up and engagement tracking in the feedback process.

Β» reminderCount

integer(int32)

false

none

Count of reminder

Β» expiresAt

string(date-time)

false

none

Indicates the date and time when the feedback will no longer be valid, ensuring timely review and action.

Β» used

boolean

false

none

Indicates whether the feedback has been utilized in decision-making processes.

Β» usedAt

string(date-time)

false

none

Timestamp indicating when the feedback was provided, essential for tracking the relevance and timeliness of user insights.

Β» submitterUserId

integer(int64)

false

none

Unique identifier for the submitter user

Β» submitterEmail

string

false

none

Email address of the individual submitting feedback, used for communication and follow-up regarding the feedback provided.

Enumerated Values

Attribute

Value

requestFrom

NFM, PORTAL

Get FeedbackΒΆ

HTTP Request

GET /api/feedback/{id}

πŸ“‹ Description: Retrieves detailed feedback information for a specified feedback entry, enabling users to review insights and comments associated with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FeedbackDTO

Get Feedback By Entity Type And Entity IDΒΆ

HTTP Request

GET /api/feedback/{entityType}/{entityId}

πŸ“‹ Description: Fetches feedback associated with a specific entity type and entity ID, enabling businesses to gain insights into user experiences and improve service offerings.

Parameters

Name

In

Type

Required

Description

entityType

path

string

true

Type of the entity

entityId

path

integer(int64)

true

Unique identifier for the entity

page

query

integer(int32)

false

Page number for pagination

size

query

integer(int32)

false

Number of items per page

request

query

string

false

Specifies the type of feedback request being made, allowing for tailored responses based on the entity type and ID.

asset

query

string

false

Represents the unique identifier of the asset associated with the specified entity, facilitating targeted feedback retrieval.

Default ValuesΒΆ

Parameter

Default

Type

page

0

query

size

20

query

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageFeedbackDTO

Validate TokenΒΆ

HTTP Request

GET /api/feedback/validate/{token}

πŸ“‹ Description: Validates the provided feedback token to ensure its authenticity and integrity, enabling secure access to associated feedback data. This operation is essential for maintaining the reliability of user feedback processes.

Parameters

Name

In

Type

Required

Description

token

path

string

true

Authentication token used to validate user feedback submissions within the system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

FeedbackValidationResponse

Get Feedback DashboardΒΆ

HTTP Request

GET /api/feedback/premises/{entityId}/dashboard

πŸ“‹ Description: Retrieves the dashboard data for a specific premises entity, providing insights and analytics to support informed decision-making.

Parameters

Name

In

Type

Required

Description

entityId

path

integer(int64)

true

Unique identifier for the entity

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

Β» additionalProperties

object

false

none

none

Get Average Feedback RatingΒΆ

HTTP Request

GET /api/feedback/average-rating/{requestId}

πŸ“‹ Description: Retrieves the average rating for a specific feedback request identified by the provided request ID, enabling businesses to assess performance and customer satisfaction effectively.

Parameters

Name

In

Type

Required

Description

requestId

path

integer(int64)

true

Unique identifier for the request

Responses

Status

Meaning

Description

Schema

200

OK

OK

number