Number Group

Overview

The Number Group API enables the creation, retrieval, updating, and deletion of number group records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create

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

This API will creat new Number group.

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

Request Body:

{
    "data_set": "<Data-set>",           //string
    "ngrp": "<Number-group>",           //string
    "seri": "<Series>",                 //string
    "dsca": "<Series-description>"      //string
}

Fields Details:

Field Name	Description	Data Type	Length
data_set	Data Set	String	10
ngrp	Number Group	String	3
seri	Series	String	8
dsca	Series Description	String	120

---

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",
    "dsca": "<Series-description>",
    "ngrp": "<Number-group>",
    "seri": "<Series>",
}

Fields Details:

Field	Description	Data Type	Example
data_set	Data Set	String	"Dataset1"
dsca	Series Description	String	"Economic"
ngrp	Number Group	String	"320"
seri	Series	String	"INN"

---

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request)

When the Data set,Number group and Series 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/number_grp/{ Company }

This API will update a Number group.

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

Request Body:

{
    "data_set": "<Data-set>",           //string
    "ngrp": "<Number-group>",           //string
    "seri": "<Series>",                 //string
    "dsca": "<Series-description>"      //string
}

Response Body: (Status: 200)

{
    "data_set": "<Data-set>",
    "dsca": "<Series-description>",
    "ngrp": "<Number-group>",
    "seri": "<Series>",
}

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 Data set,Number group and Series:

{
    "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/number_grp/{ Company }/{ record_id }

This API will delete a Number group.

• 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 Number group id is paased:

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

Get

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

This API will get a Number group.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

{
   "data_set": "<Data-set>",
   "dsca": "<Series-description>",
   "ngrp": "<Number-group>",
   "seri": "<Series>",
}

Response Body: (Status: 200)

When invalid or wrong Number group 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/number_grp/{ Company }/{ PageSize }/{ PageNumber }

This API will get all Number groups.

• Method: GET
• Authentication: Bearer <token>

Response Body: (Status: 200)

[
  {
    "data_set": "<Data-set>",
    "dsca": "<Series-description>",
    "ngrp": "<Number-group>",
    "seri": "<Series>",
  },
  .
  .
  .
]

Response Body: (Status: 401 - Unauthorized)

When there is no token or invalid token passed:

{
    "message": "Unauthorized!"
}