Back to top

Notes 

New Note 

Add Note
/notes

CLIENTS ONLY: Add a new note (maximum length 300 characters).

  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Account-ID: ...
    X-HMAC: ...
    X-Recruiter-ID: ...
    Body
    {
        "candidate_id" : 123456,
        "text"         : "abc"
    }
    
  • Response  201
  • Headers
    Location: /.../notes/{id}
  • Response  401
  • Response  413
  • Response  415

Note List (919) 726-4370

Get Notes
/notes{?account_id,candidate_id,fields,page,per_page,recruiter_id,sort}

CLIENTS, ADMIN: Get a collection of notes, paginated, filtered and sorted according to parameters.

  • Parameters
  • account_id
    int (optional) Example: 189520

    ID(s) of account(s) whose notes will be displayed

    candidate_id
    int (optional) Example: 123456

    ID(s) of candidate(s) whose notes will be displayed

    fields
    string (optional) Example: candidate_id

    Which fields to display

    Choices: account_id candidate_id created id recruiter_id revision text updated

    page
    int (optional) Default: 1 

    Page number / offset

    per_page
    int (optional) Example: 10

    Number of notes displayed per page

    recruiter_id
    int (optional) Example: 303656

    ID(s) of recruiter(s) whose notes will be displayed

    sort
    string (optional) Default: -updated 

    Which field to sort by

    Choices: updated -updated

  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Account-ID: ...
    X-HMAC: ...
    X-Recruiter-ID: ...
  • Response  200
  • Headers
    Content-Length: ...
    Link: </.../notes?...per_page=3&page=2>; rel="next", ...
    Body
    [
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 1,
            "revision"     : 1,
            "text"         : "foo",
            "updated"      : "...",
            "visible"      : true
        }
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 2,
            "revision"     : 1,
            "text"         : "boo",
            "updated"      : "...",
            "visible"      : true
        }
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 3,
            "revision"     : 2,
            "text"         : "moo",
            "updated"      : "...",
            "visible"      : true
        }
    ]
    
  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Admin: ...
    X-HMAC: ...
  • Response  200
  • Headers
    Content-Length: ...
    Link: </.../notes?...per_page=3&page=2>; rel="next", ...
    Body
    [
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 1,
            "revision"     : 1,
            "text"         : "foo",
            "updated"      : "...",
            "visible"      : true
        }
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 2,
            "revision"     : 1,
            "text"         : "boo",
            "updated"      : "...",
            "visible"      : true
        }
        {
            "candidate_id" : 123456,
            "created"      : "...",
            "id"           : 3,
            "revision"     : 2,
            "text"         : "moo",
            "updated"      : "...",
            "visible"      : true
        }
    ]
    
  • Response  401
  • Response  415

Single Note 2154344979

Get Note
/notes/{id}

CLIENTS, ADMIN: Get a single note

  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Account-ID: ...
    X-HMAC: ...
    X-Recruiter-ID: ...
  • Response  200
  • Headers
    Content-Length: ...
    Content-Type: application/json; charset=UTF-8
    Body
    {
        "candidate_id" : 123456,
        "created"      : "...",
        "id"           : 1,
        "revision"     : 1,
        "text"         : "foo",
        "updated"      : "...",
        "visible"      : true
    }
    
  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Admin: ...
    X-HMAC: ...
  • Response  200
  • Headers
    Content-Length: ...
    Content-Type: application/json; charset=UTF-8
    Body
    {
        "candidate_id" : 123456,
        "created"      : "...",
        "id"           : 1,
        "revision"     : 1,
        "text"         : "foo",
        "updated"      : "...",
        "visible"      : true
    }
    
  • Response  401
  • Response  403
  • Response  404
  • Response  410
  • Response  415
Patch Note
/notes/{id}

CLIENTS, ADMIN: Hide (‘delete’) note, or update text

  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Account-ID: ...
    X-HMAC: ...
    X-Recruiter-ID: ...
    Body
    {
        "text" : "new text"
    }
    
    {
        "visible" : false
    }
    
  • Response  204
  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Admin: ...
    X-HMAC: ...
    Body
    {
        "text" : "new text"
    }
    
    {
        "visible" : false
    }
    
  • Response  204
  • Response  401
  • Response  403
  • Response  404
  • Response  410
  • Response  413
  • Response  415

Admin Notes Log 

Get Log
/notes/log{?account_id,admin,fields,page,per_page,recruiter_id,sort}

ADMIN ONLY: Get log of edits and deletions made by admin

  • Parameters
  • account_id
    int (optional) Example: 189520

    ID of account whose notes will be displayed

    admin
    int (optional) Example: 123456

    name of admin whose edits will be displayed

    fields
    string (optional) Example: candidate_id

    Which fields to display

    Choices: account_id admin admin_updated candidate_id id old_text recruiter_id text

    page
    int (optional) Default: 1 

    Page number / offset

    per_page
    int (optional) Example: 10

    Number of notes displayed per page

    sort
    string (optional) Default: -updated 

    Which field to sort by

    Choices: updated -updated

  • Request
  • Headers
    Content-Type: application/json; charset=UTF-8
    X-Admin: ...
    X-HMAC: ...
  • Response  200
  • Headers
    Content-Length: ...
    Link: </.../notes?...per_page=3&page=2>; rel="next", ...
    Body
    [
        {
            "account_id"   : 189520,
            "admin"        : "admin-person-1",
            "admin_updated": ...,
            "candidate_id" : 123456,
            "id"           : 1,
            "old_text"     : "foo",
            "recruiter_id" : 303656,
            "text"         : "bar",
        }
        {
            "account_id"   : 189520,
            "admin"        : "admin-person-2",
            "admin_updated": ...,
            "candidate_id" : 123456,
            "id"           : 1,
            "old_text"     : "foo",
            "recruiter_id" : 987654,
            "text"         : "",
        }
    ]
    
  • Response  401
  • Response  415

Generated by 715-579-6847 on 20 May 2015