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 .xml suffix or ?format=xml

HTTP + 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

<CorrespondenceRequestedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <pid>0</pid>
  <token>String</token>
</CorrespondenceRequestedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CorrespondenceRequestedResponse 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>
  <regent_id>0</regent_id>
  <request_assigned_date>0001-01-01T00:00:00</request_assigned_date>
  <request_code>String</request_code>
  <request_date>0001-01-01T00:00:00</request_date>
  <request_description>String</request_description>
  <request_instance>String</request_instance>
  <request_status>String</request_status>
</CorrespondenceRequestedResponse>