Get candidate availability

POST /candidate/availablity

This API is to listing availability of candidates based on given filter. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

application/json

Body

Responses

  • 200 application/json

    OK
POST /candidate/availablity 
curl \
 -X POST https://api-console.logezy.co/v1/candidate/availablity \
 -H "Accept: string" \
 -H "Content-Type: string" \
 -d '{"start_date":"2024-05-04","end_date":"2024-05-04","region":42,"job":42,"candidate":42,"status":["U"],"availabilitystatus":"submitted"}'
Request example 
# Headers
Accept: string
Content-Type: string

# Payload
{
  "start_date": "2024-05-04",
  "end_date": "2024-05-04",
  "region": 42,
  "job": 42,
  "candidate": 42,
  "status": [
    "U"
  ],
  "availabilitystatus": "submitted"
}
Response examples (200) 
{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 100000,
        "full_name": "Saravana Developer",
        "availabilities": [
          {
            "id": 111111,
            "candidate_id": 100000,
            "shift_id": 1,
            "date": "2024-05-03",
            "availability": "E",
            "notes": null,
            "created_by": null,
            "created_at": "2024-01-30 05:30:06",
            "updated_at": "2024-01-30 05:30:06",
            "created": null
          }
        ]
      }
    ],
    "first_page_url": "http://api-console.localhost:8000/v1/candidate/availablity?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://api-console.localhost:8000/v1/candidate/availablity?page=1",
    "next_page_url": null,
    "path": "http://api-console.localhost:8000/v1/candidate/availablity",
    "per_page": 40,
    "prev_page_url": null,
    "to": 1,
    "total": 1
  },
  "message": "Candidate Availability retrieved successfully."
}