Detalhes da petição
- URL Base: {host}/ASMSAPI/
- URI:
/api/v9/company/{id}
- Cara:OBTER
-
Cabeçalhos necessários:
content-type: application/json
X-Authorization: Bearer {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/{id}
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Id | Número | Sim | Identificador da empresa |
Corpo da petição
N/A
Exemplos de Uri
/api/v9/company/1
Responder
{
"Address1": "",
"Address2": "",
"Address3": "",
"CityId": 4,
"CityName": "Cali",
"Contact": "Servicio al cliente",
"CountryId": 2,
"CountryName": "Colombia",
"Description": "Empresa Guia",
"Email": "correo@empresaguia.com",
"Ext": "",
"FaxNumber": "",
"Id": "",
"isActive": true,
"Location": "",
"Mobil": "3111111111",
"Name": "Guia",
"Nit": "80090000909",
"Phone1": "6022002020",
"Phone2": "6023003030",
"Phone3": "",
"StatusId": "1",
"WebSiteURL": "",
"ProjectId": "25",
"ConsoleType": 3,
"RegisterType": 38
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
totalItems | Número | Número total de objetos encontrados |
conteúdo | Lista | Lista de itens |
hasIntegration | Texto | Determine se a empresa tem integrações |
Id | Número | Identificação de usuário |
identificação do local | Número | Identificador de localização da empresa |
Nome | Texto | Nome da empresa |
ID do projeto | Texto | ID do projeto associado |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
500 | Erro de servidor interno | FalhaGetCompanies |