regis

<back to all web services

ProgramsRequest

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

public class dtos
{

    public static class ProgramsRequest
    {
        
    }

    public static class ProgramsResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<ProgramResponse> programs = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ProgramsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<ProgramResponse> getPrograms() { return programs; }
        public ProgramsResponse setPrograms(ArrayList<ProgramResponse> value) { this.programs = value; return this; }
    }

    public static class ProgramResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer id = null;
        public String program_code = null;
        public String program_pretty_code = null;
        public String program_long_name = null;
        public String available_concentrations = null;
        public Boolean is_active = null;
        public Date timestamp = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ProgramResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getId() { return id; }
        public ProgramResponse setId(Integer value) { this.id = value; return this; }
        public String getProgramCode() { return program_code; }
        public ProgramResponse setProgramCode(String value) { this.program_code = value; return this; }
        public String getProgramPrettyCode() { return program_pretty_code; }
        public ProgramResponse setProgramPrettyCode(String value) { this.program_pretty_code = value; return this; }
        public String getProgramLongName() { return program_long_name; }
        public ProgramResponse setProgramLongName(String value) { this.program_long_name = value; return this; }
        public String getAvailableConcentrations() { return available_concentrations; }
        public ProgramResponse setAvailableConcentrations(String value) { this.available_concentrations = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public ProgramResponse setIsActive(Boolean value) { this.is_active = value; return this; }
        public Date getTimestamp() { return timestamp; }
        public ProgramResponse setTimestamp(Date value) { this.timestamp = value; return this; }
    }

}

Java ProgramsRequest 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 /Programs HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ProgramsResponse 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>
  <programs>
    <ProgramResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <available_concentrations>String</available_concentrations>
      <id>0</id>
      <is_active>false</is_active>
      <program_code>String</program_code>
      <program_long_name>String</program_long_name>
      <program_pretty_code>String</program_pretty_code>
      <timestamp>0001-01-01T00:00:00</timestamp>
    </ProgramResponse>
  </programs>
</ProgramsResponse>