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
Benefit Assignment (POST)
Course Offering (POST)
Course Offering Schedules (POST)
Hold Definition (POST)
Learning Equivalency (GET, POST)
Learning Equivalency ID (GET, PUT)
Learner Restriction Violation (GET, POST)
Learnings Graph (POST, PATCH)
Learnings Graph (GET)
Request Bodies
Response Bodies
Fundraising
PDF

Hold Definition (POST)

Create a hold definition with hold reasons and a resolution plan.
Resource
Resource example
Available version
64.0
HTTP methods
POST
Request body for POST
JSON example
Properties
Name Type Description Required or Optional Available Version
canResolve​Automatically Boolean Indicates whether the restriction can be auto-resolved (true) or requires manual resolution (false). Optional 64.0
description String Description of the hold. Optional 64.0
effectiveFrom String Date from which the hold is effective. Optional 64.0
effectiveTo String Date till which the hold is effective. Optional 64.0
name String Name of the hold. Optional 64.0
reasons String[] Reasons for the hold. Optional 64.0
regulatory​AuthorityId String Unique ID of the regulatory authority. Required 64.0
resolution Action Plan Template Input Unique ID of the action plan template associated with the resolution of this hold. Required 64.0
subject String Subject of the hold. Optional 64.0
type String Type of the hold. Optional 64.0
Response body for POST
Hold Setup