regis

<back to all web services

CorrespondenceRequestedRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
"use strict";
export class CorrespondenceRequestedResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,request_code?:string,request_description?:string,request_instance?:string,request_status?:string,request_date?:string,request_assigned_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    request_code;
    /** @type {string} */
    request_description;
    /** @type {string} */
    request_instance;
    /** @type {string} */
    request_status;
    /** @type {?string} */
    request_date;
    /** @type {?string} */
    request_assigned_date;
}
export class CorrespondenceRequestedRequest {
    /** @param {{pid?:number,token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    pid;
    /** @type {string} */
    token;
}

JavaScript CorrespondenceRequestedRequest DTOs

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

HTTP + CSV

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

{"pid":0,"token":"String"}
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"}},"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"}