Inventory

Campaign Inventory Management APIs

Facilitates the maintenance and management of inventories.

Create a Inventory Log.

post

Creates Inventory Log On successful Inventory Log Ok response is returned.

Body

The request object, containing all necessary information for creating an Inventory Log and the request body metadata

requestInfoobjectOptional

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.

inventoryLogobjectRequired

Responses

application/json

objectOptional

The request object, containing all necessary information for creating an Inventory Log and the request body metadata

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /log/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 645

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "inventoryLog": {
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    }
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "inventoryLog": {
    "inventoryLogId": "UUID",
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update An Inventory Log.

post

Update An Inventory Log, Ok response is returned.

Body

requestInfoobjectOptional

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.

inventoryLogobjectOptional

Responses

application/json

objectOptional

The request object, containing all necessary information for creating an Inventory Log and the request body metadata

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /log/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 645

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "inventoryLog": {
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    }
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "inventoryLog": {
    "inventoryLogId": "UUID",
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Search Inventory Log.

post

Search Inventory Log Ok response is returned.

Body

requestInfoobjectOptional

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.

inventorySearchCriteriaobjectOptional

Responses

application/json

objectOptional

The search response object.

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /log/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "inventorySearchCriteria": {
    "inventoryLogId": "UUID",
    "transactionPartyId": "WARE-HOUSE-2",
    "warehouseId": "WARE-HOUSE-3",
    "campaignId": "CAMP-ID",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "transactionType": "RECEIVED",
    "transactionDate": 1663218161
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 0,
  "inventoryLogs": [
    {
      "tenantId": "text",
      "inventoryLogId": "UUID",
      "campaignId": "CAMP-ID",
      "transactionPartyId": "WARE-HOUSE-2",
      "transactionPartyType": "RECEIVED",
      "transactionReason": "RETURNED REASON",
      "transactionDate": 1663218161,
      "warehouseId": "WARE-HOUSE-3",
      "resource": {
        "tenantId": "text",
        "resourceId": "ID-1",
        "resourceType": "BEDNET",
        "resourceName": "LLIN",
        "quantity": 100,
        "quantityUnit": "BALE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "clientReferenceId": "GUID",
      "additionalFields": {
        "schema": "INVENTORY",
        "version": 2,
        "fields": [
          {
            "key": "Vehicle Number",
            "value": "MH12AB1212"
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Create a Reconciliation Log.

post

Creates Reconciliation Log On successful Reconciliation Ok response is returned.

Body

The request object, containing all necessary information for creating an Inventory Log and the request body metadata

requestInfoobjectOptional

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.

reconciliationLogobjectRequired

Responses

application/json

objectOptional

The request object, containing all necessary information for creating an Reconciliation and the request body metadata

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /reconciliation/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 549

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "reconciliationLog": {
    "tenantId": "text",
    "warehouseId": "WARE-HOUSE-2",
    "campaignId": "CAMP-ID",
    "dateOfReconciliation": 1663218161,
    "clientReferenceId": "GUID",
    "calculatedCount": 200,
    "physicallyRecordedCount": 122,
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "comment": "RECEIVED",
    "transactionReason": "100 Entry Missing"
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "reconciliationLog": {
    "tenantId": "text",
    "warehouseId": "WARE-HOUSE-2",
    "campaignId": "CAMP-ID",
    "dateOfReconciliation": 1663218161,
    "clientReferenceId": "GUID",
    "calculatedCount": 200,
    "physicallyRecordedCount": 122,
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    "comment": "RECEIVED",
    "transactionReason": "100 Entry Missing",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Search reconciliation Logs.

post

Search reconciliation Logs Ok response is returned.

Body

The request object, containing all necessary information for creating an Reconciliation and the request body metadata

requestInfoobjectOptional

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.

reconciliationSearchCriteriaobjectRequired

Responses

application/json

objectOptional

The search response object.

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /reconciliation/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 427

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "reconciliationSearchCriteria": {
    "warehouseId": "WARE-HOUSE-2",
    "dateOfReconciliation": 1663218161,
    "clientReferenceId": "GUID",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "limit": 5,
    "offset": 5
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 0,
  "reconciliationLogs": [
    {
      "reconciliationId": "1212",
      "tenantId": "text",
      "warehouseId": "WARE-HOUSE-2",
      "campaignId": "CAMP-ID",
      "dateOfReconciliation": 1663218161,
      "clientReferenceId": "GUID",
      "calculatedCount": 200,
      "physicallyRecordedCount": 122,
      "resource": {
        "tenantId": "text",
        "resourceId": "ID-1",
        "resourceType": "BEDNET",
        "resourceName": "LLIN",
        "quantity": 100,
        "quantityUnit": "BALE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "comment": "RECEIVED",
      "transactionReason": "100 Entry Missing",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}