{"info":{"_postman_id":"be9e76c2-9328-4c90-b3fe-4d6cdb35558d","name":"User WebAPI","description":"

Introduction

This Web API focuses on executing basic User CRUD operations against a database.

Overview

Use Post, Get, Put and Delete methods to Create, Read, Update and Delete entities from the database.

Authentication

No authentication required

Error Codes

404 and 500 errors are to be expected if things go south.

Rate limit

No rate limits apply

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"8122691","collectionId":"be9e76c2-9328-4c90-b3fe-4d6cdb35558d","publishedId":"SVSHr9nV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-13T04:17:08.000Z"},"item":[{"name":"Create","item":[{"name":"PostUser","id":"1d4c4b5f-5825-42c6-931c-73fe95661db2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Linus Torvalds\",\n \"userName\": \"ltorvalds\",\n \"birthDate\": \"1969-12-28T00:00:00\",\n \"passWordHash\": \"psHash\",\n \"passWordSalt\": \"pwSalt\",\n \"creationDate\": \"2019-07-12T20:54:48.88\",\n \"isActive\": true\n}"},"url":"localhost/api/user","description":"

Adds an User entry to the database. The User object should me sent on the request's body

\n","urlObject":{"path":["api","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"35e74045-af98-4b01-a6fd-8d0a0e966064","name":"PostUser","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Linus Torvalds\",\n \"userName\": \"ltorvalds\",\n \"birthDate\": \"1969-12-28T00:00:00\",\n \"passWordHash\": \"psHash\",\n \"passWordSalt\": \"pwSalt\",\n \"creationDate\": \"2019-07-12T20:54:48.88\",\n \"isActive\": true\n}"},"url":"localhost/api/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Sat, 13 Jul 2019 04:11:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"12"}],"_postman_id":"1d4c4b5f-5825-42c6-931c-73fe95661db2"}],"id":"914875cf-cc9e-4c8d-8e1b-35caaa2d6336","description":"

Post

Request to add an User entry to the database.

\n","event":[{"listen":"prerequest","script":{"id":"3b88f1f4-a8c0-4684-9722-f497b7f761ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c7fdb73-912f-4316-915b-fb3c226c63bd","type":"text/javascript","exec":[""]}}],"_postman_id":"914875cf-cc9e-4c8d-8e1b-35caaa2d6336"},{"name":"Retrieve","item":[{"name":"GetUsers","id":"a1374653-b2f8-4669-9b55-b2146f53282e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"localhost/api/user","description":"

Gets Users

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ee5762d-fb7c-42c1-bb55-ee24c4c36699","id":"0ee5762d-fb7c-42c1-bb55-ee24c4c36699","name":"Retrieve","type":"folder"}},"urlObject":{"path":["api","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d595f43f-288f-42a9-89db-14b27ee6724c","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"localhost/api/user"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a1374653-b2f8-4669-9b55-b2146f53282e"},{"name":"GetUserById","id":"0336da46-b4f7-4ec6-9a4e-572a4b666e98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost/api/user/1","description":"

Retrieves an User entry from the database by the provided Id.

Get

All requests contained here will retrieve one or more User objects from the database.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"43e3f561-eb84-4f5f-af07-ed7642ec3abd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cb2cc88-53b8-41f3-8ef8-c6902cb15a51","type":"text/javascript","exec":[""]}}],"_postman_id":"0ee5762d-fb7c-42c1-bb55-ee24c4c36699"},{"name":"Update","item":[{"name":"PutUserById","id":"fc6c35d2-84d5-4fde-9f0f-f280754ff13d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 1,\n \"name\": \"Kenneth Lane Thompson\",\n \"userName\": \"kenlane\",\n \"birthDate\": \"1943-02-04T00:00:00\",\n \"passWordHash\": \"psHash\",\n \"passWordSalt\": \"pwSalt\",\n \"creationDate\": \"2019-07-10T20:54:48.667\",\n \"isActive\": true\n}"},"url":"localhost/api/user","description":"

Updates an User entry on the target database based on the provided Id.

\n","urlObject":{"path":["api","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc6c35d2-84d5-4fde-9f0f-f280754ff13d"}],"id":"048d99f0-5d73-46d2-8e41-f30a555c51fd","description":"

Put

Request to update an User entry on the database.

\n","event":[{"listen":"prerequest","script":{"id":"1043f5aa-552b-42d0-87e7-51c23b99747a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a490f492-2d61-49ff-83df-ad60d869b501","type":"text/javascript","exec":[""]}}],"_postman_id":"048d99f0-5d73-46d2-8e41-f30a555c51fd"},{"name":"Delete","item":[{"name":"DeleteUserById","id":"bdec8166-be77-4bb7-8caa-a69e6d76180b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"localhost/api/user/12","description":"

Deletes an User entry from the database based on the provided Id.

\n","urlObject":{"path":["api","user","12"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3d02d455-048c-4eaf-bb05-cd92be87cf60","name":"DeleteUserById","originalRequest":{"method":"DELETE","header":[],"url":"localhost/api/user/12"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Sat, 13 Jul 2019 04:12:57 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bdec8166-be77-4bb7-8caa-a69e6d76180b"}],"id":"5df69005-9181-422d-8ff1-a7a323bcf7bb","description":"

Delete

Request to delete an User entry from the database.

\n","event":[{"listen":"prerequest","script":{"id":"66995d01-3ed0-4c57-8717-9bf54bc035b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"abef194c-80a6-4836-8ea2-23d6913d4c94","type":"text/javascript","exec":[""]}}],"_postman_id":"5df69005-9181-422d-8ff1-a7a323bcf7bb"},{"name":"Cache","item":[{"name":"SetUsersCacheData","id":"0b3b0e33-2a4d-4268-aa41-c9c66236382e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/api/user/SetUsersCacheData","description":"

Set

Sets the cache data based on the GetUsers GET method.

\n","urlObject":{"protocol":"http","path":["api","user","SetUsersCacheData"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c8e01c73-2833-4f39-aba5-dd18502d77bf","name":"SetUsersCacheData","originalRequest":{"method":"GET","header":[],"url":"http://localhost/api/user/SetUsersCacheData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Mon, 15 Jul 2019 12:00:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"0b3b0e33-2a4d-4268-aa41-c9c66236382e"},{"name":"GetUsersCacheData","id":"75211ff9-efa8-4692-bb3d-68a4db618636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/api/user/GetUsersCacheData","description":"

Get

Gets the cached data.

\n","urlObject":{"protocol":"http","path":["api","user","GetUsersCacheData"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a1199042-7a72-42a2-b6bc-0f242cd8f660","name":"GetUsersCacheData","originalRequest":{"method":"GET","header":[],"url":"http://localhost/api/user/GetUsersCacheData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Mon, 15 Jul 2019 12:01:22 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 1,\n \"Name\": \"Kenneth Lane Thompson\",\n \"UserName\": \"kenlane\",\n \"BirthDate\": \"1943-02-04T00:00:00\",\n \"PassWordHash\": \"psHash\",\n \"PassWordSalt\": \"pwSalt\",\n \"CreationDate\": \"2019-07-10T20:54:48.667\",\n \"IsActive\": true\n },\n {\n \"Id\": 2,\n \"Name\": \"Andrew Tanenbaum\",\n \"UserName\": \"atanen\",\n \"BirthDate\": \"1944-03-16T00:00:00\",\n \"PassWordHash\": \"psHash\",\n \"PassWordSalt\": \"pwSalt\",\n \"CreationDate\": \"2019-07-10T20:54:48.797\",\n \"IsActive\": true\n },\n {\n \"Id\": 3,\n \"Name\": \"Margaret Hamilton\",\n \"UserName\": \"mhamil\",\n \"BirthDate\": \"1936-08-17T00:00:00\",\n \"PassWordHash\": \"psHash\",\n \"PassWordSalt\": \"pwSalt\",\n \"CreationDate\": \"2019-07-10T20:54:48.88\",\n \"IsActive\": true\n }\n]"}],"_postman_id":"75211ff9-efa8-4692-bb3d-68a4db618636"},{"name":"GetUserCacheDataById","id":"40fff685-6edd-45e6-ab5a-01d249e5158e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/api/user/GetUserCacheDataById/1","description":"

Get

Gets an User from the cached data with the specific provided ID.

\n","urlObject":{"protocol":"http","path":["api","user","GetUserCacheDataById","1"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0eebea25-846b-4057-8b5e-34d033308341","name":"GetUserCacheDataById","originalRequest":{"method":"GET","header":[],"url":"http://localhost/api/user/GetUserCacheDataById/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Mon, 15 Jul 2019 12:02:55 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": 1,\n \"Name\": \"Kenneth Lane Thompson\",\n \"UserName\": \"kenlane\",\n \"BirthDate\": \"1943-02-04T00:00:00\",\n \"PassWordHash\": \"psHash\",\n \"PassWordSalt\": \"pwSalt\",\n \"CreationDate\": \"2019-07-10T20:54:48.667\",\n \"IsActive\": true\n}"}],"_postman_id":"40fff685-6edd-45e6-ab5a-01d249e5158e"},{"name":"RemoveUsersCacheData","id":"f7feda66-3af7-4734-b114-dad1354d8a01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Delete

Deletes all the cached data.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"6670935c-36a9-48c2-9474-32da01bda3bd","name":"RemoveUsersCacheData","originalRequest":{"method":"GET","header":[],"url":"http://localhost/api/user/RemoveUsersCacheData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.1"},{"key":"Date","value":"Mon, 15 Jul 2019 12:05:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"f7feda66-3af7-4734-b114-dad1354d8a01"}],"id":"56eb7187-3bf7-4a52-b2ca-36a69158ab72","_postman_id":"56eb7187-3bf7-4a52-b2ca-36a69158ab72","description":""}]}