paulj/hpr_documentation
1
0
Fork 0
forked from HPR/hpr_documentation
Code Pull Requests Activity

2024-12-22_17-07-52Z_Sunday

Browse Source
This commit is contained in:
Ken Fallon
2024-12-22 18:07:52 +01:00
parent 0a7edefb63
commit f9308d2784
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
workflow/uploading_a_show.md
View File

@@ -24,7 +24,7 @@ This process involves requesting a slot and verifying that the request is valid.
sequenceDiagram sequenceDiagram
Host->>HPR: Display current schedule Host->>HPR: Display current schedule
Note over HPR: calendar.php Note over HPR: calendar.php
HPR->>HPR: Remove any old stale requests REQUEST_UNVERIFIED HPR->>DB: Remove any old stale requests REQUEST_UNVERIFIED
HPR->>HPR: Remove any requests from this IP older than 15min HPR->>HPR: Remove any requests from this IP older than 15min
HPR->>Host: Display Calendar page HPR->>Host: Display Calendar page
``` ```
@@ -51,7 +51,7 @@ sequenceDiagram
Note over Host: 412 Precondition Failed Note over Host: 412 Precondition Failed
end end
HPR->>HPR: Create a temporary entry for this Host HPR->>HPR: Create a temporary entry for this Host
Note over HPR: Workflow state REQUEST_UNVERIFIED HPR->>DB: Set status to REQUEST_UNVERIFIED
HPR->>HPR: Check for excessive uploads HPR->>HPR: Check for excessive uploads
alt Excessive uploads found alt Excessive uploads found
HPR->>Host: Uploads have temporarily been suspended HPR->>Host: Uploads have temporarily been suspended
@@ -66,6 +66,7 @@ sequenceDiagram
end end
HPR->>HPR: Generate webform of free slots HPR->>HPR: Generate webform of free slots
HPR->>HPR: Populate the list of posted shows HPR->>HPR: Populate the list of posted shows
HPR->>Host: Webform HPR->>Host: Webform
``` ```
> The website returns the webpage for the Host to enter their email address, and modify the date. > The website returns the webpage for the Host to enter their email address, and modify the date.
@@ -90,11 +91,12 @@ sequenceDiagram
email-->>Host: email upload url email-->>Host: email upload url
end end
end end
HPR->>DB: Set status to REQUEST_EMAIL_SENT
HPR->>Host: Thank You page HPR->>Host: Thank You page
``` ```
> If an error occurs one of the following error codes will be returned. > If an error occurs one of the following error codes will be returned.
## request_confirm.php Errors ### request_confirm.php Errors
| 412 Error Code | Check | | 412 Error Code | Check |
| --- | ------ | | --- | ------ |
@@ -126,6 +128,10 @@ sequenceDiagram
> The website provides a "Thank You" page notifying the Host that the email is sent. > The website provides a "Thank You" page notifying the Host that the email is sent.
# Confirming a working email address
> The Host checks their email and receives a link to where they can upload their show
`email` `email`
![The email confirmation page](request_slot_thank_you.png) ![The email confirmation page](request_slot_thank_you.png)