Schedule of Rates (archive)

This page describes the low level design for the SOR and rates services

Overview

Schedule of rates are defined by the state to provide detailed specifications for materials, labour, machinery etc..Rates are also defined at the state level but can be customized at the ULB level. This service provides a way to create/update/search for SORs and add rates to the SORs.

API Specifications

API Contract Link

16KB

sor-rates-1.0.0.yaml

APIs

Create an SOR

Create a SOR in the system with relevant details

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_create

Body

application/json

Request object to create sor in the system

requestInfo*RequestInfo (object)

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.

sors*array of SOR (object)

Response

202400

Successful created SOR

Body

*/*

responseInfoRequestInfo (object)

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.

sors*array of SOR (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "sors": [
        {
          "tenantId": "pb",
          "sorNumber": "LD-00001",
          "sorType": "Material, Works, Labour",
          "uom": "kg, sqm, cm"
        }
      ]
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "sors": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb",
      "sorNumber": "LD-00001",
      "sorType": "Material, Works, Labour",
      "sorSubType": "Earth Work, RCC work",
      "sorVariant": "FN",
      "uom": "kg, sqm, cm",
      "uomValue": "10kg, 100sqm",
      "description": "K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent.",
      "isActive": false,
      "details": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
          "code": "text",
          "description": "text",
          "isActive": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Update an SOR

Submit SOR with the head details to update SORs in the system

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_update

Body

application/json

Request object to create sor in the system

requestInfo*RequestInfo (object)

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.

sors*array of SOR (object)

Response

202400

Successful created SOR

Body

*/*

responseInfoRequestInfo (object)

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.

sors*array of SOR (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "sors": [
        {
          "tenantId": "pb",
          "sorNumber": "LD-00001",
          "sorType": "Material, Works, Labour",
          "uom": "kg, sqm, cm"
        }
      ]
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "sors": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb",
      "sorNumber": "LD-00001",
      "sorType": "Material, Works, Labour",
      "sorSubType": "Earth Work, RCC work",
      "sorVariant": "FN",
      "uom": "kg, sqm, cm",
      "uomValue": "10kg, 100sqm",
      "description": "K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent.",
      "isActive": false,
      "details": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
          "code": "text",
          "description": "text",
          "isActive": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Search an SOR

Submit SOR search request to get SOR list from the system

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_search

Body

application/json

Request object to search sor in the system

requestInfo*RequestInfo (object)

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.

criteria*SORSearchCriteria (object)

Request for SOR _searcrh

pagination*Pagination (object)

Pagination details

Response

202400

Successful search SOR

Body

*/*

responseInfoRequestInfo (object)

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.

sors*array of SOR (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "criteria": {},
      "pagination": {}
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "sors": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb",
      "sorNumber": "LD-00001",
      "sorType": "Material, Works, Labour",
      "sorSubType": "Earth Work, RCC work",
      "sorVariant": "FN",
      "uom": "kg, sqm, cm",
      "uomValue": "10kg, 100sqm",
      "description": "K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent.",
      "isActive": false,
      "details": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
          "code": "text",
          "description": "text",
          "isActive": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Create an rates of SOR

Submit SOR with the rate details to create an SOR in the system

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_create

Body

application/json

Request object to create rates in the system

requestInfo*RequestInfo (object)

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.

rateDetails*array of RateDetails (object)

Response

202400

Successful created rate details

Body

*/*

ResponseInfo*RequestInfo (object)

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.

rateDetails*array of RateDetails (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "rateDetails": [
        {}
      ]
    }),
});
const data = await response.json();

Response

202400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "rateDetails": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb.jalandhar OR dwss",
      "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "detailId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "validFrom": 0,
      "validTo": 0,
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 0
        }
      ],
      "isActive": false,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Create an rates of SOR

Submit SOR with the rate details to create an SOR in the system

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_update

Body

application/json

Request object to update rates for sor in the system

requestInfo*RequestInfo (object)

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.

rateDetails*array of RateDetails (object)

Response

202400

Successful updated Rates

Body

*/*

ResponseInfo*RequestInfo (object)

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.

rateDetails*array of RateDetails (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "rateDetails": [
        {}
      ]
    }),
});
const data = await response.json();

Response

202400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "rateDetails": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb.jalandhar OR dwss",
      "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "detailId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "validFrom": 0,
      "validTo": 0,
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 0
        }
      ],
      "isActive": false,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Search Rates for SOR and SOR heads

Submit Rate search request to get Rate list list from the system

POSThttps://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_search

Body

application/json

Request object to search sor in the system

requestInfo*RequestInfo (object)

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.

criteria*RateSearchCriteria (object)

Request for rate _search api

pagination*Pagination (object)

Pagination details

Response

202400

Successful search Rates

Body

*/*

ResponseInfo*RequestInfo (object)

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.

rateDetails*array of RateDetails (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 0,
        "msgId": "text",
        "action": "text"
      },
      "criteria": {
        "tenantId": "text"
      },
      "pagination": {}
    }),
});
const data = await response.json();

Response

202400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 0,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ]
    },
    "correlationId": "text"
  },
  "rateDetails": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb.jalandhar OR dwss",
      "sorId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "detailId": "251c51eb-e970-4e01-a99a-70136c47a934",
      "validFrom": 0,
      "validTo": 0,
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 0
        }
      ],
      "isActive": false,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Data Model

DB Schema Diagram

Web Sequence Diagrams

SOR APIs

SOR Create

SOR Update

SOR Search

Rates

Create Rates

Update Rates

Search Rates

Master Data Types

The following masters need to be created as part of this module:

• SOR Type

• SOR Subtype

• Unit of measurement