regis

<back to all web services

SyncAddressRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Address

export class SyncBioAndAddressResponse
{
    public responseStatus: ResponseStatus;
    public successfull: boolean;

    public constructor(init?: Partial<SyncBioAndAddressResponse>) { (Object as any).assign(this, init); }
}

export class SyncAddressRequest
{
    public regent_id: number;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public email: string;
    public phone_home: string;
    public phone_bus: string;
    public phone_cell: string;
    public queued_by_username: string;
    public queued_by_CRM: boolean;
    public queued_by_RE: boolean;
    public queued_by_Sugar: boolean;
    public queued_by_REGIS: boolean;

    public constructor(init?: Partial<SyncAddressRequest>) { (Object as any).assign(this, init); }
}

TypeScript SyncAddressRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: 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}