AIRBNB

FRONTEND GUIDE FOR AI CODING AGENTS - PART 7 - AdminPanel Service

This document is a part of a REST API guide for the airbnb project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of adminPanel

Service Access

AdminPanel service management is handled through service specific base urls.

AdminPanel service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the adminPanel service, the base URLs are:

• Preview: https://airbnb3.prw.mindbricks.com/adminpanel-api
• Staging: https://airbnb3-stage.mindbricks.co/adminpanel-api
• Production: https://airbnb3.mindbricks.co/adminpanel-api

Scope

AdminPanel Service Description

Administrative and compliance management backend for moderation, audit, dispute, financial oversight, localization, and GDPR in the Airbnb-style rental platform...

AdminPanel service provides apis and business logic for following data objects in airbnb application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

localizationSetting Data Object: Admin-configured valid languages/currencies for site usage and preference.

adminDisputeAction Data Object: Record of an admin's moderation/decision action on a dispute.

apiKey Data Object: Admin-generated API key for internal/external integration—has revocation, audit trail.

financialReport Data Object: System-generated or admin-generated report snapshots of platform financials for a given period (GDPR/tax).

auditLog Data Object: Immutable audit log for recording sensitive admin actions and platform changes.

gdprAction Data Object: Record of individual user GDPR/consent/export/delete request flow. Used for logs, compliance, and controls.

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

• 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
• 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3,
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

Error Response

If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters.
• 401 Unauthorized: The request lacked a valid authentication token; login is required.
• 403 Forbidden: The current token does not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Airbnb application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"airbnb3-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

LocalizationSetting Data Object

Admin-configured valid languages/currencies for site usage and preference.

LocalizationSetting Data Object Properties

LocalizationSetting data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Filter Properties

languageCode currencyCode isCurrencyActive

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• languageCode: String has a filter named languageCode

• currencyCode: String has a filter named currencyCode

• isCurrencyActive: Boolean has a filter named isCurrencyActive

AdminDisputeAction Data Object

Record of an admin's moderation/decision action on a dispute.

AdminDisputeAction Data Object Properties

AdminDisputeAction data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Relation Properties

disputeId adminId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• disputeId: ID Relation to dispute.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• adminId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

disputeId adminId

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• disputeId: ID has a filter named disputeId

• adminId: ID has a filter named adminId

ApiKey Data Object

Admin-generated API key for internal/external integration—has revocation, audit trail.

ApiKey Data Object Properties

ApiKey data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Relation Properties

createdBy

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• createdBy: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

FinancialReport Data Object

System-generated or admin-generated report snapshots of platform financials for a given period (GDPR/tax).

FinancialReport Data Object Properties

FinancialReport data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Relation Properties

createdBy

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• createdBy: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

period

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• period: String has a filter named period

AuditLog Data Object

Immutable audit log for recording sensitive admin actions and platform changes.

AuditLog Data Object Properties

AuditLog data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Relation Properties

performedBy

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• performedBy: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

performedBy objectId actionObject occurredAt actionType

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• performedBy: ID has a filter named performedBy

• objectId: ID has a filter named objectId

• actionObject: String has a filter named actionObject

• occurredAt: Date has a filter named occurredAt

• actionType: String has a filter named actionType

GdprAction Data Object

Record of individual user GDPR/consent/export/delete request flow. Used for logs, compliance, and controls.

GdprAction Data Object Properties

GdprAction data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• status: [pending, complete, failed]

Relation Properties

userId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• userId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

API Reference

Get Auditlog API

Fetch audit log entry by ID (admin only).

Rest Route

The getAuditLog API REST controller can be triggered via the following route:

/v1/auditlogs/:auditLogId

Rest Request Parameters

The getAuditLog api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/auditlogs/:auditLogId

  axios({
    method: 'GET',
    url: `/v1/auditlogs/${auditLogId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auditLog",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"auditLog": {
		"id": "ID",
		"performedBy": "ID",
		"objectId": "ID",
		"details": "Object",
		"ipAddress": "String",
		"actionObject": "String",
		"occurredAt": "Date",
		"actionType": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Get Financialreport API

Retrieve financial/tax report snapshot by ID (admin only).

Rest Route

The getFinancialReport API REST controller can be triggered via the following route:

/v1/financialreports/:financialReportId

Rest Request Parameters

The getFinancialReport api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/financialreports/:financialReportId

  axios({
    method: 'GET',
    url: `/v1/financialreports/${financialReportId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "financialReport",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"financialReport": {
		"id": "ID",
		"period": "String",
		"cityTaxByLocation": "Object",
		"totalPayouts": "Double",
		"createdBy": "ID",
		"totalRefunds": "Double",
		"currency": "String",
		"generatedAt": "Date",
		"totalRevenue": "Double",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Create Financialreport API

Snapshot financial and tax data for a period. Immutable after creation.

Rest Route

The createFinancialReport API REST controller can be triggered via the following route:

/v1/financialreports

Rest Request Parameters

The createFinancialReport api has got 7 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/financialreports

  axios({
    method: 'POST',
    url: '/v1/financialreports',
    data: {
            period:"String",  
            cityTaxByLocation:"Object",  
            totalPayouts:"Double",  
            createdBy:"ID",  
            totalRefunds:"Double",  
            currency:"String",  
            totalRevenue:"Double",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "financialReport",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"financialReport": {
		"id": "ID",
		"period": "String",
		"cityTaxByLocation": "Object",
		"totalPayouts": "Double",
		"createdBy": "ID",
		"totalRefunds": "Double",
		"currency": "String",
		"generatedAt": "Date",
		"totalRevenue": "Double",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

List Auditlogs API

List audit log entries (admin only). Filterable by type, performer, object, date.

Rest Route

The listAuditLogs API REST controller can be triggered via the following route:

/v1/auditlogs

Rest Request Parameters The listAuditLogs api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/auditlogs

  axios({
    method: 'GET',
    url: '/v1/auditlogs',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auditLogs",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"auditLogs": [
		{
			"id": "ID",
			"performedBy": "ID",
			"objectId": "ID",
			"details": "Object",
			"ipAddress": "String",
			"actionObject": "String",
			"occurredAt": "Date",
			"actionType": "String",
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Financialreports API

List period financial/tax reports for admin/AUDIT purposes.

Rest Route

The listFinancialReports API REST controller can be triggered via the following route:

/v1/financialreports

Rest Request Parameters The listFinancialReports api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/financialreports

  axios({
    method: 'GET',
    url: '/v1/financialreports',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "financialReports",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"financialReports": [
		{
			"id": "ID",
			"period": "String",
			"cityTaxByLocation": "Object",
			"totalPayouts": "Double",
			"createdBy": "ID",
			"totalRefunds": "Double",
			"currency": "String",
			"generatedAt": "Date",
			"totalRevenue": "Double",
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Auditlog API

Record an admin/platform action/event in the audit log. Called from side-effect flows, not direct user.

Rest Route

The createAuditLog API REST controller can be triggered via the following route:

/v1/auditlogs

Rest Request Parameters

The createAuditLog api has got 6 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/auditlogs

  axios({
    method: 'POST',
    url: '/v1/auditlogs',
    data: {
            performedBy:"ID",  
            objectId:"ID",  
            details:"Object",  
            ipAddress:"String",  
            actionObject:"String",  
            actionType:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auditLog",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"auditLog": {
		"id": "ID",
		"performedBy": "ID",
		"objectId": "ID",
		"details": "Object",
		"ipAddress": "String",
		"actionObject": "String",
		"occurredAt": "Date",
		"actionType": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Create Localizationsetting API

Add a supported language/currency for global usage.

Rest Route

The createLocalizationSetting API REST controller can be triggered via the following route:

/v1/localizationsettings

Rest Request Parameters

The createLocalizationSetting api has got 5 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/localizationsettings

  axios({
    method: 'POST',
    url: '/v1/localizationsettings',
    data: {
            languageCode:"String",  
            effectiveFrom:"Date",  
            effectiveTo:"Date",  
            currencyCode:"String",  
            isCurrencyActive:"Boolean",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "localizationSetting",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"localizationSetting": {
		"id": "ID",
		"languageCode": "String",
		"effectiveFrom": "Date",
		"effectiveTo": "Date",
		"currencyCode": "String",
		"isCurrencyActive": "Boolean",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Admindisputeactions API

List all moderation/decision records by admins for disputes. Filter by disputeId/adminId.

Rest Route

The listAdminDisputeActions API REST controller can be triggered via the following route:

/v1/admindisputeactions

Rest Request Parameters The listAdminDisputeActions api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/admindisputeactions

  axios({
    method: 'GET',
    url: '/v1/admindisputeactions',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminDisputeActions",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"adminDisputeActions": [
		{
			"id": "ID",
			"disputeId": "ID",
			"actionTaken": "String",
			"notes": "Text",
			"adminId": "ID",
			"outcome": "String",
			"actionDate": "Date",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Admindisputeaction API

Admin records moderation/decision action on a dispute (creates audit log as side effect).

Rest Route

The createAdminDisputeAction API REST controller can be triggered via the following route:

/v1/admindisputeactions

Rest Request Parameters

The createAdminDisputeAction api has got 5 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/admindisputeactions

  axios({
    method: 'POST',
    url: '/v1/admindisputeactions',
    data: {
            disputeId:"ID",  
            actionTaken:"String",  
            notes:"Text",  
            adminId:"ID",  
            outcome:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminDisputeAction",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"adminDisputeAction": {
		"id": "ID",
		"disputeId": "ID",
		"actionTaken": "String",
		"notes": "Text",
		"adminId": "ID",
		"outcome": "String",
		"actionDate": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Localizationsetting API

Update a localization setting. Admin only.

Rest Route

The updateLocalizationSetting API REST controller can be triggered via the following route:

/v1/localizationsettings/:localizationSettingId

Rest Request Parameters

The updateLocalizationSetting api has got 6 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/localizationsettings/:localizationSettingId

  axios({
    method: 'PATCH',
    url: `/v1/localizationsettings/${localizationSettingId}`,
    data: {
            languageCode:"String",  
            effectiveFrom:"Date",  
            effectiveTo:"Date",  
            currencyCode:"String",  
            isCurrencyActive:"Boolean",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "localizationSetting",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"localizationSetting": {
		"id": "ID",
		"languageCode": "String",
		"effectiveFrom": "Date",
		"effectiveTo": "Date",
		"currencyCode": "String",
		"isCurrencyActive": "Boolean",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Gdpraction API

Compliance admin records status of a GDPR request (pending/complete/failed). No delete allowed for compliance records.

Rest Route

The updateGdprAction API REST controller can be triggered via the following route:

/v1/gdpractions/:gdprActionId

Rest Request Parameters

The updateGdprAction api has got 3 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/gdpractions/:gdprActionId

  axios({
    method: 'PATCH',
    url: `/v1/gdpractions/${gdprActionId}`,
    data: {
            status:"Enum",  
            processedAt:"Date",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "gdprAction",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"gdprAction": {
		"id": "ID",
		"requestedAt": "Date",
		"status": "Enum",
		"status_idx": "Integer",
		"actionType": "String",
		"userId": "ID",
		"processedAt": "Date",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

List Gdpractions API

List all GDPR/compliance records with status for audit/compliance purposes.

Rest Route

The listGdprActions API REST controller can be triggered via the following route:

/v1/gdpractions

Rest Request Parameters The listGdprActions api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/gdpractions

  axios({
    method: 'GET',
    url: '/v1/gdpractions',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "gdprActions",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"gdprActions": [
		{
			"id": "ID",
			"requestedAt": "Date",
			"status": "Enum",
			"status_idx": "Integer",
			"actionType": "String",
			"userId": "ID",
			"processedAt": "Date",
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Apikey API

Create/administer an API key (for integrations, partners, automation). Key is hashed at rest.

Rest Route

The createApiKey API REST controller can be triggered via the following route:

/v1/apikeys

Rest Request Parameters

The createApiKey api has got 5 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/apikeys

  axios({
    method: 'POST',
    url: '/v1/apikeys',
    data: {
            key:"String",  
            active:"Boolean",  
            description:"String",  
            revokedAt:"Date",  
            createdBy:"ID",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "apiKey",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"apiKey": {
		"id": "ID",
		"key": "String",
		"active": "Boolean",
		"description": "String",
		"revokedAt": "Date",
		"createdBy": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Apikeys API

Show all API keys with status (hash only, never show the sensitive key string itself).

Rest Route

The listApiKeys API REST controller can be triggered via the following route:

/v1/apikeys

Rest Request Parameters The listApiKeys api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/apikeys

  axios({
    method: 'GET',
    url: '/v1/apikeys',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "apiKeys",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"apiKeys": [
		{
			"id": "ID",
			"key": "String",
			"active": "Boolean",
			"description": "String",
			"revokedAt": "Date",
			"createdBy": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Apikey API

Update API key metadata or deactivate (e.g. revoke). Only admin allowed.

Rest Route

The updateApiKey API REST controller can be triggered via the following route:

/v1/apikeys/:apiKeyId

Rest Request Parameters

The updateApiKey api has got 4 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/apikeys/:apiKeyId

  axios({
    method: 'PATCH',
    url: `/v1/apikeys/${apiKeyId}`,
    data: {
            active:"Boolean",  
            description:"String",  
            revokedAt:"Date",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "apiKey",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"apiKey": {
		"id": "ID",
		"key": "String",
		"active": "Boolean",
		"description": "String",
		"revokedAt": "Date",
		"createdBy": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Localizationsettings API

Show all currently configured languages/currencies.

Rest Route

The listLocalizationSettings API REST controller can be triggered via the following route:

/v1/localizationsettings

Rest Request Parameters The listLocalizationSettings api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/localizationsettings

  axios({
    method: 'GET',
    url: '/v1/localizationsettings',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "localizationSettings",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"localizationSettings": [
		{
			"id": "ID",
			"languageCode": "String",
			"effectiveFrom": "Date",
			"effectiveTo": "Date",
			"currencyCode": "String",
			"isCurrencyActive": "Boolean",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Gdpraction API

User/admin submits GDPR request (export/delete/consent). Logged for compliance; status may be updated by compliance admin only.

Rest Route

The createGdprAction API REST controller can be triggered via the following route:

/v1/gdpractions

Rest Request Parameters

The createGdprAction api has got 3 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/gdpractions

  axios({
    method: 'POST',
    url: '/v1/gdpractions',
    data: {
            actionType:"String",  
            userId:"ID",  
            processedAt:"Date",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "gdprAction",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"gdprAction": {
		"id": "ID",
		"requestedAt": "Date",
		"status": "Enum",
		"status_idx": "Integer",
		"actionType": "String",
		"userId": "ID",
		"processedAt": "Date",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.