regis

<back to all web services

LetterSentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/correspondence
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class LetterSentRequest
    {
        public Integer pid = null;
        
        public Integer getPid() { return pid; }
        public LetterSentRequest setPid(Integer value) { this.pid = value; return this; }
    }

    public static class LetterSentResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String document_name = null;
        public String document_description = null;
        public String program = null;
        public String letter_status = null;
        public String application_status = null;
        public Date application_date = null;
        public Date added_date = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public LetterSentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public LetterSentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getDocumentName() { return document_name; }
        public LetterSentResponse setDocumentName(String value) { this.document_name = value; return this; }
        public String getDocumentDescription() { return document_description; }
        public LetterSentResponse setDocumentDescription(String value) { this.document_description = value; return this; }
        public String getProgram() { return program; }
        public LetterSentResponse setProgram(String value) { this.program = value; return this; }
        public String getLetterStatus() { return letter_status; }
        public LetterSentResponse setLetterStatus(String value) { this.letter_status = value; return this; }
        public String getApplicationStatus() { return application_status; }
        public LetterSentResponse setApplicationStatus(String value) { this.application_status = value; return this; }
        public Date getApplicationDate() { return application_date; }
        public LetterSentResponse setApplicationDate(Date value) { this.application_date = value; return this; }
        public Date getAddedDate() { return added_date; }
        public LetterSentResponse setAddedDate(Date value) { this.added_date = value; return this; }
    }

}

Java LetterSentRequest 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

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