MACS3 API Services Release Notes

Dangerous Goods - IMDG Amendment 40

dg macs3api

We are happy to announce that the IMDG Amendment 40 is now available in the DG API. To use the latest rules, set the amendmentNumber in the HTTP request body to 40. If the value is not provided, the API will continue to use the IMDG Amendment 39 until the use of version 40 becomes mandatory. If you need to use a specific IMDG Amendment version, we recommend setting the value in every request.

Lash API extension for lash bar equalizer

#macs3api lashing v2.9.1

In order to equalize the tension between a top lash bar (connected to the bottom of the container above) and a bottom lash bar (connected to the top of the container below) a lash bar equalizer might be used.

The response of the /ships/{imoNumber}/lash/calculations endpoint has been extended and returns an extended LashBarResult with LashBarUserEqualizer as "Indicates whether the lash bar uses an equalizer".

Dangerous Goods - More API response control

#macs3api dg v2.9.0

For more control over the API, the response of the /ships/{imoNumber}/dago/check endpoint has been extended and DaGoCheckResult does now contain Errors as "a list of errors resulted from invalid parameters".

    Stability Calculation for MPC vessels

    #macs3api stability

    The Stability Calculation Service has been extended to support MPC vessels.

    API-Usage

    Call the /ships/{imoNumber}/stability endpoint to calculate stability for MPC Vessels and include new Calculation Parameters:

    • Hold
      Specify a list of holds
    • Panels
      Specify  a list of panels
    • GeneralCargos
      specify a list of General Cargo items

    Additionally we added new Settings Parameter:

    • Add10PercentToTimber
      Indicates whether 10 % shall be added to the weight of timber loaded on deck. Only possible if the vessel allows loading timber on deck.
    • VisibilityLimitOption
      Select between None, Imo, PanamaWithFees, PanamaWithoutFees or Custom.
    • CustomVisibilityLimitLength
      Specifies the length limit to be used for remaining stack height calculations if the custom VisibilityLimitOption has been chosen.


      The Calculation Result
       has been extended by a holds results.


      Documentation (OpenAPI Specification)
      Available at https://api.stability.macs3.com

      Dangerous Good - Alternative profile feeds

      #macs3api dg v2.7.0

      We introduced FeedId as query-parameter when calling the /ships/{imoNumber}/dago/check endpoint to enable the DG-API utilizing Customer-managed profile-feeds in addition to the public Navis profile-feed (default).

      Dangerous Goods extensions for RiskZones, sheltered bays and sunlight

      #macs3api dg v2.6.0

      The MACS3 API Service Dangerous Goods got some additional parameters.

      You now have one more DaGoContainerParameter:

      • userDefinedHandlingInstructions
        With this DaGoContainerParameter you can add additional information which represents the User-def1 und User-def2 for the Handling Instructions in MACS3. Just write your parameter as a string and separate each one by a comma.

      And then there some new DaGoSettingsParameter:

      • firstBaySheltered
        This parameter sets if marine pollutants are allowed, by setting them to true or false
      • lastBaySheltered
        This parameter sets if marine pollutants are allowed, by setting them to true or false
      • sunlightOnlyTopAndOutmost
        This parameter checks only the sunlight check from the top and starboard and portside, otherwise from the fore and aft side too. (To use this setting checkForSunlight needs to be true).
      • checkRiskZones
        You can now check for additional Risk Zones

      Please welcome our 4th API Service - Condition-Check

      Please welcome our 4th API Service - Condition-Check

      #macs3api conditioncheck

      We are excited to introduce our 4th API Service (Alpha) - Condition-Check. It offers the most important container checks originating from the MACS3 Desktop-Application. Check out the list below and stay tuned - more checks are coming!

      API-Usage

      Specify your loading condition and the checks to carry out in ConditionCheckParameters.


      Documentation (OpenAPI Specification)

      Available at https://api.conditioncheck.macs3.com

      feature
      • Stack-Design-Check
        Checks whether a stack is designed for a specific type of container, e.g. 30’ container.

      • Stack-Height-Check
        Checks for maximum height in hold.

      • Stack-Weight-Check
        Checks for exceeded stack weight.

      • HeavyOnLight-Check
        Checks if the weight of container doesn’t not exceed the weight of any container below on more than the weight, mentioned in “Belco/Settings/Warnings”.

      • Verified-Gross-Mass-Check
        Checks the VGM flag for each full container, allowing to detect those containers, which weight was not obtained according to the SOLAS Guidelines.

      • Handling-Check
        Checks for handling instructions as defined in the Cargo Editor / Details, e.g. stowage UD=Under deck required.

      • Reefer-Check
        Reefer at non reefer positions.

      • Irregular-Cargo-Check
        Checks of empties with non-empty weight; too big overdimensions (exceeding standard container size); over- or underweight of single containers; reefer temperatures out of range -50C…+50C; unusual height, width and length of single containers.

      • Serial-Number-Check
        Container without any number, double or wrong numbers (with wrong check digit according to ISO 6346).

      • Occupied-Check
        Checks any double use of stowage cells, especially for OOG cargo.

      • Flying-Container-Check
        Checks for (partly) flying containers, e.g. a 40’ container loaded on top of only one 20’ container.

      Dangerous Goods Company Rules

      #macs3api dg v2.5.0

      DG Company Rules is a MACS3 feature to add company-specific rules in addition to the IMDG code. You can restrict the stowage positions for containers with dangerous cargo. It is possible to prohibit special classes or UN numbers in specific stowage positions.

      We added an endpoint for uploading company rules files. Developers may add the corresponding rule identifier to dangerous goods check requests to apply company rules. 

      API-Usage

      Upload your Company-Rules via the/rules endpoint. Note the returned RulesIdentifier inside the response.


      Specify the RuleIdentifier in subsequent DG Calls in order to apply company rules.


      Documentation (OpenAPI Specification)
      Available at https://api.dago.macs3.com

      Deflection Correction

      #macs3api stability

      The Stability Calculation Service now supports Deflection Correction.

      If "draughts with deflection correction” is desired and feasible according to the vessel-data, the draughts are calculated taking into account deflection of the vessel due to bending moments. The deflection is calculated by solving the differential equation which establishes the relationship between the variables bending moment M, the modulus of elasticity E, the moment of inertia I and the deflection y: M = E*I* d2y/dx2

      API-Usage

      Call the /parameters endpoint to see whether a vessel is able to calculate deflection correction.


      If a vessel is capable to calculate draughts with deflection correction, set withDeflectionCorrection to true in CalculationParameter/Settings:


      Affected results
      : Drafts, Airdrafts, Visibility, PropellerImmersion


      Note
      The following properties on the summary results are deprecated and will be removed in the next major version:


      Documentation (OpenAPI Specification)
      Available at https://api.stability.macs3.com

      Extended Stability Configuration Settings

      #macs3api stability

      The configuration settings for calling the Stability Service have been extended by Bending Moment Limit Mode and Default Container Spacings.

      MACS3-Usage

      In MACS3 you can find the corresponding Bending Moment Limit Mode in the menu Tools/Calculation Modes.


      In MACS3 you can find the corresponding Default Container Spacings in the menu Belco/Settings/Weight and VCG.


      API-Usage

      Call the /parameters endpoint to retrieve the vessel-specific settings.


      Prepare the Stability Calculation by specifying bmLimitMode and containerSpacing in CalculationParameter/Settings. If no values are specified, defaults are used.


      Call the /stability endpoint to perform the Stability Calculation.


      Documentation (OpenAPI Specification)
      Available at https://api.stability.macs3.com