GET v1/imos/changed/{objectType}?sinceUTC={sinceUTC}&untilUTC={untilUTC}&audit={audit}&apiToken={apiToken}

Used to determine which objects have been changed since the given timestamp. By default the endpoint goes off of the 'Last Update' field on the provided objectType. If an object type is missing the Last Update field, please try using the optional 'audit' argument.' Example ObjectTypes to search for: Vessel, Voyage, Fixture, Port

Request Information

URI Parameters

NameDescriptionTypeAdditional information
objectType

The name of the data object your SQL table name (for useTemporalTables) that you are interested in. Generally speaking, the 'objectType' will match with the data source name in the VIP Report Designer, after you remove the spaces. Examples: Voyage, Vessel, VoyagePnl, OperationsInvoiceDetails, etc. Warning: Not all data objects will be accessible by this endpoint!

string

Required

sinceUTC

A timestamp representing the lower bound of how far back you want to check. Example: 10/23/18 for October 23rd, 2018

date

Required

untilUTC

A timestamp representing the upper bound of when you want to check. Example: 10/23/19 for October 23rd, 2019

date

None.

audit

A boolean switch for whether or not to check against the IMOS Audit Table. This flag goes by the IMOS Form Name and may be useful if the desired data object does not have a 'last update field'. Not all tables, however, are properly tracked by the audit table.

boolean

Default value is False

apiToken

Your Veslink API Token

string

None.

Body Parameters

None.

Response Information

Resource Description

A set of key-value pairs based on the primary keys of the data object

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.