Skip to content

Position ​

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

GET /position/get-by-id/{id} ​

Get position using its _id

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

MaydonTurTavsif
_idstring
namestring
created_atstring
updated_atstring
is_deletedboolean
completely_deletedboolean
sectionsobject[]
sections[]._idstring
sections[].is_deletedboolean
sections[].completely_deletedboolean
sections[].namestring
organizationsobject[]
organizations[]._idstring
organizations[].organization_idstring
organizations[].max_employee_countnumber
organizations[].is_availableboolean
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "created_at": "string",
    "updated_at": "string",
    "is_deleted": false,
    "completely_deleted": false,
    "sections": [
      {
        "_id": "string",
        "is_deleted": false,
        "completely_deleted": false,
        "name": "string"
      }
    ],
    "organizations": [
      {
        "_id": "string",
        "organization_id": "string",
        "max_employee_count": 0,
        "is_available": false
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /position/get-paging ​

Get positions by paging

So‘rov tanasi

MaydonTurMajburiyTavsif
pagenumberHaStandart: 1
limitnumberHaStandart: 20
searchstringYo‘q
section_idstringYo‘q
organization_idstringYo‘q
accessed_organization_idsstring[]Yo‘q
json
{
  "page": 1,
  "limit": 20,
  "search": "string",
  "section_id": "63f8b0c4e4b0d3a2f8e4b0c4",
  "organization_id": "63f8b0c4e4b0d3a2f8e4b0c4",
  "accessed_organization_ids": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ]
}

Javob

data.total — jami yozuvlar soni, data.data[] — joriy sahifadagi yozuvlar. Quyidagi jadval bitta yozuvni tavsiflaydi.

MaydonTurTavsif
_idstring
namestring
created_atstring
updated_atstring
max_employee_countnumber
employee_countnumber
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "string",
        "name": "string",
        "created_at": "string",
        "updated_at": "string",
        "max_employee_count": 0,
        "employee_count": 0
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /position/create ​

Create an HR position. name, section_ids (at least one existing section) and organizations (at least one entry) are required. Returns the created position aggregated with its sections. Fails with 400 if the name already exists in the account, or if a referenced section or organization does not exist.

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHaPosition name (required, 3–100 characters). Must be unique within the account.
section_idsstring[]HaSections (departments) this position belongs to (required, at least one). Every id must reference an existing, non-deleted section.
organizationsobject[]HaPer-organization availability of the position (required, at least one).
organizations[].organization_idstringHaOrganization the position is opened in (required). Must exist.
organizations[].is_availablebooleanHaWhether the position is currently open for hiring in this organization (required). A position whose every organization entry is is_available=false is auto soft-deleted by the backend.
organizations[].max_employee_countnumberYo‘qHeadcount cap for this organization. Defaults to 0 (uncapped) when omitted.
json
{
  "name": "Sales manager",
  "section_ids": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ],
  "organizations": [
    {
      "organization_id": "63f8b0c4e4b0d3a2f8e4b0c4",
      "is_available": false,
      "max_employee_count": 0
    }
  ]
}

Javob

Javob tuzilishi quyidagi bilan bir xil: GET /position/get-by-id/{id}.

PUT /position/update/{id} ​

Update an HR position by ObjectId. name, section_ids and organizations are all required — this is a full replacement of those fields, not a patch. The organizations named in the payload are pulled and re-pushed; organizations not named keep their existing entry. Returns the updated position aggregated with its sections.

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHaPosition ObjectId to update

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHaUpdated position name (required, 3–100 characters).
section_idsstring[]HaSections (departments) this position belongs to (required, at least one). Every id must reference an existing, non-deleted section.
organizationsobject[]HaFull replacement set of per-organization entries (required, at least one). The entries for the organizations named here are removed and re-added, so send every organization the position should remain open in — an organization left out keeps its previous entry untouched.
organizations[].organization_idstringHaOrganization the position is opened in (required). Must exist.
organizations[].is_availablebooleanHaWhether the position is currently open for hiring in this organization (required). A position whose every organization entry is is_available=false is auto soft-deleted by the backend.
organizations[].max_employee_countnumberYo‘qHeadcount cap for this organization. Defaults to 0 (uncapped) when omitted.
json
{
  "name": "Sales manager",
  "section_ids": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ],
  "organizations": [
    {
      "organization_id": "63f8b0c4e4b0d3a2f8e4b0c4",
      "is_available": false,
      "max_employee_count": 0
    }
  ]
}

Javob

Javob tuzilishi quyidagi bilan bir xil: GET /position/get-by-id/{id}.

DELETE /position/delete/{id} ​

Soft-delete an HR position by ObjectId (sets is_deleted=true). Fails with 400 when at least one employee still holds the position — the error payload lists the blocking employees. Deleting an already-deleted position is a no-op.

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHaPosition ObjectId to delete

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "63f8b0c4e4b0d3a2f8e4b0c4",
  "time": "2025-05-01T12:00:00Z"
}

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API