Required role: | REGISUserRole |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<LetterSentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<pid>0</pid>
</LetterSentRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <LetterSentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <added_date>0001-01-01T00:00:00</added_date> <application_date>0001-01-01T00:00:00</application_date> <application_status>String</application_status> <document_description>String</document_description> <document_name>String</document_name> <letter_status>String</letter_status> <program>String</program> <regent_id>0</regent_id> </LetterSentResponse>