regis

<back to all web services

SyncAddressRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Address
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 SyncAddressRequest
            Public Overridable Property regent_id As Integer
            Public Overridable Property addr1 As String
            Public Overridable Property addr2 As String
            Public Overridable Property city As String
            Public Overridable Property state As String
            Public Overridable Property country As String
            Public Overridable Property code As String
            Public Overridable Property email As String
            Public Overridable Property phone_home As String
            Public Overridable Property phone_bus As String
            Public Overridable Property phone_cell As String
            Public Overridable Property queued_by_username As String
            Public Overridable Property queued_by_CRM As Boolean
            Public Overridable Property queued_by_RE As Boolean
            Public Overridable Property queued_by_Sugar As Boolean
            Public Overridable Property queued_by_REGIS As Boolean
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class SyncBioAndAddressResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property successfull As Boolean
        End Class
    End Namespace
End Namespace

VB.NET SyncAddressRequest 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 /Sync/Address HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	email: String,
	phone_home: String,
	phone_bus: String,
	phone_cell: String,
	queued_by_username: String,
	queued_by_CRM: False,
	queued_by_RE: False,
	queued_by_Sugar: False,
	queued_by_REGIS: False
}
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
		}
	},
	successfull: False
}