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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			program_code: String,
			program_pretty_code: String,
			program_long_name: String,
			available_concentrations: String,
			is_active: False,
			timestamp: 0001-01-01
		}
	]
}