Entity Management
- Kook Siong Then
Base Url: /smartfin/api/v1/whitelist
Retrieve Company Data
GET /smartfin/api/v1/whitelist
Get all company data that are visible to current user.
Authentication / Authorization
Headers
Schema
Headers:
Content-Type: application/json
Authorization：
string - JWT <<YOUR_API_KEY_HERE>> (required)
Responses
Example:
{
"error_code": 0,
"value": {
"items": [
{
"last_update_time": "2020-07-20 10:33:45",
"user_id": 10,
"entity_id": 2905,
"create_by_name": "test10",
"entity_name": "name",
"entity_type": "",
"country": "country",
"address": "address",
"company_id": 1,
"create_time": "2020-07-20 10:33:45",
"create_by": 10,
"update_by": "",
"tel": "tel",
"credit_amt": "",
"invoice_code": "",
"invoice_add": "",
"invoice_bank": "",
"reg_no": "",
"credit_ccy": "",
"fax_no": "",
"invalid": "",
"update_by_name": "",
"email": "email@example.com"
},
{
"last_update_time": "2020-07-20 10:29:33",
"user_id": 10,
"entity_id": 2901,
"create_by_name": "test10",
"entity_name": "name",
"entity_type": "",
"country": "country",
"address": "address",
"company_id": 1,
"create_time": "2020-07-20 10:29:33",
"create_by": 10,
"update_by": "",
"credit_amt": "",
"invoice_code": "",
"invoice_add": "",
"invoice_bank": "",
"reg_no": "",
"credit_ccy": "",
"fax_no": "",
"invalid": "",
"tel": "tel",
"update_by_name": "",
"email": "email@example.com"
},
..
],
"company_type": [
"OWNER",
"COUNTERPARTY"
],
"broker": [
"VANTAGE",
"BGC",
"STEEM1961",
"SSY"
],
"company_name": [
"VITOL SA",
"name",
"xyz",
"HYUNDAI",
"BRITISH AIRWAYS",
"CHINA AVIATION OIL (SINGAPORE) CORPORATION LTD",
"yyyy",
"updated name2",
"SC SHIPPING",
"qqq",
"updated name",
"aaaaa",
"PTT"
]
}
} |
Returns
|
Schema
last_update_time, update_by_name, update_by - stringInformation about last updated time for the data and the user who updating the data.
create_time, create_by, create_by_name - stringInformation about created time for the data and the user who creating the data.
user_id- User Id ( who the data belongs to)entity_id- A unique ID assigned to the data. This ID can be used to retrieve company data.company_id- The main company Id for the data.
entity_name- Company nameentity_type- Company type (COUNTERPARTYorBROKER)
entity_name and entity_type cannot be duplicated,
Eg.
entity_nameof 'COMPANY NAME' will not allow to be stored if the sameentity_namehas been found in database.Eg.
entity_nameof ‘COMPANY NAME' andentity_typeof 'COUNTERPARTY’ will not allow to be stored if the sameentity_nameandentity_typehas been found in database.
Extra information of the company data
The status of company data (true or false)
Update / Insert Company Data
POST /smartfin/api/v1/whitelist
Insert new or update existing company data in database
Authentication / Authorization
Headers
Schema
Headers:
Content-Type: application/json
Authorization：
string - JWT <<YOUR_API_KEY_HERE>> (required)
Request
Example:
JSON Body: |
Schema
Contain the same parameters as
itemsin response body of Entity Management | Responses ( Refer to the definition of each parameter )entity_iddoes not need to be parsed and not required in this arrayConsists of new company data to be inserted into database.
Contain the same parameters as
itemsin response body of Entity Management | Responses ( Refer to the definition of each parameter )Consists of existing company data to be updated into database.
Response
Example:
Schema
Contain the same parameters as
itemsin response body of Entity Management | Responses ( Refer to the definition of each parameter )The array list contains data of failed and successful inserts
Contain the same parameters as
itemsin response body of Entity Management | Responses ( Refer to the definition of each parameter )updatedconsists of data that has been updated successfully ,wherefailedconsists of data that has not been updated in database.The relevant error message will be returned if there are any duplicated data attempting to insert or update into the database.
Insert process will fail if there is an existing company with the same entity_name, entity_type or same entity_name
Update process will fail if there is an existing company with the same entity_name, entity_type or same entity_name
Delete Company
DELETE /smartfin/api/v1/whitelist
Deletes single / multiple company according to its entity_id
Authentication / Authorization
Headers
Schema
Headers:
Content-Type: application/json
Authorization：
string - JWT <<YOUR_API_KEY_HERE>> (required)
Request
Example:
JSON Body: |
A list that consists of unique
entity_id, that user would like to delete from.
Response:
Example:
Return a list of object named
value, each object containsentity_idthat indicates the company that has been deleted successfully.