regis

<back to all web services

SyncAddressRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Address
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 SyncAddressRequest:
    regent_id: int = 0
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    email: Optional[str] = None
    phone_home: Optional[str] = None
    phone_bus: Optional[str] = None
    phone_cell: Optional[str] = None
    queued_by_username: Optional[str] = None
    queued_by__c_r_m: bool = False
    queued_by__r_e: bool = False
    queued_by__sugar: bool = False
    queued_by__r_e_g_i_s: bool = False

Python SyncAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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}