regis

<back to all web services

LetterSentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
"use strict";
export class LetterSentResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,document_name?:string,document_description?:string,program?:string,letter_status?:string,application_status?:string,application_date?:string,added_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    document_name;
    /** @type {string} */
    document_description;
    /** @type {string} */
    program;
    /** @type {string} */
    letter_status;
    /** @type {string} */
    application_status;
    /** @type {?string} */
    application_date;
    /** @type {?string} */
    added_date;
}
export class LetterSentRequest {
    /** @param {{pid?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    pid;
}

JavaScript LetterSentRequest 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}
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,"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"}