Skip to main content

HQ Manager Dashboard

Dashboard View​

dashboard view

Section​

Job Overview​

Get completed jobs statistics (top left box with the caption JOB OVERVIEW)

Contract​

  • URL: /api/portal/dashboard/jobs-overview
  • Method: GET
  • Permission: get-completed-jobs-statistics

Response​

{
    "data": {
        "total_active_jobs": "0",
        "total_open_jobs": "0",
        "total_completed_jobs_of_current_month": "0",
        "total_cancelled_jobs": "5",
        "job_charts": [
            {
                "status": 1,
                "type": 1,
                "data": [
                    {
                        "total_jobs": 0,
                        "month_number": 11,
                        "month": "Nov",
                        "year": 2023
                    },
                    ...
                ]
            },
            ...
        ]
    },
    "message": "Retrieved successfully"
}

Hiring Overview​

Get total_active_jobs, total_open_jobs, total_completed_jobs_of_current_month and hiring chart of a company (top right box with the caption HIRING OVERVIEW)

Contract​

  • URL: /api/portal/dashboard/hiring-overview
  • Method: GET
  • Permission: get-hiring-overview

Response​

{
    "data": {
        "total_today_hired": "0",
        "total_hired_of_current_month": "0",
        "hiring_charts": [
            {
                "total_hired_staffs": "14",
                "month_number": 11,
                "month": "Nov",
                "year": 2023
            },
            ...
        ]
    },
    "message": "Retrieved successfully"
}

Available Credit Total​

Available credits total by HQ (inside CREDIT OVERVIEW box, top right side with value 3,584,609.55)

Contract​

  • URL: /api/portal/credit/hq/availableCreditsTotalByHq
  • Method: GET
  • Permission: view-available-credits-total-by-hq
  • Possible Role Type: HQ, AREA, LOCATION

Response​

{
    "data": {
        "available_credit_total": <double>,
        "url_logo": "<string>",
        "location_badge_assignments": []
    },
    "message": "Retrieved successfully"
}

JOD Credit Available​

JOD credit available with HQ (inside CREDIT OVERVIEW box, top left side with value 2,740,760.17)

Contract​

  • URL: /api/portal/credit/jodCreditAvailableHq
  • Method: GET
  • Permission: view-jod-credit-available-hq
  • Possible Role Type: HQ, AREA, LOCATION

Response​

{
    "data": {
        "available_credits": <double>,
    },
    "message": "Retrieved successfully"
}

Consume Credit Current Month​

JOD credit available with HQ (inside CREDIT OVERVIEW box, middle side with value 0)

Contract​

  • URL: /api/portal/payment/consumed-credits-by-hq
  • Method: GET
  • Permission: consumed-credits-by-hq
  • Possible Role Type: HQ, AREA, LOCATION

Response​

{
    "data": {
        "consumed_credits_current_month": <double>,
        "consumed_credits_previous_month": <double>
    },
    "message": "Get consumed credits successfully"
}

Credit Overview Chart​

credit overview (Received Credits, Consumed Credits) of last 12 months (chart inside CREDIT OVERVIEW box)

Contract​

  • URL: /api/portal/dashboard/credit-overview
  • Method: GET
  • Permission: get-hiring-overview

Response​

{
    "data": {
        "total_today_hired": "0",
        "total_hired_of_current_month": "0",
        "hiring_charts": [
            {
                "total_hired_staffs": "14",
                "month_number": 11,
                "month": "Nov",
                "year": 2023
            },
            ...
        ]
    },
    "message": "Retrieved successfully"
}

Rating Overview​

average rating of a company (botom right box with the caption RATING OVERVIEW)

Contract​

  • URL: /api/portal/dashboard/rating-overview
  • Method: GET
  • Permission: get-rating-overview
  • Possible Role Type: HQ, AREA, LOCATION

Response​

{
  "data":{
    "average_rating":<float>
  },
  "message":"Retrieved successfully"
}

Super Admin Dashboard

Dashboard View​

dashboard view

Section​

Company​

Get total number of partner companies (top left box with the caption Company)

Contract​

  • URL: /api/portal/company/summary
  • Method: GET
  • Permission: summary-company
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL, SUPER_HQ_EXTERNAL(depending on company permission)

Response​

{
    "data": {
        "total": <int>, // total companies in database
        "total_enable": <int>, // total companies with status = 1
        "total_disable": <int> // total companies with status = 0
    },
    "message": "Retrieved successfully"
}

HQ Manager​

Get total number of HQ managers (top midle box with the caption HQ MANAGER)

Contract​

  • URL: /api/portal/hquser/summary
  • Method: GET
  • Permission: summary-hq-user
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, // total hq user in database
        "total_enable": <int>, // total enabled hq user
        "total_disable": <int> // total disabled hq user
    },
    "message": "Retrieved successfully"
}

Future Payment​

Get total number of future payments (top midle box below HQ Manager box with the caption FUTURE PAYMENT)

Contract​

  • URL: /api/portal/payment/futurePayment/summary
  • Method: GET
  • Permission: summary-job-payment-by-status
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, 
    },
    "message": "Retrieved successfully"
}

Payment Summary​

Get processed and unprocessed payment statistics for last 12 months (bottom box with the caption PAYMENT SUMMARY)

Contract​

  • URL: /api/portal/dashboard/payment-statistics
  • Method: GET
  • Permission: get-payment-statistics
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": [
        {
            "processed_credits": <double>,
            "month_number": <int>,
            "month": "<month 3 chars>",
            "year": <int>,
            "unprocessed_credits": <double>
        },
        ...
    ],
    "message": "Retrieved successfully"
}

Job Types​

Get summary of job type (right side box with magnifier icon)

Contract​

  • URL: /api/portal/jobtype/summary
  • Method: GET
  • Permission: summary-job-type
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, // total all job type in database
        "total_enable": <int>, // total enabled job type
        "total_disable": <int> // total disabled job type
    },
    "message": "Retrieved successfully"
}

Locations​

Get data summary location by status (right side box with map point icon)

Contract​

  • URL: /api/portal/location/summary
  • Method: GET
  • Permission: summary-location-by-status
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, // total all locations in database
        "total_enable": <int>, // total enabled locations
        "total_disable": <int> // total disabled locations
    },
    "message": "Retrieved successfully"
}

Applicants​

Get data summary applicant user by status (right side box with paper & pen icon)

Contract​

  • URL: /api/portal/applicantuser/summary
  • Method: GET
  • Permission: get-summary-applicant-user
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, // total all applicants in database
        "total_enable": <int>, // total enabled applicants
        "total_disable": <int> // total disabled applicants
    },
    "message": "Retrieved successfully"
}

Educational Institutes​

Get datdata summary education by status (right side box with hat icon)

Contract​

  • URL: /api/portal/education/summary
  • Method: GET
  • Permission: get-summary-education-by-status
  • Possible Role Type: SUPER_ADMIN, USER_ADMIN, INTERNAL

Response​

{
    "data": {
        "total": <int>, // total all education in database
        "total_enable": <int>, // total enabled education
        "total_disable": <int> // total disabled education
    },
    "message": "Retrieved successfully"
}