Git Product home page Git Product logo

interview-backend's Introduction

README

Lets try and get these right this time, right Dane?!?

Important - Domain https://interviewtracker-api.herokuapp.com NOTE: can pass auth_token in Header data

CREATE USER

STATUS 201 CREATED from POST [domain]/users

data:

"user": {
  "email": "[email protected]",
  "password": "atleast8chars"
}

sample response:

{
    "user": {
        "email": "[email protected]",
        "authentication_token": "GhBPRwKabKQX2wLzwU56"
    }
}

USER SIGN IN

STATUS 200 OK from POST [domain]/users/sign_in

data:

{
  "user": {
    "email": "[email protected]",
    "password": "atleast8chars"
  }
}

sample response:

{
    "user": {
        "email": "[email protected]",
        "authentication_token": "GhBPRwKabKQX2wLzwU56"
    }
}

GET USERS LISTINGS

STATUS 200 OK from GET [domain]/users/listings

data:

  "auth_token": {
    "GhBPRwKabKQX2wLzwU56"
  }

sample response:

{
    "listings": [
        {
            "user_id": 2,
            "id": 2,
            "company_id": null,
            "contact_id": null,
            "job_title": null,
            "applied": false,
            "contact_email": null,
            "phone_number": null,
            "posting_url": null,
            "created_at": "2015-03-07T13:21:12.592Z",
            "updated_at": "2015-03-07T13:21:12.592Z",
            "submitted_resume": false,
            "date_resume_submitted": null,
            "opportunity_ranking": 4,
            "opportunity_description": "Great small hot new social web startup",
            "company_summary": "the owner mark seems like a nice guy, they like likes.",
            "lead_source": "Was referred by CTO, forgot his name :("
        },
        {
            "user_id": 2,
            "id": 3,
            "job_title": null,
            "applied": false,
            "contact_email": null,
            "phone_number": null,
            "posting_url": null,
            "created_at": "2015-03-07T13:26:20.245Z",
            "updated_at": "2015-03-07T13:26:20.245Z",
            "submitted_resume": false,
            "date_resume_submitted": null,
            "opportunity_ranking": 4,
            "opportunity_description": "Great small hot new social web startup",
            "company_summary": "the owner mark seems like a nice guy, they like likes.",
            "lead_source": "Was referred by CTO, forgot his name :("
        }
    ]
}

GET ONE LISTING

STATUS 200 OK from GET [domain]/users/listings/[:lid]

data:

  "auth_token": {
    "GhBPRwKabKQX2wLzwU56"
  }

sample response

{
    "listing": {
        "user_id": 1,
        "id": 1,
        "job_title": "Front End Engineer",
        "applied": false,
        "contact_email": "[email protected]",
        "phone_number": null,
        "posting_url": "http://www.google.com/jobs/job/1234",
        "created_at": "2015-03-07T13:54:38.501Z",
        "updated_at": "2015-03-07T13:54:38.501Z",
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

EDIT LISTING

STATUS 200 OK from PATCH [domain]/users/listings/[:lid]

data:

{
    "listing": {
        "job_title": "Front End Engineer",
        "applied": false,
        "contact_email": "[email protected]",
        "phone_number": null,
        "email": "[email protected]",
        "posting_url": "http://www.google.com/jobs/job/1234",
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

response:

{
    "listing": {
        "user_id": 1,
        "id": 1,
        "company_id": 2,
        "contact_id": 2,
        "job_title": "Engineer",
        "applied": false,
        "contact_email": "[email protected]",
        "phone_number": null,
        "posting_url": "http://www.google.com/jobs/job/1234",
        "created_at": "2015-03-07T13:54:38.501Z",
        "updated_at": "2015-03-07T14:47:41.935Z"
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

POST A LISTING

STATUS 201 CREATED from POST [domain]/users/listings

data

{
    "listing": {
        "job_title": "Junior Ruby Developer",
        "applied": false,
        "contact_email": "[email protected],
        "phone_number": "18005556677,
        "posting_url": "https://www.facebook.com/jobs/234",
        "company_name": "Facebook",
        "notes": null,
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

response

{
    "listing": {
        "id": 2,
        "user_id": 1,
        "contact_id": null,
        "job_title": "Junior Ruby Developer",
        "applied": false,
        "contact_email": "[email protected]",
        "phone_number": "18005556677",
        "posting_url": "https://www.facebook.com/jobs/234",
        "created_at": "2015-03-07T18:37:30.543Z",
        "updated_at": "2015-03-07T18:37:30.543Z",
        "interview_id": null,
        "company_name": "Facebook",
        "notes": null,
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

DELETE A LISTING

STATUS 200 OK from DELETE [domain]/users/listings/[:lid]

data: Provide auth_token in header

sample response

{
    "message": "Listing successfully deleted"
}

POST AN INTERVIEW

STATUS 201 CREATED from POST [domain]/users/listings/[:lid]/intervews

data:

{
    "interview": {
        "follow_up_email": null,
        "interview_time": null,
        "interviewtype": null,
        "interviewed": false,
        "notes": null,
        "status": null
    }
}

response:

{
    "listing": {
        "id": 2,
        "user_id": 1,
        "contact_id": null,
        "job_title": "Junior Ruby Developer",
        "applied": false,
        "contact_email": "[email protected]",
        "phone_number": "18005556677",
        "posting_url": "https://www.facebook.com/jobs/234",
        "created_at": "2015-03-07T18:37:30.543Z",
        "updated_at": "2015-03-07T18:37:30.543Z",
        "interview_id": null,
        "company_name": "Facebook",
        "notes": null,
        "submitted_resume": false,
        "date_resume_submitted": null,
        "opportunity_ranking": 4,
        "opportunity_description": "Great small hot new social web startup",
        "company_summary": "the owner mark seems like a nice guy, they like likes.",
        "lead_source": "Was referred by CTO, forgot his name :("
    }
}

GET USER PROFILE

STATUS 200 OK from GET [domain]/user

data: just auth_token in header

response:

{
    "user": {
        "id": 2,
        "email": "[email protected]",
        "full_name": "dylan dechant",
        "age": 28,
        "experience": "things",
        "skills": "sleeeping",
        "education": "school"
    }
}

EDIT USER PROFILE

STATUS 200 OK from PATCH [domain]/user

data: auth_token in header, body:

{
    "user": {
        "full_name": "dylan dechant",
        "age": 28,
        "experience": "things",
        "skills": "sleeeping",
        "education": "school"
    }
}

response:

{
    "user": {
        "id": 2,
        "email": "[email protected]",
        "full_name": "dylan dechant",
        "age": 28,
        "experience": "things",
        "skills": "sleeeping",
        "education": "school"
    }
}

GET PRE INTERVIEW CHECKLIST

STATUS 200 OK from GET [domain]/users/listings/[:lid]/preinterview

data: auth_token in header

{
    "preinterview": {
        "research": null,
        "interviewer": null,
        "location": null,
        "businesscards": null,
        "keyfindings": null,
        "interviewtips": null
    }
}

GET POST INTERVIEW CHECKLIST

STATUS 200 OK from GET [domain]/users/listings/[:lid]/postinterview

data: auth_token in header

{
    "postinterview": {
        "takeaway": null,
        "conversation": null,
        "whodidyoumeet": null,
        "status": null,
        "contactemail": null,
        "recruiteremail": null,
        "thankyounote": "suckkaaaa"
    }
}

EDIT PRE INTERVIEW CHECKLIST

STATUS 200 OK from PATCH [domain]/users/listings/[:lid]/preinterview

data: auth_token in header and any of these fields

{
    "preinterview": {
        "research": "your value",
        "interviewer": "your value",
        "location": "your value",
        "businesscards": "your value",
        "keyfindings": "your value",
        "interviewtips": "your value"
    }
}

response:

{
    "preinterview": {
        "research": "your value",
        "interviewer": "your value",
        "location": "your value",
        "businesscards": "your value",
        "keyfindings": "your value",
        "interviewtips": "your value"
    }
}

EDIT POST INTERVIEW CHECKLIST

STATUS 200 OK from PATCH [domain]/users/listings/[:lid]/postinterview

data: auth_token in header and any of these fields

{
    "postinterview": {
        "takeaway": "your value",
        "conversation": "your value",
        "whodidyoumeet": "your value",
        "status": "your value",
        "contactemail": "your value",
        "recruiteremail": "your value",
        "thankyounote": "your value"
    }
}

response:

{
    "postinterview": {
        "takeaway": "your value",
        "conversation": "your value",
        "whodidyoumeet": "your value",
        "status": "your value",
        "contactemail": "your value",
        "recruiteremail": "your value",
        "thankyounote": "your value"
    }
}

interview-backend's People

Contributors

dylandechant avatar mgashraf avatar chubeesah avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.