regis

<back to all web services

LetterSentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
LetterSentRequest Parameters:
NameParameterData TypeRequiredDescription
pidbodyintNo
LetterSentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
document_nameformstringNo
document_descriptionformstringNo
programformstringNo
letter_statusformstringNo
application_statusformstringNo
application_dateformDateTime?No
added_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"pid":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000"}