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

post

/sor/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.

sorsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"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.","auditDetails":{},"additionalDetails":{},"details":[]}]}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": true,
      "auditDetails": {},
      "additionalDetails": {},
      "details": []
    }
  ]
}

Successful created SOR

Update an SOR

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

post

/sor/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.

sorsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"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.","auditDetails":{},"additionalDetails":{},"details":[]}]}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": true,
      "auditDetails": {},
      "additionalDetails": {},
      "details": []
    }
  ]
}

Successful created SOR

Search an SOR

Submit SOR search request to get SOR list from the system

post

/sor/v1/_search

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.

criteriaobjectrequired

Request for SOR _searcrh

paginationobjectrequired

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"criteria":{"ids":[null],"sorNumbers":[null]},"pagination":{"limit":10,"offSet":0,"order":{"0":"a","1":"s","2":"c"}}}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": true,
      "auditDetails": {},
      "additionalDetails": {},
      "details": []
    }
  ]
}

Successful search SOR

Create an rates of SOR

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

post

/sor/rate/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.

rateDetailsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"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","additionalDetails":{},"auditDetails":{},"amountDetail":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","type":"Gst, cess, charge ","amount":1,"additionalDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": 1,
      "validTo": 1,
      "isActive": true,
      "additionalDetails": {},
      "auditDetails": {},
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 1,
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Successful created rate details

Create an rates of SOR

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

post

/sor/rate/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.

rateDetailsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"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","additionalDetails":{},"auditDetails":{},"amountDetail":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","type":"Gst, cess, charge ","amount":1,"additionalDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": 1,
      "validTo": 1,
      "isActive": true,
      "additionalDetails": {},
      "auditDetails": {},
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 1,
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Successful updated Rates

Search Rates for SOR and SOR heads

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

post

/sor/rate/v1/_search

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.

criteriaobjectrequired

Request for rate _search api

paginationobjectrequired

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/works/SOR-Service/1.0.0/sor/rate/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"criteria":{"tenantId":"text","ids":[null],"sorIds":[null],"headCodeIds":[null]},"pagination":{"limit":10,"offSet":0,"order":{"0":"a","1":"s","2":"c"}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "roles": [
        {
          "tenantId": "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": 1,
      "validTo": 1,
      "isActive": true,
      "additionalDetails": {},
      "auditDetails": {},
      "amountDetail": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "type": "Gst, cess, charge ",
          "amount": 1,
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Successful search Rates

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