Swagger EditorLoading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Click here to access the technical specifications for this service.
Project module UI configuration - for MuktaSoft
Project user stories - for MuktaSoft
Employee user manual on using the Project module - for MuktaSoft
This service models estimates for Works projects
Estimate Service allows users to create estimates and forward them for approval to higher authorities across departments for technical, financial, and admin sanctions. For more technical information on this service, please refer to the GitHub module README and the docs folder. The detailed estimate allows users to select a SOR (schedule of rates) item to add to the estimate and enter detailed measurements for the SOR item (if applicable).
Base Path: /estimates/
The diagram below shows the interaction between the estimate service and the persister, indexer. This does not follow the default pattern. Instead, enrichment of the payload for the indexer happens via a separate consumer and then the enriched payload is pushed to a topic. The indexer listens to this topic and sends it to ElasticSearch.
Estimate inbox uses the Inbox V2 service (from DIGIT core) which queries ES to retrieve details for the inbox. For more information on Inbox V2, please refer here.
An inbox is needed when there are workflows enabled for the service.
The proposed sequence diagram is below.
TBD
Estimates module UI configuration - for MuktaSoft
Estimates user stories - for MuktaSoft
Employee user manual on using the Estimates module - for MuktaSoft
Describes a calculator service for computing attendance
The Muster Roll service aggregates attendance logs from the attendance service based on some rules and presents an attendance aggregate for a time period (week or month) per individual. This can then be used to compute payments or other semantics.
Base Path: /muster-roll
Muster Roll UI configuration - for MuktaSoft
The Expense service allows users to capture the details for expense bills and payments.
Base path: /expense/bill/
The API specification is available . To view it in the Swagger editor, click below.
TBD
Index Name: expense-bill-index
Expense UI configuration - for MuktaSoft
Expense user manual
This page describes the low level design for the SOR and rates services
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.
The following masters need to be created as part of this module:
SOR Type
SOR Subtype
Unit of measurement
Work related contracts
The Contracts service allows users to enter, update, search and store functional details linked to works contracts.
Base path:/contracts
API spec Click below to view it in Swagger Editor.
Below are the sequence diagrams for the creation and consumption of revision contracts.
Description of the attendance service
Attendance service allows users to maintain attendance registers, enrol individuals, create, update or search attendance logs and manage staff permissions.
Base Path: /attendance/
Persister configuration:
Indexer configuration:
- for MuktaSoft
- for MuktaSoft
- for MuktaSoft
- for MuktaSoft
Update one or more measurement entries
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Accepted update measurement request.
ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Create one or more measurement entries
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Accepted create measurement request.
ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Create a SOR in the system with relevant details
Request object to create sor in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the SOR
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant
"pb"The unique formatted identifier or code of the SOR
"LD-00001"The SOR type code from master data
"Material, Works, Labour"Code of SOR Sub type from MDMS where applicable
"Earth Work, RCC work"Code of SOR variant from MDMS
"FN"Unit of measurement
"kg, sqm, cm"Base quantity for UOM against which rates are defined
"10kg, 100sqm"User Input Field. Max Characters can be 240.
"K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent."^[A-Za-z0-9\/ . _$@#]*$Indicates whether this SOR is active or not
Composition of the SOR in the case of complex SORs that are a combination of multiple other SORs. Not applicable to simple SORs.
Unique identifier of the head.
"251c51eb-e970-4e01-a99a-70136c47a934"SOR ID to which this detail belongs to
"251c51eb-e970-4e01-a99a-70136c47a934"SOR code or head code
Description of head details
It stores the status of the sor.
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Successful created SOR
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the SOR
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant
"pb"The unique formatted identifier or code of the SOR
"LD-00001"The SOR type code from master data
"Material, Works, Labour"Code of SOR Sub type from MDMS where applicable
"Earth Work, RCC work"Code of SOR variant from MDMS
"FN"Unit of measurement
"kg, sqm, cm"Base quantity for UOM against which rates are defined
"10kg, 100sqm"User Input Field. Max Characters can be 240.
"K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent."^[A-Za-z0-9\/ . _$@#]*$Indicates whether this SOR is active or not
Composition of the SOR in the case of complex SORs that are a combination of multiple other SORs. Not applicable to simple SORs.
Unique identifier of the head.
"251c51eb-e970-4e01-a99a-70136c47a934"SOR ID to which this detail belongs to
"251c51eb-e970-4e01-a99a-70136c47a934"SOR code or head code
Description of head details
It stores the status of the sor.
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Submit SOR with the head details to update SORs in the system
Request object to create sor in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the SOR
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant
"pb"The unique formatted identifier or code of the SOR
"LD-00001"The SOR type code from master data
"Material, Works, Labour"Code of SOR Sub type from MDMS where applicable
"Earth Work, RCC work"Code of SOR variant from MDMS
"FN"Unit of measurement
"kg, sqm, cm"Base quantity for UOM against which rates are defined
"10kg, 100sqm"User Input Field. Max Characters can be 240.
"K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent."^[A-Za-z0-9\/ . _$@#]*$Indicates whether this SOR is active or not
Composition of the SOR in the case of complex SORs that are a combination of multiple other SORs. Not applicable to simple SORs.
Unique identifier of the head.
"251c51eb-e970-4e01-a99a-70136c47a934"SOR ID to which this detail belongs to
"251c51eb-e970-4e01-a99a-70136c47a934"SOR code or head code
Description of head details
It stores the status of the sor.
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Successful created SOR
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the SOR
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant
"pb"The unique formatted identifier or code of the SOR
"LD-00001"The SOR type code from master data
"Material, Works, Labour"Code of SOR Sub type from MDMS where applicable
"Earth Work, RCC work"Code of SOR variant from MDMS
"FN"Unit of measurement
"kg, sqm, cm"Base quantity for UOM against which rates are defined
"10kg, 100sqm"User Input Field. Max Characters can be 240.
"K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent."^[A-Za-z0-9\/ . _$@#]*$Indicates whether this SOR is active or not
Composition of the SOR in the case of complex SORs that are a combination of multiple other SORs. Not applicable to simple SORs.
Unique identifier of the head.
"251c51eb-e970-4e01-a99a-70136c47a934"SOR ID to which this detail belongs to
"251c51eb-e970-4e01-a99a-70136c47a934"SOR code or head code
Description of head details
It stores the status of the sor.
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Creates a measurement entry along with workflow details.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
This defines a measurement with or without detailed measures.
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Action of the workflow to be performned on the request
comment for the workflow action to be performed
Accepted create measurement book request.
ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
This defines a measurement with or without detailed measures.
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Action of the workflow to be performned on the request
comment for the workflow action to be performed
Update values in a measurement book
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
This defines a measurement with or without detailed measures.
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Action of the workflow to be performned on the request
comment for the workflow action to be performed
Accepted update measurement book request.
ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
This defines a measurement with or without detailed measures.
Unique identifier of the detailed measurement entry
"251c51eb-e970-4e01-a99a-70136c47a934"Formatted number for this entry
Reference to a real world mBook or file or docket. Optional attribute.
The entity to which this measurement belongs or is related to
"Contract number"Date (in epoch time) when measurement was taken if different from the system created time
The item which is being measured.
"contractlineitemid"Measured length if applicable
200Measured breadth if applicable
200Measured height if applicable
200Number of items with same dimensions
Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.
Sum of all measurements so far for a given targetId
Flag for soft deletion
Any observational comments made during measurement
Reference to documents related to the organisation that have been attached via file upload
system id of the Document.
unique document type code, should be validated with document type master
File store reference key.
The unique id(Pancard Number,Adhar etc.) of the given Document.
Json object to capture any extra information which is not accommodated by model
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Flag used to soft delete entries
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.
Action of the workflow to be performned on the request
comment for the workflow action to be performed
Submit SOR with the rate details to create an SOR in the system
Request object to update rates for sor in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
System generated unique identifier for the rate
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant that could be a department/ulb/state
"pb.jalandhar OR dwss"ID of SOR
"251c51eb-e970-4e01-a99a-70136c47a934"ID of the detail item in the SOR. Applicable in the case of complex SORs
"251c51eb-e970-4e01-a99a-70136c47a934"Timestamp valid from
Timestamp valid to
Unique identifier of the AmountDetail
"251c51eb-e970-4e01-a99a-70136c47a934"Amount type master
"Gst, cess, charge "SOR amount for the current sor detail
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
It stores the status of the rate.
Any additional information that needs to be attached to the rate. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Successful updated Rates
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
System generated unique identifier for the rate
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant that could be a department/ulb/state
"pb.jalandhar OR dwss"ID of SOR
"251c51eb-e970-4e01-a99a-70136c47a934"ID of the detail item in the SOR. Applicable in the case of complex SORs
"251c51eb-e970-4e01-a99a-70136c47a934"Timestamp valid from
Timestamp valid to
Unique identifier of the AmountDetail
"251c51eb-e970-4e01-a99a-70136c47a934"Amount type master
"Gst, cess, charge "SOR amount for the current sor detail
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
It stores the status of the rate.
Any additional information that needs to be attached to the rate. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Submit SOR with the rate details to create an SOR in the system
Request object to create rates in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
System generated unique identifier for the rate
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant that could be a department/ulb/state
"pb.jalandhar OR dwss"ID of SOR
"251c51eb-e970-4e01-a99a-70136c47a934"ID of the detail item in the SOR. Applicable in the case of complex SORs
"251c51eb-e970-4e01-a99a-70136c47a934"Timestamp valid from
Timestamp valid to
Unique identifier of the AmountDetail
"251c51eb-e970-4e01-a99a-70136c47a934"Amount type master
"Gst, cess, charge "SOR amount for the current sor detail
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
It stores the status of the rate.
Any additional information that needs to be attached to the rate. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Successful created rate details
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
System generated unique identifier for the rate
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant that could be a department/ulb/state
"pb.jalandhar OR dwss"ID of SOR
"251c51eb-e970-4e01-a99a-70136c47a934"ID of the detail item in the SOR. Applicable in the case of complex SORs
"251c51eb-e970-4e01-a99a-70136c47a934"Timestamp valid from
Timestamp valid to
Unique identifier of the AmountDetail
"251c51eb-e970-4e01-a99a-70136c47a934"Amount type master
"Gst, cess, charge "SOR amount for the current sor detail
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
It stores the status of the rate.
Any additional information that needs to be attached to the rate. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Submit Rate search request to get Rate list list from the system
Request object to search sor in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Request for rate _search api
Pagination details
Limit for total no of records in single search max limit should be defined as envirnment variable
offset or page no
Total count for a perticular criteria
result sorting order
Sorting order
Sorting order
Successful search Rates
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
System generated unique identifier for the rate
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant that could be a department/ulb/state
"pb.jalandhar OR dwss"ID of SOR
"251c51eb-e970-4e01-a99a-70136c47a934"ID of the detail item in the SOR. Applicable in the case of complex SORs
"251c51eb-e970-4e01-a99a-70136c47a934"Timestamp valid from
Timestamp valid to
Unique identifier of the AmountDetail
"251c51eb-e970-4e01-a99a-70136c47a934"Amount type master
"Gst, cess, charge "SOR amount for the current sor detail
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
It stores the status of the rate.
Any additional information that needs to be attached to the rate. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Submit SOR search request to get SOR list from the system
Request object to search sor in the system
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Request for SOR _searcrh
Pagination details
Limit for total no of records in single search max limit should be defined as envirnment variable
offset or page no
Total count for a perticular criteria
result sorting order
Sorting order
Sorting order
Successful search SOR
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Unique identifier of the SOR
"251c51eb-e970-4e01-a99a-70136c47a934"Unique identifier of the tenant
"pb"The unique formatted identifier or code of the SOR
"LD-00001"The SOR type code from master data
"Material, Works, Labour"Code of SOR Sub type from MDMS where applicable
"Earth Work, RCC work"Code of SOR variant from MDMS
"FN"Unit of measurement
"kg, sqm, cm"Base quantity for UOM against which rates are defined
"10kg, 100sqm"User Input Field. Max Characters can be 240.
"K.B. bricks (25 Cm x 12Cm x 8Cm) having crushing strength not less than 75 Kg./Cm2 with dimensional tolerance ± 8 percent."^[A-Za-z0-9\/ . _$@#]*$Indicates whether this SOR is active or not
Composition of the SOR in the case of complex SORs that are a combination of multiple other SORs. Not applicable to simple SORs.
Unique identifier of the head.
"251c51eb-e970-4e01-a99a-70136c47a934"SOR ID to which this detail belongs to
"251c51eb-e970-4e01-a99a-70136c47a934"SOR code or head code
Description of head details
It stores the status of the sor.
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Any additional information that needs to be attached to the sor. For attachments, fileStoreIds will also be stored here.