rest-api-guide • 12/31/2025

REST API GUIDE

linkedin-profile-service

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

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the Profile Service's REST API. This document is designed to provide a comprehensive guide to interfacing with our Profile Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the Profile Service via HTTP requests for purposes such as creating, updating, deleting and querying Profile objects.

Overview

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST It's important to note that the Profile Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

Authentication And Authorization

To ensure secure access to the Profile service's protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it's important to note that access control varies across different routes:

Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

Token Locations

When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

Location	Token Name / Param Name
Query	access_token
Authorization Header	Bearer
Header	linkedin-access-token
Cookie	linkedin-access-token

Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.

Api Definitions

This section outlines the API endpoints available within the Profile service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It's important to understand the flexibility in how parameters can be included in requests to effectively interact with the Profile service.

This service is configured to listen for HTTP requests on port 3001, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

API Test Interface (API Face): /
Swagger Documentation: /swagger
Postman Collection Download: /getPostmanCollection
Health Checks: /health and /admin/health
Current Session Info: /currentuser
Favicon: /favicon.ico

This service is accessible via the following environment-specific URLs:

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

Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

Query Parameters: Included directly in the URL's query string.

Path Parameters: Embedded within the URL's path.

Body Parameters: Sent within the JSON body of the request.

Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user's session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user's session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the Profile service's API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

Common Parameters

The Profile service's business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

getJoins (BOOLEAN): Controls whether to retrieve associated objects along with the main object. By default, getJoins is assumed to be true. Set it to false if you prefer to receive only the main fields of an object, excluding its associations.
excludeCQRS (BOOLEAN): Applicable only when getJoins is true. By default, excludeCQRS is set to false. Enabling this parameter (true) omits non-local associations, which are typically more resource-intensive as they require querying external services like ElasticSearch for additional information. Use this to optimize response times and resource usage.
requestId (String): Identifies a request to enable tracking through the service's log chain. A random hex string of 32 characters is assigned by default. If you wish to use a custom requestId, simply include it in your query parameters.
caching (BOOLEAN): Determines the use of caching for query API. By default, caching is enabled (true). To ensure the freshest data directly from the database, set this parameter to false, bypassing the cache.
cacheTTL (Integer): Specifies the Time-To-Live (TTL) for query caching, in seconds. This is particularly useful for adjusting the default caching duration (5 minutes) for get list queries. Setting a custom cacheTTL allows you to fine-tune the cache lifespan to meet your needs.
pageNumber (Integer): For paginated get list API's, this parameter selects which page of results to retrieve. The default is 1, indicating the first page. To disable pagination and retrieve all results, set pageNumber to 0.
pageRowCount (Integer): In conjunction with paginated API's, this parameter defines the number of records per page. The default value is 25. Adjusting pageRowCount allows you to control the volume of data returned in a single request.

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the Profile service.

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 within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

400 Bad Request: The request was improperly formatted or contained invalid parameters, preventing the server from processing it.
401 Unauthorized: The request lacked valid authentication credentials or the credentials provided do 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 that prevented it from fulfilling the request.

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

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

Object Structure of a Successfull Response

When the Profile service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

Key Characteristics of the Response Envelope:

Data Presentation: Depending on the nature of the request, the service returns either a single data object or an array of objects encapsulated within the JSON envelope.
- Creation and Update API: These API routes return the unmodified (pure) form of the data object(s), without any associations to other data objects.
- Delete API: Even though the data is removed from the database, the last known state of the data object(s) is returned in its pure form.
- Get Requests: A single data object is returned in JSON format.
- Get List Requests: An array of data objects is provided, reflecting a collection of resources.
Data Structure and Joins: The complexity of the data structure in the response can vary based on the API's architectural design and the join options specified in the request. The architecture might inherently limit join operations, or they might be dynamically controlled through query parameters.
- Pure Data Forms: In some cases, the response mirrors the exact structure found in the primary data table, without extensions.
- Extended Data Forms: Alternatively, responses might include data extended through joins with tables within the same service or aggregated from external sources, such as ElasticSearch indices related to other services.
- Join Varieties: The extensions might involve one-to-one joins, resulting in single object associations, or one-to-many joins, leading to an array of objects. In certain instances, the data might even feature nested inclusions from other data objects.

Design Considerations: The structure of a API's response data is meticulously crafted during the service's architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

Brief Data: Certain API's return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

HTTP Status Codes:

200 OK: This status code is returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request has been processed successfully.
201 Created: This status code is specific to CREATE operations, signifying that the requested resource has been successfully created.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. 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 performed.

Handling Errors:

For details on handling error scenarios and understanding the structure of error responses, please refer to the "Error Response" section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

Resources

Profile service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

Profile resource

Resource Definition : Professional profile for a user, includes core info and arrays of experience/education/skills. One profile per user... Profile Resource Properties

Name	Type	Definition
summary	Text	Profile summary (bio/description).
headline	String	Short tagline or headline for profile.
profilePhotoUrl	String	URL for profile photo/avatar.
userId	ID	Foreign key to auth:user. Owner of the profile. Single profile per user.
fullName	String	Full name for display/search.
currentCompany	String	Current employer/company, free text for now.
industry	String	Industry sector name for profile.
languages	String	Array of language names as string, links to language object (lookup/filter only).
skills	String	List of professional skills (free-form tags).
location	String	Location information (city, country, etc.)
experience	Object	Array of experienceItem objects (job history).
profileVisibility	Enum	Controls who can view profile: public or private. Used in search/list visibility.
education	Object	Array of educationItem objects (degrees/certificates).
certifications	String	Professional certifications by name, links to certification object.

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

profileVisibility Enum Property

Property Definition : Controls who can view profile: public or private. Used in search/list visibility.Enum Options

Name	Value	Index
public	`"public""`	0
private	`"private""`	1

Premiumsubscription resource

Resource Definition : premium subscription for a user Premiumsubscription Resource Properties

Name	Type	Definition
profileId	ID	the profile id of the subscription
currency	String	currency
status	String	**
price	Double	the price of the subscription
userId	ID	the userid of the subscription
_paymentConfirmation	Enum	An automatic property that is used to check the confirmed status of the payment set by webhooks.

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

_paymentConfirmation Enum Property

Property Definition : An automatic property that is used to check the confirmed status of the payment set by webhooks.Enum Options

Name	Value	Index
pending	`"pending""`	0
processing	`"processing""`	1
paid	`"paid""`	2
canceled	`"canceled""`	3

Certification resource

Resource Definition : Official certification available for selection in user profile (dictionary only, not user relation). Certification Resource Properties

Name	Type	Required	Default	Definition
name	String			Unique certification name (e.g. PMP, CFA, AWS Certified).

Language resource

Resource Definition : Official language available for selection in user profile (dictionary only, not user relation). Language Resource Properties

Name	Type	Required	Default	Definition
name	String			Unique language name (e.g. English, Spanish).

Sys_premiumsubscriptionPayment resource

Resource Definition : 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 Resource Properties

Name	Type	Definition
ownerId	ID	* An ID value to represent owner user who created the order*
orderId	ID	an ID value to represent the orderId which is the ID parameter of the source premiumsubscription object
paymentId	String	A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
paymentStatus	String	A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
statusLiteral	String	A string value to represent the logical payment status which belongs to the application lifecycle itself.
redirectUrl	String	A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

Sys_paymentCustomer resource

Resource Definition : A payment storage object to store the customer values of the payment platform Sys_paymentCustomer Resource Properties

Name	Type	Definition
userId	ID	* An ID value to represent the user who is created as a stripe customer*
customerId	String	A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway
platform	String	A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

Sys_paymentMethod resource

Resource Definition : A payment storage object to store the payment methods of the platform customers Sys_paymentMethod Resource Properties

Name	Type	Definition
paymentMethodId	String	A string value to represent the id of the payment method on the payment platform.
userId	ID	* An ID value to represent the user who owns the payment method*
customerId	String	A string value to represent the customer id which is generated on the payment gateway.
cardHolderName	String	A string value to represent the name of the card holder. It can be different than the registered customer.
cardHolderZip	String	A string value to represent the zip code of the card holder. It is used for address verification in specific countries.
platform	String	A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.
cardInfo	Object	A Json value to store the card details of the payment method.

Business Api

Update Profile API

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

API Crud Type : update

Default access route : PATCH /v1/profiles/:profileId

Parameters

The updateProfile api has got 14 parameters

Parameter	Type	Required	Population
profileId	ID	true	request.params?.profileId
summary	Text	false	request.body?.summary
headline	String	false	request.body?.headline
profilePhotoUrl	String	false	request.body?.profilePhotoUrl
fullName	String	false	request.body?.fullName
currentCompany	String	false	request.body?.currentCompany
industry	String	false	request.body?.industry
languages	String	false	request.body?.languages
skills	String	false	request.body?.skills
location	String	false	request.body?.location
experience	Object	false	request.body?.experience
profileVisibility	Enum	true	request.body?.profileVisibility
education	Object	false	request.body?.education
certifications	String	false	request.body?.certifications

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: {
    
    }
  });

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the "Error Response" section.

Following JSON represents the most comprehensive form of the profile object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Profile.

Delete Profile API

API Definition : Deletes the profile of the authenticated user (soft delete).

API Crud Type : delete

Default access route : DELETE /v1/profiles/:profileId

Parameters

The deleteProfile api has got 1 parameter

Parameter	Type	Required	Population
profileId	ID	true	request.params?.profileId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the profile object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Profile.

Delete Language API

API Definition : Deletes a language entry from the dictionary.

API Crud Type : delete

Default access route : DELETE /v1/languages/:languageId

Parameters

The deleteLanguage api has got 1 parameter

Parameter	Type	Required	Population
languageId	ID	true	request.params?.languageId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the language object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Language.

Update Language API

API Definition : Edit an existing language entry.

API Crud Type : update

Default access route : PATCH /v1/languages/:languageId

Parameters

The updateLanguage api has got 1 parameter

Parameter	Type	Required	Population
languageId	ID	true	request.params?.languageId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the language object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Language.

List Profiles API

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

API Crud Type : list

Default access route : GET /v1/profiles

The listProfiles api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the profiles object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Profiles.

List Languages API

API Definition : Lists all available languages for profile selection.

API Crud Type : list

Default access route : GET /v1/languages

The listLanguages api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the languages object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Languages.

Get Language API

API Definition : Retrieves a language entry by ID.

API Crud Type : get

Default access route : GET /v1/languages/:languageId

Parameters

The getLanguage api has got 1 parameter

Parameter	Type	Required	Population
languageId	ID	true	request.params?.languageId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the language object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Language.

Create Language API

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

API Crud Type : create

Default access route : POST /v1/languages

Parameters

The createLanguage api has got 1 parameter

Parameter	Type	Required	Population
name	String	true	request.body?.name

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the language object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Language.

Create Profile API

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

API Crud Type : create

Default access route : POST /v1/profiles

Parameters

The createProfile api has got 13 parameters

Parameter	Type	Required	Population
summary	Text	false	request.body?.summary
headline	String	false	request.body?.headline
profilePhotoUrl	String	false	request.body?.profilePhotoUrl
fullName	String	true	request.body?.fullName
currentCompany	String	false	request.body?.currentCompany
industry	String	false	request.body?.industry
languages	String	false	request.body?.languages
skills	String	false	request.body?.skills
location	String	false	request.body?.location
experience	Object	false	request.body?.experience
profileVisibility	Enum	true	request.body?.profileVisibility
education	Object	false	request.body?.education
certifications	String	false	request.body?.certifications

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the profile object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Profile.

Get Profile API

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

API Crud Type : get

Default access route : GET /v1/profiles/:profileId

Parameters

The getProfile api has got 1 parameter

Parameter	Type	Required	Population
profileId	ID	true	request.params?.profileId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the profile object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Profile.

Delete Premuimsub API

API Crud Type : delete

Default access route : DELETE /v1/premuimsub/:premiumsubscriptionId

Parameters

The deletePremuimSub api has got 1 parameter

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.params?.premiumsubscriptionId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Premuimsub.

Update Certification API

API Definition : Edit an existing certification entry.

API Crud Type : update

Default access route : PATCH /v1/certifications/:certificationId

Parameters

The updateCertification api has got 1 parameter

Parameter	Type	Required	Population
certificationId	ID	true	request.params?.certificationId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the certification object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Certification.

Create Premuimsub API

API Crud Type : create

Default access route : POST /v1/premuimsub

Parameters

The createPremuimSub api has got 5 parameters

Parameter	Type	Required	Population
profileId	ID	true	request.body?.profileId
currency	String	true	request.body?.currency
status	String	true	request.body?.status
price	Double	true	request.body?.price
userId	ID	true	request.body?.userId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Premuimsub.

List Certifications API

API Definition : Lists all available certifications for profile selection/display.

API Crud Type : list

Default access route : GET /v1/certifications

The listCertifications api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the certifications object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Certifications.

Update Premuimsub API

API Crud Type : update

Default access route : PATCH /v1/premuimsub/:premiumsubscriptionId

Parameters

The updatePremuimSub api has got 6 parameters

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.params?.premiumsubscriptionId
profileId	ID	false	request.body?.profileId
currency	String	false	request.body?.currency
status	String	false	request.body?.status
price	Double	false	request.body?.price
userId	ID	false	request.body?.userId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Premuimsub.

Get Premuimsub API

API Crud Type : get

Default access route : GET /v1/premuimsub/:premiumsubscriptionId

Parameters

The getPremuimSub api has got 1 parameter

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.params?.premiumsubscriptionId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Premuimsub.

Create Certification API

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

API Crud Type : create

Default access route : POST /v1/certifications

Parameters

The createCertification api has got 1 parameter

Parameter	Type	Required	Population
name	String	true	request.body?.name

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the certification object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Certification.

Get Certification API

API Definition : Retrieves a certification entry by ID.

API Crud Type : get

Default access route : GET /v1/certifications/:certificationId

Parameters

The getCertification api has got 1 parameter

Parameter	Type	Required	Population
certificationId	ID	true	request.params?.certificationId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the certification object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Certification.

List Premuimsub API

API Crud Type : list

Default access route : GET /v1/premuimsub

The listPremuimSub api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the premiumsubscriptions object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Premuimsub.

Delete Certification API

API Definition : Deletes a certification entry from the dictionary.

API Crud Type : delete

Default access route : DELETE /v1/certifications/:certificationId

Parameters

The deleteCertification api has got 1 parameter

Parameter	Type	Required	Population
certificationId	ID	true	request.params?.certificationId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the certification object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Certification.

Get Premiumsubscriptionpayment2 API

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

API Crud Type : get

Default access route : GET /v1/premiumsubscriptionpayment2/:sys_premiumsubscriptionPaymentId

Parameters

The getPremiumsubscriptionPayment2 api has got 1 parameter

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Premiumsubscriptionpayment2.

List Premiumsubscriptionpayments2 API

API Definition : This route is used to list all payments.

API Crud Type : list

Default access route : GET /v1/premiumsubscriptionpayments2

The listPremiumsubscriptionPayments2 api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayments object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Premiumsubscriptionpayments2.

Create Premiumsubscriptionpayment API

API Definition : This route is used to create a new payment.

API Crud Type : create

Default access route : POST /v1/premiumsubscriptionpayment

Parameters

The createPremiumsubscriptionPayment api has got 5 parameters

Parameter	Type	Required	Population
orderId	ID	true	request.body?.orderId
paymentId	String	true	request.body?.paymentId
paymentStatus	String	true	request.body?.paymentStatus
statusLiteral	String	true	request.body?.statusLiteral
redirectUrl	String	false	request.body?.redirectUrl

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Create Premiumsubscriptionpayment.

Update Premiumsubscriptionpayment API

API Definition : This route is used to update an existing payment.

API Crud Type : update

Default access route : PATCH /v1/premiumsubscriptionpayment/:sys_premiumsubscriptionPaymentId

Parameters

The updatePremiumsubscriptionPayment api has got 5 parameters

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId
paymentId	String	false	request.body?.paymentId
paymentStatus	String	false	request.body?.paymentStatus
statusLiteral	String	false	request.body?.statusLiteral
redirectUrl	String	false	request.body?.redirectUrl

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Update Premiumsubscriptionpayment.

Delete Premiumsubscriptionpayment API

API Definition : This route is used to delete a payment.

API Crud Type : delete

Default access route : DELETE /v1/premiumsubscriptionpayment/:sys_premiumsubscriptionPaymentId

Parameters

The deletePremiumsubscriptionPayment api has got 1 parameter

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Delete Premiumsubscriptionpayment.

List Premiumsubscriptionpayments2 API

API Definition : This route is used to list all payments.

API Crud Type : list

Default access route : GET /v1/premiumsubscriptionpayments2

The listPremiumsubscriptionPayments2 api has got no parameters.

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

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

{"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":[]}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Premiumsubscriptionpayments2.

Get Premiumsubscriptionpaymentbyorderid API

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

API Crud Type : get

Default access route : GET /v1/premiumsubscriptionpaymentbyorderid/:orderId

Parameters

The getPremiumsubscriptionPaymentByOrderId api has got 2 parameters

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId
orderId	String	true	request.params?.orderId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Premiumsubscriptionpaymentbyorderid.

Get Premiumsubscriptionpaymentbypaymentid API

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

API Crud Type : get

Default access route : GET /v1/premiumsubscriptionpaymentbypaymentid/:paymentId

Parameters

The getPremiumsubscriptionPaymentByPaymentId api has got 2 parameters

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId
paymentId	String	true	request.params?.paymentId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Premiumsubscriptionpaymentbypaymentid.

Get Premiumsubscriptionpayment2 API

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

API Crud Type : get

Default access route : GET /v1/premiumsubscriptionpayment2/:sys_premiumsubscriptionPaymentId

Parameters

The getPremiumsubscriptionPayment2 api has got 1 parameter

Parameter	Type	Required	Population
sys_premiumsubscriptionPaymentId	ID	true	request.params?.sys_premiumsubscriptionPaymentId

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: {
    
    }
  });

Following JSON represents the most comprehensive form of the sys_premiumsubscriptionPayment object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Premiumsubscriptionpayment2.

Start Premiumsubscriptionpayment API

API Definition : Start payment for premiumsubscription

API Crud Type : update

Default access route : PATCH /v1/startpremiumsubscriptionpayment/:premiumsubscriptionId

Parameters

The startPremiumsubscriptionPayment api has got 2 parameters

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.params?.premiumsubscriptionId
paymentUserParams	Object	false	request.body?.paymentUserParams

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

  axios({
    method: 'PATCH',
    url: `/v1/startpremiumsubscriptionpayment/${premiumsubscriptionId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Start Premiumsubscriptionpayment.

Refresh Premiumsubscriptionpayment API

API Definition : Refresh payment info for premiumsubscription from Stripe

API Crud Type : update

Default access route : PATCH /v1/refreshpremiumsubscriptionpayment/:premiumsubscriptionId

Parameters

The refreshPremiumsubscriptionPayment api has got 2 parameters

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.params?.premiumsubscriptionId
paymentUserParams	Object	false	request.body?.paymentUserParams

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

  axios({
    method: 'PATCH',
    url: `/v1/refreshpremiumsubscriptionpayment/${premiumsubscriptionId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"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"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Refresh Premiumsubscriptionpayment.

Callback Premiumsubscriptionpayment API

API Definition : Refresh payment values by gateway webhook call for premiumsubscription

API Crud Type : update

Default access route : POST /v1/callbackpremiumsubscriptionpayment

Parameters

The callbackPremiumsubscriptionPayment api has got 1 parameter

Parameter	Type	Required	Population
premiumsubscriptionId	ID	true	request.body?.premiumsubscriptionId

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

  axios({
    method: 'POST',
    url: '/v1/callbackpremiumsubscriptionpayment',
    data: {
            premiumsubscriptionId:"ID",  
    
    },
    params: {
    
    }
  });

Following JSON represents the most comprehensive form of the premiumsubscription object in the respones. However, some properties may be omitted based on the object's internal logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"premiumsubscription","method":"POST","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"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Callback Premiumsubscriptionpayment.

Get Paymentcustomerbyuserid API

API Definition : This route is used to get the payment customer information by user id.

API Crud Type : get

Default access route : GET /v1/paymentcustomers/:userId

Parameters

The getPaymentCustomerByUserId api has got 2 parameters

Parameter	Type	Required	Population
sys_paymentCustomerId	ID	true	request.params?.sys_paymentCustomerId
userId	String	true	request.params?.userId

To access the api you can use the REST controller with the path GET /v1/paymentcustomers/:userId

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

Following JSON represents the most comprehensive form of the sys_paymentCustomer object in the respones. However, some properties may be omitted based on the object's internal logic.

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

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For Get Paymentcustomerbyuserid.

List Paymentcustomers API

API Definition : This route is used to list all payment customers.

API Crud Type : list

Default access route : GET /v1/paymentcustomers

The listPaymentCustomers api has got no parameters.

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

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

Following JSON represents the most comprehensive form of the sys_paymentCustomers object in the respones. However, some properties may be omitted based on the object's internal logic.

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

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Paymentcustomers.

List Paymentcustomermethods API

API Definition : This route is used to list all payment customer methods.

API Crud Type : list

Default access route : GET /v1/paymentcustomermethods/:userId

Parameters

The listPaymentCustomerMethods api has got 1 parameter

Parameter	Type	Required	Population
userId	String	true	request.params?.userId

To access the api you can use the REST controller with the path GET /v1/paymentcustomermethods/:userId

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

Following JSON represents the most comprehensive form of the sys_paymentMethods object in the respones. However, some properties may be omitted based on the object's internal logic.

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

For a detailed description of the `` api with its internal and inter-service logic please refer to the Business API Specification Document For List Paymentcustomermethods.

Authentication Specific Routes

Common Routes

Route: currentuser

Route Definition: Retrieves the currently authenticated user's session information.

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

Returns the authenticated session object associated with the current access token.
If no valid session exists, responds with a 401 Unauthorized.

// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response Returns the session object, including user-related data and token information.

{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}

Error Response 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

Notes

This route is typically used by frontend or mobile applications to fetch the current session state after login.
The returned session includes key user identity fields, tenant information (if applicable), and the access token for further authenticated requests.
Always ensure a valid access token is provided in the request to retrieve the session.

Route: permissions

*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

Fetches all active permission records (givenPermissions entries) associated with the current user session.
Returns a full array of permission objects.
Requires a valid session (access token) to be available.

// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

Returns an array of permission objects.

[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]

Each object reflects a single permission grant, aligned with the givenPermissions model:

**permissionName**: The permission the user has.
**roleId**: If the permission was granted through a role. -**subjectUserId**: If directly granted to the user.
**subjectUserGroupId**: If granted through a group.
**objectId**: If tied to a specific object (OBAC).
**canDo**: True or false flag to represent if permission is active or restricted.

Error Responses

401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

500 Internal Server Error: Unexpected error fetching permissions.

Notes

The /permissions route is available across all backend services generated by Mindbricks, not just the auth service.
Auth service: Fetches permissions freshly from the live database (givenPermissions table).
Other services: Typically use a cached or projected view of permissions stored in a common ElasticSearch store, optimized for faster authorization checks.

Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

Route: permissions/:permissionName

Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

Parameter	Type	Required	Population
permissionName	String	Yes	`request.params.permissionName`

Behavior

Evaluates whether the current user has access to the given permissionName.
Returns a structured object indicating:
- Whether the permission is generally granted (canDo)
- Which object IDs are explicitly included or excluded from access (exceptions)
Requires a valid session (access token).

// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

{
  "canDo": true,
  "exceptions": [
    "a1f2e3d4-xxxx-yyyy-zzzz-object1",
    "b2c3d4e5-xxxx-yyyy-zzzz-object2"
  ]
}

If canDo is true, the user generally has the permission, but not for the objects listed in exceptions (i.e., restrictions).
If canDo is false, the user does not have the permission by default — but only for the objects in exceptions, they do have permission (i.e., selective overrides).
The exceptions array contains valid UUID strings, each corresponding to an object ID (typically from the data model targeted by the permission).

Copyright

All sources, documents and other digital materials are copyright of .

About Us

For more information please visit our website: .

. .

Menu

LinkedIn Clone

REST API GUIDE

linkedin-profile-service

Architectural Design Credit and Contact Information

Documentation Scope

Authentication And Authorization

Token Locations

Api Definitions

Common Parameters

Supported Common Parameters:

Error Response

Object Structure of a Successfull Response

API Response Structure

Resources

Profile resource

Enum Properties

profileVisibility Enum Property

Premiumsubscription resource

Enum Properties

_paymentConfirmation Enum Property

Certification resource

Language resource

Sys_premiumsubscriptionPayment resource

Sys_paymentCustomer resource

Sys_paymentMethod resource

Business Api

Update Profile API

Parameters

Delete Profile API

Parameters

Delete Language API

Parameters

Update Language API

Parameters

List Profiles API

List Languages API

Get Language API

Parameters

Create Language API

Parameters

Create Profile API

Parameters

Get Profile API

Parameters

Delete Premuimsub API

Parameters

Update Certification API

Parameters

Create Premuimsub API

Parameters

List Certifications API

Update Premuimsub API

Parameters

Get Premuimsub API

Parameters

Create Certification API

Parameters

Get Certification API

Parameters

List Premuimsub API

Delete Certification API

Parameters

Get Premiumsubscriptionpayment2 API

Parameters

List Premiumsubscriptionpayments2 API

Create Premiumsubscriptionpayment API

Parameters

Update Premiumsubscriptionpayment API

Parameters

Delete Premiumsubscriptionpayment API

Parameters

List Premiumsubscriptionpayments2 API

Get Premiumsubscriptionpaymentbyorderid API

Parameters

Get Premiumsubscriptionpaymentbypaymentid API

Parameters

Get Premiumsubscriptionpayment2 API

Parameters

Start Premiumsubscriptionpayment API