You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

990 lines
26 KiB

{
"openapi": "3.0.0",
"info": {
"title": "Rili Personnas API",
"description": "Rili Personnas Management API Documentation",
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost:8080",
"description": "Local Development Server"
}
],
"paths": {
"/rilipersonnas/add": {
"post": {
"summary": "Add Tenant",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
}
],
"requestBody": {
"description": "Rili Personnas parameters",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OptRiliPersonnasParams"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleDataResponse"
}
}
}
}
}
}
},
"/rilipersonnas/edit": {
"post": {
"summary": "Edit Tenant",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
}
],
"requestBody": {
"description": "Rili Personnas parameters",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OptRiliPersonnasParams"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleDataResponse"
}
}
}
}
}
}
},
"/rilipersonnas/batchDelete": {
"post": {
"summary": "Delete Tenant",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
}
],
"requestBody": {
"description": "Delete parameters",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteRiliPersonnasParams"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleDataResponse"
}
}
}
}
}
}
},
"/rilipersonnas/getListPage": {
"get": {
"summary": "Get Tenant list",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
},
{
"name": "UTCOffset",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": -480
},
"description": "Time zone offset in minutes from GMT, e.g., +480 for UTC+8"
},
{
"name": "pageNum",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Page number"
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Page size"
},
{
"name": "tenantId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Tenant ID"
},
{
"name": "tenantName",
"in": "query",
"schema": {
"type": "string"
},
"description": "Tenant name"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageResponseRiliPersonnasLatest"
}
}
}
}
}
}
},
"/rilipersonnas/getHistoryListPage": {
"get": {
"summary": "Get Tenant list",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
},
{
"name": "UTCOffset",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": -480
},
"description": "Time zone offset in minutes from GMT, e.g., +480 for UTC+8"
},
{
"name": "pageNum",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Page number"
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Page size"
},
{
"name": "tenantId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Tenant ID"
},
{
"name": "historyId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "History ID"
},
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Start date"
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "End date"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageResponseRiliPersonnasHistory"
}
}
}
}
}
}
},
"/rilipersonnas/batchImport": {
"post": {
"summary": "Batch import buildings from Excel file",
"tags": ["rilipersonnas"],
"parameters": [
{
"name": "LoginName",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "admin"
},
"description": "Login name"
},
{
"name": "AccessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Authentication token"
},
{
"name": "UserId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User ID"
},
{
"name": "CompanyId",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
},
"description": "User's company ID"
},
{
"name": "LanguageType",
"in": "header",
"required": true,
"schema": {
"type": "integer",
"default": 2,
"enum": [0, 1, 2],
"description": "0 - Chinese, 1 - English, 2 - Japanese"
},
"description": "Language type"
}
],
"requestBody": {
"description": "Excel file to import",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"excelFile": {
"type": "string",
"format": "binary",
"description": "Excel file containing data to import"
}
},
"required": ["excelFile"]
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleDataResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"OptRiliPersonnasParams": {
"type": "object",
"properties": {
"tenantId": {
"type": "integer",
"format": "int64",
"description": "Tenant ID"
},
"tenantName": {
"type": "string",
"description": "Tenant name"
},
"description": {
"type": "string",
"description": "Description"
},
"contactPerson": {
"type": "string",
"description": "Contact person"
},
"contactPhone": {
"type": "string",
"description": "Contact phone"
},
"email": {
"type": "string",
"description": "Email address"
},
"status": {
"type": "integer",
"description": "Status"
}
}
},
"DeleteRiliPersonnasParams": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of IDs to delete"
}
}
},
"SimpleDataResponse": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "Response code"
},
"msg": {
"type": "string",
"description": "Response message"
},
"data": {
"type": "object",
"description": "Response data"
}
}
},
"PageInfoRiliPersonnasLatest": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of records"
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiliPersonnasLatest"
},
"description": "List of records"
},
"pageNum": {
"type": "integer",
"description": "Current page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"size": {
"type": "integer",
"description": "Current page size"
},
"startRow": {
"type": "integer",
"description": "Start row index"
},
"endRow": {
"type": "integer",
"description": "End row index"
},
"pages": {
"type": "integer",
"description": "Total number of pages"
},
"prePage": {
"type": "integer",
"description": "Previous page number"
},
"nextPage": {
"type": "integer",
"description": "Next page number"
},
"isFirstPage": {
"type": "boolean",
"description": "Is first page"
},
"isLastPage": {
"type": "boolean",
"description": "Is last page"
},
"hasPreviousPage": {
"type": "boolean",
"description": "Has previous page"
},
"hasNextPage": {
"type": "boolean",
"description": "Has next page"
},
"navigatePages": {
"type": "integer",
"description": "Navigate pages"
},
"navigatepageNums": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Navigate page numbers"
},
"navigateFirstPage": {
"type": "integer",
"description": "Navigate first page"
},
"navigateLastPage": {
"type": "integer",
"description": "Navigate last page"
}
}
},
"PageInfoRiliPersonnasHistory": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of records"
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiliPersonnasHistory"
},
"description": "List of records"
},
"pageNum": {
"type": "integer",
"description": "Current page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"size": {
"type": "integer",
"description": "Current page size"
},
"startRow": {
"type": "integer",
"description": "Start row index"
},
"endRow": {
"type": "integer",
"description": "End row index"
},
"pages": {
"type": "integer",
"description": "Total number of pages"
},
"prePage": {
"type": "integer",
"description": "Previous page number"
},
"nextPage": {
"type": "integer",
"description": "Next page number"
},
"isFirstPage": {
"type": "boolean",
"description": "Is first page"
},
"isLastPage": {
"type": "boolean",
"description": "Is last page"
},
"hasPreviousPage": {
"type": "boolean",
"description": "Has previous page"
},
"hasNextPage": {
"type": "boolean",
"description": "Has next page"
},
"navigatePages": {
"type": "integer",
"description": "Navigate pages"
},
"navigatepageNums": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Navigate page numbers"
},
"navigateFirstPage": {
"type": "integer",
"description": "Navigate first page"
},
"navigateLastPage": {
"type": "integer",
"description": "Navigate last page"
}
}
},
"PageResponseRiliPersonnasLatest": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "Response code"
},
"msg": {
"type": "string",
"description": "Response message"
},
"data": {
"$ref": "#/components/schemas/PageInfoRiliPersonnasLatest",
"description": "Page response data"
}
}
},
"PageResponseRiliPersonnasHistory": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "Response code"
},
"msg": {
"type": "string",
"description": "Response message"
},
"data": {
"$ref": "#/components/schemas/PageInfoRiliPersonnasHistory",
"description": "Page response data"
}
}
},
"RiliPersonnasLatest": {
"type": "object",
"properties": {
"tenantId": {
"type": "integer",
"format": "int64",
"description": "Tenant ID"
},
"tenantName": {
"type": "string",
"description": "Tenant name"
},
"description": {
"type": "string",
"description": "Description"
},
"contactPerson": {
"type": "string",
"description": "Contact person"
},
"contactPhone": {
"type": "string",
"description": "Contact phone"
},
"email": {
"type": "string",
"description": "Email address"
},
"status": {
"type": "integer",
"description": "Status"
},
"createdBy": {
"type": "integer",
"format": "int64",
"description": "Created by"
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Created time"
},
"updatedBy": {
"type": "integer",
"format": "int64",
"description": "Updated by"
},
"updatedTime": {
"type": "string",
"format": "date-time",
"description": "Updated time"
}
}
},
"RiliPersonnasHistory": {
"type": "object",
"properties": {
"historyId": {
"type": "integer",
"format": "int64",
"description": "History ID"
},
"tenantId": {
"type": "integer",
"format": "int64",
"description": "Tenant ID"
},
"tenantName": {
"type": "string",
"description": "Tenant name"
},
"description": {
"type": "string",
"description": "Description"
},
"contactPerson": {
"type": "string",
"description": "Contact person"
},
"contactPhone": {
"type": "string",
"description": "Contact phone"
},
"email": {
"type": "string",
"description": "Email address"
},
"status": {
"type": "integer",
"description": "Status"
},
"operationType": {
"type": "string",
"description": "Operation type (ADD, EDIT, DELETE)"
},
"operatorId": {
"type": "integer",
"format": "int64",
"description": "Operator ID"
},
"operatorName": {
"type": "string",
"description": "Operator name"
},
"operationTime": {
"type": "string",
"format": "date-time",
"description": "Operation time"
}
}
}
}
}
}