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 = 52)
    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=52&projectId=2
    • api/v9/company/search?itemType=38&projectId=2&criteria=

    Responder

    {
    "content": [
        {
            "id": 1,
            "locationId": 2,
            "name": "Guia"
        }
    ],
    "totalItems": 1
}

    Parâmetros de resposta

    Título Tipo de dado Descrição
    Id Número ID da empresa
    Localização Texto Localização da empresa
    Nome Texto Nome da empresa

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    403 Proibido Acesso negado
    500 Erro de servidor interno FalhaGetDetail