| Required role: | REGISUserRole |
| POST | /correspondence |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| pid | body | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| document_name | form | string | No | |
| document_description | form | string | No | |
| program | form | string | No | |
| letter_status | form | string | No | |
| application_status | form | string | No | |
| application_date | form | DateTime? | No | |
| added_date | form | DateTime? | 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 /correspondence HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
pid: 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,
document_name: String,
document_description: String,
program: String,
letter_status: String,
application_status: String,
application_date: 0001-01-01,
added_date: 0001-01-01
}