Codelayer API Documentation

  • Introduction

    • General Information
  • API Reference

    • Accounts

      • General Ledger
      • Get Account Details
      • Prepare General Ledger
      • Status Request
    • Authentication

      • Authentication
      • Key Validator
    • Camera Server

      • Camera List
      • Get Date and Time
      • Get Snap Shot
      • Set date
      • Vehicle List
    • Connection Check (IQM_V3)

      • Check Connection
    • Cost Centre Management

      • Cost centre Checklist
      • Cost centre Previous Reading Details
      • Gatepass Details
      • Save Checklist Details
      • Save Trip Details
      • Saved Checklist Data
    • Data Temporary Holder

      • Get Data
      • Get Key List
      • Save Data
    • DB Connection Details(IQ_V3)

      • DB Details
    • ESC POS Printing Support

      • Print Bill
      • Print KOT
    • Fee Management

      • Get Admission Details
      • Get Admission Fee Details
      • Get Course Type
      • Get CourseLevel
      • Get Dailyclosingstatus
      • Get Director details
      • Get District
      • Get Educational Qualification
      • Get Eligibility Criteria
      • Get Feepending Data
      • Get Feestruture Data
      • Get Is_available_api
      • Get Master Batch
      • Get MasterCourse
      • Get Pending Fee
      • Get Scholarship
      • Get SpecialDiscountConfiguration
      • Get State
      • Get Student Details
      • Get Subject Data
      • Get Webhook
      • Save Admission Details
      • Save Admission Fee Details
      • Save Course Type
      • Save CourseLevel
      • Save Director
      • Save Eligibility Criteria
      • Save Fee Collection Audit
      • Save Feestructure
      • Save Master Batch
      • Save Master Course
      • Save Scholarship
      • Save SpecialDiscountConfiguration
      • Save Student
      • Save Subject
    • Final Accounts

      • Debtors/Creditors Schedule
      • Prepare Final Account
      • Show Available Requests
      • Status Request
      • Trialbalance (ACGCODE)
    • Firm Database (IQM_V3)

      • Databases
    • Firm Database (IQ_V3_EXT)

      • Database List For Extended IQs
      • QM DB Connection Details
    • FoodProducts

      • Get Non Continous Customer Sale
      • Get Product Routewise Discount
      • Get Routes
    • Front Office

      • Cancel E-Invoice
      • Fetch Card Settlement
      • Generate DC
      • Get E-Invoice
      • Get E-Way Bill
      • Get Invoice Cash Received
      • Invoice Cash Received Save
      • Invoice Data
      • Invoice Save
      • Save Card Settlement
      • Update Audited
    • Internal Data Holder

      • Get Saved Key Data
      • Get Stored Key Details
      • Remove Saved Key Details
      • Save Key Data
    • Inventory_HO

      • PurchaseOrderAudited
      • PurchaseOrderLocateReq
      • PurchaseOrderReqCancel
      • PurchaseOrderReqSave
      • PurchaseOrderSave
      • RequstedPurchaseOrders
    • IQ_V3_Ext Functions

      • Closing Status
      • Get Max Refresh Session
    • Issue Indent

      • Indent Fetch
      • Indent Save
    • Issue Indent Audit

      • Indent Audit Save
    • Masters

      • Account Group
      • AcHeads
      • Active Costcentres
      • Available Firmdb Details
      • Bank
      • Customer wise product rate
      • Employees
      • External Vehicle Type
      • External Vehicles List
      • External Vehicles Save
      • Filter Conditions
      • Get Designation
      • Get GST Schedule
      • Get Hsn
      • Get State
      • Invoice Source
      • Issue Heads
      • Material Count Details
      • Materials
      • Own Vehicles List
      • Places
      • Product
      • Quarry
      • Refetch Master
      • Save Filter Conditions
      • Save Userwise Report Columns
      • Sundries
      • Transporting Heads And Equipment Works
      • Uoms
      • User wise Report Columns
      • Vehicle In Purpose Types
    • Power Management

      • Generator Reading Cancel
      • Generator Reading Data
      • Generator Reading Save
      • Master Save
      • Power Master Data
      • Previous Generator Readings
      • Previous Purchased Power Readings
      • Purchased Power Reading Cancel
      • Purchased Power Reading Data
      • Purchased Power Reading Save
    • Preferences

      • Preferences
    • Production

      • Crusher Production Cancel
      • Crusher Production Locate
      • Crusher Production Save
      • Crusher Production Update
      • Get Production Summary
      • Job Card Cancel
      • Job Card Locate
      • Job Card Save
    • Purchase

      • Get purchase order details
      • Save Purchase
      • SaveUpdateaudited
      • ViewSavedPurchaseDetails
    • Security Systems

      • Cancel GateManagement Qrcode
      • Cancel Outpass
      • Device Configuration Locate
      • Device Configuration Save
      • Device List
      • Fetch Gate Management Data
      • Gate In - Pending Vehicles List
      • Gate In - Remove Pending Vehicles List
      • Gate In - Save Gate In for New Vehicles
      • GateManagement Manual GateOut
      • Get GateManagement GateIn Vehicle
      • Get GateManagement Invehicle
      • Get GateManagement Outpass Data
      • Get GateManagement Outvehicle
      • Get GateManagement QrCode CheckValid
      • Get GateManagementVehicles for Gateout
      • Get GateManagementVehicles for Outpass
      • Get Manual GateOperation
      • Get Outpass
      • Get Outpass Reasons
      • Get Permanent Outpass
      • Get Saved Camera VehicleDetails
      • Save GateManagement
      • Save Manual GateOperation
      • Save Outpass
      • Save Outpass Reason
      • Update GateManagement QrCode
      • Update Vehicle GateManagement
      • Vehicle Q - Cancel Vehicle In
      • Vehicle Q - Fetch Vehicle In
      • Vehicle Q - Save Vehicle In
    • Sessions

      • Get Cash Balance
      • Get Denomination Data
      • Get Session Closing Data
      • Get Session Data
      • Save Session
      • Session Validation
    • Weighing

      • Cancel Weighment
      • Clear Weigment Used
      • Edit Weighment
      • Get Outpass Weighment Data
      • Get Saved Weighment
      • Get Weighment Match Data
      • Get Weigment
      • Locate Saved Weighment
      • Locate Weighment Vehicle
      • Mark Outpass Done
      • Mark Weigment Used In Transaction
      • Opposite Weighment Pending Vehicles
      • Save New Weighment
      • Vehicle Weighment Data Details
      • Weigment Completed Vehicle List
    • MIS DashBoard

      • 00 webmenu
      • 01 Net costing prepare
      • 01 Net costing result
      • 01 Net costing status
      • 02 Route Sales
      • 02 Route salesstatus
      • 02 Routesles Prepare
      • 03 Sales Register
      • 03 Sales Register Prepare
      • 03 Sales Register Status
      • Ageing Creditors=> Prepare
      • Ageing Creditors=> Report
      • Ageing Creditors=> Status
      • Ageing Debtors=> Prepare
      • Ageing Debtors=> Report
      • Ageing Debtors=> Status
      • Ageing of Creditors
      • Ageing of Debtors
      • Bank Balance Summary
      • Cash Balance Summary
      • Firm Category
      • Firm List
      • Firmwise Sales Summary
      • P and L
      • P and L Prepare
      • P and L Status
      • QM Production
      • Sales Summary Firm wise Product Wise
      • Sales Summary MOS Wise
      • Sales Summary Product wise
      • Sales Summary- Firm wise ProductCategory wise
      • Sales Summary- Product Category wise
      • Trial Balance
      • Trial Balance Prepare
      • Trial Balance Status
    • License request
    • Register Device
    • Response Codes
Codelayer API Documentation
License request

This is the URL to request the lisense and the location of the base url of the service. This request should be done to https://license.codelayer.co.in/

URL

system/license

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
imei String 14 50 M 12345678901234 IMEI of the accessing device
appID String 3 30 M QM_V3 Application ID of the requesting application. this is the same application ID provided to the front end developer for registering the device.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
licenses Array 1 M List of the licenses for the device.
statusCode Integer 1 3 M 2 Status code.
1 = Approval Pending
2 = Approved
3 = Rejected
productName String 100 M Quarry Manager - Version III Name of the product.
clientName String 50 M Codelayer Technologies Pvt. Ltd. Name of the company.
clientLocation String 50 M clientLocation Location as registered by the client.
validTill String 10 M The date of expiry of the license. This can be a date in yyyy-mm-dd format or Unlimited. Unlimited means there is no expiry of the license.
baseURL String 250 M https://qm.api.codelayer.co.in this it the base url of the API.
status String 8 16 M Approved The description of the statusCode
features Array M List of additional features available with the license
id Integer 1 M 1 ID of the feature.
feature_name String 1 50 M Bill Cancellation Name of the feature.
description String M Allows to cancel existing bill. Description of the feature.
urls Array 1 M List of urls used in the feature.
name String 1 50 M Cancel Bill Name of the function
url String 1 250 M sales/cancel_bill The url for the function.
description String 250 M Cancel the bill. Description of the function.
license_key String 86 M ci8oYXcJgSDiCUvgVewjySW0N/IbJq4PJnmURf3Ve6LMjE4JyhadAZl7BYlUM77Vxds4hOUo3VhVZl4sHpIKHA The license key for the device. This key is needed for user login.

 

Sample Request
{
    "imei": "12345678901234",
    "appID": "QM_V3"
}
Sample Success Response
{
    "licenses": [
        {
            "statusCode": "2",
            "productName": "Quarry Manager - Version III",
            "clientName": "Codelayer Technologies Pvt. Ltd.",
            "clientLocation": "clientLocation",
            "validTill": "The date of expiry of the license.",
            "baseURL": "https://qm.api.codelayer.co.in",
            "status": "Approved",
            "features": [
                {
                    "id": "1",
                    "feature_name": "Bill Cancellation",
                    "description": "Allows to cancel existing bill.",
                    "urls": [
                        {
                            "name": "Cancel Bill",
                            "url": "sales/cancel_bill",
                            "description": "Cancel the bill."
                        }
                    ]
                }
            ],
            "license_key": "ci8oYXcJgSDiCUvgVewjySW0N/IbJq4PJnmURf3Ve6LMjE4JyhadAZl7BYlUM77Vxds4hOUo3VhVZl4sHpIKHA"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}