regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SyncBioAndAddressResponse:
    response_status: Optional[ResponseStatus] = None
    successfull: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SyncBioRequest:
    regent_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    middle_name: Optional[str] = None
    preferred_name: Optional[str] = None
    birth_name: Optional[str] = None
    prefix: Optional[str] = None
    current_occupation: Optional[str] = None
    dob: Optional[datetime.datetime] = None
    deceased_date: Optional[datetime.datetime] = None
    gender: Optional[str] = None
    marital_status: Optional[str] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    queued_by_username: Optional[str] = None
    queued_by__c_r_m: bool = False
    queued_by__r_e: bool = False
    queued_by__r_e_g_i_s: bool = False
    queued_by__sugar: bool = False

Python SyncBioRequest 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/Bio HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	first_name: String,
	last_name: String,
	middle_name: String,
	preferred_name: String,
	birth_name: String,
	prefix: String,
	current_occupation: String,
	dob: 0001-01-01,
	deceased_date: 0001-01-01,
	gender: String,
	marital_status: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	queued_by_username: String,
	queued_by_CRM: False,
	queued_by_RE: False,
	queued_by_REGIS: False,
	queued_by_Sugar: 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
}