POST v1/forms/submit?apiToken={apiToken}&voyageNo={voyageNo}&portCallSeq={portCallSeq}&inTransit={inTransit}&async={async}

Submits a form associated with a specific company and vessel. The Veslink voyage number and port call sequence number are optional and are normally not specified. The message body should contain XML for the form you are submitting.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiToken

Your API Token

 string

None.
voyageNo

(Optional) Veslink vessel voyage number

 integer

None.
portCallSeq

(Optional) Veslink voyage port call sequence number

 integer

None.
inTransit

(Optional) true on passage

 boolean

None.
async

(Optional) Run asynchronously

 boolean

Default value is False

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
NameDescriptionTypeAdditional 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": "cc29a12a-cce4-411a-ac63-b0ba2230907e",
  "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>cc29a12a-cce4-411a-ac63-b0ba2230907e</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>