3Dshock/client/README.md

45 lines
697 B
Markdown
Raw Normal View History

2021-03-08 01:18:51 +00:00
# 3DShock Client
2021-03-07 23:58:10 +00:00
2021-03-08 01:18:51 +00:00
# Requirements (pages)
2021-03-07 23:58:10 +00:00
2021-03-08 02:17:00 +00:00
# Routes
Client Datatype
```ts
type Client = {
name: string
email: string
phone: number
active_session: boolean
}
```
post /api/clients -> create new client
get /api/clients -> get client list
get /api/clients/:id -> get client
```ts
type Session = string[] | null
```
post /api/clients/:id/session -> begin capture
get /api/clients/:id/session -> get active sesion (list of preview photo locations)
delete /api/clients/:id/session -> delete all current photos (for new capture)
2021-03-08 01:18:51 +00:00
## Create Session
2021-03-07 23:58:10 +00:00
2021-03-08 01:18:51 +00:00
Information gathering
- name
- email
- phone
## Session Capture
2021-03-07 23:58:10 +00:00
start session
2021-03-08 01:18:51 +00:00
## Capture Review Phase
## Capture Finish -> Create Session