regis

<back to all web services

AddressSyncRequest

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

}

namespace regis.ClassLibrary.Responses
{
    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 AddressSyncResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual AddressResponse sugar_address { get; set; }
        public virtual PhoneEmailResponse sugar_phone_email { get; set; }
        public virtual AddressResponse regis_address { get; set; }
        public virtual PhoneEmailResponse regis_phone_email { get; set; }
        public virtual AddressResponse re_address { get; set; }
        public virtual PhoneEmailResponse re_phone_email { get; set; }
        public virtual bool exists_in_sugar { get; set; }
        public virtual bool exists_in_re { get; set; }
        public virtual bool are_equal { get; set; }
        public virtual bool addr_are_equal { get; set; }
        public virtual bool city_are_equal { get; set; }
        public virtual bool state_are_equal { get; set; }
        public virtual bool country_are_equal { get; set; }
        public virtual bool code_are_equal { get; set; }
        public virtual bool phone_home_are_equal { get; set; }
        public virtual bool phone_cell_are_equal { get; set; }
        public virtual bool phone_bus_are_equal { get; set; }
        public virtual bool email_are_equal { 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# AddressSyncRequest 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 /admissions/{uuid}/address/sync 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
		}
	},
	uuid: String,
	regent_id: 0,
	sugar_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-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	sugar_phone_email: 
	{
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		email: String,
		start_date: 0001-01-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	regis_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-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	regis_phone_email: 
	{
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		email: String,
		start_date: 0001-01-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	re_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-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	re_phone_email: 
	{
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		email: String,
		start_date: 0001-01-01,
		end_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		changed_by: String,
		changed_date: 0001-01-01
	},
	exists_in_sugar: False,
	exists_in_re: False,
	are_equal: False,
	addr_are_equal: False,
	city_are_equal: False,
	state_are_equal: False,
	country_are_equal: False,
	code_are_equal: False,
	phone_home_are_equal: False,
	phone_cell_are_equal: False,
	phone_bus_are_equal: False,
	email_are_equal: False
}