Páginas filhas
  • API Qualificações (Manutenção Industrial)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

AA Ambos"P" = Produto Serviço

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

Observação

id

Id único para rastreamento do registro de ponta a ponta

1210

NUMBER

S

N

-

-

Gerado automaticamente quando o registro é inserido na tabela.

codigoErp

Código de relacionamento com o ERP

15

STRING

N

N

-

-

-

razaoSocialdescricao

Razão socialDescrição

40

STRING

N

S

-

-

-

nomeFantasiadetalhe

Nome fantasiaDetalhamento

40500

STRING

N

S

-

-

-

endereco

Endereço e número

40

STRING

N

N

-

-

-

bairro

Bairro

40

STRING

N

N

-

-

-

cidade

Cidade

40

STRING

N

N

-

-

-

uf

Sigla da unidade federativa

2

STRING

N

N

-

Unidades Federativas do Brasil.

-

codigoCep

Código do CEP

9

STRING

N

N

-

-

-

numeroCaixaPostal

Número da caixa postal

9

STRING

N

N

-

-

-

cnpj

CNPJ

18

STRING

N

N

-

-

CNPJ será validado caso informado.

inscricaoEstadual

Inscrição estadual

18

STRING

N

N

-

-

-

numeroDDD

Número do DDD

4

STRING

N

N

-

-

-

numeroTelefone

Número do telefone

9

STRING

N

N

-

-

-

numeroFax

Número do fax

9

STRING

N

N

-

-

-

siteEmail

Site ou e-mail

40

STRING

N

N

-

-

-

classeFornecedor

Classe do fornecedor

utilizadoIndustria

Utiliza na Indústria

1

STRING

N

N

"

N"

"

N" =

Não

"S" =

Sim

-


GET (Consulta FornecedorQualificação)

http:127.0.0.1:8080/entity/v1/fornecedoresInd?page=1&pagesize=2qualificacoesInd

Bloco de código
languagejava
titleResponse
{
    "hasNext": falsetrue,
    "items": [
        {
            "id": 2,
            "codigoErp": "FORNEC23"null,
            "razaoSocialdescricao": "IDAJUSTADOR FORNECEDORMECANICO",
            "nomeFantasiadetalhe": "TESTE DE FORNCEDOR",
            "endereco": null,
            "bairroutilizadoIndustria": null,
            "cidade": null,"N"
            "uf": "SP"},
            "codigoCep": "19800000",{
            "numeroCaixaPostalid": null3,
            "cnpjcodigoErp": "38646495000101",
            "inscricaoEstadual": "189289389489",
            "numeroDDD": null,
            "numeroTelefonedescricao": null,
            "numeroFax": "18- 3302-"ALMOXARIFE",
            "siteEmaildetalhe": null,
            "classeFornecedorutilizadoIndustria": "AN"
        }
     ]
}

Parâmetros

  • page: Número da página.
  • pagesize: Quantidade máxima de registros por página.

...

  • Todos os atributos podem ser usados como parâmetro para a busca.


PUT/PATCH (Modifica FornecedorQualificação)

http:127.0.0.1:8080/entity/v1/fornecedoresIndqualificacoesInd

Estrutura de dados para envio (exemplo):

Bloco de código
languagejava
titleBody
collapsetrue
{
    "codigoErp": "FORNEC23", 
    "cnpj": "38.646.495/0001-01CARGO-0003",
    "inscricaoEstadualdescricao": "189.289.389-489",
    "codigoCep": "19800-000",
    "razaoSocial": "ID FORNECEDOR",
    "nomeFantasia": "TESTE DE FORNCEDOR",
    "endereco": null,
    "bairro": nullANALISTA DE SISTEMAS SR. III",
    "cidadedetalhe": null,
    "uf": "SP",
    "numeroCaixaPostal": null,
    "numeroDDD": null,
    "numeroTelefone": null,
    "numeroFax": "18- 3302-",
    "siteEmail": null,
    "classeFornecedor": "A"
"Pessoa responsável por analistar e implementar soluções tecnológicas para resolução dos problemas"
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{
    "id": 1,
    "codigoErp": "FORNEC23CARGO-0003", 
    "cnpj": "38646495000101",
    "inscricaoEstadual"descricao": "189289389489",
    "codigoCep": "19800000",
    "razaoSocial": "ID FORNECEDOR",
    "nomeFantasia": "TESTE DE FORNCEDOR",
    "endereco": nullANALISTA DE SISTEMAS SR. III",
    "bairrodetalhe": null,
    "cidade": null,
    "uf": "SP",
    "numeroCaixaPostal": null,
    "numeroDDD": null"Pessoa responsável por analistar e implementar soluções tecnológicas para resolução dos problemas",
    "numeroTelefoneid": null,
    "numeroFax": "18- 3302-",
    "siteEmail": null,
    "classeFornecedor": "A""10028"
}

Observações

  • Quando PATCH poderão ser informados apenas os atributos que necessitam de atualização.
  • No caso de PUT deverão ser informados os atributos necessários/obrigatórios.
  • Deverá ser informado ao menos um dos atributos para localização do Fornecedor da Qualificação (id ou codigoErp).
  • Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização do fornecedorda qualificação. Será realizada uma busca por outros fornecedores outras qualificações com IDs diferentes que utilizem o codigoErp informado e caso nenhum fornecedor seja encontrado, nenhuma qualificação seja encontrada o valor informado será atualizado para o fornecedor do id informadoalterado, e caso seja encontrado um encontrada uma ou mais fornecedores qualificações com IDs diferentes já utilizando este codigoErp uma mensagem será exibida e a atualização não poderá ser feita.
  • Quando PATCH poderão ser informados apenas os atributos que necessitam de atualização.
  • alteração não será realizada.
  • Caso apenas o atributo codigoErp for informado, será realizada uma busca pelas qualificações que utilizem esse código e caso sejam encontradas duas ou mais qualificações utilizando este codigoErp uma mensagem será exibida e a alteração não será realizadaNo caso de PUT deverão ser informados os atributos necessários/obrigatórios.
  • Caso o atributo cnpj seja informado, o conteúdo será validado aceitando apenas um cnpj válido.Caso os atributos cnpj, inscricaoEstadual e codigoCep forem informados, será removido caracteres especiais, mantendo-se apenas números e letras descricao for informado, será realizada uma busca por outras qualificações com IDs diferentes que utilizem a descricao informada e caso nenhuma qualificação seja encontrada o valor informado será alterado, e caso seja encontrada uma ou mais qualificações com IDs diferentes já utilizando essa descricao uma mensagem será exibida e a alteração não será realizada.


POST (Insere FornecedorQualificação)

http:127.0.0.1:8080/entity/v1/fornecedoresIndqualificacoesInd

Estrutura de dados para envio:

Bloco de código
languagejava
titleBody
collapsetrue
{
    "codigoErp": "FORNEC25CARGO-0003",
    "razaoSocialdescricao": "Razão social do fornecedorANALIST. DE SIST. SR. III",
    "nomeFantasiadetalhe": "Nome fantasia do fornecedorsem detalhes"
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{
    "codigoErp": "FORNEC25CARGO-0003",
    "razaoSocialdescricao": "Razão social do fornecedorANALIST. DE SIST. SR. III",
    "nomeFantasiadetalhe": "Nome fantasia do fornecedorsem detalhes",
    "classeFornecedorutilizadoIndustria": "AN",
    "id": "2310028"
}

Observações

  • O atributo id será gerado automaticamente e atribuído ao novo fornecedorà nova qualificação, e caso seja informado será desconsiderado.
  • Caso o atributo codigoErp for informado, será realizada uma busca por outros fornecedores outras qualificações que utilizem esse código e caso seja encontrado um caso seja encontrada uma ou mais fornecedores qualificações já utilizando este codigoErp uma mensagem será exibida e a inclusão não poderá ser feitaserá realizada.
  • Deverão ser informados os atributos requeridos razaoSocial e nomeFantasia.
  • Caso o atributo cnpj seja informado, o conteúdo será validado aceitando apenas um cnpj válido.
  • Caso os atributos cnpj, inscricaoEstadual e codigoCep forem informados, será removido caracteres especiais, mantendo-se apenas números e letrasO atributo descricao deverá ser informado. Será realizada uma busca por outras qualificações que utilizem essa descrição e caso nenhuma qualificação seja encontrada a inclusão será realizada, e caso seja encontrada uma ou mais qualificações já utilizando essa descricao uma mensagem será exibida e a inclusão não será realizada.


DELETE (Exclui FornecedorQualificação)

Disponibilizado endpoint para excluir o Fornecedora Qualificação.

Método DELETE:

http:127.0.0.1:8080/entity/v1/fornecedoresIndqualificacoesInd

Parâmetros

  • Deverá ser informado ao menos um dos atributos para localização do Fornecedor da Qualificação (id ou codigoErp).
  • Caso seja informado apenas o atributo codigoErp, será realizada uma busca por fornecedores pelas qualificações que utilizem esse código e caso seja encontrado dois código e caso sejam encontradas duas ou mais fornecedores qualificações utilizando este codigoErp uma mensagem será exibida e a deleção não poderá ser feitaserá realizada.
  • Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização e exclusão do fornecedor da qualificação e o codigoErp será desconsiderado.
  • Caso o registro do fornecedor da qualificação esteja sendo utilizado por registros de outras tabelas relacionadas a exclusão não será permitida realizada e uma mensagem será exibida.

...