PT
Español
English
Português
    Pesquisa de empresa

    Você obtém uma lista de empresas ou fornecedores que correspondem aos seus critérios de pesquisa.

    Detalhes da petição

    • URL base: {host}/ASMSAPI/
    • Uri: /api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}
    • Tipo: GET

    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização X: Portador {token}

    Descrição do URL

    • {host}: Ele representa o domínio do ambiente no qual a API está localizada.
    • ASMSAPI/: Prefixo de API fixo.
    • URI: Ponto de extremidade específico para a solicitação.


    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}


    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    tipo de item Enumerador Sim Tipo de pesquisa (Compañia = 38, Proveedor = 58)
    ID do projeto Número Não ID do projeto
    ID do cliente Número Não ID do cliente
    ID do serviço Número Não Identificador de serviço
    Critérios Texto Não Texto de pesquisa do usuário
    filterCaseUser Texto Não Determine se você deve pré-filtrar por cliente

    Corpo da petição

    N/A

    Exemplos de uri

    • api/v9/company/search?itemType=38&projectId=2&criteria=Guia
    • api/v9/company/search?itemType=58&projectId=2
    • api/v9/company/search?itemType=38&projectId=2&criteria=

    Responder

    {
    "content": [
        {
            "hasIntegration": false,
            "id": 1,
            "locationId": 2,
            "name": "Guia",
            "projectId": 25
        }
    ],
    "totalItems": 1
}

    Parâmetros de resposta

    Nome Tipo de dado Descrição
    Endereço1 Texto Primeiro campo de endereço
    Endereço2 Texto Segundo campo de endereço
    Endereço3 Texto Terceiro campo de endereço
    Identificação da cidade Número Identificador da cidade
    Nome da cidade Texto Nome descritivo da cidade
    Contato Texto Contato principal da empresa
    Identificação do país Número Identificador do país onde a empresa está localizada
    Nome do país Texto Nome amigável do país onde a empresa está localizada
    Descrição Texto Ações corretivas quando o caso é marcado como um grande problema
    Email Texto E-mail do contato principal da empresa
    Ext Texto Ramal telefônico do contato principal da empresa
    Número de fax Texto Número de fax do contato principal da empresa
    Id Número Identificador da empresa
    éAtivo Booleano Verdadeiro se a empresa estiver ativa
    Localização Texto Localização
    Mobil Texto Número de telemóvel do principal contacto da empresa
    Nome Texto Nome amigável da empresa
    Lêndea Texto Número de identificação fiscal da empresa (NIT)
    Telefone1 Texto O primeiro telefone da empresa
    Telefone2 Texto Segundo telefone da empresa
    Telefone3 Texto Terceiro telefone da empresa
    StatusId Número ID do estado
    URL do Site Texto URL do site da empresa
    ID do projeto Número ID do projeto
    Tipo de console Número Identificador do console que origina a solicitação
    Tipo de registro Número Tipo de registro a ser criado (Compañia = 38, Proveedor = 58)

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest IdNotEmpty
    500 Erro de servidor interno FalhaGetDetail