POST v1/agent/form?voyageNo={voyageNo}&portCallSeq={portCallSeq}&apiToken={apiToken}

Submits a form for a specific port call associated with a company. The data for the form should be contained within the message body of the POST request.

Request Information

URI Parameters

Name	Description	Type	Additional information
voyageNo	The voyage number of the port call this form is associated with	integer	Required
portCallSeq	The port call sequence number of the port call this form is associated with	integer	Required
apiToken	Your API token	string	None.

Body Parameters

None.

Request Formats

application/xml, text/xml

Sample:

<Form FormIdentifier="Veson Standard Form" CompanyCode="CODE" VesselCode="ABCD">
  <VesselName>ABCD Vessel</VesselName>
  <VoyageNo>1</VoyageNo>
  ...
</Form>

Response Information

Resource Description

FormSubmissionResponse

Name	Type	Additional information
FormID	globally unique identifier	None.
Success	boolean	None.
FormStatus	string	None.
FormErrors	Collection of string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "formID": "29d7092a-b3cb-4c44-b3ab-b5a034681d54",
  "success": true,
  "formStatus": "sample string 2",
  "formErrors": [
    "sample string 1",
    "sample string 2"
  ],
  "message": "sample string 3"
}

application/xml, text/xml

Sample:

<FormSubmissionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FormID>29d7092a-b3cb-4c44-b3ab-b5a034681d54</FormID>
  <Success>true</Success>
  <FormStatus>sample string 2</FormStatus>
  <FormErrors>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </FormErrors>
  <Message>sample string 3</Message>
</FormSubmissionResponse>