Created 14 Mar 2017, by Steven Loh

Objective

Provide a set of web API for Internal Costing module.

API list and endpoints

GET costsheet/internal/globals/index

1. Returns the global data required by the internal costing listing page.
2. Focus on returning data for web controls inside Advanced Search panel.

GET costsheet/internal/globals/edit

1. Returns the global data required by the add/edit pop-up for internal costing module.
2. Focus on returning data for web controls for data selection, e.g. dropdown boxes. Do not return data that are costsheet specific.

GET costsheet/internal/?[get-params]

1. Returns list of internal costing available on the system.
2. GET params shall accomodate requirements by listing page advanced search, and standard q, p, n and o params.
3. Every element in the data array shall only return internal costing details required by the listing table.

GET costsheet/internal/{id}

1. Returns an object representing one internal costing record containing only the required data to be used by the view and add/edit pop-up.
2. Returns costsheet view model with dummy data if {id} is -1, and empty view model with default values if {id} is 0.
3. Returns 404 if the costsheet does not belong to internal costing type.

POST costsheet/internal

1. Creates a new internal costing.

PUT costsheet/internal/{id}

1. Updates an existing internal costing identified by {id}.
2. Updating of an internal costing only allowed for costsheet with status:
   • New
   • Confirmed (within accounting period)

GET costsheet/internal/{id}/status

1. Returns a collection (log) of status of the internal costing identified by {id}, sorted by CREATE_DATE of the status.
2. This API returns all records and does not support any get-params.

POST costsheet/internal/{id}/status

1. Creates a new status for the internal costing.
2. This API is used to change the latest status of an internal costing and creates a log of the status change of the costsheet, e.g. confirmed, rejected, cancelled.

Others

1. API for internal costing does not implement the DELETE method.
2. Estimation: 60 hours, including database schema design and implementation, FO integration.