dmca_anchorage_permit_details-open-api

Published by
Dubai Maritime City Authority (DMCA)
dmca_anchorage_permit_details-open-api
Updated: 16 Sep 2021 0.00 KB
Open Data
API
Showing anchorage Permit Details
Show more

Description:

Additional Info

Field Value
Last updated 16 Sep 2021
Created 10 May 2018
Format API
License License not specified
id
c6c776c0-2e05-4b1a-8050-628d80d9b027
package id
60657d87-28fc-4685-a5d0-d21629012066
revision id
4c162654-6eeb-4798-ac44-6fd02b1050a4
state
active
Show more

Attribute Details

Attribute Name Attribute Description Attribute Language Attribute Classification Attribute Datatype Attribute Size Attribute Range of Values Attribute Foreign Key
permit_id Permit system generated ID English Open text 20
active_agent Active Agents Mix Open text 461
active_agent_id Active Agent ID English Open text 20 Anchorage Permit Details .Agent ID = Cooperate Profiles- Maritime Operation Agents .Profile ID
agents list of agent names (history of agents) English Open text 20
list_of_agents_id List of agent IDs(history of agents) English Open text 40 Anchorage Permit Details .List of agents ID in Cooperate Profiles- Maritime Operation Agents .Profile ID
estimated_arrival_time Estimated Arrival date English Open date
estimated_departure_time Estimated Departure date English Open date
expected_period_of_anchorage Expected Period of Anchorage English Open Integer
actual_anchorage_period Actual Anchorage Period English Open Integer
actual_arrival_date Actual Arrival Date English Open date
actual_departure_date Actual Departure Date English Open date
actual_period Actual Period English Open Integer
ballast_loaded Ballast/Loaded English Open text 4
distance Distance English Open Integer
draught Draught English Open Integer
location Location English Open text 4
number_of_crew Number of Crew English Open Integer
port_of_registry Port of Registry English Open text 160
purpose_of_anchorage Purpose of Anchorage English Open text 2000
shackle_number Shackle Number - no.of metal links required to anchorage English Open Integer
type_quantity_of_cargo_on_board Type & quantity of cargo on board English Open text 2000
marine_craft_id Marine Craft ID English Open text 20
imo_number International Maritime Organization number-unique reference for ships and for registered ship owners and management companies English Open text 20
vessel_condition Vessel Condition - either ballast or loaded English Open text 160
vessel_name Vessel Name English Open text 460
Show more Show less

There are no views created for this resource yet.

Embed resource view

You can copy and paste the embed code into a CMS or blog software that supports raw HTML

Dubai Pulse Data API

Access resource data via a web API with powerful query support.

Expand All
Endpoints
Expand
Collapse
The Data API can be accessed via the following actions of the CKAN action API.
  • Query
    https://api.dubaipulse.gov.ae/open/dubai-maritime-city-authority-dmca/dmca_anchorage_permit_details-open-api
How to Use?
Expand
Collapse
  • End Users will receive "API Key" and "API Secret" in two separate emails on the first time Grant of a Dataset, first Purchase of a Commercial Dataset, or Purchase of an API Package. This API Key and API Secret combination should be used to generate API token and the token will need to be included in the http headers of every API call made.

    Authentication Service to generate API token: https://api.dubaipulse.gov.ae/oauth/client_credential/accesstoken?grant_type=client_credentials with body 'client_id={API Key}&client_secret={API Secret}'

    Read the value of "access_token" from the response of the above service and use it in the header of every API call. The obtained API token is valid for certain duration (for example 30 minutes) after which a fresh token needs to be obtained.

    Header Name : Authorization
    Value : Bearer {access_token}

  • Query Parameters
    API calls can be made for full dataset result (subject to maximum results limit) or to a subset of results. Different filters can be applied on the results. Developers can use the attributes to apply a combination of filters with and/or conditions.
  • Limiting the Response Size
    Developers can limit the number of records returned by an API call passing the "Limit" parameter in the call. The value of the "Limit" must be less than the allowed maximum limit.
  • Limiting the Attributes
    Developers can limit the API response to specific set of attributes by passing the attribute names in the API call. The example below explains how the attributes can be specified in the API call. This feature can be used in conjunction with query parameters.
Examples
Expand
Collapse
  • Curl Command Sample:
    curl -X GET --header "Authorization: qMtn6xQapeouAlirfHXD7DWJFabV" "https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api"
  • Query Samples:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 AND zone_id=2 https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 OR zone_id=2
  • Record Limit Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?limit=10
  • Record Offset Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?offset=10
  • Record Order By Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?order_by=location_id
  • Attribute Limiting Sample:
    https://api.dubaipulse.gov.ae/shared/rta/rta_tram_stations-open-api?filter=location_id=223 OR zone_id=2 &column=zone_id,line_name,location_id