Title Index
Recently Changed
Page Hierarchy
Incomplete
Tags
Description:
This call is designed to submit ACE Report information using an API call.
| Parameters: | |
|---|---|
| format | json, xml |
| port_id | The port's unique ID. |
| report_date |
The date of the ACE report, in yyyy-mm-dd format |
| report | The ACE Report Submission message (max 6000 characters) |
Call Format:
Method Type: POST
For ACE Report submission: /api/submit/ace_report.<format>
Example:
| Input: | https://www.findaport.com/api/submit/ace_report.json?key=<API key>&port_id=1&report_date=2013-01-29&report=this%20is%20a%20test | |
| Output: |
An XML or JSON output confirming that your port ACE report was submitted successfully. |
|
| Alternative format Input: | https://www.findaport.com/api/submit/ace_report.xml?key=<API key>&port_id=1&report_date[year]=2013&report_date[month]=01&report_date[day]=&report=this%20 is%20a%20test |
|
| Output: | An XML or JSON output confirming that your port ACE report was submitted successfully. |
Output Fields:
| Output Fields | Descriptions | Examples |
|---|---|---|
| message | The returned message after submission | <message>Your ACE report was submitted successfully</message> |
Valid ACE Report submission returns "Your ACE report was submitted successfully"
Empty Port ID returns "Port not found for the supplied port_id"
Empty report_date message returns "Please supply report_date"
Invalid date format returns "The supplied report_date was in an incorrect format.
The correct format is yyyy-mm-dd"
Invalid alternative date format returns "Please supply report_date"
Empty report text returns "Report parameter was empty"
Previous API Call: Port - Search Next API Call: Submission - Errata Return to API Call Summary
Need an API Key? Click here here for more details.