dvl-api-hr-claims.md

HR Claims List

• URL

  /v1/hr/claims

• Method:

  GET

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  none

  Optional:

  per_page=[integer]
page=[integer]
q[date_eq]=[text]

...

• Data Params

  none

• Success Response:

  • Code: 200 OK
    Content: {"data":{
"claims":[
{"id":1,"date":"DATE","complaint":"TEXT"},

{"id":2,"date":"DATE","complaint":"TEXT"}
],
"pagination":{"page":1,"per_page":2,"total":10,"pages":5}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

• Sample Call:

• Notes:

in search query

*_eq - equal
*_cont Contains value

dvl-api-hr-employee-claim-create.md

HR Employee Claim Create

• URL

  /v1/employees/:employee_id/claims

• Method:

  POST

• HEADERS

  Authorization=bearer ACCESS_TOKEN

URL Params

Required:

employee_id=[integer]

• Data Params

  hr_employee_claim[date]=[date]
hr_employee_claim[complaint]=[text]
  

• Success Response:

  • Code: 201 CREATED
    Content: {"data":
{"vacation":{
"id":1,
"date":"DATE",
"complaint":"TEXT",
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code: 422 UNPROCESSABLE ENTITY
    Content: {"errors":{
"date":["can't be blank"],
"complaint":["can't be blank"]
}}
    

• Sample Call:

• Notes:

dvl-api-hr-employee-claim-delete.md

HR Employee Claim Delete

• URL

  /v1/employees/:employee_id/claims/:id

• Method:

  DELETE

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]
employee_id=[integer]

• Data Params

• Success Response:

  • Code: 200 OK
    Content:

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code 404 NOT FOUND
    Content: { "error": "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content:

• Sample Call:

• Notes:

dvl-api-hr-employee-claim-update.md

HR Employee Claim Update

• URL

  /v1/employees/:employee_id/claims/:id

• Method:

  PUT | PATCH

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]
employee_id=[integer]

• Data Params

  hr_employee_claim[date]=[date]
hr_employee_claim[complaint]=[text]
  

• Success Response:

  • Code: 200 OK
    Content: {"data":
{"claim":{
"id":28,
"date":"DATE",
"complaint":"TEXT"
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code 404 NOT FOUND
    Content: { "error": "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content: { "errors":{"date":["can't be blank"]}}

• Sample Call:

• Notes:

dvl-api-hr-employee-claims.md

HR Employee Claims List

• URL

  /v1/employees/:employee_id/claims

• Method:

  GET

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  none

  Optional:

  per_page=[integer]
page=[integer]
q[date_eq]=[text]
...

• Data Params

  none

• Success Response:

  • Code: 200 OK
    Content: {"data":{
"claims":[
{"id":1,"date":"DATE","complaint":"TEXT"},

{"id":2,"date":"DATE","complaint":"TEXT"},

],
"pagination":{"page":1,"per_page":2,"total":10,"pages":5}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

• Sample Call:

• Notes:

in search query

*_eq - equal
*_cont Contains value