PT
Español
English
Português
    Gestão da empresa

    Esta seção descreve as operações relacionadas à gestão de empresas (criação, edição).

    Adicionar uma empresa

    Detalhes da petição

    • URI: api/v8.6/company/add/{projectId}/type/{type}
    • Tipo: POST

    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização: TOKEN

    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    ID do projeto Número Sim ID do projeto no qual a empresa será criada.
    tipo Número Sim 1 = Empresa, 2 = Fornecedor
    COGNOME Texto Sim Apelidos da empresa.
    LATITUDE Número Não Empresa de localização Latitude.
    COMPRIMENTO Número Não Empresa de localização de comprimento
    GOOGLEADDRES Texto Não Endereço salvo no mapa
    (geolocalização)      
    LÊNDEA Texto Sim Identificador da empresa.
    LOCAL NA REDE INTERNET Texto Não Local na rede Internet
    EMAIL Texto Não Email
    DESCRIÇÃO Texto Não Descrição da empresa.
    CONTATO Texto Não Nome do contato.
    NOME DA EMPRESA Texto Sim Nome da empresa.
    ID DO PAÍS Número Não ID do país.
    CITYID Número Não ID da cidade.
    ENDEREÇO Texto Não Endereço 1.
    ADDRESS2 Texto Não Endereço 2.
    ADDRESS3 Texto Não Endereço 3.
    ADDITIONALFIELD1 Texto Não Campo adicional.
    ADDITIONALFIELD2 Texto Não Campo adicional.
    ADDITIONALFIELD3 Texto Não Campo adicional.
    ADDITIONALFIELD4 Texto Não Campo adicional.
    ADDITIONALFIELD5 Texto Não Campo adicional.
    ADDITIONALFIELD6 Texto Não Campo adicional.
    ADDITIONALFIELD7 Texto Não Campo adicional.
    ADDITIONALFIELD8 Texto Não Campo adicional.
    ADDITIONALFIELD9 Texto Não Campo adicional.
    ADDITIONALFIELD10 Texto Não Campo adicional.
    ID DE ESTADO Número Não ID de status. O valor 1..

    Corpo da petição

    Em Campo, você pode usar os parâmetros descritos acima, exceto para o URI (projectId, type). Os valores mínimos para criação são os seguintes.

    [
    {
        "Field": "ALIAS",
        "Value": "Aranda test"
    },
    {
        "Field": "NIT",
        "Value": "9052646"
    },
    {
        "Field": "COMPANYNAME",
        "Value": "Aranda test"
    },
    {
        "Field": "STATEID",
        "Value": "1"
    }
]

    Responder

    O serviço retornará um número inteiro que é o id da empresa criada, exemplo: 10091

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest InvalidProjectId
    400 Solicitação BadRequest Tipo inválido
    400 Solicitação BadRequest Empresa Inválida
    400 Solicitação BadRequest InvalidCompanyAlias
    400 Solicitação BadRequest InvalidCompanyId


    Editar uma empresa

    Detalhes da petição

    • URI: api/v8.6/company/update/{projectId}/{id}
    • Tipo: POST

    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização: TOKEN

    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    ID do projeto Número Sim ID do projeto ao qual a empresa pertence.
    Id Número Sim ID da empresa
    LATITUDE Número Não Empresa de localização Latitude.
    COMPRIMENTO Número Não Empresa de localização de comprimento
    GOOGLEADDRES Texto Não  
    LÊNDEA Texto Sim Identificador da empresa.
    LOCAL NA REDE INTERNET Texto Não Local na rede Internet
    EMAIL Texto Não Email
    DESCRIÇÃO Texto Não Descrição da empresa.
    CONTATO Texto Não Nome do contato.
    NOME DA EMPRESA Texto Sim Nome da empresa.
    ID DO PAÍS Número Não ID do país.
    CITYID Número Não ID da cidade.
    ENDEREÇO Texto Não Endereço 1.
    ADDRESS2 Texto Não Endereço 2.
    ADDRESS3 Texto Não Endereço 3.
    ADDITIONALFIELD1 Texto Não Campo adicional.
    ADDITIONALFIELD2 Texto Não Campo adicional.
    ADDITIONALFIELD3 Texto Não Campo adicional.
    ADDITIONALFIELD4 Texto Não Campo adicional.
    ADDITIONALFIELD5 Texto Não Campo adicional.
    ADDITIONALFIELD6 Texto Não Campo adicional.
    ADDITIONALFIELD7 Texto Não Campo adicional.
    ADDITIONALFIELD8 Texto Não Campo adicional.
    ADDITIONALFIELD9 Texto Não Campo adicional.
    ADDITIONALFIELD10 Texto Não Campo adicional.
    ID DE ESTADO Número Não ID de status. O valor 1..

    Corpo da petição

    Em Campo, você pode usar os parâmetros descritos acima, exceto para o URI (projectId, id).

    [
    {
    "Field": "COMPANYNAME",
    "Value": "Aranda edit"
    }
   ]

    Responder

    O serviço retornará um booleano indicando se a operação foi realizada. Exemplo: true indica que a edição foi bem-sucedida.

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest InvalidProjectId
    400 Solicitação BadRequest InvalidCompanyId
    500 Erro de servidor interno FailureUpdateCompany