PRIMAVERA | Developers

    Show / Hide Table of Contents

    Interface IBasBSInformaDB

    Namespace: IBasBS100
    Assembly: IBasBS100.dll
    Syntax
    public interface IBasBSInformaDB

    Methods

    Create(String, StdBETipos.EnumEntityType, String)

    Creates a new Informa DB product and saves it to database.

    Declaration
    void Create(string taxId, StdBETipos.EnumEntityType entityType, string entityKey)
    Parameters
    Type Name Description
    System.String taxId

    Entity tax ID

    StdBETipos.EnumEntityType entityType

    The type of entity

    System.String entityKey

    The entity ERP key

    Create(String, String, String)

    Creates a new Informa DB product and saves it to database.

    Declaration
    void Create(string taxId, string entityType, string entityKey)
    Parameters
    Type Name Description
    System.String taxId

    Entity tax ID

    System.String entityType

    The text representation of the entity type

    System.String entityKey

    The entity ERP key

    Delete(BasBETipos.EnumInformaDBIdentificationType, String)

    Declaration
    void Delete(BasBETipos.EnumInformaDBIdentificationType idType, string idValue)
    Parameters
    Type Name Description
    BasBETipos.EnumInformaDBIdentificationType idType
    System.String idValue

    Edit(BasBETipos.EnumInformaDBIdentificationType, String)

    Declaration
    BasBEInformaDBAccount Edit(BasBETipos.EnumInformaDBIdentificationType idType, string idValue)
    Parameters
    Type Name Description
    BasBETipos.EnumInformaDBIdentificationType idType
    System.String idValue
    Returns
    Type Description
    BasBEInformaDBAccount

    Exists(BasBETipos.EnumInformaDBIdentificationType, String)

    Validates if an entity is being monitored on Informa DB API.

    Declaration
    bool Exists(BasBETipos.EnumInformaDBIdentificationType idType, string idValue)
    Parameters
    Type Name Description
    BasBETipos.EnumInformaDBIdentificationType idType

    The type of ID (VAT or DUNS)

    System.String idValue

    The value of the field

    Returns
    Type Description
    System.Boolean

    Entity is being monitored or not

    FillBaseInformation(BasBEInformaDBAccount)

    Declaration
    CompanyFileItem FillBaseInformation(BasBEInformaDBAccount informaAccount)
    Parameters
    Type Name Description
    BasBEInformaDBAccount informaAccount
    Returns
    Type Description
    CompanyFileItem

    FillInformation(BasBEInformaDBAccount, Boolean, Boolean)

    Declaration
    void FillInformation(BasBEInformaDBAccount informaAccount, bool save, bool getProducts = false)
    Parameters
    Type Name Description
    BasBEInformaDBAccount informaAccount
    System.Boolean save
    System.Boolean getProducts

    FillNotifications(BasBEInformaDBAccount, Boolean)

    Declaration
    void FillNotifications(BasBEInformaDBAccount informaAccount, bool save = false)
    Parameters
    Type Name Description
    BasBEInformaDBAccount informaAccount
    System.Boolean save

    GetAccountNotifications(BasBETipos.EnumInformaDBIdentificationType, String)

    Gets all notifications for an entity.

    Declaration
    List<BasBEInformaDBNotification> GetAccountNotifications(BasBETipos.EnumInformaDBIdentificationType idType, string idValue)
    Parameters
    Type Name Description
    BasBETipos.EnumInformaDBIdentificationType idType

    Type of identification

    System.String idValue

    Identification value

    Returns
    Type Description
    System.Collections.Generic.List<BasBEInformaDBNotification>

    List of notifications

    GetAllMonitoredAccounts()

    Retrieves all monitored informaDB accounts

    Declaration
    List<BasBEInformaDBAccount> GetAllMonitoredAccounts()
    Returns
    Type Description
    System.Collections.Generic.List<BasBEInformaDBAccount>

    GetStringTableEntry(String, String, Boolean)

    Declaration
    string GetStringTableEntry(string table, string resourceId, bool refreshFromService = false)
    Parameters
    Type Name Description
    System.String table
    System.String resourceId
    System.Boolean refreshFromService
    Returns
    Type Description
    System.String

    GetUserProducts(BasBETipos.EnumInformaDBIdentificationType, String, Boolean)

    Declaration
    List<BasBEInformaDBProduct> GetUserProducts(BasBETipos.EnumInformaDBIdentificationType idType, string idValue, bool refreshFromService = false)
    Parameters
    Type Name Description
    BasBETipos.EnumInformaDBIdentificationType idType
    System.String idValue
    System.Boolean refreshFromService
    Returns
    Type Description
    System.Collections.Generic.List<BasBEInformaDBProduct>

    InsertStringTableEntry(BasBEInformaDBStringTableEntry)

    Declaration
    void InsertStringTableEntry(BasBEInformaDBStringTableEntry entry)
    Parameters
    Type Name Description
    BasBEInformaDBStringTableEntry entry

    SaveAccountNotifications(BasBEInformaDBAccount)

    Declaration
    void SaveAccountNotifications(BasBEInformaDBAccount informaAccount)
    Parameters
    Type Name Description
    BasBEInformaDBAccount informaAccount

    Update(BasBEInformaDBAccount)

    Declaration
    void Update(BasBEInformaDBAccount informaAccount)
    Parameters
    Type Name Description
    BasBEInformaDBAccount informaAccount