Skip to main content

Utilities and Lookups

Version​

This returns the current version of i.LEVEL or an ilevel related application. This is the only call that dooes not require authentication to call.

GET*/api/version

Returns the i.LEVEL version as per example.

{
    "version": "4DU15_V15.05617"
}
GET*/api/version?app=Mobile

Returns the version of Mobile installed for the i.LEVEL installation. Other options are app=StoreController and app=api

{
    "version": "1.0.26"
}

If the app parameter is not recognised or the module is not installed the version resource will return "Unknown".

Example of unidentified version.

{
    "version": "Unknown"
}

Company Info​

This returns key company information. Currently this call is used by the i.LEVEL Mobile application.

GET/api/companyinfo

Returns the company info as per example.

{
    "response": {
        "Name": "ABC Limited",
        "Address1": "Unit 10 Fashion Lane",
        "Address2": "Anyplace",
        "Address3": "AnyTown",
        "Address4": "MK40 2TE",
        "Telephone": "01234 761758",
        "Fax": "",
        "Email": "help@ilevelsupport.co.uk",
        "Web_URL": "www.ilevelsooftware.co.uk",
        "VAT_Number": "XXX XXXX XXX",
        "Reg_Number": "XXXXXXXX",
        "GLN_ILN_Code": "false",
        "Delivery_Window": 0,
        "Order_Ack_Clause": "",
        "Prices_Action": "Hide",
        "Season_Lock": 0,
        "Trade_Names": [
            {
                "Name": "Religion",
                "Logo": "BAS64ENCODEDIMAGETEXT"
            }
        ],
        "Seasons": [
            "ST16",
            "AW16",
            "WT16",
            "SS16",
            "CORE",
            "FLOW",
            "MISC",
            "SS17",
            "SPEC",
            "CCOR",
            "CFLO",
            "SMS1",
            "SMS2",
            "SMS3",
            "SMS4",
            "AW17",
            "ST17",
            "WT17",
            "NOOS",
            "RPTS",
            "SS18",
            "ST18",
            "AW18",
            "CLEA",
            "WT18",
            "SS19"
        ]
    }
}
PropertyExampleDescription
Name"ABC Limited"Name of the company
Address1"Unit 10 Fashion Lane"Address line 1
Address2"Anyplace"Address line 2
Address3"AnyTown"Address line 3
Address4"MK40 2TE"Address line 4
Telephone"01234 761758"Telephone number.
Fax""Fax number
Email"help@ilevelsupport.co.uk"Email address
Web_URL"www.ilevelsoftware.co.uk"Website URL
VAT_Number"XXX XXXX XXX"VAT number
Reg_Number"XXXXXXXX"Company registration number
GLN_ILN_Code"help@ilevelsupport.co.uk"Email address
Delivery_Window"help@ilevelsupport.co.uk"Email address
Order_Ack_Clause"help@ilevelsupport.co.uk"Email address
Prices_Action"help@ilevelsupport.co.uk"Email address
Season_Lock"help@ilevelsupport.co.uk"Email address
Trade_Names[]An object array containing tradenames and images
Seasons[]A text array containing a list of season lock excptions

Currency​

This call returns all the active currencies within i.LEVEL.

GET*/api/currency

Returns the currency info as per example.

{
    "response": {
        "Own_Currency": 1,
        "Currency": [
            {
                "id": 1,
                "code": "GBP"
            },
            {
                "id": 2,
                "code": "EUR"
            },
            {
                "id": 3,
                "code": "USD"
            },
            {
                "id": 4,
                "code": "IEU"
            },
            {
                "id": 5,
                "code": "IUS"
            },
            {
                "id": 6,
                "code": "SEK"
            },
            {
                "id": 7,
                "code": "EUD"
            }
        ]
    }
}
PropertyExampleDescription
Own_Currency1The id of the currency which is used by the company as their own currency.
Currency[]An object array containing all currency id's and codes