Version 2020-07-07.3198.d8b8364 to 2020-07-20.3361.b9c709f
What's New
GET
/api/offender-assessments/assessments Returns assessment information on Offenders at a prison.
What's Deprecated
What's Changed
GET
/api/bookings/offenderNo/{offenderNo} Offender detail.
Return Type
Insert recall //indicates that this offender is on a recall
Insert sentenceTerms //Current Sentence Terms
Insert assessments.assessmentComment //Comment from assessor
Insert assessments.assessorId //Staff member who made the assessment
Insert assessments.assessorUser //Username who made the assessment
GET
/api/bookings/{bookingId} Offender detail.
Return Type
Insert recall //indicates that this offender is on a recall
Insert sentenceTerms //Current Sentence Terms
Insert assessments.assessmentComment //Comment from assessor
Insert assessments.assessorId //Staff member who made the assessment
Insert assessments.assessorUser //Username who made the assessment
GET
/api/bookings/{bookingId}/assessment/{assessmentCode} Offender assessment detail.
Return Type
Insert assessmentComment //Comment from assessor
Insert assessorId //Staff member who made the assessment
Insert assessorUser //Username who made the assessment
GET
/api/bookings/{bookingId}/assessments Assessment Information
Return Type
Insert assessmentComment //Comment from assessor
Insert assessorId //Staff member who made the assessment
Insert assessorUser //Username who made the assessment
GET
/api/bookings/{bookingId}/non-association-details Gets the offender non-association details for a given booking
Return Type
Insert offenderNo //The offenders number
Insert firstName //The offenders first name
Insert lastName //The offenders last name
Insert agencyDescription //Description of the agency (e.g. prison) the offender is assigned to.
Insert assignedLivingUnitDescription //Description of living unit (e.g. cell) the offender is assigned to.
Insert nonAssociations //Offender non-association details
Delete details //Offender non-association details
POST
/api/offender-assessments/csra/list Retrieves Offender CRSAs for multiple offenders - POST version to allow large offender lists.
Return Type
Insert assessmentComment //Comment from assessor
Insert assessorId //Staff member who made the assessment
Insert assessorUser //Username who made the assessment
POST
/api/offender-assessments/{assessmentCode} Retrieves Offender assessment details for multiple offenders - POST version to allow large offender lists.
Return Type
Insert assessmentComment //Comment from assessor
Insert assessorId //Staff member who made the assessment
Insert assessorUser //Username who made the assessment
GET
/api/offender-assessments/{assessmentCode} Offender assessment detail for multiple offenders.
Return Type
Insert assessmentComment //Comment from assessor
Insert assessorId //Staff member who made the assessment
Insert assessorUser //Username who made the assessment
GET
/api/offender-sentences/booking/{bookingId}/sentenceTerms Sentence term details for a prisoner
Return Type
Insert lineSeq //Sentence line number
Insert sentenceStartDate //Sentence start date
Modify startDate //Start date of sentence.
GET
/api/offenders/{offenderNo} Full details about the current state of an offender
Return Type
Insert recall //indicates that this offender is on a recall
Insert sentenceTerms //Current Sentence Terms
Insert assessments.assessmentComment //Comment from assessor
Insert assessments.assessorId //Staff member who made the assessment
Insert assessments.assessorUser //Username who made the assessment