added Postman collection for exercising the API.

This commit is contained in:
chris.watts90@outlook.com 2017-02-08 22:28:54 +00:00
parent db15f01677
commit 8b0e4c5f9c

View File

@ -0,0 +1,146 @@
{
"variables": [],
"info": {
"name": "FlexiTimeTool",
"_postman_id": "5343b53a-ed28-1054-38fb-42c2e53f23b7",
"description": "",
"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
},
"item": [
{
"name": "GetUsers",
"request": {
"url": "http://localhost:8800/api/users",
"method": "GET",
"header": [],
"body": {},
"description": "GetAll Users from the DB"
},
"response": []
},
{
"name": "AddNewUser",
"request": {
"url": "http://localhost:8800/api/users",
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"FirstName\":\"Chris\",\n\t\"LastName\":\"Watts\",\n\t\"HoursPerWeek\":37.0,\n\t\"AssociatedCards\":[\n\t\t{\n\t\t\t\"CardUID\":\"5B867F01F8FF12E09000\"\n\t\t}\n\t]\n}"
},
"description": "Add a new user to the system."
},
"response": []
},
{
"name": "Get user by Id",
"request": {
"url": "http://localhost:8800/api/users/6",
"method": "GET",
"header": [],
"body": {},
"description": "Get a specific user by their userId"
},
"response": []
},
{
"name": "Edit a User",
"request": {
"url": "http://localhost:8800/api/users/edit",
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"UserId\": 1,\n \"FirstName\": \"Chris\",\n \"LastName\": \"Watts\",\n \"HoursPerWeek\": 37,\n \"AssociatedIdentifierCount\": 0,\n \"AssociatedIdentifiers\": []\n}"
},
"description": "Edit an existing users parameters, will create if it doesnt exist."
},
"response": []
},
{
"name": "Get All Unassigned Card Identifiers",
"request": {
"url": "http://localhost:8800/api/cards/unassigned",
"method": "GET",
"header": [],
"body": {},
"description": "Retrieve all card Ids that don't have an associated user."
},
"response": []
},
{
"name": "Create a new card Id",
"request": {
"url": "http://localhost:8800/api/cards/create",
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"CardUId\": \"5ad33999-2cb0-4343-afb7-5c8e1f0313c6\",\n}"
},
"description": "Defaults to no user available (appears as unassigned)\nCreates a new Card Id object in the DB"
},
"response": []
},
{
"name": "Get all card Ids",
"request": {
"url": "http://localhost:8800/api/cards/get",
"method": "GET",
"header": [],
"body": {},
"description": "Get a list of all card Ids and their associated users in the DB.\n(-1 = unassigned)"
},
"response": []
},
{
"name": "Create new Log",
"request": {
"url": "http://localhost:8800/api/swipedata",
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"CardUId\": \"19c6b7d859b74df4a1a615ede1554272\"\n}"
},
"description": "create new time log on the system. used by card/official server swipe data providers.."
},
"response": []
},
{
"name": "GetTimeLogs",
"request": {
"url": "http://localhost:8800/api/timelogs?userId=9",
"method": "GET",
"header": [],
"body": {},
"description": "Get the time log list for the user in the current calendar week."
},
"response": []
}
]
}