PT
Español
English
Português
    Publicando uma empresa

    Detalhes da petição

    • URL Base: {host}/ASMSAPI/
    • URI: api/v9/company/{id}
    • Cara: PÔR

    • Títulos obrigató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
    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
    Contato Texto Não Contato principal da empresa
    Identificação do país Número Não Identificador de país
    Nome do país Texto Sim Nome descritivo do país
    Descrição Texto Não Entendendo as ações corretivas
    Email Texto Não E-mail de contato principal
    Ext Texto Não Ramal telefônico de contato principal
    Número de fax Texto Não Número de fax do contato principal
    Id Número Sim 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 celular do contato principal
    Nome Texto Sim Nome amigável da empresa
    Lêndea Texto Sim NIT (Número de Identificação Fiscal)
    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 Número Sim URL do site
    ID do projeto Número Sim ID do projeto
    Tipo de console Número Sim Identificador do console que origina a solicitação
    Tipo de registro Número Sim Tipo de registro a ser criado


    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 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
    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": "Calle 14 # 45 -12",
    "Address2": "Edificio Guia",
    "Address3": "",
    "CityId": 4,
    "CityName": "Cali",
    "Contact": "Servicio al cliente",
    "CountryId": 2,
    "CountryName": "Colombia",
    "Description": "Empresa Guia",
    "Email": "correo@empresaguia.com",
    "Ext": "",
    "FaxNumber": "",
    "Id": "1",
    "isActive": true,
    "Location": "",
    "Mobil": "3111111111",
    "Name": "Guia",
    "Nit": "80090000909",
    "Phone1": "6022002020",
    "Phone2": "6023003030",
    "Phone3": "",
    "StatusId": "1",
    "WebSiteURL": "http://www.empresaguia.com",
    "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
        }
    ]
}

    Responder

    {
    "Result": true
}

    Parâmetros de resposta

    Nome Tipo de dado Descrição
    resultado Booleano Resultado da operação

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest Nome do parâmetro: Id
    400 Solicitação BadRequest Nome do parâmetro: ConsoleType
    400 Solicitação BadRequest Nome do parâmetro: Nome
    400 Solicitação BadRequest Nome 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 FailureUpdateCompany