This section details about the service APIs in the Packet modules
This service will create the list of Packet Rejection Reasons which are used in the MOSIP platform.
POST /packetrejectionreasons/reasoncategory
201
Description : Created
400
Description: Bad request
401
Description: Unauthorized
403
Description: Forbidden
This service will create the list of Packet Rejection Reasons which are used in the MOSIP platform.
POST /packetrejectionreasons/reasonlist
201
Description : Created
400
Description: Bad request
401
Description: Unauthorized
403
Description: Forbidden
Master data is required across the platform.
This service will provides the service for the List of Packet Rejection Reasons.
GET /packetrejectionreasons
200
Description: Success
400
Description: Bad request
401
Description: Unauthorized
404
Description: Not Found
This service will provides the service for the List of Packet Rejection Reasons.
GET /packetrejectionreasons/{reasoncategorycode}/{languagecode}
200
Description: Success
400
Description: Bad request
401
Description: Unauthorized
404
Description: Not Found
This service will provides the service for the List of Packet Rejection Reasons based on id, language and location code.
GET /packetrejectionreasons/{id}/{languagecode}/{locationcode}
200
Description: Success
400
Description: Bad request
401
Description: Unauthorized
404
Description: Not Found
Failure details
This service will create the list of Packet On-hold Reasons which are used in the MOSIP platform.
POST /packetonholdreasons
202
Description: Accepted
400
Description: Bad request
401
Description: Unauthorized
403
Description: Forbidden
Master data is required across the platform.
This service will provides the service for the List of Packet On-hold Reasons.
GET /packetonholdreasons
200
Description: Success
400
Description: Bad request
401
Description: Unauthorized
404
Description: Not Found
This service will provides the service for the List of Packet On-hold Reasons.
GET /packetonholdreasons/{id}/{languagecode}
200
Description: Success
400
Description: Bad request
401
Description: Unauthorized
404
Description: Not Found
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Error Code | Error Message | Error Description |
---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Resource Details | Description |
---|---|
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
Response format
JSON
Requires Authentication
Yes
code
Yes
Code of the reason category
name
Yes
Name of the reason category
description
Yes
description for the reason category
isActive
Yes
whether the reason category is in use
langCode
Yes
language code of the reason category
Response format
JSON
Requires Authentication
Yes
code
Yes
Code of the reason category
name
Yes
Name of the reason category
description
Yes
description for the reason category
rsnCatCode
Yes
foreign key reference from reason category code
isActive
Yes
whether the reason category is in use
langCode
Yes
language code of the reason category
Response format
JSON
Requires Authentication
Yes
NA
Response format
JSON
Requires Authentication
Yes
NA
Response format
JSON
Requires Authentication
Yes
packetrejectionreasonid
Yes
Code of the language
packetrejectionreasondesc
Yes
Name of the language
KER-MSD-035
Error occurred while fetching Reasons
Fetch Issue
KER-MSD-057
Error occurred while inserting reason details
Insertion Issue
KER-MSD-036
Reason not found
Data Not Found
KER-MSD-058
Error occurred while inserting reason details
List Insertion Issue
Response format
JSON
Requires Authentication
Yes
packetonholdreasondesc
Yes
Name of the packet rejection reason
Response format
JSON
Requires Authentication
Yes
packetonholdreasonid
Yes
Code of the language
packetonholdreasondesc
Yes
Name of the language
Response format
JSON
Requires Authentication
Yes
packetonholdreasonid
Yes
Code of the language
packetonholdreasondesc
Yes
Name of the language