regis

<back to all web services

AddressHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/address/history
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 AddressHistoryRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class AddressHistoryResponse
    {
        public AddressHistoryResponse()
        {
            addresses = new List<AddressPhoneEmailResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual List<AddressPhoneEmailResponse> addresses { get; set; }
    }

    public partial class AddressPhoneEmailResponse
    {
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual AddressResponse address { get; set; }
        public virtual PhoneEmailResponse phone { get; set; }
    }

    public partial class AddressResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string country { get; set; }
        public virtual string country_code { get; set; }
        public virtual string state { get; set; }
        public virtual string city { get; set; }
        public virtual string code { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class PhoneEmailResponse
    {
        public virtual string phone_home { get; set; }
        public virtual string phone_cell { get; set; }
        public virtual string phone_bus { get; set; }
        public virtual string email { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

}

C# AddressHistoryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /admissions/{uuid}/address/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"addresses":[{"uuid":"String","regent_id":0,"address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"phone":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}}]}