GetList
- GT (Unlicensed)
Owned by GT (Unlicensed), created
Description
Gets a list of regulated entity ids and their English and French display names for a specified service and entity.
Package Details
Interface
IServiceRegulatedEntityManagerSyntax
Task<ICollection<ServiceRegulatedEntityIdType>> GetList(int serviceId, string type)Returns
ICollection<ServiceRegulatedEntityIdType>API
GET - /api/v1/services/{id}/regulated-entities
Parameters
Parameter | Description | Type |
|---|---|---|
id | The service id associated to the regulated entity. | Path |
type | The entity type of the regulated type (ex. VESSEL). This is case insensitive. | Query string |
Returns
HTTP 200 - OK
Returns a list of regulated entities with their ids, English and French display names. The ids are returned based on a sort order.
Is there’s no regulated entity ids found, an empty list is returned.
Sample response body
Note: This example is for ServiceId = 1230 and Type = Vessel.
Example