# **LINKEDIN** **FRONTEND GUIDE FOR AI CODING AGENTS - PART 7 - JobApplication 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 jobApplication ## Service Access JobApplication service management is handled through service specific base urls. JobApplication 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 jobApplication service, the base URLs are: * **Preview:** `https://linkedin.prw.mindbricks.com/jobapplication-api` * **Staging:** `https://linkedin-stage.mindbricks.co/jobapplication-api` * **Production:** `https://linkedin.mindbricks.co/jobapplication-api` ## Scope **JobApplication Service Description** Microservice handling job postings (created by recruiters/company admins), job applications (created by users), allowing job search, application submission, and status update workflows. Enforces business rules around application status, admin controls, and lets professionals apply and track job applications .within the network. JobApplication 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. **`jobPosting` Data Object**: Job posting entity representing an open position with a company. Created/managed by company admins or recruiters. Fields include companyId, postedByUserId, title, details, requirements, employment type, salary, deadline, etc. **`jobApplication` Data Object**: Record of a user applying for a specific jobPosting (tracks application/resume/status/audit). Each application is unique per user x jobPosting. ## 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: ```json { "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. ```js { "result": "ERR", "status": 400, "message": "errMsg_organizationIdisNotAValidID", "errCode": 400, "date": "2024-03-19T12:13:54.124Z", "detail": "String" } ``` ## JobPosting Data Object Job posting entity representing an open position with a company. Created/managed by company admins or recruiters. Fields include companyId, postedByUserId, title, details, requirements, employment type, salary, deadline, etc. ### JobPosting Data Object Properties JobPosting 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. | Property | Type | IsArray | Required | Secret | Description | |----------|------|---------|----------|--------|-------------| | `description` | Text | false | Yes | No | - | | `title` | String | false | Yes | No | - | | `applicationDeadline` | Date | false | No | No | - | | `companyId` | ID | false | No | No | - | | `employmentType` | Enum | false | Yes | No | - | | `postedByUserId` | ID | false | Yes | No | - | | `salaryRange` | String | false | No | No | - | | `location` | String | false | No | No | - | | `visibility` | Enum | false | Yes | No | - | | `workplaceType` | Enum | false | Yes | No | - | | `status` | Enum | false | Yes | No | - | | `companyName` | String | false | Yes | No | - | * 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. - **employmentType**: [full_time, part_time, contract, internship, volunteer, other, temporary] - **visibility**: [public, private] - **workplaceType**: [on_site, remote, hybrid] - **status**: [active, closed] ### Relation Properties `companyId` `postedByUserId` 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. - **companyId**: ID Relation to `company`.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 - **postedByUserId**: 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 `title` `applicationDeadline` `companyId` `employmentType` `postedByUserId` `location` `visibility` `workplaceType` `status` `companyName` 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. - **title**: String has a filter named `title` - **applicationDeadline**: Date has a filter named `applicationDeadline` - **companyId**: ID has a filter named `companyId` - **employmentType**: Enum has a filter named `employmentType` - **postedByUserId**: ID has a filter named `postedByUserId` - **location**: String has a filter named `location` - **visibility**: Enum has a filter named `visibility` - **workplaceType**: Enum has a filter named `workplaceType` - **status**: Enum has a filter named `status` - **companyName**: String has a filter named `companyName` ## JobApplication Data Object Record of a user applying for a specific jobPosting (tracks application/resume/status/audit). Each application is unique per user x jobPosting. ### JobApplication Data Object Properties JobApplication 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. | Property | Type | IsArray | Required | Secret | Description | |----------|------|---------|----------|--------|-------------| | `jobPostingId` | ID | false | Yes | No | - | | `applicantUserId` | ID | false | Yes | No | - | | `coverLetter` | Text | false | No | No | - | | `resumeUrl` | String | false | No | No | - | | `lastStatusUpdateAt` | Date | false | Yes | No | - | | `status` | Enum | false | Yes | No | - | | `appliedAt` | Date | false | Yes | No | - | * Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set. ### Enum Properties Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options. - **status**: [submitted, in_review, accepted, rejected] ### Relation Properties `jobPostingId` `applicantUserId` 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. - **jobPostingId**: ID Relation to `jobPosting`.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 - **applicantUserId**: 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 `jobPostingId` `applicantUserId` `lastStatusUpdateAt` `status` `appliedAt` 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. - **jobPostingId**: ID has a filter named `jobPostingId` - **applicantUserId**: ID has a filter named `applicantUserId` - **lastStatusUpdateAt**: Date has a filter named `lastStatusUpdateAt` - **status**: Enum has a filter named `status` - **appliedAt**: Date has a filter named `appliedAt` ## Default CRUD APIs For each data object, the backend architect may designate **default APIs** for standard operations (create, update, delete, get, list). These are the APIs that frontend CRUD forms and AI agents should use for basic record management. If no default is explicitly set (`isDefaultApi`), the frontend generator auto-discovers the most general API for each operation. ### JobPosting Default APIs | Operation | API Name | Route | Explicitly Set | |-----------|----------|-------|----------------| | Create | `createJobPosting` | `/v1/jobpostings` | Auto | | Update | `updateJobPosting` | `/v1/jobpostings/:jobPostingId` | Auto | | Delete | `deleteJobPosting` | `/v1/jobpostings/:jobPostingId` | Auto | | Get | `getJobPosting` | `/v1/jobpostings/:jobPostingId` | Auto | | List | `listJobPostings` | `/v1/jobpostings` | Auto | ### JobApplication Default APIs | Operation | API Name | Route | Explicitly Set | |-----------|----------|-------|----------------| | Create | `createJobApplication` | `/v1/jobapplications` | Auto | | Update | `updateJobApplication` | `/v1/jobapplications/:jobApplicationId` | Auto | | Delete | `deleteJobApplication` | `/v1/jobapplications/:jobApplicationId` | Auto | | Get | `getJobApplication` | `/v1/jobapplications/:jobApplicationId` | Auto | | List | `listJobApplications` | `/v1/jobapplications` | Auto | When building CRUD forms for a data object, use the default create/update APIs listed above. The form fields should correspond to the API's body parameters. For relation fields, render a dropdown loaded from the related object's list API using the display label property. ## API Reference ### `Delete Jobapplication` API Delete (soft) job application. Only applicant or admin for the job's company may delete. **Rest Route** The `deleteJobApplication` API REST controller can be triggered via the following route: `/v1/jobapplications/:jobApplicationId` **Rest Request Parameters** The `deleteJobApplication` api has got 1 regular request parameter | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobApplicationId | ID | true | request.params?.["jobApplicationId"] | **jobApplicationId** : This id paremeter is used to select the required data object that will be deleted **REST Request** To access the api you can use the **REST** controller with the path **DELETE /v1/jobapplications/:jobApplicationId** ```js axios({ method: 'DELETE', url: `/v1/jobapplications/${jobApplicationId}`, data: { }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobApplication", "method": "DELETE", "action": "delete", "appVersion": "Version", "rowCount": 1, "jobApplication": { "id": "ID", "jobPostingId": "ID", "applicantUserId": "ID", "coverLetter": "Text", "resumeUrl": "String", "lastStatusUpdateAt": "Date", "status": "Enum", "status_idx": "Integer", "appliedAt": "Date", "isActive": false, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Get Jobapplication` API Get job application record. Only applicant or admin of company may view. **Rest Route** The `getJobApplication` API REST controller can be triggered via the following route: `/v1/jobapplications/:jobApplicationId` **Rest Request Parameters** The `getJobApplication` api has got 1 regular request parameter | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobApplicationId | ID | true | request.params?.["jobApplicationId"] | **jobApplicationId** : This id paremeter is used to query the required data object. **REST Request** To access the api you can use the **REST** controller with the path **GET /v1/jobapplications/:jobApplicationId** ```js axios({ method: 'GET', url: `/v1/jobapplications/${jobApplicationId}`, data: { }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobApplication", "method": "GET", "action": "get", "appVersion": "Version", "rowCount": 1, "jobApplication": { "id": "ID", "jobPostingId": "ID", "applicantUserId": "ID", "coverLetter": "Text", "resumeUrl": "String", "lastStatusUpdateAt": "Date", "status": "Enum", "status_idx": "Integer", "appliedAt": "Date", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Update Jobposting` API Update job posting fields. Only company admins for companyId may update. Ownership enforced. Edits forbidden after deadline if desired. **Rest Route** The `updateJobPosting` API REST controller can be triggered via the following route: `/v1/jobpostings/:jobPostingId` **Rest Request Parameters** The `updateJobPosting` api has got 12 regular request parameters | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobPostingId | ID | true | request.params?.["jobPostingId"] | | description | Text | true | request.body?.["description"] | | title | String | true | request.body?.["title"] | | applicationDeadline | Date | false | request.body?.["applicationDeadline"] | | companyId | ID | true | request.body?.["companyId"] | | employmentType | Enum | true | request.body?.["employmentType"] | | salaryRange | String | false | request.body?.["salaryRange"] | | location | String | false | request.body?.["location"] | | visibility | Enum | true | request.body?.["visibility"] | | workplaceType | Enum | true | request.body?.["workplaceType"] | | status | Enum | true | request.body?.["status"] | | companyName | String | true | request.body?.["companyName"] | **jobPostingId** : This id paremeter is used to select the required data object that will be updated **description** : **title** : **applicationDeadline** : **companyId** : **employmentType** : **salaryRange** : **location** : **visibility** : **workplaceType** : **status** : **companyName** : **REST Request** To access the api you can use the **REST** controller with the path **PATCH /v1/jobpostings/:jobPostingId** ```js axios({ method: 'PATCH', url: `/v1/jobpostings/${jobPostingId}`, data: { description:"Text", title:"String", applicationDeadline:"Date", companyId:"ID", employmentType:"Enum", salaryRange:"String", location:"String", visibility:"Enum", workplaceType:"Enum", status:"Enum", companyName:"String", }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobPosting", "method": "PATCH", "action": "update", "appVersion": "Version", "rowCount": 1, "jobPosting": { "id": "ID", "description": "Text", "title": "String", "applicationDeadline": "Date", "companyId": "ID", "employmentType": "Enum", "employmentType_idx": "Integer", "postedByUserId": "ID", "salaryRange": "String", "location": "String", "visibility": "Enum", "visibility_idx": "Integer", "workplaceType": "Enum", "workplaceType_idx": "Integer", "status": "Enum", "status_idx": "Integer", "companyName": "String", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Delete Jobposting` API Delete (soft) a job posting. Only admin for companyId may delete. **Rest Route** The `deleteJobPosting` API REST controller can be triggered via the following route: `/v1/jobpostings/:jobPostingId` **Rest Request Parameters** The `deleteJobPosting` api has got 1 regular request parameter | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobPostingId | ID | true | request.params?.["jobPostingId"] | **jobPostingId** : This id paremeter is used to select the required data object that will be deleted **REST Request** To access the api you can use the **REST** controller with the path **DELETE /v1/jobpostings/:jobPostingId** ```js axios({ method: 'DELETE', url: `/v1/jobpostings/${jobPostingId}`, data: { }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobPosting", "method": "DELETE", "action": "delete", "appVersion": "Version", "rowCount": 1, "jobPosting": { "id": "ID", "description": "Text", "title": "String", "applicationDeadline": "Date", "companyId": "ID", "employmentType": "Enum", "employmentType_idx": "Integer", "postedByUserId": "ID", "salaryRange": "String", "location": "String", "visibility": "Enum", "visibility_idx": "Integer", "workplaceType": "Enum", "workplaceType_idx": "Integer", "status": "Enum", "status_idx": "Integer", "companyName": "String", "isActive": false, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Get Jobposting` API Fetch a job posting by ID. Publicly visible if visibility=public, else only viewable by admins of company. **Rest Route** The `getJobPosting` API REST controller can be triggered via the following route: `/v1/jobpostings/:jobPostingId` **Rest Request Parameters** The `getJobPosting` api has got 1 regular request parameter | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobPostingId | ID | true | request.params?.["jobPostingId"] | **jobPostingId** : This id paremeter is used to query the required data object. **REST Request** To access the api you can use the **REST** controller with the path **GET /v1/jobpostings/:jobPostingId** ```js axios({ method: 'GET', url: `/v1/jobpostings/${jobPostingId}`, data: { }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobPosting", "method": "GET", "action": "get", "appVersion": "Version", "rowCount": 1, "jobPosting": { "id": "ID", "description": "Text", "title": "String", "applicationDeadline": "Date", "companyId": "ID", "employmentType": "Enum", "employmentType_idx": "Integer", "postedByUserId": "ID", "salaryRange": "String", "location": "String", "visibility": "Enum", "visibility_idx": "Integer", "workplaceType": "Enum", "workplaceType_idx": "Integer", "status": "Enum", "status_idx": "Integer", "companyName": "String", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Update Jobapplication` API Update job application (status/by admin, or resume/cover by applicant, limited). Only admins/recruiters for job's company, or applicant, may update. Status can only move forward, not revert to submitted. **Rest Route** The `updateJobApplication` API REST controller can be triggered via the following route: `/v1/jobapplications/:jobApplicationId` **Rest Request Parameters** The `updateJobApplication` api has got 4 regular request parameters | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobApplicationId | ID | true | request.params?.["jobApplicationId"] | | coverLetter | Text | false | request.body?.["coverLetter"] | | resumeUrl | String | false | request.body?.["resumeUrl"] | | status | Enum | true | request.body?.["status"] | **jobApplicationId** : This id paremeter is used to select the required data object that will be updated **coverLetter** : **resumeUrl** : **status** : **REST Request** To access the api you can use the **REST** controller with the path **PATCH /v1/jobapplications/:jobApplicationId** ```js axios({ method: 'PATCH', url: `/v1/jobapplications/${jobApplicationId}`, data: { coverLetter:"Text", resumeUrl:"String", status:"Enum", }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobApplication", "method": "PATCH", "action": "update", "appVersion": "Version", "rowCount": 1, "jobApplication": { "id": "ID", "jobPostingId": "ID", "applicantUserId": "ID", "coverLetter": "Text", "resumeUrl": "String", "lastStatusUpdateAt": "Date", "status": "Enum", "status_idx": "Integer", "appliedAt": "Date", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `Create Jobapplication` API Submit a job application for a jobPosting (by logged-in user). Only if not already applied, and before deadline. Sets status=submitted. **Rest Route** The `createJobApplication` API REST controller can be triggered via the following route: `/v1/jobapplications` **Rest Request Parameters** The `createJobApplication` api has got 4 regular request parameters | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | jobPostingId | ID | true | request.body?.["jobPostingId"] | | coverLetter | Text | false | request.body?.["coverLetter"] | | resumeUrl | String | false | request.body?.["resumeUrl"] | | status | Enum | true | request.body?.["status"] | **jobPostingId** : **coverLetter** : **resumeUrl** : **status** : **REST Request** To access the api you can use the **REST** controller with the path **POST /v1/jobapplications** ```js axios({ method: 'POST', url: '/v1/jobapplications', data: { jobPostingId:"ID", coverLetter:"Text", resumeUrl:"String", status:"Enum", }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "201", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobApplication", "method": "POST", "action": "create", "appVersion": "Version", "rowCount": 1, "jobApplication": { "id": "ID", "jobPostingId": "ID", "applicantUserId": "ID", "coverLetter": "Text", "resumeUrl": "String", "lastStatusUpdateAt": "Date", "status": "Enum", "status_idx": "Integer", "appliedAt": "Date", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` ### `List Jobpostings` API List job postings. Public jobs visible to all; private jobs visible only to company admins or recruiters. **Rest Route** The `listJobPostings` API REST controller can be triggered via the following route: `/v1/jobpostings` **Rest Request Parameters** **Filter Parameters** The `listJobPostings` api supports 10 optional filter parameters for filtering list results: **title** (`String`): Filter by title - Single (partial match, case-insensitive): `?title=` - Multiple: `?title=&title=` - Null: `?title=null` **applicationDeadline** (`Date`): Filter by applicationDeadline - Single date: `?applicationDeadline=2024-01-15` - Multiple dates: `?applicationDeadline=2024-01-15&applicationDeadline=2024-01-20` - Special: `$today`, `$ltoday`, `$week`, `$lweek`, `$month`, `$leq-`, `$lin-` - Null: `?applicationDeadline=null` **companyId** (`ID`): Filter by companyId - Single: `?companyId=` - Multiple: `?companyId=&companyId=` - Null: `?companyId=null` **employmentType** (`Enum`): Filter by employmentType - Single: `?employmentType=` (case-insensitive) - Multiple: `?employmentType=&employmentType=` - Null: `?employmentType=null` **postedByUserId** (`ID`): Filter by postedByUserId - Single: `?postedByUserId=` - Multiple: `?postedByUserId=&postedByUserId=` - Null: `?postedByUserId=null` **location** (`String`): Filter by location - Single (partial match, case-insensitive): `?location=` - Multiple: `?location=&location=` - Null: `?location=null` **visibility** (`Enum`): Filter by visibility - Single: `?visibility=` (case-insensitive) - Multiple: `?visibility=&visibility=` - Null: `?visibility=null` **workplaceType** (`Enum`): Filter by workplaceType - Single: `?workplaceType=` (case-insensitive) - Multiple: `?workplaceType=&workplaceType=` - Null: `?workplaceType=null` **status** (`Enum`): Filter by status - Single: `?status=` (case-insensitive) - Multiple: `?status=&status=` - Null: `?status=null` **companyName** (`String`): Filter by companyName - Single (partial match, case-insensitive): `?companyName=` - Multiple: `?companyName=&companyName=` - Null: `?companyName=null` **REST Request** To access the api you can use the **REST** controller with the path **GET /v1/jobpostings** ```js axios({ method: 'GET', url: '/v1/jobpostings', data: { }, params: { // Filter parameters (see Filter Parameters section above) // title: '' // Filter by title // applicationDeadline: '' // Filter by applicationDeadline // companyId: '' // Filter by companyId // employmentType: '' // Filter by employmentType // postedByUserId: '' // Filter by postedByUserId // location: '' // Filter by location // visibility: '' // Filter by visibility // workplaceType: '' // Filter by workplaceType // status: '' // Filter by status // companyName: '' // Filter by companyName } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobPostings", "method": "GET", "action": "list", "appVersion": "Version", "rowCount": "\"Number\"", "jobPostings": [ { "id": "ID", "description": "Text", "title": "String", "applicationDeadline": "Date", "companyId": "ID", "employmentType": "Enum", "employmentType_idx": "Integer", "postedByUserId": "ID", "salaryRange": "String", "location": "String", "visibility": "Enum", "visibility_idx": "Integer", "workplaceType": "Enum", "workplaceType_idx": "Integer", "status": "Enum", "status_idx": "Integer", "companyName": "String", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" }, {}, {} ], "paging": { "pageNumber": "Number", "pageRowCount": "NUmber", "totalRowCount": "Number", "pageCount": "Number" }, "filters": [], "uiPermissions": [] } ``` ### `List Jobapplications` API List job applications. Applicants see their own; admins of job's company can view all for their jobs; supports filter by status, job and applicant. **Rest Route** The `listJobApplications` API REST controller can be triggered via the following route: `/v1/jobapplications` **Rest Request Parameters** **Filter Parameters** The `listJobApplications` api supports 5 optional filter parameters for filtering list results: **jobPostingId** (`ID`): Filter by jobPostingId - Single: `?jobPostingId=` - Multiple: `?jobPostingId=&jobPostingId=` - Null: `?jobPostingId=null` **applicantUserId** (`ID`): Filter by applicantUserId - Single: `?applicantUserId=` - Multiple: `?applicantUserId=&applicantUserId=` - Null: `?applicantUserId=null` **lastStatusUpdateAt** (`Date`): Filter by lastStatusUpdateAt - Single date: `?lastStatusUpdateAt=2024-01-15` - Multiple dates: `?lastStatusUpdateAt=2024-01-15&lastStatusUpdateAt=2024-01-20` - Special: `$today`, `$ltoday`, `$week`, `$lweek`, `$month`, `$leq-`, `$lin-` - Null: `?lastStatusUpdateAt=null` **status** (`Enum`): Filter by status - Single: `?status=` (case-insensitive) - Multiple: `?status=&status=` - Null: `?status=null` **appliedAt** (`Date`): Filter by appliedAt - Single date: `?appliedAt=2024-01-15` - Multiple dates: `?appliedAt=2024-01-15&appliedAt=2024-01-20` - Special: `$today`, `$ltoday`, `$week`, `$lweek`, `$month`, `$leq-`, `$lin-` - Null: `?appliedAt=null` **REST Request** To access the api you can use the **REST** controller with the path **GET /v1/jobapplications** ```js axios({ method: 'GET', url: '/v1/jobapplications', data: { }, params: { // Filter parameters (see Filter Parameters section above) // jobPostingId: '' // Filter by jobPostingId // applicantUserId: '' // Filter by applicantUserId // lastStatusUpdateAt: '' // Filter by lastStatusUpdateAt // status: '' // Filter by status // appliedAt: '' // Filter by appliedAt } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "200", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobApplications", "method": "GET", "action": "list", "appVersion": "Version", "rowCount": "\"Number\"", "jobApplications": [ { "id": "ID", "jobPostingId": "ID", "applicantUserId": "ID", "coverLetter": "Text", "resumeUrl": "String", "lastStatusUpdateAt": "Date", "status": "Enum", "status_idx": "Integer", "appliedAt": "Date", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" }, {}, {} ], "paging": { "pageNumber": "Number", "pageRowCount": "NUmber", "totalRowCount": "Number", "pageCount": "Number" }, "filters": [], "uiPermissions": [] } ``` ### `Create Jobposting` API Create a new job posting. Only company admins/recruiters for companyId can create. postedByUserId set from session. **Rest Route** The `createJobPosting` API REST controller can be triggered via the following route: `/v1/jobpostings` **Rest Request Parameters** The `createJobPosting` api has got 11 regular request parameters | Parameter | Type | Required | Population | | ---------------------- | ---------------------- | -------- | ---------------------------- | | description | Text | true | request.body?.["description"] | | title | String | true | request.body?.["title"] | | applicationDeadline | Date | false | request.body?.["applicationDeadline"] | | companyId | ID | false | request.body?.["companyId"] | | employmentType | Enum | true | request.body?.["employmentType"] | | salaryRange | String | false | request.body?.["salaryRange"] | | location | String | false | request.body?.["location"] | | visibility | Enum | true | request.body?.["visibility"] | | workplaceType | Enum | true | request.body?.["workplaceType"] | | status | Enum | true | request.body?.["status"] | | companyName | String | true | request.body?.["companyName"] | **description** : **title** : **applicationDeadline** : **companyId** : **employmentType** : **salaryRange** : **location** : **visibility** : **workplaceType** : **status** : **companyName** : **REST Request** To access the api you can use the **REST** controller with the path **POST /v1/jobpostings** ```js axios({ method: 'POST', url: '/v1/jobpostings', data: { description:"Text", title:"String", applicationDeadline:"Date", companyId:"ID", employmentType:"Enum", salaryRange:"String", location:"String", visibility:"Enum", workplaceType:"Enum", status:"Enum", companyName:"String", }, params: { } }); ``` **REST Response** ```json { "status": "OK", "statusCode": "201", "elapsedMs": 126, "ssoTime": 120, "source": "db", "cacheKey": "hexCode", "userId": "ID", "sessionId": "ID", "requestId": "ID", "dataName": "jobPosting", "method": "POST", "action": "create", "appVersion": "Version", "rowCount": 1, "jobPosting": { "id": "ID", "description": "Text", "title": "String", "applicationDeadline": "Date", "companyId": "ID", "employmentType": "Enum", "employmentType_idx": "Integer", "postedByUserId": "ID", "salaryRange": "String", "location": "String", "visibility": "Enum", "visibility_idx": "Integer", "workplaceType": "Enum", "workplaceType_idx": "Integer", "status": "Enum", "status_idx": "Integer", "companyName": "String", "isActive": true, "recordVersion": "Integer", "createdAt": "Date", "updatedAt": "Date", "_owner": "ID" } } ``` **After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.**