-
Notifications
You must be signed in to change notification settings - Fork 1
API Walkthroughs
danbenton-mojdt edited this page Jun 19, 2023
·
34 revisions
The walkthroughs below describe typical API requests and responses as used by the front end and by suppliers.
Case | Name | From | To | Move Type | Identifier | Primary Creator |
---|---|---|---|---|---|---|
1.1 | Police to Police | Police | Police | police_transfer |
PNC |
PECS Police user |
2.1 | Police to unspecified Prison | Police | (Prison) | prison_recall |
PNC |
PECS Police user |
2.2 | Police to unspecified STC | Police | (STC) | prison_recall |
PNC |
PECS Police user |
2.3 | Police to unspecified SCH | Police | (SCH) | prison_recall |
PNC |
PECS Police user |
3.1 | Police to unspecified Prison | Police | (Prison) | video_remand |
PNC |
PECS Police user |
3.2 | Police to unspecified STC | Police | (STC) | video_remand |
PNC |
PECS Police user |
3.3 | Police to unspecified SCH | Police | (SCH) | video_remand |
PNC |
PECS Police user |
4.1 | Police to Court | Police | Court | court_appearance |
PNC |
PECS Police user |
4.2 | Police to Court | Police | Court | court_appearance |
none | PECS Police user |
5.1 | Court to Prison | Court | Prison | prison_remand |
PNC or PN
|
Supplier via API |
5.2 | Court to Prison | Court | Prison | prison_remand |
none | Supplier via API |
6.1 | IPT Singleton | Prison | Prison | prison_transfer |
PN |
PECS Prison user |
6.2 | IPT Allocation | Prison | Prison | prison_transfer |
PN |
PECS Prison user |
6.3 | IPT Tornado | Prison | Prison | prison_transfer |
PN |
Supplier via API |
7.1 | Prison to Court | Prison | Court | court_appearance |
PN |
PECS Prison user |
8.1 | STC to Court | STC | Court | court_appearance |
PNC |
PECS STC user |
9.1 | SCH to Court | SCH | Court | court_appearance |
PNC |
PECS SCH user |
10.1 | Court to Other | Court | Other | court_other |
PNC or PN
|
Supplier via API |
10.2 | Court to Other | Court | Other | court_other |
none | Supplier via API |
17.1 | Police to Hospital | Police | Hospital | hospital |
PNC |
PECS Police user |
17.2 | Police to Hospital | Police | Hospital | hospital |
none | PECS Police user |
18.1 | Prison to Hospital | Prison | Hospital | hospital |
PN |
PECS Prison user |
18.2 | Prison to Approved Premises | Prison | Approved Premises | approved_premises |
PN |
PECS Prison user |
19.1 | STC to Hospital | STC | Hospital | hospital |
PNC |
PECS STC user |
- API Guide
- Version 2
- Asked Questions
- Webhook & Email notifications
- Walkthroughs
- Deployment
- Useful Queries
- Data quality improvements
-
Journeys and Payment Related Calls
- Single journey move
- Redirection before move commences
- Redirection after move commences
- Lockouts and Lodgings
- Assessments
- Event Documentation
- GPS Track a move