Get Document Ids

This API is used to get all the indexed document ID's.

API URL

The Get Document Ids API uses the below URL:

https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/getDocumentIds

API Endpoint

The Get Document Ids API uses the below endpoint:

/getDocumentIds

API Method

The Get Document Ids API uses only POST method.

API Request Type

The Get Document Ids API uses JSON request type.

API Request Headers

Header Data Type Description
Content-Type string Indicates the input type of the incoming request body. The only supported value is application/json.

API Parameters

To execute Get Document Ids API, the following parameters in the JSON request are needed:
Name Type Description Remarks
indexType String Type of the file i.e Resume or JD Required
indexKey String Use your user key as shared by RChilli team Required
subUserId String Your user's unique_ID
Note: Make sure that there is no space in your subuser_id
 Optional
pageSize Integer Number of records return in one API call:
  • Default 50
  • maximum 500

Contact support@rchilli.com to update the limit.

For more details, click Pagination.		 Optional
pageStart Integer Start index of record to return. Can be used for paging when multiple record are searched. Default is 0. For more details, click Pagination Optional

JSON Request For Get Document Ids - Resume

{
  "index": {
    "indexKey": "Your user key",
    "indexType": "Resume",
    "subUserId": "user 1"
  },
  "pageStart": 0,
  "pageSize": 10
}

JSON Response For Get Document Ids - Resume

{
  "count": 12,
  "pageStart": 0,
  "pageSize": 10,
  "records": [
    {
      "id": "Document Id 1"
    },
    {
      "id": "Document Id 2"
    },
    {
      "id": "Document Id 3"
    },
    {
      "id": "Document Id 4"
    },
    {
      "id": "Document Id 5"
    }
  ]
}

JSON Request For Get Document Ids - JD

{
  "index": {
    "indexKey": "Your user key",
    "indexType": "JD",
    "subUserId": "user 1"
  },
  "pageStart": 0,
  "pageSize": 10
}

JSON Response For Get Document Ids - JD

{
  "count": 12,
  "pageStart": 0,
  "pageSize": 10,
  "records": [
    {
      "id": "Document Id 1"
    },
    {
      "id": "Document Id 2"
    },
    {
      "id": "Document Id 3"
    },
    {
      "id": "Document Id 4"
    },
    {
      "id": "Document Id 5"
    }
  ]
}