| Required permission: | ReadRegistrationAvailability |
| POST | /Registration/{reporting_term}/Available |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| reporting_term | path | string | No | |
| first_name | body | string | No | |
| last_name | body | string | No | |
| body | string | No | ||
| dob | body | DateTime? | No | |
| regent_id | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int? | No | |
| birthdate_exists | form | bool | No | |
| birthdate_matches | form | bool | No | |
| has_regent_login | form | bool | No | |
| is_a_regis_person | form | bool | No | |
| is_a_sugar_person | form | bool | No | |
| term_is_available | form | bool | No | |
| blocked_in_regis | form | bool | No | |
| email_matches | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/{reporting_term}/Available HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reporting_term: String,
first_name: String,
last_name: String,
email: String,
dob: 0001-01-01,
regent_id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
birthdate_exists: False,
birthdate_matches: False,
has_regent_login: False,
is_a_regis_person: False,
is_a_sugar_person: False,
term_is_available: False,
blocked_in_regis: False,
email_matches: False
}