Required role: | REGISUserRole |
POST | /admissions/{uuid}/address/sync |
---|
export class AddressResponse
{
public responseStatus: ResponseStatus;
public addr1: string;
public addr2: string;
public country: string;
public country_code: string;
public state: string;
public city: string;
public code: string;
public start_date?: string;
public end_date?: string;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public constructor(init?: Partial<AddressResponse>) { (Object as any).assign(this, init); }
}
export class PhoneEmailResponse
{
public phone_home: string;
public phone_cell: string;
public phone_bus: string;
public email: string;
public start_date?: string;
public end_date?: string;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public constructor(init?: Partial<PhoneEmailResponse>) { (Object as any).assign(this, init); }
}
export class AddressSyncResponse
{
public responseStatus: ResponseStatus;
public uuid: string;
public regent_id: number;
public sugar_address: AddressResponse;
public sugar_phone_email: PhoneEmailResponse;
public regis_address: AddressResponse;
public regis_phone_email: PhoneEmailResponse;
public re_address: AddressResponse;
public re_phone_email: PhoneEmailResponse;
public exists_in_sugar: boolean;
public exists_in_re: boolean;
public are_equal: boolean;
public addr_are_equal: boolean;
public city_are_equal: boolean;
public state_are_equal: boolean;
public country_are_equal: boolean;
public code_are_equal: boolean;
public phone_home_are_equal: boolean;
public phone_cell_are_equal: boolean;
public phone_bus_are_equal: boolean;
public email_are_equal: boolean;
public constructor(init?: Partial<AddressSyncResponse>) { (Object as any).assign(this, init); }
}
export class AddressSyncRequest
{
public uuid: string;
public constructor(init?: Partial<AddressSyncRequest>) { (Object as any).assign(this, init); }
}
TypeScript AddressSyncRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl 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}