---
title: "SoutronAPI"
canonical: "https://support.soutron.net/space/LMSAPI/2228244/SoutronAPI"
format: markdown
---
Minimum version required 4.1.5 The Soutron API allows responses in XML or Json format for all methods, append your query with the appropriate format parameter as shown below. Parameter Example Notes format=xml /SoutronAPI/catalogues/405741?format=xml Returns data in XML format. format=json /SoutronAPI/catalogues/405741?format=json   Returns data in Json format Search supports two object identification types:  Database object using IDs e.g. 1, 5, 2245 etc Database object using system or localised names for Content Types, Record Types, Validation Lists, fields. Enumerations for various attributes within the system can be downloaded using the following URL format. ./SoutronApi/metadata/enum.js //Soutron API Enumerations

const SoutronApiEnums = Object.freeze({
    BOOK_COVER_SOURCE: Object.freeze({
        Soutron: 0,
        Google: 1
    }),

    APP_STANDARDS: Object.freeze({
        Soutron: 1,
        RIS: 2
    }),

    CATALOGUE_SUBTYPE: Object.freeze({
        General: 1,
        Serial: 2,
        RecordWithVolumes: 4
    }),

    CATALOGUE_TYPE: Object.freeze({
        Standard: 10,
        Part: 20,
        Volume: 30,
        Issue: 40
    }),

    COPY_STATUS: Object.freeze({
        In: 1,
        Out: 2,
        Received: 3,
        PartialReceived: 4,
        Subscription: 5,
        OnOrder: 6,
        AwaitingBarcode: 7,
        AwaitingDistribution: 8,
        InTransit: 9,
        BeingCirculated: 10,
        AwaitingCollection: 11,
        Missing: 15,
        PendingReservation: 20,
        BeingViewed: 21,
        AwaitingViewing: 22
    }),

    FILTER_MODE: Object.freeze({
        Include: 0,
        Exclude: 1
    }),

    RECORD_FIELD_TYPE: Object.freeze({
        Unknown: 0,
        Text: 1,
        Integer: 2,
        Date: 3,
        File: 4,
        Thesaurus: 5,
        ValidationList: 6,
        URL: 7,
        ComplexDate: 8,
        Decimal: 9,
        Image: 10,
        RichText: 11,
        User: 12,
        Frequency: 13,
        Incremental: 14,
        ISBN: 15,
        ISSN: 16,
        Section: 17,
        Rating: 18,
        VirtualThesaurusMainValue: 19,
        VirtualThesaurusAdditionValues: 20,
        CatalogueRecord: 21,
        Audit: 22
    }),

    RESULT_OPEN_MODE: Object.freeze({
        API: 0,
        Portal: 1
    }),

    RSS_FIELDS: Object.freeze({
        Title: 1,
        Description: 2,
        Author: 3,
        Category: 4,
        Enclosure: 5,
        PublicationDate: 6
    }),

    SORT_ORDER: Object.freeze({
        Ascending: 0,
        Descending: 1
    }),

    SAVED_SEARCH_TYPE: Object.freeze({
        Search: 10,
        Report: 20,
        Collection: 30
    })
});