Required role: | REGISUserRole |
POST | /person/{uuid}/sidebar |
---|
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 PersonSideBarRequest
{
public virtual string uuid { get; set; }
}
}
namespace regis.ClassLibrary.Responses
{
public partial class PersonSideBarResponse
{
public PersonSideBarResponse()
{
programs = new List<StudentProgramSimpleResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual int regent_id { get; set; }
public virtual int? ubc_id { get; set; }
public virtual string regent_login { get; set; }
public virtual string uuid { get; set; }
public virtual string first_name { get; set; }
public virtual string middle_name { get; set; }
public virtual string last_name { get; set; }
public virtual string preferred_name { get; set; }
public virtual DateTime? dob { get; set; }
public virtual string citizenship { get; set; }
public virtual string citizenship_other { get; set; }
public virtual string permanent_resident { get; set; }
public virtual string addr1 { get; set; }
public virtual string addr2 { get; set; }
public virtual string city { get; set; }
public virtual string state { get; set; }
public virtual string code { get; set; }
public virtual string country { get; set; }
public virtual string email { get; set; }
public virtual string phone_home { get; set; }
public virtual string phone_cell { get; set; }
public virtual string phone_bus { get; set; }
public virtual string imageBase64 { get; set; }
public virtual string tax_number { get; set; }
public virtual List<StudentProgramSimpleResponse> programs { get; set; }
}
public partial class StudentProgramSimpleResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual int regent_id { get; set; }
public virtual string uuid { get; set; }
public virtual int program_id { get; set; }
public virtual string program_code { get; set; }
public virtual string program_name { get; set; }
public virtual string concentration_code { get; set; }
public virtual string concentration_name { get; set; }
public virtual DateTime? start_date { get; set; }
public virtual DateTime? end_date { get; set; }
public virtual string catalog { get; set; }
public virtual bool is_active { get; set; }
public virtual bool is_graduated { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/sidebar HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
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 } }, regent_id: 0, ubc_id: 0, regent_login: String, uuid: String, first_name: String, middle_name: String, last_name: String, preferred_name: String, dob: 0001-01-01, citizenship: String, citizenship_other: String, permanent_resident: String, addr1: String, addr2: String, city: String, state: String, code: String, country: String, email: String, phone_home: String, phone_cell: String, phone_bus: String, imageBase64: String, tax_number: String, programs: [ { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, uuid: String, program_id: 0, program_code: String, program_name: String, concentration_code: String, concentration_name: String, start_date: 0001-01-01, end_date: 0001-01-01, catalog: String, is_active: False, is_graduated: False } ] }