Skip to content

Adding Safeguarding Issues to the API docs #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Adding Safeguarding Issues to the API docs #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0173809
Adding Safeguarding Issues to the API docs
DanJezeph15 Apr 14, 2025
b534968
Replace all localhost with secure.tutorcruncher.com
DanJezeph15 May 14, 2025
b0f01ad
Rename all
DanJezeph15 Jun 3, 2025
b7aa930
Changes to wellbeing concerns
DanJezeph15 Jun 3, 2025
616be6a
Add role_type in all locations
DanJezeph15 Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pages/adhoccharges/ad-hoc-charge-object.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"contractor": null,
Expand All @@ -42,6 +43,7 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"status": "paid",
Expand Down
4 changes: 3 additions & 1 deletion pages/adhoccharges/create-an-ad-hoc-charge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,16 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"contractor": null,
"creator": {
"email": "[email protected]",
"first_name": "Billy",
"id": 59,
"last_name": "Holiday"
"last_name": "Holiday",
"role_type": "Administrator"
},
"currency": "GBP",
"currency_conversion": null,
Expand Down
2 changes: 2 additions & 0 deletions pages/adhoccharges/get-an-ad-hoc-charge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"contractor": null,
Expand All @@ -42,6 +43,7 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"status": "paid",
Expand Down
4 changes: 3 additions & 1 deletion pages/adhoccharges/update-an-ad-hoc-charge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,16 @@
"first_name": "Nicole",
"last_name": "Beggs",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/37/"
},
"contractor": null,
"creator": {
"email": "[email protected]",
"first_name": "Billy",
"id": 59,
"last_name": "Holiday"
"last_name": "Holiday",
"role_type": "Administrator"
},
"currency": "GBP",
"currency_conversion": null,
Expand Down
4 changes: 4 additions & 0 deletions pages/api.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,7 @@ endpoint_sections:
title: Tenders (Job Applications)
id: tenders
layout: /tenders/tenders.yml
-
title: Wellbeing Concerns
id: wellbeing-concerns
layout: /wellbeing-concerns/wellbeing-concerns.yml
1 change: 1 addition & 0 deletions pages/contractor-skills/contractor-skills-object.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/52/"
},
"subject": {
Expand Down
3 changes: 2 additions & 1 deletion pages/contractor-skills/create-a-contractor-skill.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"first_name": "Billy",
"last_name": "Holiday",
"email": null,
"url": "https://secure.tutorcruncher.com/api/69/"
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/69/"
},
"subject": {
"id": 51,
Expand Down
3 changes: 2 additions & 1 deletion pages/contractor-skills/get-a-contractor-skill.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/52/"
},
"subject": {
Expand All @@ -20,4 +21,4 @@
"ranking": 50.0,
"custom_to_branch": null
}
}
}
3 changes: 2 additions & 1 deletion pages/contractor-skills/list-all-contractor-skills.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/52/"
},
"subject": {
Expand All @@ -27,4 +28,4 @@
}
}
]
}
}
2 changes: 2 additions & 0 deletions pages/contractors/contractor-object-v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand All @@ -50,6 +51,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand Down
2 changes: 2 additions & 0 deletions pages/contractors/create-a-contractor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand All @@ -49,6 +50,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand Down
2 changes: 2 additions & 0 deletions pages/contractors/get-a-contractor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand All @@ -49,6 +50,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand Down
2 changes: 2 additions & 0 deletions pages/contractors/update-a-contractor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand All @@ -49,6 +50,7 @@
"first_name": "James",
"last_name": "Higgins",
"email": "[email protected]",
"role_type": "Tutor",
"url": "https://secure.tutorcruncher.com/api/contractors/568433/"
},
"subject": {
Expand Down
10 changes: 5 additions & 5 deletions pages/countries/list-all-countries.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@
{
"id": 3,
"name": "Afghanistan",
"url": "http://localhost:8000/api/countries/3/"
"url": "https://secure.tutorcruncher.com/api/countries/3/"
},
{
"id": 5,
"name": "Albania",
"url": "http://localhost:8000/api/countries/5/"
"url": "https://secure.tutorcruncher.com/api/countries/5/"
},
{
"id": 48,
"name": "Algeria",
"url": "http://localhost:8000/api/countries/48/"
"url": "https://secure.tutorcruncher.com/api/countries/48/"
},
{
"id": 1,
"name": "Andorra",
"url": "http://localhost:8000/api/countries/1/"
"url": "https://secure.tutorcruncher.com/api/countries/1/"
},
{
"id": 7,
"name": "Angola",
"url": "http://localhost:8000/api/countries/7/"
"url": "https://secure.tutorcruncher.com/api/countries/7/"
}
]
}
1 change: 1 addition & 0 deletions pages/invoices/get-an-invoice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
"first_name": "Melissa",
"last_name": "Spencer",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/35/"
},
"date_sent": "2020-01-03T16:11:48.312507Z",
Expand Down
1 change: 1 addition & 0 deletions pages/invoices/invoice-object.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
"first_name": "Melissa",
"last_name": "Spencer",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/35/"
},
"date_sent": "2020-01-03T16:11:48.312507Z",
Expand Down
1 change: 1 addition & 0 deletions pages/invoices/list-all-invoices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"first_name": "Jane",
"last_name": "cli_a",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/52/"
},
"status": "unpaid",
Expand Down
2 changes: 1 addition & 1 deletion pages/labels/get-a-label.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@
}
],
"contractor_editable": true,
"url": "http://localhost:8000/api/labels/42/"
"url": "https://secure.tutorcruncher.com/api/labels/42/"
}
5 changes: 3 additions & 2 deletions pages/notes/get-a-note.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@
"id": 2,
"first_name": "Diana",
"last_name": "Lafayette",
"email": "[email protected]"
"email": "[email protected]",
"role_type": "Administrator"
},
"text": "This is a test note.",
"focus": {
"id": 62,
"first_name": "Jamie",
"last_name": "Hoskins",
"email": "[email protected]",
"url": "http://localhost:8000/api/clients/62/"
"url": "https://secure.tutorcruncher.com/api/clients/62/"
}
}
6 changes: 3 additions & 3 deletions pages/notes/list-all-notes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@
"dt_updated": "2023-08-16T16:05:54.465348Z",
"creator": 2,
"text": "This note is on an appointment.",
"url": "http://localhost:8000/api/notes/3/"
"url": "https://secure.tutorcruncher.com/api/notes/3/"
},
{
"id": 2,
"dt_created": "2023-08-16T16:05:37.596813Z",
"dt_updated": "2023-08-16T16:05:37.596842Z",
"creator": 2,
"text": "This is a note on a job.",
"url": "http://localhost:8000/api/notes/2/"
"url": "https://secure.tutorcruncher.com/api/notes/2/"
},
{
"id": 1,
"dt_created": "2023-08-16T15:40:18.922862Z",
"dt_updated": "2023-08-16T15:40:18.922874Z",
"creator": 2,
"text": "* test",
"url": "http://localhost:8000/api/notes/1/"
"url": "https://secure.tutorcruncher.com/api/notes/1/"
}
]
}
1 change: 1 addition & 0 deletions pages/proforma-invoices/create-a-pfi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"first_name": "Anthony",
"last_name": "Clay",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/321/"
},
"created": true,
Expand Down
1 change: 1 addition & 0 deletions pages/proforma-invoices/get-a-proforma-invoice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"first_name": "Anthony",
"last_name": "Clay",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/7/"
},
"display_id": "PFI-2",
Expand Down
1 change: 1 addition & 0 deletions pages/proforma-invoices/list-all-proforma-invoices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"first_name": "Anthony",
"last_name": "Clay",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/7/"
},
"display_id": "PFI-2",
Expand Down
1 change: 1 addition & 0 deletions pages/proforma-invoices/proforma-invoice-object.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"first_name": "Anthony",
"last_name": "Clay",
"email": "[email protected]",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/7/"
},
"display_id": "PFI-2",
Expand Down
8 changes: 5 additions & 3 deletions pages/reports/get-a-report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@
"first_name": "Katherine",
"id": 17,
"last_name": "Brown",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/17/"
},
"creator": {
"email": "[email protected]",
"first_name": "brian",
"id": 33,
"last_name": "Johnson",
"url": "https://secure.tutorcruncher.com/api/contractors/33/"
"url": "https://secure.tutorcruncher.com/api/contractors/33/",
"role_type": "Tutor"
},
"dt_created": "2021-06-22T14:43:52.172855Z",
"extra_attrs": [
Expand All @@ -48,8 +50,8 @@
"first_name": "Jennifer",
"id": 10,
"last_name": "Brown",
"url": "http://localhost:8000/api/recipients/10/"
"role_type": "Student",
"url": "https://secure.tutorcruncher.com/api/recipients/10/"
}
}


9 changes: 6 additions & 3 deletions pages/reports/list-all-reports.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,27 @@
"first_name": "Katherine",
"id": 17,
"last_name": "Brown",
"role_type": "Client",
"url": "https://secure.tutorcruncher.com/api/clients/17/"
},
"creator": {
"email": "[email protected]",
"first_name": "brian",
"id": 33,
"last_name": "Johnson",
"url": "https://secure.tutorcruncher.com/api/contractors/33/"
"url": "https://secure.tutorcruncher.com/api/contractors/33/",
"role_type": "Tutor"
},
"dt_created": "2021-06-22T14:43:52.172855Z",
"service_recipient": {
"email": "[email protected]",
"first_name": "Jennifer",
"id": 10,
"last_name": "Brown",
"url": "http://localhost:8000/api/recipients/10/"
"role_type": "Student",
"url": "https://secure.tutorcruncher.com/api/recipients/10/"
},
"url": "http://localhost:8000/api/reports/12/"
"url": "https://secure.tutorcruncher.com/api/reports/12/"
},
...
]
Expand Down
Loading