Education Cloud Developer Guide

Introduction to Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Fields on Standard Objects for United Kingdom Compliance and Configuration
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
REST Reference
Resources
Request Bodies
Achievement Contributor Input
Action Plan Template Input
Course Offering Details Input
Course Offering Input
Course Offering Schedule Details Input
Course Offering Schedule Input
Custom Field Input
Create Learning Input
Create Learnings Input
Edu External ID Details Input
Group Achievement Mapping Input
Hold Setup Input
Hold Violation Input
Learning Equivalency Input
Learning Details Input
Learning Foundation Item Lookup Input
Learning Input
Learnings Mapping Input
Mentoring Benefit Assignment Input
Requirement Update Item Input
Single Achievement Mapping Input
Skill Achievement Mapping Input
Update Learning Input
Update Learnings Input
Response Bodies
Fundraising
PDF

Hold Violation Input

Input representation of the request to assign a hold to a student.
JSON example
1{
2  "caseStatus": "string",
3  "caseOrigin": "string",
4  "caseRecordTypeId": "string",
5  "dateCreated": "2025-07-25",
6  "description": "string",
7  "complianceDueDate": "2025-07-25",
8  "dateResolved": "2025-07-25",
9  "status": "string",
10  "type": "string",
11  "regulatoryCodeId": "string",
12  "reasons": [
13    "string"
14  ]
15}
Properties
Name Type Description Required or Optional Available Version
caseOrigin String Origin of the case for the contact user. Optional 65.0
caseRecord​TypeId String Record Type ID of the case for the contact user. Optional 65.0
caseStatus String Status of the case for the contact user. Optional 65.0
compliance​DueDate String Date by which compliance is expected for the hold violation. Optional 65.0
dateCreated String Date from which the hold violation is effective. Optional 65.0
dateResolved String Date on which the hold violation is resolved. Optional 65.0
description String Description of the hold violation. Optional 65.0
reasons String[] Reasons for the hold violation. Optional 65.0
regulatory​CodeId String Unique ID for hold Definition. Required 65.0
status String Status of the hold violation. Optional 65.0
type String Type of the hold violation. Optional 65.0