Targeted Environment

15 Jan 2021 - MTOA-INT, MTOA-TEST

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

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

GET - /api/v1/regulated-entities

The response body will return new properties.

• ServiceId

• RegulatedEntityTypeCode

• RegulatedEntityIdTypeCode

• SortOrder

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

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

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": "Value1",
    "Id": 100
  }
]

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

[
  {
    "Value": "Value1",
    "Id": 1
  }
]

The response body will also match the same information.

[
  {
    "Value": "Value1",
    "Id": 1
  }
]

MTOA NuGet packages Release Notes

Version xxxx (2021-01-15) (based on the 1.4.0 branch) 

• 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)

Schema Structure Changes

No DB structure change in this release.

Data Changes

No data change in this release.