regis

<back to all web services

ProgramsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Programs
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ProgramResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val id:Int32 = new Int32() with get,set
        member val program_code:String = null with get,set
        member val program_pretty_code:String = null with get,set
        member val program_long_name:String = null with get,set
        member val available_concentrations:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ProgramsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val programs:ResizeArray<ProgramResponse> = new ResizeArray<ProgramResponse>() with get,set

    [<AllowNullLiteral>]
    type ProgramsRequest() = 
        class end

F# 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
		}
	]
}