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