Webservicesqmb: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{QuatenusHeader}} | {{QuatenusHeader}} | ||
= Web Services Quatenus® Core | = Web Services Quatenus® Core = | ||
== 📌 Introdução == | == 📌 Introdução == | ||
Documentação dos Web Services do Quatenus® Core para integração e obtenção de dados. | |||
Versão: 12.00 | Versão: 12.00 | ||
Fonte: | Fonte: | ||
== | == 🧭 Estrutura == | ||
=== | === 📦 Licenciamento === | ||
[[QBM/WebServices/GetPartnerCodesFamilies]] | |||
[[QBM/WebServices/GetLicensableItems]] | |||
[[QBM/WebServices/GetLicensableItemExtras]] | |||
=== | === 📱 Ativos === | ||
[[QBM/WebServices/GetAssetBrands]] | |||
[[QBM/WebServices/GetAssetModels]] | |||
[[QBM/WebServices/GetDeviceClasses]] | |||
=== | === 🚗 Frota === | ||
[[QBM/WebServices/GetVehiclesBrands]] | |||
[[QBM/WebServices/GetVehiclesModels]] | |||
[[QBM/WebServices/GetVehiclesClassType]] | |||
[[QBM/WebServices/GetFuelTypes]] | |||
=== 👤 Entidades === | === 👤 Entidades === | ||
[[QBM/WebServices/GetCustomers]] | |||
[[QBM/WebServices/GetPartners]] | |||
=== 📄 Documentos === | === 📄 Documentos === | ||
[[QBM/WebServices/GetExternalContracts]] | |||
[[QBM/WebServices/GetBillingEvents]] | |||
=== 💰 Pagamentos === | === 💰 Pagamentos === | ||
[[QBM/WebServices/GetPaymentTerms]] | |||
== | == 🔐 Autenticação == | ||
Parâmetros comuns: | |||
{| class="wikitable" | {| class="wikitable" | ||
! Campo !! Descrição | ! Campo !! Descrição | ||
userName | userName | ||
- | - | ||
| Line 124: | Line 58: | ||
} | } | ||
{{QuatenusFooter}} | |||
🧩 Template Base (para cada serviço) | |||
Usa isto como padrão para todas as páginas 👇 | |||
{{QuatenusHeader}} | |||
} | |||
= | = <Nome do Serviço> = | ||
=== | == 📌 Descrição == | ||
Descrição funcional do serviço. | |||
--- | |||
== | == 🌐 Endpoint == | ||
<code> | |||
URL_DO_SERVIÇO | |||
</code> | |||
--- | |||
== 🔐 Autenticação == | |||
* userName | |||
* password | |||
* token (opcional) | |||
--- | |||
== | == 📥 Parâmetros == | ||
{| class="wikitable" | |||
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo | |||
|- | |||
| filter || string || ❌ || Filtro de pesquisa || "Fleet" | |||
|} | |||
--- | |||
== 📤 Resposta == | |||
= | {| class="wikitable" | ||
! Campo !! Tipo !! Descrição | |||
|- | |||
| Rows || object[] || Lista de resultados | |||
|- | |||
| TotalRows || int || Total de registos | |||
|} | |||
--- | |||
== | == 📄 Estrutura do Objeto == | ||
{| class="wikitable" | |||
! Campo !! Tipo !! Descrição | |||
|- | |||
| Id || int || Identificador | |||
|} | |||
--- | |||
== 🧪 Exemplo == | |||
<code> | |||
URL_EXEMPLO | |||
</code> | |||
--- | |||
== | == ⚠️ Notas == | ||
* Observações importantes | |||
--- | |||
{{QuatenusFooter}} | |||
🔧 Exemplo Real (já pronto) | |||
👉 GetLicensableItems | |||
{{QuatenusHeader}} | |||
= | = GetLicensableItems = | ||
Obtém | == 📌 Descrição == | ||
Obtém lista de produtos QBM licenciáveis. | |||
== | == 🌐 Endpoint == | ||
<code> .../QbmItemsServices.svc/GetLicensableItems </code> | |||
== 📥 Parâmetros == | |||
{| class="wikitable" | |||
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo | |||
filter | |||
- | |||
familyIds | |||
- | |||
currencyId | |||
- | |||
requestDate | |||
- | |||
args | |||
} | |||
== ⚙️ Filtros Avançados (args) == | |||
<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code> | |||
== 📤 Resposta == | |||
= | {| class="wikitable" | ||
! Campo !! Tipo !! Descrição | |||
Rows | |||
- | |||
TotalRows | |||
} | |||
== | == 📄 Estrutura do Objeto == | ||
{| class="wikitable" | |||
! Campo !! Tipo !! Descrição | |||
Code | |||
- | |||
Description | |||
- | |||
ItemType | |||
- | |||
UnitPrice | |||
- | |||
TaxRate | |||
} | |||
== 🧪 Exemplo == | |||
<code> .../GetLicensableItems?userName=xxx&password=xxx </code> | |||
== | == ⚠️ Notas == | ||
Pode usar filtros por unidade (M, Y, U, etc.) | |||
Pode filtrar por produtos ou serviços | |||
{{QuatenusFooter}} | {{QuatenusFooter}} | ||
Revision as of 15:20, 28 April 2026
Web Services Quatenus® Core
📌 Introdução
Documentação dos Web Services do Quatenus® Core para integração e obtenção de dados.
Versão: 12.00 Fonte:
🧭 Estrutura
📦 Licenciamento
QBM/WebServices/GetPartnerCodesFamilies QBM/WebServices/GetLicensableItems QBM/WebServices/GetLicensableItemExtras
📱 Ativos
QBM/WebServices/GetAssetBrands QBM/WebServices/GetAssetModels QBM/WebServices/GetDeviceClasses
🚗 Frota
QBM/WebServices/GetVehiclesBrands QBM/WebServices/GetVehiclesModels QBM/WebServices/GetVehiclesClassType QBM/WebServices/GetFuelTypes
👤 Entidades
QBM/WebServices/GetCustomers QBM/WebServices/GetPartners
📄 Documentos
QBM/WebServices/GetExternalContracts QBM/WebServices/GetBillingEvents
💰 Pagamentos
QBM/WebServices/GetPaymentTerms
🔐 Autenticação
Parâmetros comuns:
| Campo | Descrição
userName - password - token }
🧩 Template Base (para cada serviço) Usa isto como padrão para todas as páginas 👇 <Nome do Serviço>📌 DescriçãoDescrição funcional do serviço. --- 🌐 Endpoint
--- 🔐 Autenticação
--- 📥 Parâmetros
--- 📤 Resposta
--- 📄 Estrutura do Objeto
--- 🧪 Exemplo
--- ⚠️ Notas
---
🔧 Exemplo Real (já pronto) 👉 GetLicensableItems GetLicensableItems📌 DescriçãoObtém lista de produtos QBM licenciáveis. 🌐 Endpoint
📥 Parâmetros
|
|---|
