Country Codes

Overview

The Country Codes API enables the creation, retrieval, updating, and deletion of country code records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create

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

This API will creat new Country code.

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

Request Body:

{
    "data_set": "<Data_set>",            //string
    "src_ccty": "<source-contry-code>",  //string
    "src_dsca": "<source-description>",  //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
src_ccty	Source Country Codes	String	3
src_dsca	Source Country Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<Data_set>", 
    "src_ccty": "<source-country-code>", 
    "src_dsca": "<source-description>",
}

Fields Details:

Field	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
src_ccty	Source country code	String	"a12"
src_dsca	Source description	String	"testing"

---

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When both the Data set and Source Country Code is already present in the database:

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

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Country code is passed:

{
    "message": "Reference Error: Country Code."
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Data set is passed:

{
    "message": "Reference Error"
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

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

Update

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

This API will update a Country code.

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

Request Body:

{
    "data_set": "<Data_set>",            //string
    "src_ccty": "<source-contry-code>",  //string
    "src_dsca": "<source-description>",  //string
}

Response Body: (Status: 200)

{
    "data_set": "<Data_set>", 
    "src_ccty": "<source-country-code>",
    "src_dsca": "<source-description>",
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When invalid or wrong Country code is passed:

{
    "message": "Reference Error: Country Code."
}

Response Body: (Status: 400 - Bad Request)

When there is an invalid data type is passed:

{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request)

When you are trying to update the both the Data set and Country code:

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

Response Body: (Status: 500 - Internal Server Error)

When the mandatory fields are passed as an empty field:

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

Delete

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

This API will delete a Country code.

• Method: DELETE
• Authentication: Bearer <token>

Response Body: (Status: 200)

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

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error)

When invalid or wrong country code id is paased:

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

Get

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

This API will get a Country code.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "ccty": "<city-code>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",
    "src_ccty": "<source-country-code>",
    "src_dsca": "<source-description>",
}

Response Body: (Status: 200)

When invalid or wrong Country code id is paased:

{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Get All

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

This API will get all Country codes.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
  {
    "ccty": "<city-code>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",
    "src_ccty": "<source-country-code>",
    "src_dsca": "<source-description>",
  },
  .
  .
  .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}