Order Type

Overview

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

Create

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

This API will creat new Country code.

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

Request Body:

{
    "data_set": "<Data-set>",       //string
    "ord_typ": "<Order-type>",      //string
    "dsca": "<Order-description>"   //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
ord_type	Order Type	String	3
dsca	Order Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",    
    "dsca": "<Order-description>",   
    "ord_typ": "<Order-type>",      
}

Fields Details:

Field	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
dsca	Order Description	String	"Test sale"
ord_type	Order Type	String	"PS"

---

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 Order type 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'"
}

Update

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

This API will update a Order type.

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

Request Body:

{
    "data_set": "<Data-set>",       //string
    "ord_typ": "<Order-type>",      //string
    "dsca": "<Order-description>"   //string
}

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",    
    "dsca": "<Order-description>",   
    "ord_typ": "<Order-type>", 
}

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 the both the Data set and Order type:

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

Delete

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

This API will delete a Order 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 order type id is paased:

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

Get

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

This API will get a Order type.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",    
    "dsca": "<Order-description>",   
    "ord_typ": "<Order-type>", 
}

Response Body: (Status: 200)

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

This API will get all Order types.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
  {
    "data_set": "<Data-set>",    
    "dsca": "<Order-description>",   
    "ord_typ": "<Order-type>", 
  },
  .
  .
  .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}