regis

<back to all web services

SyncAddressRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Address
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SyncBioAndAddressResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val successfull:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SyncAddressRequest() = 
        member val regent_id:Int32 = new Int32() with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val code:String = null with get,set
        member val email:String = null with get,set
        member val phone_home:String = null with get,set
        member val phone_bus:String = null with get,set
        member val phone_cell:String = null with get,set
        member val queued_by_username:String = null with get,set
        member val queued_by_CRM:Boolean = new Boolean() with get,set
        member val queued_by_RE:Boolean = new Boolean() with get,set
        member val queued_by_Sugar:Boolean = new Boolean() with get,set
        member val queued_by_REGIS:Boolean = new Boolean() with get,set

F# 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
}