Client Requirements

FOM

These requirements are driven by the FOM application, which is the first client of the forest client API. Note: FOM does not need the status code, but does need a boolean value representing whether or not the forest client is active.

FOM Requirement: A FOM can only be submitted for a forest client that is active. FOM Requirement: Search by forest client name for a FOM that has been submitted

Implementation details: FOM has a copy of the forest client data (minus individuals) in its database. It needs to refresh these records on a regular basis. The reason the records are in the database are so that it can do a database query to find FOM by forest client name.

Required forest client data:

• Client number (identifier)
• Client name
• Client type code
• Whether or not the client is active
• FOM only requires records where the forest client is NOT an individual

Scenarios

Get Forest Client by ID: Given a specific forest client ID, return the forest client data. Note: FOM does not need the status code, but does need a boolean value representing whether or not the forest client is active.

Get all non-individual Forest Clients: Read the full list of forest clients. This operation will support paging. Note: FOM does not need the status code, but does need a boolean value representing whether or not the forest client is active.