-
Notifications
You must be signed in to change notification settings - Fork 1
Dataset Description
| Attribute | Type | Description | Required? | Security Classification |
|---|---|---|---|---|
| id | string | Sequentially assigned number to identify a ministry client. Stored as an 8-character string with leading zeroes (so it can't be treated as a digit) | Required | TBD |
| clientName | string | The name of the Ministry Client - Company or Individual. Entered as: the full corporate name if a Corporation; the full registered name if a Partnership; the legal surname if an Individual. | Required | TBD |
| typeCode | string | This code represents the nature of teh legal entity that is a Client of the Ministry, for example, a Corporation, Individual, Joint Venture between Clients, Partnership, etc. typeCode is always a single character. | Required | TBD |
| isActive | boolean | The value is 'true' if and only if the forest client status is 'Active' | Required | TBD |
Underlying DB Table: https://www.for.gov.bc.ca/pscripts/isb/idd/Column.asp?Name=FOREST_CLIENT
Type Code reference: https://www.for.gov.bc.ca/pscripts/isb/idd/ValidationCode.asp?Codename=CLIENT_TYPE_CODE
Given a known forest client ID, return an object that represents the name, type, and active status of the forest client. If an ID associated with an 'individual' type forest client is specified, no information will be returned.
Given a request for forest clients, return a list of forest clients. No forest clients will be returned if their type is 'individual'. If the number of forest clients in the database is higher than can be reasonably returned in a single call, the client will need to use the paging mechanism (parameters 'limit' and 'offset') to retrieve the list over multiple requests.
For version 1.0 of the forest client API, the only scope will be "corporate". This corresponds with the requirements for FOM at this time. In the future, if individual forest clients are made available through this API, the scope "individual" will be used.