Esta operação cria uma empresa. Quando você o cria, ele salva os anexos do caso e seus campos adicionais. Depois de salvá-los, ele os exclui da pasta temporária criada para ele.
Detalhes da petição
- URL Base: {host}/ASMSAPI/
- URI:
/api/v9/company
- Cara:POSTAR
-
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`
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Endereço1 | Texto | Não | Primeiro campo de endereço |
Endereço2 | Texto | Não | Segundo campo de endereço |
Endereço3 | Texto | Não | Terceiro campo de endereço |
Identificação da cidade | Número | Não | Identificador da cidade |
Nome da cidade | Texto | Não | Nome descritivo da cidade em que a empresa está localizada |
Contato | Texto | Não | Contato principal da empresa |
Identificação do país | Número | Não | Identificador do país onde a empresa está localizada |
Nome do país | Texto | Sim | Nome amigável do país onde a empresa está localizada |
Descrição | Texto | Não | Ações corretivas quando o caso é marcado como um grande problema |
Texto | Não | E-mail do contato principal da empresa | |
Ext | Texto | Não | Ramal telefônico do contato principal da empresa |
Número de fax | Texto | Não | Número de fax do contato principal da empresa |
Id | Número | Não | Identificador da empresa |
éAtivo | Booleano | Não | Verdadeiro se a empresa estiver ativa |
Localização | Texto | Não | Localização |
Mobil | Texto | Não | Número de telemóvel do principal contacto da empresa |
Nome | Texto | Sim | Nome amigável da empresa |
Lêndea | Texto | Sim | Número de identificação fiscal da empresa (NIT) |
Telefone1 | Texto | Não | O primeiro telefone da empresa |
Telefone2 | Texto | Sim | Segundo telefone da empresa |
Telefone3 | Texto | Não | Terceiro telefone da empresa |
StatusId | Número | Sim | ID do estado |
URL do Site | Texto | Não | URL do site da empresa |
ID do projeto | Número | Sim | ID do projeto |
Tipo de console | Número | Sim | A ID do console que origina a solicitação. A criação só é permitida no Admin Console (Valor 3) |
Tipo de registro | Número | Sim | Tipo de registro a ser criado: Empresa = 38, Fornecedor = 58 |
Campos adicionais (ListAdditionalField)
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
boolValue | Booleano | Não | Valor booleano do campo adicional |
Descrição | Texto | Não | Descrição do campo adicional |
habilitar | Booleano | Sim | Determina se o campo adicional está ativo |
ordem | Número | Não | Ordem a ter em conta na lista de campos adicionais |
dateValue | Data | Não | Valor de data do campo adicional |
ID do campo | Número | Sim | Identificador de campo adicional |
tipo de campo | Número | Sim | Tipo de campo adicional |
valor flutuante | Número | Não | Valor decimal do campo adicional |
identificador | Texto | Não | Identificador de campo adicional |
ID do item | Riacho | Não | Valor de byte do arquivo para o campo adicional |
intValue | Número | Não | Valor em número para o campo adicional |
stringValue | Texto | Não | Valor de texto do campo adicional |
obrigatório | Booleano | Sim | Se o campo adicional é obrigatório ou não |
Nome | Texto | Sim | Nome de identificação do campo |
visível | Booleano | Sim | O campo adicional deve estar visível ou não nos formulários |
tipo | Número | Não | Tipo de objeto que representa o objeto pai |
Corpo da petição
{
"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,
"listAdditionalField": [
{
"boolValue": null,
"catalogId": null,
"dateValue": null,
"fieldId": 977,
"fieldType": 3,
"floatValue": null,
"identifier": "A001",
"inputStream": null,
"intValue": 118,
"stringValue": "Aranda Data Safe",
"mandatory": true
},
{
"boolValue": null,
"catalogId": null,
"dateValue": null,
"fieldId": 978,
"fieldType": 3,
"floatValue": null,
"inputStream": null,
"intValue": 146,
"mandatory": true,
"stringValue": "Aranda Virtual Support"
}
]
}
Responder
{
"id": 1
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
Id | Número | Identificador da empresa |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | \r\nNome do parâmetro: ConsoleType |
400 | Solicitação BadRequest | \r\nNome do parâmetro: Nome |
400 | Solicitação BadRequest | \r\nNome do parâmetro: RegisterType |
400 | Solicitação BadRequest | InvalidProjectId |
400 | Solicitação BadRequest | StateIdIsEmpty |
400 | Solicitação BadRequest | Tipo de registro inválido |
400 | Solicitação BadRequest | Console inválido |
403 | Proibido | DoNotHavePermissionForThisAction |
500 | Erro de servidor interno | FalhaAdicionarEmpresa |