Order - API Specifications
Last updated
Last updated
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
An order is created as an outcome of an hearing or based on an application. Order will contain a set of tasks
curl -L \
--request POST \
--url '/order/v1/create' \
--header 'Content-Type: */*' \
--data '{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-03-25",
"lastModifiedDate": "2025-03-25",
"dob": 1,
"pwdExpiryDate": 1
}
},
"order": {
"tenantId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": [
"text"
],
"hearingNumber": "text",
"orderNumber": "text",
"linkedOrderNumber": "text",
"createdDate": 1,
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"orderType": "text",
"orderCategory": "Intermediate, Judgement",
"orderDetails": {},
"status": "text",
"comments": "text",
"isActive": true,
"statuteSection": {
"tenantId": "text",
"statute": "text",
"sections": [
"text"
],
"subsections": [
"text"
],
"additionalDetails": "text"
},
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}'{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"order": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": [
"text"
],
"hearingNumber": "text",
"orderNumber": "text",
"linkedOrderNumber": "text",
"createdDate": 1,
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"orderType": "text",
"orderCategory": "Intermediate, Judgement",
"orderDetails": {},
"status": "text",
"comments": "text",
"isActive": true,
"statuteSection": {
"tenantId": "text",
"statute": "text",
"sections": [
"text"
],
"subsections": [
"text"
],
"additionalDetails": "text"
},
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}ResponseInfo with order(s) updated successfully
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
An order is created as an outcome of an hearing or based on an application. Order will contain a set of tasks
curl -L \
--request POST \
--url '/order/v1/update' \
--header 'Content-Type: */*' \
--data '{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-03-25",
"lastModifiedDate": "2025-03-25",
"dob": 1,
"pwdExpiryDate": 1
}
},
"order": {
"tenantId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": [
"text"
],
"hearingNumber": "text",
"orderNumber": "text",
"linkedOrderNumber": "text",
"createdDate": 1,
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"orderType": "text",
"orderCategory": "Intermediate, Judgement",
"orderDetails": {},
"status": "text",
"comments": "text",
"isActive": true,
"statuteSection": {
"tenantId": "text",
"statute": "text",
"sections": [
"text"
],
"subsections": [
"text"
],
"additionalDetails": "text"
},
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}'{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"order": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": [
"text"
],
"hearingNumber": "text",
"orderNumber": "text",
"linkedOrderNumber": "text",
"createdDate": 1,
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"orderType": "text",
"orderCategory": "Intermediate, Judgement",
"orderDetails": {},
"status": "text",
"comments": "text",
"isActive": true,
"statuteSection": {
"tenantId": "text",
"statute": "text",
"sections": [
"text"
],
"subsections": [
"text"
],
"additionalDetails": "text"
},
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}ResponseInfo with order(s) updated successfully
search order(s) based on different parameters
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
can send in any one of the values. If multiple parameters are passed, then it will be a logical AND search
Pagination details
curl -L \
--request POST \
--url '/order/v1/search' \
--header 'Content-Type: */*' \
--data '{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-03-25",
"lastModifiedDate": "2025-03-25",
"dob": 1,
"pwdExpiryDate": 1
}
},
"criteria": {
"filingNumber": "text",
"cnrNumber": "text",
"tenantId": "text",
"id": "text",
"orderNumber": "text",
"orderType": "text",
"applicationNumber": "text",
"status": "text"
},
"pagination": {
"limit": 1,
"offSet": 1,
"sortBy": "text",
"order": {
"0": "a",
"1": "s",
"2": "c"
}
}
}'{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"TotalCount": 1,
"list": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": [
"text"
],
"hearingNumber": "text",
"orderNumber": "text",
"linkedOrderNumber": "text",
"createdDate": 1,
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"orderType": "text",
"orderCategory": "Intermediate, Judgement",
"orderDetails": {},
"status": "text",
"comments": "text",
"isActive": true,
"statuteSection": {
"tenantId": "text",
"statute": "text",
"sections": [
"text"
],
"subsections": [
"text"
],
"additionalDetails": "text"
},
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
],
"pagination": {
"limit": 1,
"offSet": 1,
"totalCount": 1,
"sortBy": "text",
"order": {
"0": "a",
"1": "s",
"2": "c"
}
}
}ResponseInfo with order list
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
can send in any one of the values and Exists value will be populated with true or false. If multiple paramters are passed, then it will be a logical AND search
curl -L \
--request POST \
--url '/order/v1/exists' \
--header 'Content-Type: */*' \
--data '{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-03-25",
"lastModifiedDate": "2025-03-25",
"dob": 1,
"pwdExpiryDate": 1
}
},
"orderList": [
{
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"orderNumber": "text",
"exists": true
}
]
}'{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"orderList": [
{
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"orderNumber": "text",
"exists": true
}
]
}ResponseInfo with order(s) updated successfully