{"info":{"_postman_id":"206b03f1-3ce9-496d-a456-bca0a7ef39e0","name":"EXADS Frontend Test API","description":"

What is this?

\n

This project is intended to be used as an API that gives support to the operations the frontend app is required to perform in order to fulfill the requirements of EXADS Frontend Test.

\n

How does it work?

\n

This is a simple REST API that can perform operations over a set of 3000 users.\n
\nImportant note: the list of users is handled in memory, which means that any modification you may have done is persisted only in memory and will be reset each time the API bootstraps.

\n

About Responses

\n

General Success Response

\n

As a general rule, success responses will have the HTTP status code 200 and, depending on the case, may or may not have data.\nA message in English will be sent along the data too.

\n
HTTP status code: 200\n\n{\n  data?: object,\n  message: string\n}\n

General Error Response

\n

As a general rule, error responses may or may not have data. The HTTP status code will vary depending on the case.\nA message in English will be sent along the data too.

\n
{\n  data?: object,\n  message: string\n}\n

Bad Request Response

\n

As a general rule, bad requests responses will have the HTTP status code 400 and 2 properties, a message explaining the reason and, if any, the missing parameters in the request.

\n
{\n  missing_params: array[],\n  message: string\n} \n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"What is this?","slug":"what-is-this"},{"content":"How does it work?","slug":"how-does-it-work"},{"content":"About Responses","slug":"about-responses"}],"owner":"11918524","collectionId":"206b03f1-3ce9-496d-a456-bca0a7ef39e0","publishedId":"TzRNFAPs","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0072BA"},"publishDate":"2021-05-04T11:32:19.000Z"},"item":[{"name":"Users","item":[{"name":"Create","id":"2c17e983-bc13-45e9-9693-520d1c4e6b7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"first_name\": \"Emanuel\",\n \"last_name\": \"Cardenosa\",\n \"email\": \"ecardenosa@homestead.com\",\n \"username\": \"ema_carde\",\n \"id_status\": 1\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{users_endpoint}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c17e983-bc13-45e9-9693-520d1c4e6b7f"},{"name":"Update","id":"5855c5ad-0927-42e5-adeb-b4f707d76e72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"first_name\": \"Giordano\",\n \"last_name\": \"Howerd\",\n \"email\": \"updated@email.com\",\n \"id_status\": 3\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/{{users_endpoint}}/{{user_id}}","urlObject":{"path":["{{users_endpoint}}","{{user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5855c5ad-0927-42e5-adeb-b4f707d76e72"},{"name":"Get by ID","id":"478626ff-6b8f-4500-9d6c-9112b5d6624e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}/{{user_id}}","urlObject":{"path":["{{users_endpoint}}","{{user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"478626ff-6b8f-4500-9d6c-9112b5d6624e"},{"name":"Get All","id":"92b2152b-7b73-467e-81a3-60cad2178c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"92b2152b-7b73-467e-81a3-60cad2178c51"},{"name":"Get a given page","id":"bc0d67cc-6f2e-49f3-9e84-0cc417e66697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}?page={{page}}&limit={{limit}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[{"key":"page","value":"{{page}}"},{"key":"limit","value":"{{limit}}"}],"variable":[]}},"response":[],"_postman_id":"bc0d67cc-6f2e-49f3-9e84-0cc417e66697"},{"name":"Get filtering by Email","id":"261a7397-f57a-44f3-aea0-8ffe4dd67870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}?email={{email}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[{"key":"email","value":"{{email}}"}],"variable":[]}},"response":[],"_postman_id":"261a7397-f57a-44f3-aea0-8ffe4dd67870"},{"name":"Get filtering by Username","id":"296adf29-de3a-4348-bd83-19a6d0badfd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}?username={{username}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[{"key":"username","value":"{{username}}"}],"variable":[]}},"response":[],"_postman_id":"296adf29-de3a-4348-bd83-19a6d0badfd9"},{"name":"Get filtering by Email and Username","id":"95c31d54-482d-4e68-9a4e-1a04e31e39a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{users_endpoint}}?email={{email}}&username={{username}}","urlObject":{"path":["{{users_endpoint}}"],"host":["{{base_url}}"],"query":[{"key":"email","value":"{{email}}"},{"key":"username","value":"{{username}}"}],"variable":[]}},"response":[],"_postman_id":"95c31d54-482d-4e68-9a4e-1a04e31e39a8"}],"id":"98d10e77-c14b-47cd-86d4-f8fb561428b1","description":"

Collection of endpoints related to Users operations

\n","_postman_id":"98d10e77-c14b-47cd-86d4-f8fb561428b1"},{"name":"Statuses","item":[{"name":"Get by ID","id":"f2902ea6-777e-4424-b30e-a31e3463b280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{statuses_endpoint}}/{{status_id}}","urlObject":{"path":["{{statuses_endpoint}}","{{status_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2902ea6-777e-4424-b30e-a31e3463b280"},{"name":"Get All","id":"1c347a18-e223-4dad-800c-91a9a1fd7e06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/{{statuses_endpoint}}","urlObject":{"path":["{{statuses_endpoint}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c347a18-e223-4dad-800c-91a9a1fd7e06"}],"id":"fc560000-11e7-49de-9650-5700b9d4037a","description":"

Collection of endpoints related to Statuses operations

\n","_postman_id":"fc560000-11e7-49de-9650-5700b9d4037a"}],"event":[{"listen":"prerequest","script":{"id":"0f5742c6-c33f-4cf0-91a9-fe9d37ea76c2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b3c5b590-2ecc-41b9-aeab-860e068f213e","type":"text/javascript","exec":[""]}}]}