Required permission: | ReadInstitutions |
POST | /institutions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
institution_id | body | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
institution_id | form | int | No | |
institution_name | form | string | No | |
institution_previous_names | form | string | No | |
institution_other_names | form | string | No | |
institution_type | form | string | No | |
accreditation_status | form | string | No | |
accreditation_status_notes | form | string | No | |
related_institutions | form | List<string> | No | |
accreditation_status_changed_date | form | DateTime? | No | |
gpa_conversion | form | string | No | |
credit_hour_conversion | form | string | No | |
addr1 | form | string | No | |
addr2 | form | string | No | |
city | form | string | No | |
state | form | string | No | |
country | form | string | No | |
zip | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /institutions HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"institution_id":0}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}