Webservicesqmb: Difference between revisions
From QuatenusWiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{QuatenusHeader}} | {{QuatenusHeader}} | ||
= | = GetLicensableItems = | ||
== 📌 Descrição == | == 📌 Descrição == | ||
Este serviço obtém uma lista de produtos QBM que correspondem a produtos licenciáveis das gamas Quatenus. | |||
--- | --- | ||
== 🌐 Endpoint == | == 🌐 Endpoint == | ||
<code> | <code> | ||
.../QbmItemsServices.svc/GetLicensableItems | |||
</code> | </code> | ||
| Line 82: | Line 16: | ||
== 🔐 Autenticação == | == 🔐 Autenticação == | ||
* userName | |||
* userName | * password | ||
* password | * token | ||
* token | |||
--- | --- | ||
| Line 92: | Line 25: | ||
{| class="wikitable" | {| class="wikitable" | ||
! Nome !! Tipo !! Obrigatório !! Descrição !! Exemplo | ! Nome !! Tipo !! Obrigatório !! Descrição !! Valor por omissão !! Exemplo | ||
|- | |||
| filter || String || ❌ || Filtro de pesquisa || "" || Fleet | |||
|- | |||
| familyIds || String || ❌ || Lista de IDs de gamas || "" || 114 | |||
|- | |||
| cultureInfo || String || ❌ || Cultura do servidor || pt-PT || en-US | |||
|- | |||
| timeZoneId || String || ❌ || Fuso horário || GMT || GMT Standard Time | |||
|- | |||
| pageNumber || String || ❌ || Página atual || "" || 1 | |||
|- | |||
| rowsPerPage || String || ❌ || Nº registos || "" || 100 | |||
|- | |||
| sortColumnName || String || ❌ || Coluna de ordenação || Code || Description | |||
|- | |- | ||
| | | sortDirection || String || ❌ || Direção ordenação || ascending || descending | ||
| | |- | ||
| requestDate || String || ❌ || Data cálculo preço || 0001-01-01 00:00 || 2013-12-04 00:00 | |||
--- | |- | ||
| currencyId || String || ❌ || Moeda || 0 || 50 | |||
|- | |||
| fromBusinessEntityId || String || ❌ || Entidade fornecedora || 0 || 123 | |||
|- | |||
| toBusinessEntityId || String || ❌ || Entidade cliente || "" || 123 | |||
|- | |||
| userName || String || ✔ || Login || - || user@test.com | |||
|- | |- | ||
| | | password || String || ✔ || Password || - || ***** | ||
|- | |- | ||
| | | token || String || ❌ || Token || - || - | ||
| | |||
-- | |||
|- | |- | ||
| | | args || JSON || ❌ || Filtros avançados || - || ver abaixo | ||
|} | |} | ||
--- | --- | ||
== | == ⚙️ Filtros Avançados (args) == | ||
Formato JSON: | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"Data": { | |||
"Global": "", | |||
"Extra": "", | |||
"Units": "", | |||
"ItemTypes": "", | |||
"IsEnabledFilter": "ALL", | |||
"HasPriceFilter": "", | |||
"IsLicensedFilter": "" | |||
} | |||
} | |||
</syntaxhighlight> | |||
--- | --- | ||
== 📊 Valores Possíveis == | |||
=== Units === | |||
* B – Box | |||
* M – Month | |||
* Y – Year | |||
* U – Unit | |||
* L – License | |||
* D – Devices | |||
= | === ItemTypes === | ||
* P – Produto | |||
* S – Serviço | |||
== | === IsEnabledFilter === | ||
* ACTIVE | |||
* INACTIVE | |||
* ALL | |||
== | === IsLicensedFilter === | ||
* LICENSED | |||
* UNLICENSED | |||
* ALL | |||
=== Currency === | |||
* 50 – EUR | |||
* 21 – BRL | |||
--- | |||
== 📤 Resposta == | |||
== | |||
Tipo: <code>PagedData<QbmLicensableItemObject></code> | |||
{| class="wikitable" | {| class="wikitable" | ||
! Campo !! Tipo !! Descrição | |||
|- | |||
| Rows || object[] || Lista de items | |||
|- | |||
| TotalRows || int || Total de registos | |||
|} | |||
--- | |||
- | |||
== 📄 Estrutura do Objeto == | == 📄 Estrutura do Objeto == | ||
{| class="wikitable" | {| class="wikitable" | ||
! Campo !! Tipo !! Nullable !! Descrição | |||
|- | |||
| Code || String || ❌ || Código do item | |||
|- | |||
| Description || String || ❌ || Descrição | |||
|- | |||
| IsEnabled || Bool || ❌ || Item ativo | |||
|- | |||
| ItemType || Char || ❌ || Tipo (P/S) | |||
|- | |||
| PartnerCodeColor || String || ✔ || Cor | |||
|- | |||
| InsertedUser || String || ❌ || Criador | |||
|- | |||
| PartnerCodeFamilyId || Int || ✔ || ID da gama | |||
|- | |||
| PartnersCodeIsExtra || Bool || ✔ || É extra | |||
|- | |||
| PartnersCodeIsGlobal || Bool || ✔ || É global | |||
|- | |||
| PartnersCodeUnit || String || ✔ || Unidade | |||
|- | |||
| QbmItemId || Int || ❌ || ID do item | |||
|- | |||
| ShortDescription || String || ✔ || Descrição curta | |||
|- | |||
| Unit || Int || ✔ || Unidade de preço | |||
|- | |||
| UnitPrice || Decimal || ✔ || Preço | |||
|- | |||
| Discount || Decimal || ✔ || Desconto | |||
|- | |||
| TaxRate || Decimal || ✔ || IVA | |||
|- | |||
| CheckBox || Bool || ❌ || Campo técnico | |||
|- | |||
| DataAction || Object || ❌ || Interno | |||
|- | |||
| DataObjectDescription || String || ❌ || Interno | |||
|- | |||
| DataSource || Object || ❌ || Interno | |||
|- | |||
| GridIndex || Int || ❌ || Interno | |||
|- | |||
| Id || String || ❌ || Interno | |||
|- | |||
| UsageHistoryId || String || ✔ || Interno | |||
|} | |||
--- | |||
- | |||
- | |||
- | |||
== 🧪 Exemplo == | == 🧪 Exemplo == | ||
<code> .../GetLicensableItems?userName=xxx&password=xxx </code> | <code> | ||
.../GetLicensableItems?selectedLanguage=pt-PT&timeZoneId=GMT&userName=xxx&password=xxx | |||
</code> | |||
--- | |||
== ⚠️ Notas == | == ⚠️ Notas == | ||
* requestDate deve estar no formato: yyyy-MM-dd HH:mm | |||
* args é obrigatório em alguns cenários | |||
* Filtros podem impactar preços calculados | |||
{{QuatenusFooter}} | {{QuatenusFooter}} | ||
Revision as of 15:25, 28 April 2026
GetLicensableItems
📌 Descrição
Este serviço obtém uma lista de produtos QBM que correspondem a produtos licenciáveis das gamas Quatenus.
---
🌐 Endpoint
.../QbmItemsServices.svc/GetLicensableItems
---
🔐 Autenticação
- userName
- password
- token
---
📥 Parâmetros
| Nome | Tipo | Obrigatório | Descrição | Valor por omissão | Exemplo |
|---|---|---|---|---|---|
| filter | String | ❌ | Filtro de pesquisa | "" | Fleet |
| familyIds | String | ❌ | Lista de IDs de gamas | "" | 114 |
| cultureInfo | String | ❌ | Cultura do servidor | pt-PT | en-US |
| timeZoneId | String | ❌ | Fuso horário | GMT | GMT Standard Time |
| pageNumber | String | ❌ | Página atual | "" | 1 |
| rowsPerPage | String | ❌ | Nº registos | "" | 100 |
| sortColumnName | String | ❌ | Coluna de ordenação | Code | Description |
| sortDirection | String | ❌ | Direção ordenação | ascending | descending |
| requestDate | String | ❌ | Data cálculo preço | 0001-01-01 00:00 | 2013-12-04 00:00 |
| currencyId | String | ❌ | Moeda | 0 | 50 |
| fromBusinessEntityId | String | ❌ | Entidade fornecedora | 0 | 123 |
| toBusinessEntityId | String | ❌ | Entidade cliente | "" | 123 |
| userName | String | ✔ | Login | - | user@test.com |
| password | String | ✔ | Password | - | ***** |
| token | String | ❌ | Token | - | - |
| args | JSON | ❌ | Filtros avançados | - | ver abaixo |
---
⚙️ Filtros Avançados (args)
Formato JSON:
{
"Data": {
"Global": "",
"Extra": "",
"Units": "",
"ItemTypes": "",
"IsEnabledFilter": "ALL",
"HasPriceFilter": "",
"IsLicensedFilter": ""
}
}
---
📊 Valores Possíveis
Units
- B – Box
- M – Month
- Y – Year
- U – Unit
- L – License
- D – Devices
ItemTypes
- P – Produto
- S – Serviço
IsEnabledFilter
- ACTIVE
- INACTIVE
- ALL
IsLicensedFilter
- LICENSED
- UNLICENSED
- ALL
Currency
- 50 – EUR
- 21 – BRL
---
📤 Resposta
Tipo: PagedData<QbmLicensableItemObject>
| Campo | Tipo | Descrição |
|---|---|---|
| Rows | object[] | Lista de items |
| TotalRows | int | Total de registos |
---
📄 Estrutura do Objeto
| Campo | Tipo | Nullable | Descrição |
|---|---|---|---|
| Code | String | ❌ | Código do item |
| Description | String | ❌ | Descrição |
| IsEnabled | Bool | ❌ | Item ativo |
| ItemType | Char | ❌ | Tipo (P/S) |
| PartnerCodeColor | String | ✔ | Cor |
| InsertedUser | String | ❌ | Criador |
| PartnerCodeFamilyId | Int | ✔ | ID da gama |
| PartnersCodeIsExtra | Bool | ✔ | É extra |
| PartnersCodeIsGlobal | Bool | ✔ | É global |
| PartnersCodeUnit | String | ✔ | Unidade |
| QbmItemId | Int | ❌ | ID do item |
| ShortDescription | String | ✔ | Descrição curta |
| Unit | Int | ✔ | Unidade de preço |
| UnitPrice | Decimal | ✔ | Preço |
| Discount | Decimal | ✔ | Desconto |
| TaxRate | Decimal | ✔ | IVA |
| CheckBox | Bool | ❌ | Campo técnico |
| DataAction | Object | ❌ | Interno |
| DataObjectDescription | String | ❌ | Interno |
| DataSource | Object | ❌ | Interno |
| GridIndex | Int | ❌ | Interno |
| Id | String | ❌ | Interno |
| UsageHistoryId | String | ✔ | Interno |
---
🧪 Exemplo
.../GetLicensableItems?selectedLanguage=pt-PT&timeZoneId=GMT&userName=xxx&password=xxx
---
⚠️ Notas
- requestDate deve estar no formato: yyyy-MM-dd HH:mm
- args é obrigatório em alguns cenários
- Filtros podem impactar preços calculados
