Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Targeted Environment

- MTOA-INT, MTOA-TEST

Enhancement: Enhancements to the service regulated entities to include the following info

...

TC_SERVICE_CD: service id

...

REGULATED_ENTITY_TYPE_CD: Regulated Entity Type Code

...

REGULATED_ENTITY_ID_TYPE_CD: Regulated Entity ID Type Code

...

Service Regulated Entities

Updates January 15 – 2021

GET - /api/v1/services/{id}/regulated-entities

The response body will return new properties.

  • ServiceId

  • RegulatedEntityTypeCode

  • RegulatedEntityIdTypeCode

  • SortOrder

Code Block
languagejson
[
  {
    "Id": 1,
    "ServiceId": 1230,
    "RegulatedEntityTypeCode": "VESSEL",
    "RegulatedEntityIdTypeCode": "VESSEL_NM",
    "SortOrder": 1,
    "EnglishDisplayName": "Vessel Name",
    "FrenchDisplayName": "Nom du bâtiment"
  }

GET - /api/v1/regulated-entities

New properties are highlighted in bold and yellow.

Note: Id is now the service regulated entity id, previously it was the unique id for the service request regulated entity id.

PUT - /api/v1/regulated-entities

When updating the value of a service regulated entity the id used was a unique id used for the service request regulated entities.

[

  {

    "Value": "Test_Update_RE_Value1",
    "Id": 100 // in previous version, this was a unique id for the service request regulated entity id.
  }

  ]

With this update the id used will be the regulated entity id found in GET - /api/v1/services/{id}/regulated-entities

[

  {

    "Value": "Test_Update_RE_Value1",
    "Id": 1
  }

  ]

The response body will also match the same information.

[

  {

    "Value": "Test_Update_RE_Value1",
    "Id": 1
  }

  ]

MTOA NuGet packages Release Notes

...

  • Updated the ServiceRegulatedEntityIdType domain object to include the following properties

    • public int ServiceId { get; set; }

    • public string RegulatedEntityTypeCode { get; set; }

    • public string RegulatedEntityIdTypeCode { get; set; }

    • public short SortOrder { get; set; }

Breaking change 
N/A

MTOA Database – Release Note for Version (v1.12.0)

...