Você obtém uma lista de empresas que correspondem a um nome ou parte do nome de uma empresa.
Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}
- 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.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}
Parâmetros
| Nome | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| nomeDaempresa | Texto | Sim | Nome completo ou parcial das empresas que você deseja encontrar |
| ID do projeto | Número | Não | ID do projeto |
| matchName | Booleano | Não | Determine se a pesquisa deve ser precisa |
Corpo da petição
N/A
Exemplos de uri
api/v9/company/getbyname?companyName=Guia&projectId=25&matchName=true
Responder
Resposta de amostra
{
"description": "Aranda software",
"Id": 2,
"isActive": true,
"location": "",
"name": "Aranda Software",
"nit": "1",
"stateId": 1
}
Parâmetros de resposta
| Título | Tipo de dado | Descrição |
|---|---|---|
| Descrição | Texto | Descrição da empresa |
| Id | Número | ID da empresa |
| éAtivo | Booleano | Determine se a empresa está ativa |
| Localização | Texto | Localização da empresa |
| Nome | Texto | Nome da empresa |
| Lêndea | Texto | NIT da empresa |
| Identificação do estado | Número | ID do estado |
Mensagens de erro
| Código | Status HTTP | Mensagem de erro |
|---|---|---|
| 400 | Solicitação de Bac | IdNotEmpty |
| 500 | Erro de servidor interno | FalhaGetCompanyByName |