{"info":{"_postman_id":"03af83dc-f12e-4fb4-9dce-4b1a928dc2a0","name":"Employee API","description":"

EMPLOYEE REST API COLLECTION

\n
The Employee Api collection contains requests and examples that show how to create new employee data, get all employee data or an employee data, update an employee data, and delete an employee data.
\n

Request:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"EMPLOYEE REST API COLLECTION","slug":"employee-rest-api-collection"}],"owner":"6979287","collectionId":"03af83dc-f12e-4fb4-9dce-4b1a928dc2a0","publishedId":"TzRLmqhQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-02T19:26:31.000Z"},"item":[{"name":"Create Employee","id":"bc1bac51-8bb1-4859-88ef-29890e8cddcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"ugo@gmail.com","description":"

Email adress of the employee

\n","type":"text"},{"key":"first_name","value":"Ugo","description":"

First name of the employee

\n","type":"text"},{"key":"last_name","value":"Christain","description":"

Last name of the employee

\n","type":"text"},{"key":"age","value":"18","description":"

Age of the employee

\n","type":"text"},{"key":"password","value":"copyninja","description":"

Employee password

\n","type":"text"},{"key":"password2","value":"copyninja","description":"

Comfirm password

\n","type":"text"}]},"url":"http://127.0.0.1:8000/api/create-user","description":"

CREATE EMPLOYEE

\n
The create employee api takes it's basics from Django authentication system.
\n
    \n
  1. Database Schemas/Models/Entities:
    2. \n
\n\n

1. Documentation for authentication can be gotten from Django Custom User Auth and Django Rest Framework Auth

\n

An employee registers with an email, first name, last name, age, password, and password2

\n

A successful response will return a token back to the employee and a status of 201. Employee can use then use token to access data

\n","urlObject":{"protocol":"http","port":"8000","path":["api","create-user"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"8deb01b3-3e61-4e55-a1af-850c5a743252","name":"register new employee","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"ugo@gmail.com","description":"Email adress of the employee","type":"text"},{"key":"first_name","value":"Ugo","description":"First name of the employee","type":"text"},{"key":"last_name","value":"Christain","description":"Last name of the employee","type":"text"},{"key":"age","value":"18","description":"Age of the employee","type":"text"},{"key":"password","value":"copyninja","description":"Employee password","type":"text"},{"key":"password2","value":"copyninja","description":"Comfirm password","type":"text"}]},"url":"http://127.0.0.1:8000/api/create-user"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 17:49:39 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, POST"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"165"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"successfully registered new user\",\n \"email\": \"ugo@gmail.com\",\n \"first_name\": \"Ugo\",\n \"last_name\": \"Christain\",\n \"token\": \"757c32c1b02397d042db1b18cb2c8be8bf933d3a\"\n}"}],"_postman_id":"bc1bac51-8bb1-4859-88ef-29890e8cddcd"},{"name":"Update Employee (PUT)","id":"07b2f624-e10e-48fa-bfc3-9eb10a59f38a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token f5791e2a4e12e23aaeafbc666e2c0d7352dadb2e","description":"

Django Token Authorization gives you permission to retreive, upate, and delete data

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"Test","description":"

First name of employee to be updated

\n","type":"text"},{"key":"last_name","value":"Admin","description":"

last name of employee to be updated

\n","type":"text"},{"key":"age","value":"53","description":"

age of employee to be updated

\n","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00003","description":"

UPDATE EMPLOYEE (PUT)

\n
The PUT update employee api allows an employee to update all the records owned by hmi/her.
\n

NB: 1. First an employee needs provide his token in the header section then set the value of the Authorization field as e.g Token 5whedge2761udf3df3d (if using postman)
2. Secondly, an employee can only update the record/data belonging to him/her

\n

1. Documentation for function based api view can be gotten from Django Rest Framework @api_view

\n

A successful response will return the employee data and a status of 200.

\n","urlObject":{"protocol":"http","port":"8000","path":["api","employee","E00003"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"0a2e4006-8d90-48bb-b11f-6414018378ab","name":"update employee (PUT) success","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token f5791e2a4e12e23aaeafbc666e2c0d7352dadb2e","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"Test","description":"First name of employee to be updated","type":"text"},{"key":"last_name","value":"Admin","description":"last name of employee to be updated","type":"text"},{"key":"age","value":"53","description":"age of employee to be updated","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00003"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:14:53 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"PUT, OPTIONS, PATCH, DELETE, GET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"130"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"employee\": {\n \"employee_id\": \"E00003\",\n \"first_name\": \"Test\",\n \"last_name\": \"Admin\",\n \"age\": \"53\",\n \"join_date\": \"2021-05-02T19:11:25.568914Z\"\n }\n}"},{"id":"30646005-1b65-4bdf-8cf8-700270bc4c22","name":"update employee (PUT) failed","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token 0009e4470ccc6c079bb10817b2b3b63a071c53d0","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"Test","description":"First name of employee to be updated","type":"text"},{"key":"last_name","value":"Admin2","description":"last name of employee to be updated","type":"text"},{"key":"age","value":"55","description":"age of employee to be updated","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00003"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:17:19 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET, PATCH, PUT, DELETE"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"53"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": \"You do not have the permission to edit\"\n}"}],"_postman_id":"07b2f624-e10e-48fa-bfc3-9eb10a59f38a"},{"name":"Obtain Token with Email and Pssword","id":"2d003fb5-40d2-4526-8c94-712b14aef269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"ugo@gmail.com","description":"

Email credential of employee

\n","type":"text"},{"key":"password","value":"copyninja","description":"

Paaword of employee

\n","type":"text"}]},"url":"http://127.0.0.1:8000/api/user/token","description":"

Obtain Token with Email and Pssword

\n
The get token api gets an employee his/her token.
\n

An employee just has to provide emil and password the response will return his token

\n

1. Documentation for obtaining token with your email an password can be found Django Rest framework ObtainAuthToken

\n

A successful response will return the token and a status of 200.

\n\n","urlObject":{"protocol":"http","port":"8000","path":["api","user","token"],"host":["127","0","0","1"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"92e6a282-7c64-46ec-b278-61da2ea97c05","name":"obtaining a token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"ugo@gmail.com","description":"Email credential of employee","type":"text"},{"key":"password","value":"copyninja","description":"Paaword of employee","type":"text"}]},"url":{"raw":"http://127.0.0.1:8000/api/user/token","protocol":"http","host":["127","0","0","1"],"port":"8000","path":["api","user","token"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 15:22:44 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"52"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"be18124b64a4d953bdf0a8e81fed26d3a4eef17f\"\n}"},{"id":"ab13c970-e952-4ca1-bd45-867ad7254397","name":"wrong user credential","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"ugo@gmail.com","description":"Email credential of employee","type":"text"},{"key":"password","value":"copyninja","description":"Paaword of employee","type":"text"}]},"url":{"raw":"http://127.0.0.1:8000/api/user/token","protocol":"http","host":["127","0","0","1"],"port":"8000","path":["api","user","token"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:18:13 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"86"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"non_field_errors\": [\n \"Invalid email or password. Try again with correct credentials\"\n ]\n}"}],"_postman_id":"2d003fb5-40d2-4526-8c94-712b14aef269"},{"name":"Upate Employee (PATCH)","id":"34326564-7f9d-4958-abcd-b3ac1ad8bd6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token 4e0757ca60f1d0b02f5f63b99cc73609992ab4f3","description":"

Django Token Authorization gives you permission to retreive, upate, and delete data

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"last_name","value":"David","description":"

last name of employee to be updated

\n","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00004","description":"

UPDATE EMPLOYEE (PATCH)

\n
The PATCH update employee api allows an employee to update a single field.
\n

NB: 1. First an employee needs provide his token in the header section then set the value of the Authorization field as e.g Token 5whedge2761udf3df3d (if using postman)
2. Secondly, an employee can only update the record/data belonging to him/her

\n

1. Documentation for function based api view can be gotten from Django Rest Framework @api_view

\n

A successful response will return the employee data and a status of 200.

\n","urlObject":{"protocol":"http","port":"8000","path":["api","employee","E00004"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"6eccd95a-c52c-4769-93c6-b708c11b6fb5","name":"upate employee (PATCH) failed","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Token 0009e4470ccc6c079bb10817b2b3b63a071c53d0","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"last_name","value":"Administrator","description":"last name of employee to be updated","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00003"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:22:25 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET, PATCH, PUT, DELETE"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"53"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": \"You do not have the permission to edit\"\n}"},{"id":"14570d86-45c3-489a-9a4b-037e5e8ffc90","name":"upate employee (PATCH) success","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Token f5791e2a4e12e23aaeafbc666e2c0d7352dadb2e","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"last_name","value":"Administrator","description":"last name of employee to be updated","type":"text"}]},"url":"http://127.0.0.1:8000/api/employee/E00003"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:23:38 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET, PATCH, PUT, DELETE"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"138"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"employee\": {\n \"employee_id\": \"E00003\",\n \"first_name\": \"Test\",\n \"last_name\": \"Administrator\",\n \"age\": \"53\",\n \"join_date\": \"2021-05-02T19:11:25.568914Z\"\n }\n}"}],"_postman_id":"34326564-7f9d-4958-abcd-b3ac1ad8bd6f"},{"name":"Delete Employee","id":"af101ef4-1743-470f-9ca0-58c2108fe957","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token 4e0757ca60f1d0b02f5f63b99cc73609992ab4f3","description":"

Django Token Authorization gives you permission to retreive, upate, and delete data

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"http://127.0.0.1:8000/api/employee/E00004","description":"

DELTE EMPLOYEE

\n
The delete employee api allows only an admin to delete an employee record.
\n

NB: 1. First an employee needs provide his token in the header section then set the value of the Authorization field as e.g Token 5whedge2761udf3df3d (if using postman)

\n

1. Documentation for function based api view can be gotten from Django Rest Framework @api_view

\n

A successful response will return the \"successfully deleted\" and a status of 200.

\n","urlObject":{"protocol":"http","port":"8000","path":["api","employee","E00004"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"16e9e6b8-e85a-463d-9f99-f9b043f3b654","name":"delete employee failed","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Token 284dbad54440f31c66b7f4e028d10fb1e6d23794","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"http://127.0.0.1:8000/api/employee/E00003"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:25:46 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET, PATCH, PUT, DELETE"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"62"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"you do not have the permission to delete this data\"\n}"},{"id":"7d5ec563-c795-4ab2-987f-dc6f0b31cb67","name":"delete employee success","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Token f5791e2a4e12e23aaeafbc666e2c0d7352dadb2e","description":"Django Token Authorization gives you permission to retreive, upate, and delete data","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"http://127.0.0.1:8000/api/employee/E00004"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 02 May 2021 19:26:45 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET, PATCH, PUT, DELETE"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"34"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"successfully deleted\"\n}"}],"_postman_id":"af101ef4-1743-470f-9ca0-58c2108fe957"},{"name":"GET Employee","id":"961d8bf1-7c3b-400a-853c-7d76bd79edc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token 0009e4470ccc6c079bb10817b2b3b63a071c53d0","type":"text"}],"url":"http://127.0.0.1:8000/api/employees","description":"

GET Employee

\n
The GET employee api allows you to get all employee data and a single employee data.
\n

NB: 1. First an employee needs provide his token in the header section then set the value of the Authorization field as e.g Token 5whedge2761udf3df3d (if using postman)
2. Secondly, to get all employee data /api/employees is the right url while /api/employee/{employee_id} will get you a single employee record. Check the examples below

\n

1. Documentation for function based api view can be gotten from Django Rest Framework @api_view

\n

A successful response will return the employee data and a status of 200.

\n","urlObject":{"protocol":"http","port":"8000","path":["api","employees"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"24ea2c78-d0c9-4660-8353-e0a87590747a","name":"get all employee records","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token 0009e4470ccc6c079bb10817b2b3b63a071c53d0","type":"text"}],"url":"http://127.0.0.1:8000/api/employees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 May 2021 16:04:58 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"OPTIONS, GET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"382"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"employees\": [\n {\n \"employee_id\": \"E00001\",\n \"first_name\": \"John\",\n \"last_name\": \"Keynes\",\n \"age\": \"29\",\n \"join_date\": \"2021-05-02T03:07:31.122156Z\"\n },\n {\n \"employee_id\": \"E00002\",\n \"first_name\": \"Sarah\",\n \"last_name\": \"Robinson\",\n \"age\": \"54\",\n \"join_date\": \"2021-05-02T03:49:01.291563Z\"\n },\n {\n \"employee_id\": \"E00003\",\n \"first_name\": \"Test\",\n \"last_name\": \"Administrator\",\n \"age\": \"53\",\n \"join_date\": \"2021-05-02T19:11:25.568914Z\"\n }\n ]\n}"},{"id":"2f812032-aa51-4dd6-b97e-b5707c6df5e4","name":"get single employee record","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token 0009e4470ccc6c079bb10817b2b3b63a071c53d0","type":"text"}],"url":"http://127.0.0.1:8000/api/employee/E00002"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 May 2021 16:06:09 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.10"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, OPTIONS, DELETE, PATCH, PUT"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"134"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"employee\": {\n \"employee_id\": \"E00002\",\n \"first_name\": \"Sarah\",\n \"last_name\": \"Robinson\",\n \"age\": \"54\",\n \"join_date\": \"2021-05-02T03:49:01.291563Z\"\n }\n}"}],"_postman_id":"961d8bf1-7c3b-400a-853c-7d76bd79edc0"}]}