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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<SyncBioRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<birth_name>String</birth_name>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<current_occupation>String</current_occupation>
<deceased_date>0001-01-01T00:00:00</deceased_date>
<dob>0001-01-01T00:00:00</dob>
<first_name>String</first_name>
<gender>String</gender>
<last_name>String</last_name>
<marital_status>String</marital_status>
<middle_name>String</middle_name>
<permanent_resident>String</permanent_resident>
<preferred_name>String</preferred_name>
<prefix>String</prefix>
<queued_by_CRM>false</queued_by_CRM>
<queued_by_RE>false</queued_by_RE>
<queued_by_REGIS>false</queued_by_REGIS>
<queued_by_Sugar>false</queued_by_Sugar>
<queued_by_username>String</queued_by_username>
<regent_id>0</regent_id>
</SyncBioRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SyncBioAndAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <successfull>false</successfull> </SyncBioAndAddressResponse>