Currency Codes

Overview:

The Currency Management API allows you to create, retrieve, update, and delete currency information. This document provides detailed information about the endpoints, request and response formats, and field descriptions.

Create:

Endpoint: /api/message/currency_codes/{ Company }

This API will create a new currency code.

• Method: POST
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

    {
        "data_set":"<data-set>",               //string
        "src_ccur":"<Source-Currency Code>",   //string
        "src_dsca":"<Source-Description>"      //string
    }

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
src_ccur	Source Currency Code	String	3
src_dsca	Source Currency Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<data-set>",  
    "src_ccur": "<Source-Currency-Code>",
    "src_dsca": "<Source-Currency-Description>"
}

Fields Details:

Field Name	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
src_ccur	Source Currency code	String	"XCD"
src_dsca	Source Currency description	String	"east caribbean dollar"

---

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When Normal User tries to create a new record :

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request / Duplicate)

When the record is already present in the database:

{
    "message": "Record already exists!"
}

Response Body: (Status: 400 - Bad Request / Invalid Payload)

When passing a record with a length exceeding the specified limit :

{
    "message": "Reference Error: Currency Code"
}

Response Body: (Status: 400 - Bad Request / Invalid Datatype)

When passing a record with invalid datatype:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error / Empty field)

When passing an empty field as input to the source currency code:

{
    "message": "Validation Errors|Validation 'isNotEmpty' failed for field 'src_ccur'"
}

When passing an empty field as input to the DataSet:

{
    "message": "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'"
}

Update:

Endpoint: /api/message/currency_codes/{ Company }

This API will update the existing currency code.

• Method: PUT
• Content-Type: application/json
• Authentication: Bearer <token>

Request Body:

    {      
        "data_set": "<data-set>",              //string
        "src_ccur":"<Source-Currency Code>",   //string 
        "src_dsca":"<Source-Description>"      //string
    }

Response Body: (Status: 200)

{   
    "data_set": "<data-set>",            
    "src_ccur": "<source-currency-code>",
    "src_dsca": "<source-currency-description>"
}

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When normal user tries to create a new record :

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request/ Not Found)

When the specified record is not found:

{
    "message": "Record not found!"
}

Response Body: (Status: 400 - Bad Request / Invalid Datatype)

When passing a record with invalid datatype:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request/ Invalid Payload)

When attempting to update a value in the currency code that was empty previously :

{
    "message": "Reference Error: Currency Code"
}

Response Body: (Status: 500 - Internal Server Error / Empty field)

When passing an empty field as input to source currency code:

{
    "message": "Validation Errors|Validation 'isNotEmpty' failed for field 'src_ccur'"
}

When passing an empty field as input to the DataSet:

{
    "message": "Validation Errors|Validation 'isNotEmpty' failed for field 'data_set'"
}

Delete:

Endpoint: /api/message/currency_codes/{ Company }/{ record_id }

This API will delete the specified record id.

• Method: DELETE
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "Message": "Message Deleted Sucessfully!"
}

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token / invalid token passed or When Normal user tries to delete the existing record:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error / Invalid Record)

When there is no record or invalid record passed:

{
    "Message": "Unable to Delete Record - Invalid Data Type"
}

Get:

Endpoint: /api/message/currency_codes/{ Company }/{ record_id }

This API retrieves the specified record id.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

    {
        "data_set": "<data-set>", 
        "dsca": "<currency-description>",
        "src_ccur": "<source-currency-code>",
        "src_dsca": "<source-currency-description>"
    }

Response Body: (Status: 200 - Success Status/Invalid id)

When there is no such id or invalid id is passed :

{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token or invalid token passed :

{
    "message": "Unauthorized!"
}

Get All:

Endpoint: /api/messages/currency_codes/{ Company }/{ PageSize }/{ PageNumber }

This API retrieves all records.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
    {
        "data_set": "<data-set>", 
        "dsca": "<currency-description>",
        "src_ccur": "<source-currency-code>",
        "src_dsca": "<source-currency-description>"
    }
]

Response Body: (Status: 401 - Unauthorized / Invalid Token)

When there is no token or invalid token passed :

{
    "message": "Unauthorized!"
}