Tashbeek API

This is the contract of the Tashbeek API. It will act as a programtic interface to our machine learning powered, job match service.

This contract will forge an agreement on behalf of IRC and Souktel how our two services ill interact and as such you can parse it with the API Blueprint parser or one of its bindings.

It is also recommended that you use a nice formatter such as aglio in order to display the docs in a nice and pretty way.

Job Match ¶

This is the core API endpoint for our service. It will handle the running of our “Job Match Algorithm”. From here you can initiate the algorithm to run for a new job opening.

Job Matches ¶

Job ID has finished matching
GET`/job-matches/?job_id={job_id}`

Once the algorithm has finished matching, this endpoint will show the selected candidates under the "scores" attribute.

Example URI

GET /job-matches/?job_id={job_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
   "_id": {
       "$oid": "5c1772c7e72d2b0083d04be9"
   }, 
   "job_id": "B6JTC4", 
   "scores": [
       {
           "case_id": "08d1bff17ce84350ae68b422deee9aaa", 
           "probs": 0.88054
       }, 
       {
           "case_id": "f2aef7ba4a28425088de1f4bc98fc681", 
           "probs": 0.58385
       }, 
   ], 
   "status": "complete"
}

Job ID hasn't finished matching
GET`/job-matches/?job_id={job_id}`

Job matches will have the status of "processing" until the matching algorithm has finished

Example URI

GET /job-matches/?job_id={job_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": {
    "$oid": "5c1772c7e72d2b0083d04be9"
  },
  "job_id": "B6JTC4",
  "status": "processing"
}

Job match doesn't exist
GET`/job-matches/?job_id={job_id}`

If we haven’t created matches for the given ID yet, you’ll receive a 404

Example URI

GET /job-matches/?job_id={job_id}

Response 404

HideShow

Headers

Content-Type: application/json

Create Job Match List
POST`/job-matches/?job_id={job_id}`

The ideal response will be a 201 for creating a new job match list

Example URI

POST /job-matches/?job_id={job_id}

Response 201

Job Match already created
POST`/job-matches/?job_id={job_id}`

If the match has already been started, you will see a response as follows

Example URI

POST /job-matches/?job_id={job_id}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": {
    "$oid": "5c1772c7e72d2b0083d04be9"
  },
  "job_id": "B6JTC4",
  "status": "processing"
}

Job Opening doesn't exist
POST`/job-matches/?job_id={job_id}`

If the job opening doesn’t exist, we will throw a 400 and point to this document

Example URI

POST /job-matches/?job_id={job_id}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Job Opening with ID does not exist.",
  "more_info": ""
}

Delete Job Match
DELETE`/job-matches/?job_id={job_id}`

To delete a job match which may be useful for rerunning the match algorithm, you can hit this endpoint with the DELETE call

Example URI

DELETE /job-matches/?job_id={job_id}

Response 204

HideShow

Headers

Content-Type: application/json

Job Seeker ¶

Job Seekers List ¶

List Job Seekers
GET`/job-seekers/`

Example URI

GET /job-seekers/

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "case_id": "86fcd660",
    "age": "50",
    "arab_coworkers": "0",
    "case_name": "null",
    "case_type": "job",
    "city": "amman",
    "completed_training_courses": "0",
    "date_opened": "2018",
    "distance_willing_to_travel": "0",
    "district": "nfjfj",
    "dob": "2015",
    "eso_id": "99",
    "external_id": "null",
    "first_name": "test4444",
    "follow_up_agreement": "0",
    "gender": "male",
    "gps": "31.97350215 35.8833914 982.35 17.15",
    "has_house_referrals": "0",
    "id_method: social_media": "Hello, world!",
    "interview_date": "2018",
    "job_interest": "0",
    "last_name": "gsjfkfn",
    "marital_status": "single",
    "mobile_num": "1234567890",
    "neighbourhood": "hdhdj",
    "nonarab_coworkers": "1",
    "opposite_gender_coworkers": "will_refuse",
    "opposite_gender_manager": "no_issue",
    "owner_id": "40c7d589ba38440a9307543a644d1da4",
    "start_time": "13:39:00.000+02",
    "testing": "yes",
    "visit_time: 11_3pm": "Hello, world!",
    "will_live_in_dorm": "0",
    "will_work_night_shift": "1"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Job Seeker Detail ¶

Show Job Seeker Detail
GET`/job-seekers/{case_id}`

Example URI

GET /job-seekers/{case_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "case_id": "86fcd660",
  "age": "50",
  "arab_coworkers": "0",
  "case_name": "null",
  "case_type": "job",
  "city": "amman",
  "completed_training_courses": "0",
  "date_opened": "2018",
  "distance_willing_to_travel": "0",
  "district": "nfjfj",
  "dob": "2015",
  "eso_id": "99",
  "external_id": "null",
  "first_name": "test4444",
  "follow_up_agreement": "0",
  "gender": "male",
  "gps": "31.97350215 35.8833914 982.35 17.15",
  "has_house_referrals": "0",
  "id_method: social_media": "Hello, world!",
  "interview_date": "2018",
  "job_interest": "0",
  "last_name": "gsjfkfn",
  "marital_status": "single",
  "mobile_num": "1234567890",
  "neighbourhood": "hdhdj",
  "nonarab_coworkers": "1",
  "opposite_gender_coworkers": "will_refuse",
  "opposite_gender_manager": "no_issue",
  "owner_id": "40c7d589ba38440a9307543a644d1da4",
  "start_time": "13:39:00.000+02",
  "testing": "yes",
  "visit_time: 11_3pm": "Hello, world!",
  "will_live_in_dorm": "0",
  "will_work_night_shift": "1"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "case_id": {
      "type": "string",
      "description": "11a9-4a7e-b3da-2bebacaebd85"
    },
    "age": {
      "type": "string"
    },
    "arab_coworkers": {
      "type": "string"
    },
    "case_name": {
      "type": "string"
    },
    "case_type": {
      "type": "string",
      "description": "seeker"
    },
    "city": {
      "type": "string"
    },
    "completed_training_courses": {
      "type": "string"
    },
    "date_opened": {
      "type": "string",
      "description": "08-19T10:40:27.701000Z"
    },
    "distance_willing_to_travel": {
      "type": "string"
    },
    "district": {
      "type": "string"
    },
    "dob": {
      "type": "string",
      "description": "08-19"
    },
    "eso_id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "follow_up_agreement": {
      "type": "string"
    },
    "gender": {
      "type": "string"
    },
    "gps": {
      "type": "string"
    },
    "has_house_referrals": {
      "type": "string"
    },
    "id_method: social_media": {
      "type": "string"
    },
    "interview_date": {
      "type": "string",
      "description": "08-21"
    },
    "job_interest": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "marital_status": {
      "type": "string"
    },
    "mobile_num": {
      "type": "string"
    },
    "neighbourhood": {
      "type": "string"
    },
    "nonarab_coworkers": {
      "type": "string"
    },
    "opposite_gender_coworkers": {
      "type": "string"
    },
    "opposite_gender_manager": {
      "type": "string"
    },
    "owner_id": {
      "type": "string"
    },
    "start_time": {
      "type": "string"
    },
    "testing": {
      "type": "string"
    },
    "visit_time: 11_3pm": {
      "type": "string"
    },
    "will_live_in_dorm": {
      "type": "string"
    },
    "will_work_night_shift": {
      "type": "string"
    }
  }
}

Matches ¶

Match List ¶

List Matches
GET`/matches/`

Example URI

GET /matches/

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "case_id": "95ec83ff",
    "case_name": "KWVTIM4PQ0Z2O84",
    "case_type": "match",
    "date_opened": "2018",
    "external_id": "null",
    "interest_applying": "1",
    "job_id": "12345678900",
    "match_job_description": "management",
    "no_interest_applying": "0",
    "owner_id": "1f50c3206882bbf8fff069d033c2cf9a"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Match Detail ¶

Show Match Detail
GET`/matches/{case_id}`

Example URI

GET /matches/{case_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "case_id": "95ec83ff",
  "case_name": "KWVTIM4PQ0Z2O84",
  "case_type": "match",
  "date_opened": "2018",
  "external_id": "null",
  "interest_applying": "1",
  "job_id": "12345678900",
  "match_job_description": "management",
  "no_interest_applying": "0",
  "owner_id": "1f50c3206882bbf8fff069d033c2cf9a"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "case_id": {
      "type": "string",
      "description": "5a6d-4738-a1cb-075683e7992b"
    },
    "case_name": {
      "type": "string"
    },
    "case_type": {
      "type": "string"
    },
    "date_opened": {
      "type": "string",
      "description": "06-11T13:53:05.854000Z"
    },
    "external_id": {
      "type": "string"
    },
    "interest_applying": {
      "type": "string"
    },
    "job_id": {
      "type": "string"
    },
    "match_job_description": {
      "type": "string"
    },
    "no_interest_applying": {
      "type": "string"
    },
    "owner_id": {
      "type": "string"
    }
  }
}

Firms ¶

Firms List ¶

List Firms
GET`/firms/`

Example URI

GET /firms/

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "case_id": "6181cce7",
    "adverstise_through_other": "لا",
    "advertise_through_agency": "no",
    "advertise_through_building_site": "no",
    "advertise_through_epu": "no",
    "advertise_through_newspapers": "no",
    "advertise_through_ngo": "no",
    "advertise_through_online": "no",
    "age_client_services": "0",
    "age_production_workers": "25",
    "age_professionals": "29",
    "age_support_services": "0",
    "application_fee": "no",
    "applied_num_client": "0",
    "applied_num_production": "15",
    "applied_num_professionals": "4",
    "applied_num_support": "0",
    "case_name": "200131892",
    "case_type": "firm",
    "cgender": "male",
    "clerical_experience_not_required": "yes",
    "cnationality": "syrian",
    "coage": "25",
    "commercial_id": "106406",
    "compact_is_good": "yes",
    "contact_time": "anytime",
    "contact_years_firm": "1",
    "contact_years_industry": "5",
    "cv10_17": "no",
    "cv10_18": "العمر",
    "cv11_17": "no",
    "cv11_18": "العمر",
    "cv12_17": "yes",
    "cv13_17": "no",
    "cv13_18": "العمر",
    "cv14_17": "no",
    "cv14_18": "العمر",
    "cv15_17": "no",
    "cv15_18": "العمر",
    "cv16_17": "yes",
    "cv17_17": "no",
    "cv17_18": "العمر",
    "cv18_17": "yes",
    "cv19_17": "yes",
    "cv1_17": "no",
    "cv1_18": "العمر",
    "cv20_17": "yes",
    "cv21_17": "no",
    "cv21_18": "العمر",
    "cv22_17": "yes",
    "cv23_17": "yes",
    "cv24_17": "no",
    "cv24_18": "العمر",
    "cv25_17": "yes",
    "cv26_17": "yes",
    "cv27_17": "no",
    "cv27_18": "العمر",
    "cv28_17": "yes",
    "cv29_17": "yes",
    "cv2_17": "no",
    "cv2_18": "العمر",
    "cv30_17": "yes",
    "cv3_17": "yes",
    "cv4_17": "yes",
    "cv5_17": "no",
    "cv6_17": "yes",
    "cv7_17": "no",
    "cv7_18": "العمر",
    "cv8_17": "no",
    "cv8_18": "العمر",
    "cv9_17": "yes",
    "date_opened": "2018",
    "displayed_salary": "yes",
    "dorms_not_required": "yes",
    "education": "secondary",
    "education_production_workers": "no_school",
    "education_professionals": "secondary",
    "employment_policy: rare_promotion": "Hello, world!",
    "employment_programs": "no",
    "end_time": "12:50:00.000+02",
    "eso_id": "13",
    "establishment_date": "2013",
    "expected_hire_production": "9",
    "expected_hire_support": "0",
    "expected_hires_client": "0",
    "expected_hires_professionals": "0",
    "experience_client_services": "0",
    "experience_not_required": "yes",
    "experience_production_workers": "1",
    "experience_professionals": "1",
    "experience_support_services": "0",
    "external_id": "null",
    "factory_experience_not_required": "yes",
    "fcity": "irbid",
    "fdistrict": "مدينة الحسنةالصناعية",
    "femail": "abdalrahmn1980@gmail.com",
    "female_employees": "3",
    "female_production_employees": "3",
    "female_professional_employees": "0",
    "female_service_employees": "0",
    "female_support_employees": "0",
    "ffname": "عمار",
    "fgps": "32.4966908 36.0266391 568.0 20.0",
    "fill_time_client": "0",
    "fill_time_production": "personal_contacts",
    "fill_time_professionals": "1",
    "fill_time_support": "0",
    "firm_consent": "yes",
    "firm_id_method": "site_visit",
    "firm_is_hiring": "yes",
    "firm_name": "مصنع كلش للبسكويت",
    "firm_national_id": "200131892",
    "firm_status": "proprietorship",
    "flname": "عبد الحي",
    "fmobile": "0795464852",
    "fphone": "0797481314",
    "fposition": "finance_manager",
    "heard_about_service": "no",
    "hire_num_client": "0",
    "hire_num_production": "6",
    "hire_num_support": "0",
    "hire_process_client_services": "لم يتم توظيف اي شخص",
    "hire_process_production_workers: personal_contacts": "Hello, world!",
    "hire_process_professionals": "personal_contacts",
    "hire_process_support_services": "لم يتم توظيف اي شخص",
    "hired_num_professionals": "1",
    "hired_syrians_since_before": "no",
    "hr_challenge: employee_turnover": "Hello, world!",
    "interview_client": "yes",
    "interview_date": "2018",
    "interview_production": "no",
    "interview_professionals": "yes",
    "interview_support": "no",
    "interview_time": "12:09:00.000+02",
    "know_about_compact": "yes",
    "know_same_about_job": "disagree",
    "labor_directorate": "ibrid",
    "management_experience_not_required": "yes",
    "management_female_employees": "0",
    "managment_employees": "1",
    "manual_experience_not_required": "yes",
    "night_shifts_not_required": "yes",
    "no_cooperation_risk": "disagree",
    "num_contract_end_last_year": "0",
    "num_fired_last_year": "0",
    "num_locations": "1",
    "num_owners": "2",
    "num_quit_last_year": "8",
    "num_turnover_last_year": "8",
    "opened_date": "2018",
    "owner_id": "40c7d589ba38440a9307543a644d1da4",
    "owner_nationality": "syrian",
    "percent_government": "0",
    "percent_private_domestic": "0",
    "percent_private_foreign": "100",
    "permanent_client_services": "0",
    "permanent_contract_professionals": "1",
    "permanent_production_workers": "13",
    "permanent_support_services": "0",
    "produce_in_roo": "no",
    "product_code": "96",
    "production_employyes": "13",
    "professional_employees": "0",
    "professional_experience_not_required": "yes",
    "promotion_method: effort_ability": "Hello, world!",
    "recruitment_test": "no",
    "salary_1year_client_services": "0",
    "salary_1year_production_workers": "235",
    "salary_1year_support_services": "0",
    "salary_5years_client_services": "0",
    "salary_5years_production_workers": "275",
    "salary_5years_professionals": "750",
    "salary_5years_support_services": "0",
    "salary_year_professionals": "600",
    "sector": "production",
    "service_employees": "0",
    "sez_firm": "yes",
    "sez_name: prince_hassan": "Hello, world!",
    "staff_april1_2018": "15",
    "staff_march1_2018": "9",
    "starting_salary_client_services": "0",
    "starting_salary_production_workers": "220",
    "starting_salary_professionals": "450",
    "starting_salary_support_services": "0",
    "support_employees": "0",
    "syrian_cares_more": "neutral",
    "syrian_client_services": "0",
    "syrian_hired_same_jordanian: strongly_disagree": "Hello, world!",
    "syrian_lower_wage": "agree",
    "syrian_outreach": "no",
    "syrian_production_workers": "2",
    "syrian_productivity_same_jordanian": "agree",
    "syrian_professionals": "1",
    "syrian_retain_longer": "neutral",
    "syrian_support_services": "0",
    "temporary_client_services": "0",
    "temporary_contract_professionals": "0",
    "temporary_production_workers": "0",
    "temporary_support_services": "0",
    "total_employees": "15",
    "training_not_required": "yes"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Firm Detail ¶

Show Firm Detail
GET`/firms/{case_id}`

Example URI

GET /firms/{case_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "case_id": "6181cce7",
  "adverstise_through_other": "لا",
  "advertise_through_agency": "no",
  "advertise_through_building_site": "no",
  "advertise_through_epu": "no",
  "advertise_through_newspapers": "no",
  "advertise_through_ngo": "no",
  "advertise_through_online": "no",
  "age_client_services": "0",
  "age_production_workers": "25",
  "age_professionals": "29",
  "age_support_services": "0",
  "application_fee": "no",
  "applied_num_client": "0",
  "applied_num_production": "15",
  "applied_num_professionals": "4",
  "applied_num_support": "0",
  "case_name": "200131892",
  "case_type": "firm",
  "cgender": "male",
  "clerical_experience_not_required": "yes",
  "cnationality": "syrian",
  "coage": "25",
  "commercial_id": "106406",
  "compact_is_good": "yes",
  "contact_time": "anytime",
  "contact_years_firm": "1",
  "contact_years_industry": "5",
  "cv10_17": "no",
  "cv10_18": "العمر",
  "cv11_17": "no",
  "cv11_18": "العمر",
  "cv12_17": "yes",
  "cv13_17": "no",
  "cv13_18": "العمر",
  "cv14_17": "no",
  "cv14_18": "العمر",
  "cv15_17": "no",
  "cv15_18": "العمر",
  "cv16_17": "yes",
  "cv17_17": "no",
  "cv17_18": "العمر",
  "cv18_17": "yes",
  "cv19_17": "yes",
  "cv1_17": "no",
  "cv1_18": "العمر",
  "cv20_17": "yes",
  "cv21_17": "no",
  "cv21_18": "العمر",
  "cv22_17": "yes",
  "cv23_17": "yes",
  "cv24_17": "no",
  "cv24_18": "العمر",
  "cv25_17": "yes",
  "cv26_17": "yes",
  "cv27_17": "no",
  "cv27_18": "العمر",
  "cv28_17": "yes",
  "cv29_17": "yes",
  "cv2_17": "no",
  "cv2_18": "العمر",
  "cv30_17": "yes",
  "cv3_17": "yes",
  "cv4_17": "yes",
  "cv5_17": "no",
  "cv6_17": "yes",
  "cv7_17": "no",
  "cv7_18": "العمر",
  "cv8_17": "no",
  "cv8_18": "العمر",
  "cv9_17": "yes",
  "date_opened": "2018",
  "displayed_salary": "yes",
  "dorms_not_required": "yes",
  "education": "secondary",
  "education_production_workers": "no_school",
  "education_professionals": "secondary",
  "employment_policy: rare_promotion": "Hello, world!",
  "employment_programs": "no",
  "end_time": "12:50:00.000+02",
  "eso_id": "13",
  "establishment_date": "2013",
  "expected_hire_production": "9",
  "expected_hire_support": "0",
  "expected_hires_client": "0",
  "expected_hires_professionals": "0",
  "experience_client_services": "0",
  "experience_not_required": "yes",
  "experience_production_workers": "1",
  "experience_professionals": "1",
  "experience_support_services": "0",
  "external_id": "null",
  "factory_experience_not_required": "yes",
  "fcity": "irbid",
  "fdistrict": "مدينة الحسنةالصناعية",
  "femail": "abdalrahmn1980@gmail.com",
  "female_employees": "3",
  "female_production_employees": "3",
  "female_professional_employees": "0",
  "female_service_employees": "0",
  "female_support_employees": "0",
  "ffname": "عمار",
  "fgps": "32.4966908 36.0266391 568.0 20.0",
  "fill_time_client": "0",
  "fill_time_production": "personal_contacts",
  "fill_time_professionals": "1",
  "fill_time_support": "0",
  "firm_consent": "yes",
  "firm_id_method": "site_visit",
  "firm_is_hiring": "yes",
  "firm_name": "مصنع كلش للبسكويت",
  "firm_national_id": "200131892",
  "firm_status": "proprietorship",
  "flname": "عبد الحي",
  "fmobile": "0795464852",
  "fphone": "0797481314",
  "fposition": "finance_manager",
  "heard_about_service": "no",
  "hire_num_client": "0",
  "hire_num_production": "6",
  "hire_num_support": "0",
  "hire_process_client_services": "لم يتم توظيف اي شخص",
  "hire_process_production_workers: personal_contacts": "Hello, world!",
  "hire_process_professionals": "personal_contacts",
  "hire_process_support_services": "لم يتم توظيف اي شخص",
  "hired_num_professionals": "1",
  "hired_syrians_since_before": "no",
  "hr_challenge: employee_turnover": "Hello, world!",
  "interview_client": "yes",
  "interview_date": "2018",
  "interview_production": "no",
  "interview_professionals": "yes",
  "interview_support": "no",
  "interview_time": "12:09:00.000+02",
  "know_about_compact": "yes",
  "know_same_about_job": "disagree",
  "labor_directorate": "ibrid",
  "management_experience_not_required": "yes",
  "management_female_employees": "0",
  "managment_employees": "1",
  "manual_experience_not_required": "yes",
  "night_shifts_not_required": "yes",
  "no_cooperation_risk": "disagree",
  "num_contract_end_last_year": "0",
  "num_fired_last_year": "0",
  "num_locations": "1",
  "num_owners": "2",
  "num_quit_last_year": "8",
  "num_turnover_last_year": "8",
  "opened_date": "2018",
  "owner_id": "40c7d589ba38440a9307543a644d1da4",
  "owner_nationality": "syrian",
  "percent_government": "0",
  "percent_private_domestic": "0",
  "percent_private_foreign": "100",
  "permanent_client_services": "0",
  "permanent_contract_professionals": "1",
  "permanent_production_workers": "13",
  "permanent_support_services": "0",
  "produce_in_roo": "no",
  "product_code": "96",
  "production_employyes": "13",
  "professional_employees": "0",
  "professional_experience_not_required": "yes",
  "promotion_method: effort_ability": "Hello, world!",
  "recruitment_test": "no",
  "salary_1year_client_services": "0",
  "salary_1year_production_workers": "235",
  "salary_1year_support_services": "0",
  "salary_5years_client_services": "0",
  "salary_5years_production_workers": "275",
  "salary_5years_professionals": "750",
  "salary_5years_support_services": "0",
  "salary_year_professionals": "600",
  "sector": "production",
  "service_employees": "0",
  "sez_firm": "yes",
  "sez_name: prince_hassan": "Hello, world!",
  "staff_april1_2018": "15",
  "staff_march1_2018": "9",
  "starting_salary_client_services": "0",
  "starting_salary_production_workers": "220",
  "starting_salary_professionals": "450",
  "starting_salary_support_services": "0",
  "support_employees": "0",
  "syrian_cares_more": "neutral",
  "syrian_client_services": "0",
  "syrian_hired_same_jordanian: strongly_disagree": "Hello, world!",
  "syrian_lower_wage": "agree",
  "syrian_outreach": "no",
  "syrian_production_workers": "2",
  "syrian_productivity_same_jordanian": "agree",
  "syrian_professionals": "1",
  "syrian_retain_longer": "neutral",
  "syrian_support_services": "0",
  "temporary_client_services": "0",
  "temporary_contract_professionals": "0",
  "temporary_production_workers": "0",
  "temporary_support_services": "0",
  "total_employees": "15",
  "training_not_required": "yes"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "case_id": {
      "type": "string",
      "description": "9517-4b31-a4fa-aac266f1cb84"
    },
    "adverstise_through_other": {
      "type": "string"
    },
    "advertise_through_agency": {
      "type": "string"
    },
    "advertise_through_building_site": {
      "type": "string"
    },
    "advertise_through_epu": {
      "type": "string"
    },
    "advertise_through_newspapers": {
      "type": "string"
    },
    "advertise_through_ngo": {
      "type": "string"
    },
    "advertise_through_online": {
      "type": "string"
    },
    "age_client_services": {
      "type": "string"
    },
    "age_production_workers": {
      "type": "string"
    },
    "age_professionals": {
      "type": "string"
    },
    "age_support_services": {
      "type": "string"
    },
    "application_fee": {
      "type": "string"
    },
    "applied_num_client": {
      "type": "string"
    },
    "applied_num_production": {
      "type": "string"
    },
    "applied_num_professionals": {
      "type": "string"
    },
    "applied_num_support": {
      "type": "string"
    },
    "case_name": {
      "type": "string"
    },
    "case_type": {
      "type": "string"
    },
    "cgender": {
      "type": "string"
    },
    "clerical_experience_not_required": {
      "type": "string"
    },
    "cnationality": {
      "type": "string"
    },
    "coage": {
      "type": "string"
    },
    "commercial_id": {
      "type": "string"
    },
    "compact_is_good": {
      "type": "string"
    },
    "contact_time": {
      "type": "string"
    },
    "contact_years_firm": {
      "type": "string"
    },
    "contact_years_industry": {
      "type": "string"
    },
    "cv10_17": {
      "type": "string"
    },
    "cv10_18": {
      "type": "string"
    },
    "cv11_17": {
      "type": "string"
    },
    "cv11_18": {
      "type": "string"
    },
    "cv12_17": {
      "type": "string"
    },
    "cv13_17": {
      "type": "string"
    },
    "cv13_18": {
      "type": "string"
    },
    "cv14_17": {
      "type": "string"
    },
    "cv14_18": {
      "type": "string"
    },
    "cv15_17": {
      "type": "string"
    },
    "cv15_18": {
      "type": "string"
    },
    "cv16_17": {
      "type": "string"
    },
    "cv17_17": {
      "type": "string"
    },
    "cv17_18": {
      "type": "string"
    },
    "cv18_17": {
      "type": "string"
    },
    "cv19_17": {
      "type": "string"
    },
    "cv1_17": {
      "type": "string"
    },
    "cv1_18": {
      "type": "string"
    },
    "cv20_17": {
      "type": "string"
    },
    "cv21_17": {
      "type": "string"
    },
    "cv21_18": {
      "type": "string"
    },
    "cv22_17": {
      "type": "string"
    },
    "cv23_17": {
      "type": "string"
    },
    "cv24_17": {
      "type": "string"
    },
    "cv24_18": {
      "type": "string"
    },
    "cv25_17": {
      "type": "string"
    },
    "cv26_17": {
      "type": "string"
    },
    "cv27_17": {
      "type": "string"
    },
    "cv27_18": {
      "type": "string"
    },
    "cv28_17": {
      "type": "string"
    },
    "cv29_17": {
      "type": "string"
    },
    "cv2_17": {
      "type": "string"
    },
    "cv2_18": {
      "type": "string"
    },
    "cv30_17": {
      "type": "string"
    },
    "cv3_17": {
      "type": "string"
    },
    "cv4_17": {
      "type": "string"
    },
    "cv5_17": {
      "type": "string"
    },
    "cv6_17": {
      "type": "string"
    },
    "cv7_17": {
      "type": "string"
    },
    "cv7_18": {
      "type": "string"
    },
    "cv8_17": {
      "type": "string"
    },
    "cv8_18": {
      "type": "string"
    },
    "cv9_17": {
      "type": "string"
    },
    "date_opened": {
      "type": "string",
      "description": "08-27T11:56:31.695000Z"
    },
    "displayed_salary": {
      "type": "string"
    },
    "dorms_not_required": {
      "type": "string"
    },
    "education": {
      "type": "string"
    },
    "education_production_workers": {
      "type": "string"
    },
    "education_professionals": {
      "type": "string"
    },
    "employment_policy: rare_promotion": {
      "type": "string"
    },
    "employment_programs": {
      "type": "string"
    },
    "end_time": {
      "type": "string"
    },
    "eso_id": {
      "type": "string"
    },
    "establishment_date": {
      "type": "string",
      "description": "02-24"
    },
    "expected_hire_production": {
      "type": "string"
    },
    "expected_hire_support": {
      "type": "string"
    },
    "expected_hires_client": {
      "type": "string"
    },
    "expected_hires_professionals": {
      "type": "string"
    },
    "experience_client_services": {
      "type": "string"
    },
    "experience_not_required": {
      "type": "string"
    },
    "experience_production_workers": {
      "type": "string"
    },
    "experience_professionals": {
      "type": "string"
    },
    "experience_support_services": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "factory_experience_not_required": {
      "type": "string"
    },
    "fcity": {
      "type": "string"
    },
    "fdistrict": {
      "type": "string"
    },
    "femail": {
      "type": "string"
    },
    "female_employees": {
      "type": "string"
    },
    "female_production_employees": {
      "type": "string"
    },
    "female_professional_employees": {
      "type": "string"
    },
    "female_service_employees": {
      "type": "string"
    },
    "female_support_employees": {
      "type": "string"
    },
    "ffname": {
      "type": "string"
    },
    "fgps": {
      "type": "string"
    },
    "fill_time_client": {
      "type": "string"
    },
    "fill_time_production": {
      "type": "string"
    },
    "fill_time_professionals": {
      "type": "string"
    },
    "fill_time_support": {
      "type": "string"
    },
    "firm_consent": {
      "type": "string"
    },
    "firm_id_method": {
      "type": "string"
    },
    "firm_is_hiring": {
      "type": "string"
    },
    "firm_name": {
      "type": "string"
    },
    "firm_national_id": {
      "type": "string"
    },
    "firm_status": {
      "type": "string"
    },
    "flname": {
      "type": "string"
    },
    "fmobile": {
      "type": "string"
    },
    "fphone": {
      "type": "string"
    },
    "fposition": {
      "type": "string"
    },
    "heard_about_service": {
      "type": "string"
    },
    "hire_num_client": {
      "type": "string"
    },
    "hire_num_production": {
      "type": "string"
    },
    "hire_num_support": {
      "type": "string"
    },
    "hire_process_client_services": {
      "type": "string"
    },
    "hire_process_production_workers: personal_contacts": {
      "type": "string"
    },
    "hire_process_professionals": {
      "type": "string"
    },
    "hire_process_support_services": {
      "type": "string"
    },
    "hired_num_professionals": {
      "type": "string"
    },
    "hired_syrians_since_before": {
      "type": "string"
    },
    "hr_challenge: employee_turnover": {
      "type": "string"
    },
    "interview_client": {
      "type": "string"
    },
    "interview_date": {
      "type": "string",
      "description": "11-01"
    },
    "interview_production": {
      "type": "string"
    },
    "interview_professionals": {
      "type": "string"
    },
    "interview_support": {
      "type": "string"
    },
    "interview_time": {
      "type": "string"
    },
    "know_about_compact": {
      "type": "string"
    },
    "know_same_about_job": {
      "type": "string"
    },
    "labor_directorate": {
      "type": "string"
    },
    "management_experience_not_required": {
      "type": "string"
    },
    "management_female_employees": {
      "type": "string"
    },
    "managment_employees": {
      "type": "string"
    },
    "manual_experience_not_required": {
      "type": "string"
    },
    "night_shifts_not_required": {
      "type": "string"
    },
    "no_cooperation_risk": {
      "type": "string"
    },
    "num_contract_end_last_year": {
      "type": "string"
    },
    "num_fired_last_year": {
      "type": "string"
    },
    "num_locations": {
      "type": "string"
    },
    "num_owners": {
      "type": "string"
    },
    "num_quit_last_year": {
      "type": "string"
    },
    "num_turnover_last_year": {
      "type": "string"
    },
    "opened_date": {
      "type": "string",
      "description": "08-27T11:56:31.000000Z"
    },
    "owner_id": {
      "type": "string"
    },
    "owner_nationality": {
      "type": "string"
    },
    "percent_government": {
      "type": "string"
    },
    "percent_private_domestic": {
      "type": "string"
    },
    "percent_private_foreign": {
      "type": "string"
    },
    "permanent_client_services": {
      "type": "string"
    },
    "permanent_contract_professionals": {
      "type": "string"
    },
    "permanent_production_workers": {
      "type": "string"
    },
    "permanent_support_services": {
      "type": "string"
    },
    "produce_in_roo": {
      "type": "string"
    },
    "product_code": {
      "type": "string"
    },
    "production_employyes": {
      "type": "string"
    },
    "professional_employees": {
      "type": "string"
    },
    "professional_experience_not_required": {
      "type": "string"
    },
    "promotion_method: effort_ability": {
      "type": "string"
    },
    "recruitment_test": {
      "type": "string"
    },
    "salary_1year_client_services": {
      "type": "string"
    },
    "salary_1year_production_workers": {
      "type": "string"
    },
    "salary_1year_support_services": {
      "type": "string"
    },
    "salary_5years_client_services": {
      "type": "string"
    },
    "salary_5years_production_workers": {
      "type": "string"
    },
    "salary_5years_professionals": {
      "type": "string"
    },
    "salary_5years_support_services": {
      "type": "string"
    },
    "salary_year_professionals": {
      "type": "string"
    },
    "sector": {
      "type": "string"
    },
    "service_employees": {
      "type": "string"
    },
    "sez_firm": {
      "type": "string"
    },
    "sez_name: prince_hassan": {
      "type": "string"
    },
    "staff_april1_2018": {
      "type": "string"
    },
    "staff_march1_2018": {
      "type": "string"
    },
    "starting_salary_client_services": {
      "type": "string"
    },
    "starting_salary_production_workers": {
      "type": "string"
    },
    "starting_salary_professionals": {
      "type": "string"
    },
    "starting_salary_support_services": {
      "type": "string"
    },
    "support_employees": {
      "type": "string"
    },
    "syrian_cares_more": {
      "type": "string"
    },
    "syrian_client_services": {
      "type": "string"
    },
    "syrian_hired_same_jordanian: strongly_disagree": {
      "type": "string"
    },
    "syrian_lower_wage": {
      "type": "string"
    },
    "syrian_outreach": {
      "type": "string"
    },
    "syrian_production_workers": {
      "type": "string"
    },
    "syrian_productivity_same_jordanian": {
      "type": "string"
    },
    "syrian_professionals": {
      "type": "string"
    },
    "syrian_retain_longer": {
      "type": "string"
    },
    "syrian_support_services": {
      "type": "string"
    },
    "temporary_client_services": {
      "type": "string"
    },
    "temporary_contract_professionals": {
      "type": "string"
    },
    "temporary_production_workers": {
      "type": "string"
    },
    "temporary_support_services": {
      "type": "string"
    },
    "total_employees": {
      "type": "string"
    },
    "training_not_required": {
      "type": "string"
    }
  }
}

Job Opening ¶

Job Openings List ¶

List Job Openings
GET`/job-seekers/`

Example URI

GET /job-seekers/

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "case_id": "cce13022",
    "job_id": "NCJDI5",
    "age_accepted: all_age": "Hello, world!",
    "bus_covered": "yes",
    "case_name": "NCJDI5",
    "case_type": "job",
    "childcare_subsidy_offered": "no",
    "date_opened": "2018",
    "date_required": "2018",
    "dorm_covered": "no",
    "driving_ability_required": "no",
    "education_required: no_school": "Hello, world!",
    "english_proficiency_required": "not_literate",
    "external_id\"": "nul",
    "female_requied": "yes",
    "free_meals_at_wok": "no",
    "health_insurance_offered": "no",
    "housing_subsidy_offered": "no",
    "it_proficiency_required": "none",
    "job_description": "production",
    "job_production: textile_worker": "Hello, world!",
    "job_title": "خياطات",
    "label_name": "مصنع البشائر لصناعة الالبسة",
    "literacy_required": "no",
    "male_required": "no",
    "meal_subsidy_offered": "no",
    "night_shifts_required": "no",
    "num_vacancies": "3",
    "owner_id": "40c7d589ba38440a9307543a644d1da4",
    "physical_work_abilities_required": "no",
    "school_subsidy_offered": "no",
    "specialization_required": "no",
    "syrian_considered": "no",
    "syrian_not_considered": "يرغب صاحب العمل بتشغيل العمالة الاردنية",
    "transport_subsidy_offered": "no",
    "wage_offered": "220",
    "work_permit_offered": "no",
    "years_experience_required": "1"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Job Opening Detail ¶

Show Job Opening Detail
GET`/job-seekers/{case_id}`

Example URI

GET /job-seekers/{case_id}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "case_id": "cce13022",
  "job_id": "NCJDI5",
  "age_accepted: all_age": "Hello, world!",
  "bus_covered": "yes",
  "case_name": "NCJDI5",
  "case_type": "job",
  "childcare_subsidy_offered": "no",
  "date_opened": "2018",
  "date_required": "2018",
  "dorm_covered": "no",
  "driving_ability_required": "no",
  "education_required: no_school": "Hello, world!",
  "english_proficiency_required": "not_literate",
  "external_id\"": "nul",
  "female_requied": "yes",
  "free_meals_at_wok": "no",
  "health_insurance_offered": "no",
  "housing_subsidy_offered": "no",
  "it_proficiency_required": "none",
  "job_description": "production",
  "job_production: textile_worker": "Hello, world!",
  "job_title": "خياطات",
  "label_name": "مصنع البشائر لصناعة الالبسة",
  "literacy_required": "no",
  "male_required": "no",
  "meal_subsidy_offered": "no",
  "night_shifts_required": "no",
  "num_vacancies": "3",
  "owner_id": "40c7d589ba38440a9307543a644d1da4",
  "physical_work_abilities_required": "no",
  "school_subsidy_offered": "no",
  "specialization_required": "no",
  "syrian_considered": "no",
  "syrian_not_considered": "يرغب صاحب العمل بتشغيل العمالة الاردنية",
  "transport_subsidy_offered": "no",
  "wage_offered": "220",
  "work_permit_offered": "no",
  "years_experience_required": "1"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "case_id": {
      "type": "string",
      "description": "00ba-402d-a6f1-b80df74317e0"
    },
    "job_id": {
      "type": "string"
    },
    "age_accepted: all_age": {
      "type": "string"
    },
    "bus_covered": {
      "type": "string"
    },
    "case_name": {
      "type": "string"
    },
    "case_type": {
      "type": "string",
      "description": "opening"
    },
    "childcare_subsidy_offered": {
      "type": "string"
    },
    "date_opened": {
      "type": "string",
      "description": "10-28T13:34:51.170000Z"
    },
    "date_required": {
      "type": "string",
      "description": "11-28"
    },
    "dorm_covered": {
      "type": "string"
    },
    "driving_ability_required": {
      "type": "string"
    },
    "education_required: no_school": {
      "type": "string"
    },
    "english_proficiency_required": {
      "type": "string"
    },
    "external_id\"": {
      "type": "string"
    },
    "female_requied": {
      "type": "string"
    },
    "free_meals_at_wok": {
      "type": "string"
    },
    "health_insurance_offered": {
      "type": "string"
    },
    "housing_subsidy_offered": {
      "type": "string"
    },
    "it_proficiency_required": {
      "type": "string"
    },
    "job_description": {
      "type": "string"
    },
    "job_production: textile_worker": {
      "type": "string"
    },
    "job_title": {
      "type": "string"
    },
    "label_name": {
      "type": "string",
      "description": "خياطات"
    },
    "literacy_required": {
      "type": "string"
    },
    "male_required": {
      "type": "string"
    },
    "meal_subsidy_offered": {
      "type": "string"
    },
    "night_shifts_required": {
      "type": "string"
    },
    "num_vacancies": {
      "type": "string"
    },
    "owner_id": {
      "type": "string"
    },
    "physical_work_abilities_required": {
      "type": "string"
    },
    "school_subsidy_offered": {
      "type": "string"
    },
    "specialization_required": {
      "type": "string"
    },
    "syrian_considered": {
      "type": "string"
    },
    "syrian_not_considered": {
      "type": "string"
    },
    "transport_subsidy_offered": {
      "type": "string"
    },
    "wage_offered": {
      "type": "string"
    },
    "work_permit_offered": {
      "type": "string"
    },
    "years_experience_required": {
      "type": "string"
    }
  }
}

Job Match ¶

Job Matches ¶

Job ID has finished matchingGET/job-matches/?job_id={job_id}

Example URI

Headers

Body

Job ID hasn't finished matchingGET/job-matches/?job_id={job_id}

Example URI

Headers

Body

Job match doesn't existGET/job-matches/?job_id={job_id}

Example URI

Headers

Create Job Match ListPOST/job-matches/?job_id={job_id}

Example URI

Job Match already createdPOST/job-matches/?job_id={job_id}

Example URI

Headers

Body

Job Opening doesn't existPOST/job-matches/?job_id={job_id}

Example URI

Headers

Body

Delete Job MatchDELETE/job-matches/?job_id={job_id}

Example URI

Headers

Job Seeker ¶

Job Seekers List ¶

List Job SeekersGET/job-seekers/

Example URI

Headers

Body

Schema

Job Seeker Detail ¶

Show Job Seeker DetailGET/job-seekers/{case_id}

Example URI

Headers

Body

Schema

Matches ¶

Match List ¶

List MatchesGET/matches/

Example URI

Headers

Body

Schema

Match Detail ¶

Show Match DetailGET/matches/{case_id}

Example URI

Headers

Body

Schema

Firms ¶

Firms List ¶

List FirmsGET/firms/

Example URI

Headers

Body

Schema

Firm Detail ¶

Show Firm DetailGET/firms/{case_id}

Example URI

Headers

Body

Schema

Job Opening ¶

Job Openings List ¶

List Job OpeningsGET/job-seekers/

Example URI

Headers

Body

Schema

Job Opening Detail ¶

Show Job Opening DetailGET/job-seekers/{case_id}

Example URI

Headers

Body

Schema

Job ID has finished matching
GET`/job-matches/?job_id={job_id}`

Job ID hasn't finished matching
GET`/job-matches/?job_id={job_id}`

Job match doesn't exist
GET`/job-matches/?job_id={job_id}`

Create Job Match List
POST`/job-matches/?job_id={job_id}`

Job Match already created
POST`/job-matches/?job_id={job_id}`

Job Opening doesn't exist
POST`/job-matches/?job_id={job_id}`

Delete Job Match
DELETE`/job-matches/?job_id={job_id}`

List Job Seekers
GET`/job-seekers/`

Show Job Seeker Detail
GET`/job-seekers/{case_id}`

List Matches
GET`/matches/`

Show Match Detail
GET`/matches/{case_id}`

List Firms
GET`/firms/`

Show Firm Detail
GET`/firms/{case_id}`

List Job Openings
GET`/job-seekers/`

Show Job Opening Detail
GET`/job-seekers/{case_id}`