LINKEDIN

FRONTEND GUIDE FOR AI CODING AGENTS - PART 10 - Profile Service

This document is a part of a REST API guide for the linkedin 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 profile

Service Access

Profile service management is handled through service specific base urls.

Profile 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 profile service, the base URLs are:

• Preview: https://linkedin.prw.mindbricks.com/profile-api
• Staging: https://linkedin-stage.mindbricks.co/profile-api
• Production: https://linkedin.mindbricks.co/profile-api

Scope

Profile Service Description

Handles user professional profiles, including experience, education, skills, languages, certifications, profile photo, and visibility controls. Enables recruiter search, elastic-style indexing, and profile editing, with all data linked to authenticated users..

Profile service provides apis and business logic for following data objects in linkedin 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.

profile Data Object: Professional profile for a user, includes core info and arrays of experience/education/skills. One profile per user...

premiumsubscription Data Object: premium subscription for a user

certification Data Object: Official certification available for selection in user profile (dictionary only, not user relation).

language Data Object: Official language available for selection in user profile (dictionary only, not user relation).

sys_premiumsubscriptionPayment Data Object: A payment storage object to store the payment life cyle of orders based on premiumsubscription object. It is autocreated based on the source object's checkout config

sys_paymentCustomer Data Object: A payment storage object to store the customer values of the payment platform

sys_paymentMethod Data Object: A payment storage object to store the payment methods of the platform customers

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 Linkedin 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

"linkedin-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.

Profile Data Object

Professional profile for a user, includes core info and arrays of experience/education/skills. One profile per user...

Profile Data Object Properties

Profile 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.

Array Properties

languages skills experience education certifications

Array properties can hold multiple values. Array properties should be respected according to their multiple structure in the frontend in any user input for them. Please use multiple input components for the array proeprties when needed.

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.

• profileVisibility: [public, private]

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

Filter Properties

headline fullName currentCompany industry location

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.

• headline: String has a filter named headline

• fullName: String has a filter named fullName

• currentCompany: String has a filter named currentCompany

• industry: String has a filter named industry

• location: String has a filter named location

Premiumsubscription Data Object

premium subscription for a user

Premiumsubscription Data Object Properties

Premiumsubscription 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.

• _paymentConfirmation: [pending, processing, paid, canceled]

Relation Properties

profileId 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.

• profileId: ID Relation to profile.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

• 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

Filter Properties

profileId currency status price userId _paymentConfirmation

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.

• profileId: ID has a filter named subscriptionProfileId

• currency: String has a filter named subscriptionCurrency

• status: String has a filter named subscriptionStatus

• price: Double has a filter named subscriptionPrice

• userId: ID has a filter named subscriptionUserId

• _paymentConfirmation: Enum has a filter named _paymentConfirmation

Certification Data Object

Official certification available for selection in user profile (dictionary only, not user relation).

Certification Data Object Properties

Certification 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

name

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.

• name: String has a filter named name

Language Data Object

Official language available for selection in user profile (dictionary only, not user relation).

Language Data Object Properties

Language 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

name

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.

• name: String has a filter named name

Sys_premiumsubscriptionPayment Data Object

A payment storage object to store the payment life cyle of orders based on premiumsubscription object. It is autocreated based on the source object's checkout config

Sys_premiumsubscriptionPayment Data Object Properties

Sys_premiumsubscriptionPayment 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

ownerId orderId paymentId paymentStatus statusLiteral redirectUrl

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.

• ownerId: ID has a filter named ownerId

• orderId: ID has a filter named orderId

• paymentId: String has a filter named paymentId

• paymentStatus: String has a filter named paymentStatus

• statusLiteral: String has a filter named statusLiteral

• redirectUrl: String has a filter named redirectUrl

Sys_paymentCustomer Data Object

A payment storage object to store the customer values of the payment platform

Sys_paymentCustomer Data Object Properties

Sys_paymentCustomer 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

userId customerId platform

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.

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• platform: String has a filter named platform

Sys_paymentMethod Data Object

A payment storage object to store the payment methods of the platform customers

Sys_paymentMethod Data Object Properties

Sys_paymentMethod 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

paymentMethodId userId customerId cardHolderName cardHolderZip platform cardInfo

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.

• paymentMethodId: String has a filter named paymentMethodId

• userId: ID has a filter named userId

• customerId: String has a filter named customerId

• cardHolderName: String has a filter named cardHolderName

• cardHolderZip: String has a filter named cardHolderZip

• platform: String has a filter named platform

• cardInfo: Object has a filter named cardInfo

API Reference

Update Profile API

Updates the profile of the authenticated user. Includes visibility settings, skills, experience, etc.

Rest Route

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

/v1/profiles/:profileId

Rest Request Parameters

The updateProfile api has got 14 request parameters

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

  axios({
    method: 'PATCH',
    url: `/v1/profiles/${profileId}`,
    data: {
            summary:"Text",  
            headline:"String",  
            profilePhotoUrl:"String",  
            fullName:"String",  
            currentCompany:"String",  
            industry:"String",  
            languages:"String",  
            skills:"String",  
            location:"String",  
            experience:"Object",  
            profileVisibility:"Enum",  
            education:"Object",  
            certifications:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "profile",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"profile": {
		"id": "ID",
		"summary": "Text",
		"headline": "String",
		"profilePhotoUrl": "String",
		"userId": "ID",
		"fullName": "String",
		"currentCompany": "String",
		"industry": "String",
		"languages": "String",
		"skills": "String",
		"location": "String",
		"experience": "Object",
		"profileVisibility": "Enum",
		"profileVisibility_idx": "Integer",
		"education": "Object",
		"certifications": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Profile API

Deletes the profile of the authenticated user (soft delete).

Rest Route

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

/v1/profiles/:profileId

Rest Request Parameters

The deleteProfile api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/profiles/:profileId

  axios({
    method: 'DELETE',
    url: `/v1/profiles/${profileId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "profile",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"profile": {
		"id": "ID",
		"summary": "Text",
		"headline": "String",
		"profilePhotoUrl": "String",
		"userId": "ID",
		"fullName": "String",
		"currentCompany": "String",
		"industry": "String",
		"languages": "String",
		"skills": "String",
		"location": "String",
		"experience": "Object",
		"profileVisibility": "Enum",
		"profileVisibility_idx": "Integer",
		"education": "Object",
		"certifications": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Language API

Deletes a language entry from the dictionary.

Rest Route

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

/v1/languages/:languageId

Rest Request Parameters

The deleteLanguage api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/languages/:languageId

  axios({
    method: 'DELETE',
    url: `/v1/languages/${languageId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "language",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"language": {
		"id": "ID",
		"name": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Language API

Edit an existing language entry.

Rest Route

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

/v1/languages/:languageId

Rest Request Parameters

The updateLanguage api has got 1 request parameter

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

  axios({
    method: 'PATCH',
    url: `/v1/languages/${languageId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

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

List Profiles API

Lists profiles by search/filter. Only public profiles are listed, unless the current user is the owner.

Rest Route

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

/v1/profiles

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "profiles",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"profiles": [
		{
			"id": "ID",
			"summary": "Text",
			"headline": "String",
			"profilePhotoUrl": "String",
			"userId": "ID",
			"fullName": "String",
			"currentCompany": "String",
			"industry": "String",
			"languages": "String",
			"skills": "String",
			"location": "String",
			"experience": "Object",
			"profileVisibility": "Enum",
			"profileVisibility_idx": "Integer",
			"education": "Object",
			"certifications": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Languages API

Lists all available languages for profile selection.

Rest Route

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

/v1/languages

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

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

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

REST Response

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

Get Language API

Retrieves a language entry by ID.

Rest Route

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

/v1/languages/:languageId

Rest Request Parameters

The getLanguage api has got 1 request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "language",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"language": {
		"id": "ID",
		"name": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Language API

Add a new language to the dictionary for user profiles. Must be unique by name.

Rest Route

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

/v1/languages

Rest Request Parameters

The createLanguage api has got 1 request parameter

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

  axios({
    method: 'POST',
    url: '/v1/languages',
    data: {
            name:"String",  
    
    },
    params: {
    
    }
  });

REST Response

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

Create Profile API

Creates a new professional profile for the authenticated user. Each user can create only one profile.

Rest Route

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

/v1/profiles

Rest Request Parameters

The createProfile api has got 13 request parameters

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

  axios({
    method: 'POST',
    url: '/v1/profiles',
    data: {
            summary:"Text",  
            headline:"String",  
            profilePhotoUrl:"String",  
            fullName:"String",  
            currentCompany:"String",  
            industry:"String",  
            languages:"String",  
            skills:"String",  
            location:"String",  
            experience:"Object",  
            profileVisibility:"Enum",  
            education:"Object",  
            certifications:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "profile",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"profile": {
		"id": "ID",
		"summary": "Text",
		"headline": "String",
		"profilePhotoUrl": "String",
		"userId": "ID",
		"fullName": "String",
		"currentCompany": "String",
		"industry": "String",
		"languages": "String",
		"skills": "String",
		"location": "String",
		"experience": "Object",
		"profileVisibility": "Enum",
		"profileVisibility_idx": "Integer",
		"education": "Object",
		"certifications": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Profile API

Retrieves a user profile by ID. If private, only the owner can get; if public, anyone can view.

Rest Route

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

/v1/profiles/:profileId

Rest Request Parameters

The getProfile api has got 1 request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "profile",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"profile": {
		"id": "ID",
		"summary": "Text",
		"headline": "String",
		"profilePhotoUrl": "String",
		"userId": "ID",
		"fullName": "String",
		"currentCompany": "String",
		"industry": "String",
		"languages": "String",
		"skills": "String",
		"location": "String",
		"experience": "Object",
		"profileVisibility": "Enum",
		"profileVisibility_idx": "Integer",
		"education": "Object",
		"certifications": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Premuimsub API

Rest Route

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

/v1/premuimsub/:premiumsubscriptionId

Rest Request Parameters

The deletePremuimSub api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/premuimsub/:premiumsubscriptionId

  axios({
    method: 'DELETE',
    url: `/v1/premuimsub/${premiumsubscriptionId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "premiumsubscription",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"premiumsubscription": {
		"id": "ID",
		"profileId": "ID",
		"currency": "String",
		"status": "String",
		"price": "Double",
		"userId": "ID",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Certification API

Edit an existing certification entry.

Rest Route

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

/v1/certifications/:certificationId

Rest Request Parameters

The updateCertification api has got 1 request parameter

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

  axios({
    method: 'PATCH',
    url: `/v1/certifications/${certificationId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

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

Create Premuimsub API

Rest Route

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

/v1/premuimsub

Rest Request Parameters

The createPremuimSub api has got 5 request parameters

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

  axios({
    method: 'POST',
    url: '/v1/premuimsub',
    data: {
            profileId:"ID",  
            currency:"String",  
            status:"String",  
            price:"Double",  
            userId:"ID",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "premiumsubscription",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"premiumsubscription": {
		"id": "ID",
		"profileId": "ID",
		"currency": "String",
		"status": "String",
		"price": "Double",
		"userId": "ID",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Certifications API

Lists all available certifications for profile selection/display.

Rest Route

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

/v1/certifications

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

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

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

REST Response

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

Update Premuimsub API

Rest Route

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

/v1/premuimsub/:premiumsubscriptionId

Rest Request Parameters

The updatePremuimSub api has got 6 request parameters

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

  axios({
    method: 'PATCH',
    url: `/v1/premuimsub/${premiumsubscriptionId}`,
    data: {
            profileId:"ID",  
            currency:"String",  
            status:"String",  
            price:"Double",  
            userId:"ID",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "premiumsubscription",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"premiumsubscription": {
		"id": "ID",
		"profileId": "ID",
		"currency": "String",
		"status": "String",
		"price": "Double",
		"userId": "ID",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Premuimsub API

Rest Route

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

/v1/premuimsub/:premiumsubscriptionId

Rest Request Parameters

The getPremuimSub api has got 1 request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "premiumsubscription",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"premiumsubscription": {
		"id": "ID",
		"profileId": "ID",
		"currency": "String",
		"status": "String",
		"price": "Double",
		"userId": "ID",
		"_paymentConfirmation": "Enum",
		"_paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Certification API

Add a new certification for user profiles. Must be unique by name.

Rest Route

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

/v1/certifications

Rest Request Parameters

The createCertification api has got 1 request parameter

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

  axios({
    method: 'POST',
    url: '/v1/certifications',
    data: {
            name:"String",  
    
    },
    params: {
    
    }
  });

REST Response

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

Get Certification API

Retrieves a certification entry by ID.

Rest Route

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

/v1/certifications/:certificationId

Rest Request Parameters

The getCertification api has got 1 request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "certification",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"certification": {
		"id": "ID",
		"name": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Premuimsub API

Rest Route

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

/v1/premuimsub

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

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

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

REST Response

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

Delete Certification API

Deletes a certification entry from the dictionary.

Rest Route

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

/v1/certifications/:certificationId

Rest Request Parameters

The deleteCertification api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/certifications/:certificationId

  axios({
    method: 'DELETE',
    url: `/v1/certifications/${certificationId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "certification",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"certification": {
		"id": "ID",
		"name": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Premiumsubscriptionpayment2 API

This route is used to get the payment information by ID.

Rest Route

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

/v1/premiumsubscriptionpayment2/:sys_premiumsubscriptionPaymentId

Rest Request Parameters

The getPremiumsubscriptionPayment2 api has got 1 request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Premiumsubscriptionpayments2 API

This route is used to list all payments.

Rest Route

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

/v1/premiumsubscriptionpayments2

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_premiumsubscriptionPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Premiumsubscriptionpayment API

This route is used to create a new payment.

Rest Route

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

/v1/premiumsubscriptionpayment

Rest Request Parameters

The createPremiumsubscriptionPayment api has got 5 request parameters

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

  axios({
    method: 'POST',
    url: '/v1/premiumsubscriptionpayment',
    data: {
            orderId:"ID",  
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Premiumsubscriptionpayment API

This route is used to update an existing payment.

Rest Route

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

/v1/premiumsubscriptionpayment/:sys_premiumsubscriptionPaymentId

Rest Request Parameters

The updatePremiumsubscriptionPayment api has got 5 request parameters

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

  axios({
    method: 'PATCH',
    url: `/v1/premiumsubscriptionpayment/${sys_premiumsubscriptionPaymentId}`,
    data: {
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Premiumsubscriptionpayment API

This route is used to delete a payment.

Rest Route

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

/v1/premiumsubscriptionpayment/:sys_premiumsubscriptionPaymentId

Rest Request Parameters

The deletePremiumsubscriptionPayment api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/premiumsubscriptionpayment/:sys_premiumsubscriptionPaymentId

  axios({
    method: 'DELETE',
    url: `/v1/premiumsubscriptionpayment/${sys_premiumsubscriptionPaymentId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Premiumsubscriptionpayments2 API

This route is used to list all payments.

Rest Route

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

/v1/premiumsubscriptionpayments2

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_premiumsubscriptionPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Get Premiumsubscriptionpaymentbyorderid API

This route is used to get the payment information by order id.

Rest Route

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

/v1/premiumsubscriptionpaymentbyorderid/:orderId

Rest Request Parameters

The getPremiumsubscriptionPaymentByOrderId api has got 2 request parameters

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Premiumsubscriptionpaymentbypaymentid API

This route is used to get the payment information by payment id.

Rest Route

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

/v1/premiumsubscriptionpaymentbypaymentid/:paymentId

Rest Request Parameters

The getPremiumsubscriptionPaymentByPaymentId api has got 2 request parameters

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_premiumsubscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_premiumsubscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Premiumsubscriptionpayment2 API

This route is used to get the payment information by ID.

Rest Route

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

/v1/premiumsubscriptionpayment2/:sys_premiumsubscriptionPaymentId

Rest Request Parameters

The getPremiumsubscriptionPayment2 api has got 1 request parameter