Versions Compared

Key

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

...

Is there’s no regulated entity ids found, an empty list is returned.

Sample request responseresponse body

Note: This example is for ServiceId = 1230 and Type = Vessel.

Code Block
languagejson
[
  {
    "ServiceId": 1230,
    "RegulatedEntityTypeCode": "VESSEL",
    "RegulatedEntityIdTypeCode": "VESSEL_NM",
    "IdSortOrder": 1,
    "EnglishDisplayName": "Vessel Name",
    "FrenchDisplayName": "Nom du bâtiment"
  },
  {
    "ServiceId": 1230,
    "RegulatedEntityTypeCode": "Id"VESSEL",
    "RegulatedEntityIdTypeCode": "CDN_SHIP_IND",
    "SortOrder": 2,
    "EnglishDisplayName": "Canadian Vessel?",
    "FrenchDisplayName": "BâtimentBâtment canadien?"
  },
  {
    "ServiceId": 1230,
    "RegulatedEntityTypeCode": "VESSEL",
    "IdRegulatedEntityIdTypeCode": "IMO",
    "SortOrder": 3,
    "EnglishDisplayName": "IMO",
    "FrenchDisplayName": "OMI"
  },
  {
    "ServiceId": 1230,
    "RegulatedEntityTypeCode": "VESSEL",
    "RegulatedEntityIdTypeCode": "OFFICIAL_NO",
    "IdSortOrder": 4,
    "EnglishDisplayName": "Official No.",
    "FrenchDisplayName": "Numéro officiel"
  }
]

...

Code Block
languagec#
//Use your service id and entity type.
const int serviceId = 1230;
const string entity = "VESSEL";

//Returns a list of service regulated entity type ids.
var serviceRegulatedEntityIdTypes = await MtoaApi.ServiceRegulatedEntityApiserviceRegulatedEntityManager.GetList(serviceId, entity);

...