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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class AddressSyncRequest
            Public Overridable Property uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class AddressResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property country As String
            Public Overridable Property country_code As String
            Public Overridable Property state As String
            Public Overridable Property city As String
            Public Overridable Property code As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class AddressSyncResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property sugar_address As AddressResponse
            Public Overridable Property sugar_phone_email As PhoneEmailResponse
            Public Overridable Property regis_address As AddressResponse
            Public Overridable Property regis_phone_email As PhoneEmailResponse
            Public Overridable Property re_address As AddressResponse
            Public Overridable Property re_phone_email As PhoneEmailResponse
            Public Overridable Property exists_in_sugar As Boolean
            Public Overridable Property exists_in_re As Boolean
            Public Overridable Property are_equal As Boolean
            Public Overridable Property addr_are_equal As Boolean
            Public Overridable Property city_are_equal As Boolean
            Public Overridable Property state_are_equal As Boolean
            Public Overridable Property country_are_equal As Boolean
            Public Overridable Property code_are_equal As Boolean
            Public Overridable Property phone_home_are_equal As Boolean
            Public Overridable Property phone_cell_are_equal As Boolean
            Public Overridable Property phone_bus_are_equal As Boolean
            Public Overridable Property email_are_equal As Boolean
        End Class

        Public Partial Class PhoneEmailResponse
            Public Overridable Property phone_home As String
            Public Overridable Property phone_cell As String
            Public Overridable Property phone_bus As String
            Public Overridable Property email As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET 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
}