regis

<back to all web services

CorrespondenceRequestedRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
CorrespondenceRequestedRequest Parameters:
NameParameterData TypeRequiredDescription
pidbodyintNo
tokenbodystringNo
CorrespondenceRequestedResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
request_codeformstringNo
request_descriptionformstringNo
request_instanceformstringNo
request_statusformstringNo
request_dateformDateTime?No
request_assigned_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,"token":"String"}
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,"request_code":"String","request_description":"String","request_instance":"String","request_status":"String","request_date":"0001-01-01T00:00:00.0000000","request_assigned_date":"0001-01-01T00:00:00.0000000"}