regis

<back to all web services

RegistrationAvailableRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/Registration/{reporting_term}/Available
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class RegistrationAvailableRequest
    {
        public virtual string reporting_term { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual int? regent_id { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class RegistrationAvailableResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int? regent_id { get; set; }
        public virtual bool birthdate_exists { get; set; }
        public virtual bool birthdate_matches { get; set; }
        public virtual bool has_regent_login { get; set; }
        public virtual bool is_a_regis_person { get; set; }
        public virtual bool is_a_sugar_person { get; set; }
        public virtual bool term_is_available { get; set; }
        public virtual bool blocked_in_regis { get; set; }
        public virtual bool email_matches { get; set; }
    }

}

C# RegistrationAvailableRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/{reporting_term}/Available HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","first_name":"String","last_name":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","regent_id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"birthdate_exists":false,"birthdate_matches":false,"has_regent_login":false,"is_a_regis_person":false,"is_a_sugar_person":false,"term_is_available":false,"blocked_in_regis":false,"email_matches":false}