Required permission: | SyncBioAndAddresses |
POST | /Sync/Bio |
---|
export class SyncBioAndAddressResponse
{
public responseStatus: ResponseStatus;
public successfull: boolean;
public constructor(init?: Partial<SyncBioAndAddressResponse>) { (Object as any).assign(this, init); }
}
export class SyncBioRequest
{
public regent_id: number;
public first_name: string;
public last_name: string;
public middle_name: string;
public preferred_name: string;
public birth_name: string;
public prefix: string;
public current_occupation: string;
public dob?: string;
public deceased_date?: string;
public gender: string;
public marital_status: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public queued_by_username: string;
public queued_by_CRM: boolean;
public queued_by_RE: boolean;
public queued_by_REGIS: boolean;
public queued_by_Sugar: boolean;
public constructor(init?: Partial<SyncBioRequest>) { (Object as any).assign(this, init); }
}
TypeScript SyncBioRequest 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 /Sync/Bio HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
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-01T00:00:00.0000000","deceased_date":"0001-01-01T00:00:00.0000000","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/csv 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}