ChemPal Documentation - v1.6.0
    Preparing search index...

    Interface AmbeedGetPmsSdsByAmsResponse

    Root of the PMS/SDS-by-AMS response body returned by webapi/v1/getPmsSdsByAms.

    interface AmbeedGetPmsSdsByAmsResponse {
        time: string;
        lang: string;
        source: number;
        code: number;
        value: {
            isokk: boolean;
            errmsg: string;
            sds_list: {
                [key: string]: { [key: string]: { status: boolean; url: string } };
            };
            data: null;
            chemical_info: { [key: string]: { [key: string]: string } };
            api_data: null;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    time lang source code value

    Properties

    time: string

    The timestamp of the response

    lang: string

    The language of the response

    source: number

    The source of the response

    code: number

    The response code

    value: {
        isokk: boolean;
        errmsg: string;
        sds_list: {
            [key: string]: { [key: string]: { status: boolean; url: string } };
        };
        data: null;
        chemical_info: { [key: string]: { [key: string]: string } };
        api_data: null;
    }

    The response value containing SDS document links and chemical info.

    Type declaration

    • isokk: boolean

      Whether the lookup succeeded.

    • errmsg: string

      Error message when the lookup failed (empty on success).

    • sds_list: { [key: string]: { [key: string]: { status: boolean; url: string } } }

      SDS documents keyed by AM identifier, then by language/region.

    • data: null

      Reserved field, always null in observed responses.

    • chemical_info: { [key: string]: { [key: string]: string } }

      Chemical metadata keyed by AM identifier, then by field name.

    • api_data: null

      Reserved field, always null in observed responses.

    Settings

    Member Visibility

    On This Page

    Properties