| Required permission: | SyncBioAndAddresses |
| POST | /Sync/Address |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | body | int | No | |
| addr1 | body | string | No | |
| addr2 | body | string | No | |
| city | body | string | No | |
| state | body | string | No | |
| country | body | string | No | |
| code | body | string | No | |
| body | string | No | ||
| phone_home | body | string | No | |
| phone_bus | body | string | No | |
| phone_cell | body | string | No | |
| queued_by_username | body | string | No | |
| queued_by_CRM | body | bool | No | |
| queued_by_RE | body | bool | No | |
| queued_by_Sugar | body | bool | No | |
| queued_by_REGIS | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| successfull | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
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
}