Agility360 Candidate Engagement App

REST API documentation


Technical contact: Lawrence McDaniel: (415) 766-9012 | lpm0073@gmail.com

Business contact: Ryan Gibson: (903) 267-0300 | rgibson@agility360.net

Master Project Site: project.agility360app.net

Note: As a matter of convenience this api will be publicly accessible during development. Afterwards I will setup security credentials that will be stored locally in the mobile app.

Note: This api uses 128-bit SSL encryption.

Usage: This API provides all of the data resources for the Candidate Engagement mobile app. You can use a standard web browser like Chrome to view this api. Alternatively, you can also use something more sophisticated, like a REST client such as Postman to test the POST methods in your API to create a new candidate account.


Candidates

URL end point: /beta/candidates/{accountName}

GET

This API contains the /candidates/{accountName} resource. By making a GET request to /candidates/{accountName} you can retrieve the master account profile record of a candidate in your MySQL database. If you are looking for a specific candidate, for example the candidate with accountName "mcdaniel", you can make a GET request to /candidates/mcdaniel.

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel

Sample body response object:

                {
                  "candidate_id": 6,
                  "account_name": "mcdaniel"
                  "first_name": "Lawrence",
                  "middle_name": "Philip",
                  "last_name": "McDaniel",
                  "job_hunting": 0,
                  "phone_number": "(415) 766-9012",
                  "email": "lpm0073@gmail.com",
                  "city": "Plano",
                  "state": "TX",
                  "industry_id": 0,
                  "subindustry_id": 0,
                  "profession_id": 0,
                  "subprofession_id": 0,
                  "create_date": 2017-07-31 20:57:32,
                  "update_date": 2017-07-31 20:57:32
                }
              

POST

Sample body request object:

                {
                  "account_name": "mcdaniel",
                  "first_name": "Lawrence",
                  "middle_name": "Philip",
                  "last_name": "McDaniel",
                  "job_hunting": "0",
                  "phone_number": "(415) 766-9012",
                  "email": "lpm0073@gmail.com",
                  "city": "Plano",
                  "state": "TX",
                  "subprofession_id": "0",
                  "industry_id": "0",
                  "profession_id": "0",
                  "subindustry_id": "0"
                }
              

PATCH

Sample body request object:

                  {
                    "account_name": "mcdaniel",
                    "first_name": "Lawrence",
                    "middle_name": "Philip",
                    "last_name": "McDaniel",
                    "job_hunting": "0",
                    "phone_number": "(415) 766-9012",
                    "email": "lpm0073@gmail.com",
                    "city": "Plano",
                    "state": "TX",
                    "subprofession_id": "0",
                    "industry_id": "0",
                    "profession_id": "0",
                    "subindustry_id": "0"
                  }
                

Sample body response object if successful:

                  {
                    "response": "success"
                  }
                

Sample body response object if failure:

                  {
                    "reponse": "failure",
                    "err": "JSON string of error message from source system"
                  }
                

DELETE

Query parameter: ID

Sample body response object if successful:

                  {
                    "response": "success"
                  }
                

Sample body response object if failure:

                  {
                    "reponse": "failure",
                    "err": "JSON string of error message from source system"
                  }
                

Candidates - Job History

Example URI's

GET

Sample body response object:

                  [
                    {
                      "department": "None",
                      "create_date": "2017-08-01 16:55:55",
                      "candidate_id": "6",
                      "end_date": "2017-06-30 15:55:10",
                      "final_salary": "35000.0",
                      "start_date": "1979-08-01 15:55:10",
                      "job_title": "Fry Chef",
                      "id": 1,
                      "company_name": "Burger Shack"
                    },
                    {
                      "department": "None",
                      "create_date": "2017-08-01 17:03:37",
                      "candidate_id": "6",
                      "end_date": "1981-03-31 15:55:10",
                      "final_salary": "12000.0",
                      "start_date": "1981-01-01 15:55:10",
                      "job_title": "Medical research volunteer",
                      "id": 2,
                      "company_name": "Nuclear Fission Research Center"
                    }
                  ]
                

POST

Sample body request object:

                  {
                    "account_name": "mcdaniel",
                    "company_name": "CIA",
                    "job_title": "Secret Spy",
                    "start_date": "1985-02-01 15:55:10",
                    "end_date": "1987-10-12 15:55:10",
                    "final_salary": 180000
                  }
                

DELETE

Query parameter: ID

Sample body response object if successful:

                    {
                      "response": "success"
                    }
                  

Sample body response object if failure:

                    {
                      "reponse": "failure",
                      "err": "JSON string of error message from source system"
                    }
                  

PATCH

Sample body request object:

                      {
                        "id": 13,
                        "account_name": "mcdaniel",
                        "company_name": "Chipendales",
                        "job_title": "Manchild wannabe dancer",
                        "start_date": "1979-08-01 15:55:10",
                        "end_date": "2017-06-30 15:55:10",
                        "final_salary": 0,
                        "department": "the C team"
                      }
                    

Sample body response object if successful:

                      {
                        "response": "success"
                      }
                    

Sample body response object if failure:

                      {
                        "reponse": "failure",
                        "err": "JSON string of error message from source system"
                      }
                    

Candidates - Education

URL end point: /beta/candidates/{accountName}/education

GET

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/education

Sample body response object:

                    [
                      {
                        "id": 10,
                        "candidate_id": "6",
                        "institution_name": "Trump University",
                        "degree": "Certified Sucker",
                        "graduated": "1",
                        "start_date": "2015-01-03 00:00:00",
                        "end_date": "2017-06-30 00:00:00",
                        "create_date": "2017-08-03 14:39:42"
                      }
                    ]
                  

POST

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/education + payload

Sample body request object:

                    {
                      "account_name": "mcdaniel",
                      "institution_name": "Tommy Wu School",
                      "degree": "Big Money Real Estate",
                      "start_date": "1979-08-01 15:55:10",
                      "end_date": "2017-06-30 15:55:10",
                      "graduated": 1
                    }
                  

DELETE

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/education/id

Query parameter: ID

Sample body response object if successful:

                      {
                        "response": "success"
                      }
                    

Sample body response object if failure:

                      {
                        "reponse": "failure",
                        "err": "JSON string of error message from source system"
                      }
                    

PATCH

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/education/id

Sample body request object:

                        {
                          "id": 10,
                          "account_name": "mcdaniel",
                          "institution_name": "Tommy Wu School",
                          "degree": "Big Money Real Estate",
                          "start_date": "1979-08-01 15:55:10",
                          "end_date": "2017-06-30 15:55:10",
                          "graduated": 1
                        }
                      

Sample body response object if successful:

                        {
                          "response": "success"
                        }
                      

Sample body response object if failure:

                        {
                          "reponse": "failure",
                          "err": "JSON string of error message from source system"
                        }
                      

Candidates - Certifications

URL end point: /beta/candidates/{accountName}/certifications/

GET

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/certifications

Sample body response object:

                      {
[{"create_date": "2017-08-03 14:24:17", "certification_name": "Certified looney tunes", "institution_name": "Terrel State Hospital", "date_received": "1995-04-01 00:00:00", "candidate_id": "6", "expire_date": "None", "id": 8}, {"create_date": "2017-08-03 14:24:51", "certification_name": "Certified looney tunes", "institution_name": "Terrel State Hospital", "date_received": "1995-04-01 00:00:00", "candidate_id": "6", "expire_date": "None", "id": 9}, {"create_date": "2017-08-03 14:46:32", "certification_name": "Certified Angus", "institution_name": "Internet School of halfwits", "date_received": "2017-02-15 00:00:00", "candidate_id": "6", "expire_date": "None", "id": 13}]
                      }
                    

POST

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/certifications + payload

Sample body request object:

                      {
                        "account_name": "mcdaniel",
                        "institution_name": "Terrel State Hospital",
                        "certification_name": "Certified looney tunes",
                        "date_received": "1995-4-01 0:0:0",
                        "expire_date": null
                      }
                    

DELETE

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/certifications/id

Query parameter: ID

Sample body response object if successful:

                        {
                          "response": "success"
                        }
                      

Sample body response object if failure:

                        {
                          "reponse": "failure",
                          "err": "JSON string of error message from source system"
                        }
                      

PATCH

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/certifications/id

Sample body request object:

                          {
                            "id": 10,
                            "account_name": "mcdaniel",
                            "institution_name": "Tommy Wu School",
                            "certification_name": "Big Money Real Estate",
                            "date_received": "1979-08-01 15:55:10",
                            "expire_date": "2017-06-30 15:55:10"
                          }
                        

Sample body response object if successful:

                          {
                            "response": "success"
                          }
                        

Sample body response object if failure:

                          {
                            "reponse": "failure",
                            "err": "JSON string of error message from source system"
                          }
                        

Candidate - Questionnaires

GET

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/questionnaires

Sample body response object:

                          [
                            {
                              "questionnaire_id": 1,
                              "questionnaire": "Larry's custom questionnaire"
                            }
                          ]
                      

Candidate - Questionnaire Questions

GET

Example URI: https://api.agility360app.net/beta/candidates/mcdaniel/questionnaires/1

Sample body response object:

                        [
                          {
                            "question_id": 74,
                            "seq": 1,
                            "question": "Why didn't you choose a better career?",
                            "response": "I lakc durrexun in my life.",
                            "response_text": "I lakc durrexun in my life.",
                            "response_double": null,
                            "datatype_id": 0,
                            "response_datetime": "None"
                          },
                          {
                            "question_id": 75,
                            "seq": 2,
                            "question": "Are you willing to work on christmas?",
                            "response": "I have plans that day.",
                            "response_text": "I have plans that day.",
                            "response_double": null,
                            "datatype_id": 0,
                            "response_datetime": "None"
                          },
                          {
                            "question_id": 76,
                            "seq": 3,
                            "question": "What is the meaning of life?",
                            "response": "43",
                            "response_text": "43",
                            "response_double": null,
                            "datatype_id": 0,
                            "response_datetime": "None"
                          },
                          {
                            "question_id": 77,
                            "seq": 4,
                            "question": "Calculate the poisson distribution of the surface area of your apartment.",
                            "response": "say whau?",
                            "response_text": "say whau?",
                            "response_double": null,
                            "datatype_id": 0,
                            "response_datetime": "None"
                          },
                          {
                            "question_id": 78,
                            "seq": 5,
                            "question": "Name two mathematicians who live in non-uclydean N-space.",
                            "response": "Reimann and Klandenschtorck",
                            "response_text": "Reimann and Klandenschtorck",
                            "response_double": null,
                            "datatype_id": 0,
                            "response_datetime": "None"
                          }
                        ]
                      

Industries

URL end point: /beta/industries/

GET

Example URI: https://api.agility360app.net/beta/industries

Sample body response object:

                        {
                          "Undefined": 1,
                          "Mortgage": 2,
                          "Banking": 3,
                          "Energy": 4,
                          "Fast Food": 5,
                          "Extreme Sports": 6,
                          "Reality Television": 7
                        }
                      

Professions

GET

Example URI: https://api.agility360app.net/beta/professions

Sample body response object:

                          {
                            "Undefined": 1,
                            "Toaster Repairman": 2
                            "Basket Weaving Expert": 3,
                            "Senior Gamer": 4,
                            "Pastry Taster": 5,
                            "Thought Police": 6
                          }