integracoes:web-services-listar-listar-faturas-pagas
no way to compare when less than two revisions
Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
— | integracoes:web-services-listar-listar-faturas-pagas [12/12/2019 18:37] (atual) – criada tadeu.sarmento | ||
---|---|---|---|
Linha 1: | Linha 1: | ||
+ | {{ajuda: | ||
+ | |||
+ | ====== WebService Listar Faturas Pagas ====== | ||
+ | |||
+ | < | ||
+ | O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via **Query Parameter**. | ||
+ | |||
+ | Ele espera os seguintes Parâmetros: | ||
+ | - key, //String// contendo a chave de autenticação da empresa. | ||
+ | - value, //String// contendo a matrícula que será usada como filtro. | ||
+ | - ano, //Integer// ano que será usado como filtro. | ||
+ | </ | ||
+ | \\ | ||
+ | |||
+ | ===== Exemplo de requisição para o sistema ===== | ||
+ | |||
+ | Com as seguintes informações: | ||
+ | |IP|192.168.64.111| | ||
+ | |Chave de autenticação|aBC123DEF| | ||
+ | |Matrícula|5101433| | ||
+ | |Ano|2019| | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== A Requisição Seria ===== | ||
+ | |||
+ | http:// | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Retorno em Caso de Sucesso ===== | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | \\ | ||
+ | |||
+ | **Exemplo**: | ||
+ | |||
+ | <WRAP center round box 100%> | ||
+ | {{ : | ||
+ | </ | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Retorno em Caso de erro ===== | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | **Exemplo**: | ||
+ | |||
+ | \\ | ||
+ | <WRAP center round box 100%> | ||
+ | {{ : | ||
+ | </ | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Possíveis Códigos de Retorno ===== | ||
+ | |Código|Mensagem| | ||
+ | |400|" | ||
+ | |401|" | ||
+ | |404|" | ||
+ | |500|“”| | ||
+ | \\ | ||
+ | |||
+ | Clique **[[=treinamentos: |
integracoes/web-services-listar-listar-faturas-pagas.txt · Última modificação: 12/12/2019 18:37 por tadeu.sarmento