| Required role: | REGISUserRole |
| POST | /admissions/{uuid}/address/sync |
|---|
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 AddressResponse:
response_status: Optional[ResponseStatus] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
country: Optional[str] = None
country_code: Optional[str] = None
state: Optional[str] = None
city: Optional[str] = None
code: Optional[str] = None
start_date: Optional[datetime.datetime] = None
end_date: Optional[datetime.datetime] = None
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneEmailResponse:
phone_home: Optional[str] = None
phone_cell: Optional[str] = None
phone_bus: Optional[str] = None
email: Optional[str] = None
start_date: Optional[datetime.datetime] = None
end_date: Optional[datetime.datetime] = None
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressSyncResponse:
response_status: Optional[ResponseStatus] = None
uuid: Optional[str] = None
regent_id: int = 0
sugar_address: Optional[AddressResponse] = None
sugar_phone_email: Optional[PhoneEmailResponse] = None
regis_address: Optional[AddressResponse] = None
regis_phone_email: Optional[PhoneEmailResponse] = None
re_address: Optional[AddressResponse] = None
re_phone_email: Optional[PhoneEmailResponse] = None
exists_in_sugar: bool = False
exists_in_re: bool = False
are_equal: bool = False
addr_are_equal: bool = False
city_are_equal: bool = False
state_are_equal: bool = False
country_are_equal: bool = False
code_are_equal: bool = False
phone_home_are_equal: bool = False
phone_cell_are_equal: bool = False
phone_bus_are_equal: bool = False
email_are_equal: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressSyncRequest:
uuid: Optional[str] = None
Python AddressSyncRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"sugar_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"regis_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"re_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"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}