Common Request and Response Objects
API Request Object
The Request Object JSON structure.
| Name | Type | Description |
|---|---|---|
| url | String | URL (Generic URI format ref: RFC). |
| text | String | Text Paragraph. |
API Response Types
Unsuccessful Response Object
The unsuccessful response JSON structure.
| Name | Type | Description |
|---|---|---|
| status | String | Request Status (Reference: Status & Error Codes) |
| errorCode | Integer | Request error code (Reference: Status & Error Codes) |
| message | String | Error message. |
| license | String | AmplifyReach License. |
Example: Unsuccessful Response
{
"license": "By accessing AmplifyReach or using information generated by
AmplifyReach API, you are agreeing to be bound by the AmplifyReach Terms of Use.",
"errorCode": 1003,
"message": "Authentication Failed - Unknown User",
"status": "fail"
}Pending Response Objects
The pending response JSON structure.
| Name | Type | Description |
|---|---|---|
| status | String | Request Status (Reference: Status & Error Codes) |
| uid | String | Pending Request ID |
| license | String | AmplifyReach License. |
Example: Pending Response
{ "uid": "0e438ffd7327a87749b5aaa4ec64d16d",
"license": "By accessing AmplifyReach or using information generated by AmplifyReach API,
you are agreeing to be bound by the AmplifyReach Terms of Use.",
"status": "pending"
}