Skip to content

Permit - Permit Usage (Indicate if the permit or its equivalent covers commercial and/or non-commercial use)

Overview

This endpoint allows you to retrieve terms that specify whether a permit or its equivalent covers commercial and/or non-commercial use. This endpoint is useful for identifying the scope of usage rights associated with a permit, including whether it permits commercial activities, non-commercial activities, or both. The data obtained can help in understanding and managing the terms of use for various permits and ensuring compliance with their conditions.

Endpoint

GET /api/v2013/thesaurus/domains/A7B77788-8C90-4849-9327-E181E9522F3A/terms

Headers

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

Usages

This table describes the keywords field that is used to indicate if the permit or its equivalent covers commercial and/or non-commercial use.

TitleFieldSchema
Indicate if the permit or its equivalent covers commercial and/or non-commercial usekeywords    IRCC - create

Environment URLs

This API has two different endpoints for production and development environments. Use the appropriate endpoint based on your current environment.

  • PROD Endpoint: https://api.cbd.int/

    • This endpoint is used for accessing the production environment of the API. Use this endpoint for all live, real-world applications where you need to interact with the actual production data.
  • DEV Endpoint: https://api.cbddev.xyz/

    • This endpoint is for the development environment. Use this for testing, development, and staging purposes. It allows you to safely test your applications without affecting the live production data.

Playground

Swagger playground is loading, please wait...