{"id":17922478,"url":"https://github.com/pthorpe92/mvscanner","last_synced_at":"2025-04-03T10:45:39.688Z","repository":{"id":208530689,"uuid":"714832411","full_name":"PThorpe92/mvscanner","owner":"PThorpe92","description":"Front End For A Scanner Application","archived":false,"fork":false,"pushed_at":"2023-11-21T22:49:51.000Z","size":249,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-26T18:58:21.471Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PThorpe92.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-05T23:32:50.000Z","updated_at":"2023-11-21T22:50:22.000Z","dependencies_parsed_at":"2023-11-22T01:18:38.824Z","dependency_job_id":null,"html_url":"https://github.com/PThorpe92/mvscanner","commit_stats":null,"previous_names":["pthorpe92/mvscanner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PThorpe92%2Fmvscanner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PThorpe92%2Fmvscanner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PThorpe92%2Fmvscanner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PThorpe92%2Fmvscanner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PThorpe92","download_url":"https://codeload.github.com/PThorpe92/mvscanner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246989498,"owners_count":20865306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-28T20:39:21.679Z","updated_at":"2025-04-03T10:45:39.659Z","avatar_url":"https://github.com/PThorpe92.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MVCF Scanning system API design\n\n\n## Data/Tables\n________________\n### Resident:   \n________________\n- __rfid__:     == `String` (17 digit num)\n- __name__:     == `String` (Last, First)\n- __doc__:      == `String` (982392)\n- __room__:     == `String` (e.g 10b) 1 number \u0026\u0026 'b' | t''\n __unit:__     == `int`\n\n### `/api/residents`\n**GET: Index** `/api/residents`\n\n**GET: SHOW** `/api/residents/{rfid}`\n\n**POST: Create** `/api/residents   body=full payload`\n\n**PATCH: Update** `/api/residents/{rfid}   body={any_updated_fields}`\n\n**DELETE: Delete** `/api/residents/{id}`  \n\n\n\n**GET: Index** `/api/residents/{id}/timestamps`\nGet all timestamps for X resident DEFAULT= TODAY\n\n**GET: Show** `/api/residents/{id}/timestamps/{start_date}/{end_date}`\n\n========================================================\n## Locations:  \n#### `/api/locations`\n\n- `id`: _int_   e.g. (6)\n- `name`: _string_ e.g. (DeltaPod)\n\n**GET: Index** (all locations)\n\n**GET: Show** `/api/locations{id}` Get the name of location X\n\n**POST: Create** `/api/locations{body=full_payload}` Add a new location to sign out to\n\n### `/api/locations/{id}/timestamps`\n\n**GET: Show** Get all timestamps for X location DEFAULT= TODAY\n\n### `/api/locations/{id}/timestamps/{start_date}/{end_date}`\n\n**GET: Show** Get all timestamps for X location within date range\n\n\n## Timestamps\n\n### `/api/timestamps`\n\n- __rfid__: `string`\n- __dest__: `string`\n\n**GET: Index** `/api/timestamps` Get timestamps for that day (default)\n\n**GET: Show** `/api/timestamps`\n\n**POST: Create** `/api/timestamps/{body=timestamp}`\n\nTIMESTAMP (Sent by front-end)\n```json\n  [ \n    {\n      \"rfid\": \"12345678901234567\",\n      \"location\": 8\n    }\n  ]\n```\nRETURNS: (from back-end)\n```json\n  {\n    \"rfid\": \"12345678901234567\",\n    \"location\": 0,\n    \"timestamp\": \"2019-10-10 10:10:10\"\n  }\n```\n### IF two timestamps are received at the same location, the location returned will be 0: \"AWAY\" and that can be checked for on the front-end, and you can send another timestamp after prompting the user\n\n\n**GET Show** `/api/timestamps/{start_date}/{end_date}`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpthorpe92%2Fmvscanner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpthorpe92%2Fmvscanner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpthorpe92%2Fmvscanner/lists"}