Product Type Classification

Overview

The Product Type API enables the creation, retrieval, updating, and deletion of product type records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create

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

This API will create a new Product type.

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

Request Body:

{
    "data_set": "<Data_set>",      //string
    "cls_code": "<Product-type>",  //string
    "dsca": "<description>",       //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
cls_code	Product Type	String	3
dsca	Description	String	120

---

Response Body: (Status: 200)

{
    "cls_code": "<Product-type>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",
}

Fields Details:

Field Name	Description	Data Type	Example
cls_code	Product Type	String	"AB123"
data_set	Data Set	String	"Dataset1"
dsca	Description	String	"test"

---

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 Product type code is already present in the database:

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

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 'cls_code'"
}

Update

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

This API will update a Product type.

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

Request Body:

{
    "data_set": "<Data_set>",      //string
    "cls_code": "<Product-type>",  //string
    "dsca": "<description>",       //string
}

Response Body: (Status: 200)

{
    "cls_code": "<Product-type>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",  
}

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

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 both the Data set and Product type 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 'cls_code'"
}

Delete

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

This API will delete a Product type.

• 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 Product type code id is paased:

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

Get

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

This API will get a Product type.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "cls_code": "<Product-type>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",
}

Response Body: (Status: 200)

When invalid or wrong Product type 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/ln_prdtyp_class_code/{ Company }/{ PageSize }/{ PageNumber }

This API will get all Product type.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
   {
    "cls_code": "<Product-type>",
    "data_set": "<Data_set>", 
    "dsca": "<description>",  
   },
   .
   .
   .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}