Health Service API

Create/Add a new product

Create a new product

post

/product/v1/_create

Body

RequestInfoobjectrequired

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.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Productobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","Product":[{"tenantId":"tenantA","type":"DRUG","name":"Paracetamol","manufacturer":"J&J","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Product": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product request has been accepted.

Update product

Update product

post

/product/v1/_update

Body

RequestInfoobjectrequired

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.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Productobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","Product":[{"tenantId":"tenantA","type":"DRUG","name":"Paracetamol","manufacturer":"J&J","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Product": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product request has been accepted.

Search product

Search product

post

/product/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

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.

Productobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Product":{"id":[null],"type":"DRUG","name":"Paracetamol","manufacturer":"J&J"}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Product": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product.

Create/Add a new variant for a product

Create/Add a new variant for a product

post

/product/variant/v1/_create

Body

RequestInfoobjectrequired

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.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

ProductVariantobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/variant/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","ProductVariant":[{"tenantId":"tenantA","productId":"text","sku":"PAR-200","variation":"Paracetamol 200mg white color","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProductVariant": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product Variant request has been accepted.

Update product variant

Update product variant

post

/product/variant/v1/_update

Body

RequestInfoobjectrequired

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.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

ProductVariantobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/variant/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","ProductVariant":[{"tenantId":"tenantA","productId":"text","sku":"PAR-200","variation":"Paracetamol 200mg white color","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProductVariant": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product variant request has been accepted.

Search product variant

Search product variant

post

/product/variant/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

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.

ProductVariantobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/product/variant/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProductVariant":{"id":[null],"sku":"PAR-200","variation":"Paracetamol 200mg white color"}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProductVariant": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Product Variant.