Skip to content
This repository was archived by the owner on Aug 3, 2022. It is now read-only.

Commit 957afe6

Browse files
arnav1991arnav1991
committed
added get employee api
1 parent c543f65 commit 957afe6

File tree

6 files changed

+692
-3
lines changed

6 files changed

+692
-3
lines changed

‎docs/build/doctrees/environment.pickle

383 Bytes
Binary file not shown.

‎docs/build/doctrees/gettingStarted/authentication.doctree

40.2 KB
Binary file not shown.

‎docs/build/html/_sources/gettingStarted/authentication.rst.txt

+230-1
Original file line numberDiff line numberDiff line change
@@ -336,4 +336,233 @@ Once the payment is done sucessfully the email is sent out to the candidate.
336336
337337
**Query Parameters**
338338

339-
* id (string): Reference id retreived in invite employee API.
339+
* id (string): Reference id retreived in invite employee API.
340+
341+
Get Candidate
342+
-------------
343+
344+
AIM of this API is used to get employee details.
345+
346+
.. note::
347+
This API should only be used after getting the packages in previous API.
348+
349+
**Path** : /company/employee
350+
351+
**Method** : GET
352+
353+
**Example Request**
354+
.. code::
355+
356+
curl --location --request GET 'http://localhost:3080/company/employee?id
357+
=5d9f192f-446d-4576-926c-289863d6dbf6' \
358+
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImFqaXRlc2gudGl3YXJpQHNwcmluZ3JvbGUuY29tIiwiZG9tYWluIjoic3ByaW5ncm9sZS5jb20iLCJleHBpcmVzIjoxNTg3Mzk1Mjg0OTM5fQ.121Niu--6hEtBJ35_-1Plug96oYY63kG8mVPcQPX-7E' \
359+
360+
361+
**Example Response**
362+
.. code::
363+
364+
{
365+
"success": true,
366+
"successMsg": "packages retrived successfully",
367+
"data": {
368+
"employee": {
369+
"id": "5d9f192f-446d-4576-926c-289863d6dbf6",
370+
"access_id": "ca4be4ab-c256-4377-a9fa-9e60538ae6d3",
371+
"email": "[email protected]",
372+
"first_name": "abc",
373+
"middle_name": "",
374+
"last_name": "xyz",
375+
"name_verified": null,
376+
"created_at": "2019-07-25T13:15:19.000Z",
377+
"updated_at": "2020-03-30T14:32:24.000Z",
378+
"employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472",
379+
"payment_id": "fff773ce-7c8c-48b1-8476-bceb88f5dd62",
380+
"email_sent": true,
381+
"payment": false,
382+
"status": "VERIFIED",
383+
"flow_completed": true,
384+
"CompanyCreatedBy": "[email protected]",
385+
"EmployeeLimitId": "574077a2-1800-4e5e-bec8-cb51adf42848",
386+
"kbaqna": {
387+
"id": "d7131f0a-e716-41d4-bbcd-fd8a419bd938",
388+
"access_id": "ca4be4ab-c256-4377-a9fa-9e60538ae6d3",
389+
"email": "[email protected]",
390+
"questions_flag": 1,
391+
"kba_enabled": 1,
392+
"question_count": "4",
393+
"correct_answers": "1",
394+
"verified": false,
395+
"created_at": "2019-07-25T13:21:00.000Z",
396+
"updated_at": "2019-08-05T08:35:33.000Z",
397+
"IDMSessionId": "64ee9ce28fd84f43",
398+
"EmployeeEmail": "[email protected]"
399+
},
400+
"Employements": [
401+
{
402+
"id": "3cefb130-0d34-4859-ad95-ae5f7c42bcc7",
403+
"email": "[email protected]",
404+
"access_id": null,
405+
"employer_name": "SpringRole",
406+
"employer_name_verified": 0,
407+
"employer_phone": "1-",
408+
"employer_phone_verified": null,
409+
"employer_address": "Hosur Road",
410+
"employer_address_verified": 0,
411+
"employer_town": "Bengaluru",
412+
"employer_town_verified": 0,
413+
"state": "KA",
414+
"state_verified": null,
415+
"zipcode": "560029",
416+
"zipcode_verified": null,
417+
"employer_country": "India",
418+
"employer_country_verified": 0,
419+
"job_title": "Job",
420+
"job_title_verified": 0,
421+
"start_date": "01-01-2000",
422+
"start_date_verified": 0,
423+
"end_date": "01-01-2000",
424+
"end_date_verified": 0,
425+
"supervisor_name": "Name",
426+
"supervisor_contact": null,
427+
"current_employment": null,
428+
"current_employment_verified": 0,
429+
"contract_type": null,
430+
"contract_type_verified": "0",
431+
"source": null,
432+
"created_at": "2019-08-01T12:40:47.000Z",
433+
"updated_at": "2019-09-11T11:56:27.000Z",
434+
"job_type": "full time employee",
435+
"reason_for_leaving": null,
436+
"status": 2,
437+
"super_admin_status": 1,
438+
"consent": null
439+
}
440+
],
441+
"Education": [
442+
{
443+
"id": "a3cb1983-e69f-4053-a494-3fce7323bf66",
444+
"email": "[email protected]",
445+
"access_id": null,
446+
"employee_alias_name": null,
447+
"employee_alias_name_verified": null,
448+
"school_name": "CMS",
449+
"school_name_verified": null,
450+
"school_campus": "CMS",
451+
"school_campus_verified": null,
452+
"phone": null,
453+
"phone_verified": null,
454+
"address": null,
455+
"address_verified": null,
456+
"town": null,
457+
"town_verified": null,
458+
"city": "Lucknow",
459+
"city_verified": null,
460+
"state": "UP",
461+
"state_verified": null,
462+
"zipcode": null,
463+
"zipcode_verified": null,
464+
"country": "India",
465+
"country_verified": null,
466+
"start_date": "01-01-2000",
467+
"start_date_verified": null,
468+
"end_date": "01-01-2000",
469+
"end_date_verified": null,
470+
"degree": "Degree",
471+
"degree_verified": null,
472+
"major": null,
473+
"major_verified": null,
474+
"school_type": "University",
475+
"source": null,
476+
"created_at": "2019-08-01T13:20:23.000Z",
477+
"updated_at": "2020-03-30T14:32:22.000Z",
478+
"currently_attending": 0,
479+
"completed_successfully": 1,
480+
"status": 2,
481+
"super_admin_status": 1
482+
}
483+
],
484+
"EmployeeLimit": {
485+
"id": "574077a2-1800-4e5e-bec8-cb51adf42848",
486+
"employement": 2,
487+
"education": 1,
488+
"professional_license": 1,
489+
"civil_court": 0,
490+
"driving_license": 0,
491+
"package_id": null,
492+
"created_at": "2019-07-25T13:15:19.000Z",
493+
"updated_at": "2019-07-25T13:15:19.000Z",
494+
"EmployeeInviteGroupId": "6d3eae64-32b8-42d4-9f87-86b746afabd2",
495+
"EmployeeInviteGroup": {
496+
"id": "6d3eae64-32b8-42d4-9f87-86b746afabd2",
497+
"package": "gold",
498+
"active": false,
499+
"created_at": "2019-07-25T13:15:17.000Z",
500+
"updated_at": "2019-07-26T12:45:14.000Z",
501+
"CompanyCreatedBy": "[email protected]",
502+
"PackageId": "2"
503+
}
504+
},
505+
"EmployeeDetail": {
506+
"id": "29e8611d-1072-447f-914b-c38c19648138",
507+
"access_id": "ca4be4ab-c256-4377-a9fa-9e60538ae6d3",
508+
"address": "17 2nd Street, Suite 201",
509+
"address_verified": null,
510+
"driving_number": null,
511+
"driving_number_verified": null,
512+
"city": " Santa Monica,",
513+
"city_verified": null,
514+
"state": "CA",
515+
"state_verified": null,
516+
"zipcode": "90401",
517+
"zipcode_verified": null,
518+
"country": null,
519+
"country_verified": null,
520+
"birthdate": "29-05-1994",
521+
"birthdate_verified": null,
522+
"phone": "1-9179139020",
523+
"phone_verified": null,
524+
"ssn": "3485",
525+
"ssn_verified": null,
526+
"created_at": "2019-07-25T13:20:20.000Z",
527+
"updated_at": "2019-07-25T13:20:20.000Z",
528+
"EmployeeEmail": "[email protected]"
529+
},
530+
"EmployeeVerification": {
531+
"id": "0a392e86-6973-46d9-a6a1-a7124c5efce1",
532+
"s3_gov_id": "https://spring-verify-us.s3.amazonaws.com/employee-id/fuspuzumlu%40desoz.com/passport.jpg",
533+
"s3_gov_id_back": null,
534+
"s3_gov_id_match": false,
535+
"s3_web_img": null,
536+
"s3_passport_verified": 1,
537+
"s3_dl_verified": null,
538+
"verification_type": "id",
539+
"address": null,
540+
"address_verified": null,
541+
"city": null,
542+
"city_verified": null,
543+
"state": null,
544+
"state_verified": null,
545+
"zipcode": null,
546+
"zipcode_verified": null,
547+
"country": null,
548+
"country_verified": null,
549+
"birthdate": null,
550+
"birthdate_verified": null,
551+
"criminal_verified": null,
552+
"created_at": "2019-07-25T13:20:55.000Z",
553+
"updated_at": "2019-08-01T10:06:48.000Z",
554+
"is_report_checked": true,
555+
"summary_of_rights_accepted": true,
556+
"background_check_disclosure_accepted": true,
557+
"id_manual_review": null,
558+
"super_admin_status": null,
559+
"EmployeeEmail": "[email protected]"
560+
}
561+
},
562+
"review": []
563+
}
564+
}
565+
566+
**Query Parameters**
567+
568+
* employeeId (uuid): Contains the id of the employee.

0 commit comments

Comments
 (0)