regis

<back to all web services

SyncAddressRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Address
SyncAddressRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idbodyintNo
addr1bodystringNo
addr2bodystringNo
citybodystringNo
statebodystringNo
countrybodystringNo
codebodystringNo
emailbodystringNo
phone_homebodystringNo
phone_busbodystringNo
phone_cellbodystringNo
queued_by_usernamebodystringNo
queued_by_CRMbodyboolNo
queued_by_REbodyboolNo
queued_by_SugarbodyboolNo
queued_by_REGISbodyboolNo
SyncBioAndAddressResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
successfullformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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}