Atividades e relacionados (Section SubGroup (Subgrupo da Seção))

Descrição de um subgrupo da seção

OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.

Inserir subgrupo na seção

POST /CenterWeb/api/{$apiKey}/sectionSubGroup.xml

Esta operação serve para incluir um subgrupo em uma seção do sistema.

Veja um exemplo da requisição com dados em XML utilizando o Identificador Interno do subgrupo e do item:

<sectionSubGroup>

<subGroup>

<id>{subGroupId}</id>

</subGroup>

<section>

<id>{sectionId}</id>

</section>

</sectionSubGroup>

Veja um exemplo da requisição com dados em XML utilizando o Identificador Alternativo do subgrupo e do item:

<sectionSubGroup>

<subGroup>

<alternativeIdentifier>{subGroupAltId}</alternativeIdentifier>

</subGroup>

<section>

<alternativeIdentifier>{sectionAltId}</alternativeIdentifier>

</section>

</sectionSubGroup>

Alterar subgrupo da seção

POST /CenterWeb/api/{$apiKey}/sectionSubGroup/antigoSubgrupo/minhaSecao.xml

Esta operação serve para alterar o subgrupo ou a seção de uma relação entre um subgrupo da seção do sistema. Você deve informar na URL o Alternative do antigo subgrupo e na requisição o dado do subgrupo que irá substituí-lo.

Veja um exemplo da requisição com dados em XML utilizando o identificador interno do subgrupo e do item:

<sectionSubGroup>

<subGroup>

<id>{subGroupId}</id>

</subGroup>

<section>

<id>{sectionId}</id>

</section>

</sectionSubGroup>

Veja um exemplo da requisição com dados em XML utilizando o Identificador Alternativo do subgrupo e do item:

<sectionSubGroup>

<subGroup>

<alternativeIdentifier>{subGroupAltId}</alternativeIdentifier>

</subGroup>

<section>

<alternativeIdentifier>{sectionAltId}</alternativeIdentifier>

</section>

</sectionSubGroup>

Inclusão de subgrupos em lote na seção

POST /CenterWeb/api/{$apiKey}/batch/sectionSubGroups.xml

Este recurso permite fazer a inclusão e atualização em lote de subgrupos da seção, sem que haja necessidade de fazer inúmeras requisições à API:

<sectionSubGroups>

<sectionSubGroup>

<subGroup>

<id>15728352</id>

</subGroup>

<section>

<id>3892</id>

</section>

</sectionSubGroup>

...

<sectionSubGroup>

<subGroup>

<id>15728352</id>

</subGroup>

<section>

<id>3892</id>

</section>

</sectionSubGroup>

</sectionSubGroups>

O elemento "<sectionSubGroup></sectionSubGroup>" representa cada subgrupo da seção a ser inserido, limitando em 100 o número máximo de subgrupos por requisição.

Caso algum erro ocorra, toda a operação será abortada e nenhum subgrupo da seção será inserido.

Como retorno a esta chamada o sistema apresenta os o link de acesso a cada subgrupo criado.

Ex:

<result>

<resourceName>sectionSubGroups</resourceName>

<size>2</size>

<entries>

<entry id="1803794" link="/sectionSubGroup/1803794.xml" />

<entry id="1803795" link="/sectionSubGroup/1803795.xml" />

</entries>

</result>

Busca por subgrupos na seção

GET /CenterWeb/api/{$apiKey}/sectionSubGroup.xml

Se preferir ainda, pode refinar as pesquisas enviando parâmetros na requisição, para isso é necessário adicionar parâmetros igual realizamos em uma requisição HTTP:

GET /CenterWeb/api/{$apiKey}/sectionSubGroup.xml?section=1234

Esta requisição está puxando todos os subgrupos vinculados a alguma seção específica identificada pelo id.

Enviar parâmetros para a API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:

<result>

<resourceName>sectionSubGroup</resourceName>

<size>2</size>

<entries>

<entry id="203" link="/sectionSubGroup/203.xml"/>

<entry id="292" link="/sectionSubGroup/292.xml"/>

</entries>

</result>

A resposta da requisição será uma mensagem contendo o total de registro retornados e uma lista simples, sem detalhes de cada registro retornado, contendo para cada entrada retornada o Id do registro no uMov.me e o link que possa ser usado para recuperar os dados específicos deste registro. Através desta resposta, o chamador da API pode agora buscar as informações específicas dos retornos que foram encontrados.

Busca de um subgrupo da seção específico

GET /CenterWeb/api/{$apiKey}/sectionSubGroup/{$id}.xml

Este recurso serve para puxar dados de um campo da seção específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<sectionSubGroup>

<id>203</id>

<subGroup>

<id>3558929</id>

<description>Padrão</description>

<alternativeIdentifier>1</alternativeIdentifier>

<active>true</active>

</subGroup>

<section>

<id>3416289</id>

<description>seção qualquer</description>

<order>0</order>

<alternativeIdentifier>qualquer</alternativeIdentifier>

<active>true</active>

<mandatory>1</mandatory>

<useItem>0</useItem>

<findItemsByIdentifier>false</findItemsByIdentifier>

<itemFillMode>0</itemFillMode>

<groupingItemsTypeOnMobile>1</groupingItemsTypeOnMobile>

<activityHistoryReportType>V</activityHistoryReportType>

<displayItemsInMobile>0</displayItemsInMobile>

<seeItemsCollectedAutomatically>false</seeItemsCollectedAutomatically>

<quizMode>false</quizMode>

<locked>false</locked>

<markCompleteGroup>false</markCompleteGroup>

<documentation/>

<executionWayItem>0</executionWayItem>

<cleanFilterSearchItem>false</cleanFilterSearchItem>

</section>

</sectionSubGroup>

Remoção de um subgrupo da seção em específico

DELETE /CenterWeb/api/{$apiKey}/sectionSubGroup/{subGroupId}/{sectionId}.xml

DELETE /CenterWeb/api/{$apiKey}/sectionSubGroup/{subGroupAltId}/{sectionAltId}.xml

Como confirmação da remoção do subgrupo da seção, o sistema retorna como status da requisição, o código de retorno 200 (OK)

bem como apresenta a seguinte mensagem de retorno:

<result>

<statusCode>200</statusCode>

<message>scheduleItem: scheduleItem.item.exclusion.successful</message>

</result>