Operator REST API¶
/call_centre/api/v1/case/{case_reference}/eligibility_check/¶
- Eligibility_Check PUTParameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eligibility_Check POSTParameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eligibility_Check GETParameters: (
case_reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eligibility_Check PATCHParameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/eligibility_check/is_eligible/¶
- Eligibility_Check POSTParameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/eligibility_check/validate/¶
- Eligibility_Check GETParameters: (
case_reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/personal_details/¶
- Personal_Details PUTParameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)- Personal_Details POSTParameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)- Personal_Details GETParameters: (
case_reference, type: string
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)- Personal_Details PATCHParameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/personal_details/set_diversity/¶
- Personal_Details POSTParameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/adaptation_details/¶
- Adaptation_Details PUTParameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Adaptation_Details POSTParameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Adaptation_Details GETParameters: (
case_reference, type: string
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Adaptation_Details PATCHParameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/eod_details/¶
- Eod_Details PUTParameters: (
case_reference, type: string
[categories] type: field
[notes] type: string {‘max’: 5000, ‘min’: None}
)
→ EODDetailsSerializer(
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[categories] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eod_Details POSTParameters: (
case_reference, type: string
[categories] type: field
[notes] type: string {‘max’: 5000, ‘min’: None}
)
→ EODDetailsSerializer(
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[categories] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eod_Details GETParameters: (
case_reference, type: string
)
→ EODDetailsSerializer(
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[categories] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Eod_Details PATCHParameters: (
case_reference, type: string
[categories] type: field
[notes] type: string {‘max’: 5000, ‘min’: None}
)
→ EODDetailsSerializer(
[notes] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[categories] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/thirdparty_details/¶
- Third_Party_Details PUTParameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Third_Party_Details POSTParameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Third_Party_Details GETParameters: (
case_reference, type: string
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- Third_Party_Details PATCHParameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/diagnosis/¶
- Diagnosis PUTParameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Diagnosis POSTParameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Diagnosis PATCHParameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Diagnosis GETParameters: (
case_reference, type: string
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Diagnosis DELETEParameters: (
case_reference, type: string
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/diagnosis/move_down/¶
- Diagnosis POSTParameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/diagnosis/move_up/¶
- Diagnosis POSTParameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/logs/¶
- Log GETParameters: (
case_reference, type: string
)
→ LogSerializer(
[code] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[level] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[patch] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[timer] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case/{case_reference}/notes_history/¶
- Case_Notes_History GETParameters: (
case_reference, type: string
)
→ CaseNotesHistorySerializer(
[operator_notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[type_notes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case/¶
- Case POSTParameters: (
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)- Case GET
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/future_callbacks/¶
- Case GET
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/¶
- Case PUTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)- Case GETParameters: (
reference, type: string
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)- Case PATCHParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/assign/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/assign_alternative_help/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/assign_suggest/¶
- Case GETParameters: (
reference, type: string
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/call_me_back/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/decline_help/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/defer_assignment/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/link_personal_details/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/search_for_personal_details/¶
- Case GETParameters: (
reference, type: string
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/start_call/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/stop_call_me_back/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case/{reference}/suspend/¶
- Case POSTParameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
source, type: choice
[requires_action_at] type: datetime
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_at] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[rejected] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[flagged_with_eod] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
source, type: choice {‘max’: None, ‘defaultValue’: u’PHONE’, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/category/¶
- Category GET
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/category/{code}/¶
- Category GETParameters: (
code, type: string
)
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/provider/rota/¶
- Out_Of_Hours_Rota POSTParameters: (
start_date, type: datetime
end_date, type: datetime
category, type: field
provider, type: field
)
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Out_Of_Hours_Rota GET
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/provider/rota/{pk}/¶
- Out_Of_Hours_Rota PUTParameters: (
pk, type: string
start_date, type: datetime
end_date, type: datetime
category, type: field
provider, type: field
)
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Out_Of_Hours_Rota GETParameters: (
pk, type: string
)
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Out_Of_Hours_Rota PATCHParameters: (
pk, type: string
start_date, type: datetime
end_date, type: datetime
category, type: field
provider, type: field
)
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Out_Of_Hours_Rota DELETEParameters: (
pk, type: string
)
→ OutOfHoursRotaSerializer(
category, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_date, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
provider, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/provider/¶
- Provider GET
→ ProviderSerializer(
[short_code] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[telephone_frontdoor] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[telephone_backdoor] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/provider/{pk}/¶
- Provider GETParameters: (
pk, type: string
)
→ ProviderSerializer(
[short_code] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[telephone_frontdoor] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[telephone_backdoor] type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/user/¶
- User POSTParameters: (
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
)
→ OperatorSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_cla_superuser] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)- User GET
→ OperatorSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_cla_superuser] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/user/{user__username}/¶
- User GETParameters: (
user__username, type: string
)
→ OperatorSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_cla_superuser] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/user/{user__username}/password_reset/¶
- User POSTParameters: (
user__username, type: string
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
)
→ OperatorSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_cla_superuser] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/user/{user__username}/reset_lockout/¶
- User POSTParameters: (
user__username, type: string
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
)
→ OperatorSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_cla_superuser] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/event/{action}/¶
- Event GETParameters: (
action, type: string
)/call_centre/api/v1/knowledgebase/article/¶
- Article GET
→ ArticleSerializer(
[website] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[geographic_coverage] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type_of_service] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 732876, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[accessibility] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[service_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[public_description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 732951, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[service_tag] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[when_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[how_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
resource_type, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
telephone_numbers, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[address] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[keywords] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[opening_hours] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
categories, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/knowledgebase/article/{pk}/¶
- Article GETParameters: (
pk, type: string
)
→ ArticleSerializer(
[website] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[geographic_coverage] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type_of_service] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 732876, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[accessibility] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[service_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[public_description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 732951, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[service_tag] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[when_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[how_to_use] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
resource_type, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
telephone_numbers, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[address] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[keywords] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[opening_hours] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
categories, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/knowledgebase/category/¶
- Article_Category GET
→ ArticleCategorySerializer(
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 25, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/knowledgebase/category/{pk}/¶
- Article_Category GETParameters: (
pk, type: string
)
→ ArticleCategorySerializer(
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 25, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/guidance/note/¶
- Guidance_Note GET
→ serializer_class(
body, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
title, type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/guidance/note/{name}/¶
- Guidance_Note GETParameters: (
name, type: string
)
→ serializer_class(
body, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
title, type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/notifications/notification/¶
- Notification GET
→ NotificationSerializer(
[description] type: string {‘max’: 600, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
notification, type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_time, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_time, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
type, type: choice {‘max’: None, ‘defaultValue’: u’notification’, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/notifications/notification/{pk}/¶
- Notification GETParameters: (
pk, type: string
)
→ NotificationSerializer(
[description] type: string {‘max’: 600, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
notification, type: string {‘max’: 100, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
start_time, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
end_time, type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
type, type: choice {‘max’: None, ‘defaultValue’: u’notification’, ‘readOnly’: False, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/adaptations/¶
- Adaptation_Details_Metadata POSTParameters: (
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/mattertype/¶
- Matter_Type GET
→ MatterTypeSerializerBase(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
code, type: string {‘max’: 4, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
description, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
level, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/mattertype/{pk}/¶
- Matter_Type GETParameters: (
pk, type: string
)
→ MatterTypeSerializerBase(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
code, type: string {‘max’: 4, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
description, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
level, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/mediacode/¶
- Media_Code GET
→ MediaCodeSerializerBase(
code, type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[group] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/mediacode/{pk}/¶
- Media_Code GETParameters: (
pk, type: string
)
→ MediaCodeSerializerBase(
code, type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[group] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/feedback/¶
- Feedback GET
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725311, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725384, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[issue] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/feedback/{reference}/¶
- Feedback PUTParameters: (
reference, type: string
[justified] type: boolean
[resolved] type: boolean
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725311, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725384, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[issue] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Feedback GETParameters: (
reference, type: string
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725311, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725384, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[issue] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)- Feedback PATCHParameters: (
reference, type: string
[justified] type: boolean
[resolved] type: boolean
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725311, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 725384, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[issue] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/case_archive/¶
- Case_Archived GET
→ CaseArchivedSerializer(
[outcome_code_date] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[financially_eligible] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[knowledgebase_items_used] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[area_of_law] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[specialist_referred_to] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_specialist_closed] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_of_birth] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[in_scope] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[outcome_code] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_specialist_referred] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/case_archive/{laa_reference}/¶
- Case_Archived GETParameters: (
laa_reference, type: string
)
→ CaseArchivedSerializer(
[outcome_code_date] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[financially_eligible] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[knowledgebase_items_used] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[area_of_law] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[specialist_referred_to] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_specialist_closed] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_of_birth] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[in_scope] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[outcome_code] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[date_specialist_referred] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)/call_centre/api/v1/csvupload/¶
- Csv_Upload GET
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 717285, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 717359, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/csvupload/{pk}/¶
- Csv_Upload GETParameters: (
pk, type: string
)
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 717285, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 52, 717359, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)/call_centre/api/v1/timer/¶
- Timer POST