Vicon Web API
Tópicos da Referência
Descrição dos parâmetros
Autenticação
Listagem
Inserção/Remoção de registros
Posicionamento de usuário
Consulta a registros
Sensores de Monitoramento
| Parâmetro |
Descrição |
| action |
Ação requisitada |
| token |
Chave de temporária de operação acesso |
| email |
E-mail de usuário cadastrado no projeto
|
| password |
Senha de acesso do usuário <email>
no projeto |
| pid |
Número identificador único do projeto no projeto |
| idform |
Número identificador único do formulário no projeto |
| idrecord |
Número identificador do registro no projeto |
| output |
Formato de impressão do resultado do processamento. Valores possíveis: xml (default) | json |
Descrição
Autenticar para receber um token a partir de um <email>, <password>
Parâmetros de entrada
email, password
Exemplo de Chamada
https://vigiante.com/api.php?action=login&email=user@domain.com&password=12345
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: action, email, password
|
| -2 |
-2Invalid email and/or password
|
| abcdefgh |
abcdefghToken successfully generated. Valid for 120 minutes.
|
Descrição
Listar projetos do usuario a partir de um <token>
Parâmetros de entrada
email, password
Exemplo de Chamada
https://vigiante.com/api.php?action=listuserprojects&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: token
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<id>-2</id>
<detail>Invalid token (expired after 120 minutes of its generation).</detail>
</result>]]> |
Descrição
Listar usuários de um projeto <pid>
Parâmetros de entrada
pid, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://vigiante.com/api.php?action=listprojectusers&pid=4&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: action, pid [,token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Users cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<id>1</id>
<project>
<idProject>4</idProject>
<idUserCreator>4</idUserCreator>
<strUserCreatorEmail>machinerfernanda@gmail.com</strUserCreatorEmail>
<strUserCreatorName/>
<blnActive>1</blnActive>
<dtDateCreation>2026-04-20 22:16:53</dtDateCreation>
<strName/>
<txtDescription/>
<strAlias>machinerfernandagmail</strAlias>
<strAddress/>
<dblLatitude/>
<dblLongitude/>
<idCountry>30</idCountry>
<idCSSTheme>1</idCSSTheme>
<strThemeName>united</strThemeName>
<strRGBColor>00427e</strRGBColor>
<strGoogleAnalyticsID/>
<strSkypeID/>
<strLogoFile/>
<strBackgroundFile/>
<idProjectUserViewScope>3</idProjectUserViewScope>
<idProjectUserEditScope>3</idProjectUserEditScope>
<blnAllowAllView>1</blnAllowAllView>
<blnAllowFormShare>1</blnAllowFormShare>
<intAllowJoinAsLevel>3</intAllowJoinAsLevel>
<blnMobileAllowEditCoordinates>1</blnMobileAllowEditCoordinates>
<intBackupFrequencyDays>30</intBackupFrequencyDays>
<dtBackupLastExecution/>
<intRecordClusterRadiusMts>0</intRecordClusterRadiusMts>
<blnMapClusterer>0</blnMapClusterer>
<blnQRPublicAccess>0</blnQRPublicAccess>
<blnBlockReportVisitors>0</blnBlockReportVisitors>
<intMarkerSizePx>32</intMarkerSizePx>
<strCountryName>Brazil</strCountryName>
<strLanguageCode>br</strLanguageCode>
<strCurrencySymbol>BRL</strCurrencySymbol>
<strDateCreation>20/04/26</strDateCreation>
<strBackupLastExecution>-</strBackupLastExecution>
<strBackupNextExecution>03/07/2026</strBackupNextExecution>
<strURL>https://vigiante.com/?idProject=4</strURL>
<strURLExternal>https://vigiante.com/machinerfernandagmail</strURLExternal>
<strURLEmbed>https://vigiante.com/machinerfernandagmail-embed</strURLEmbed>
<strRGBColorDark>001426</strRGBColorDark>
<strRGBColorLight>e6ecf2</strRGBColorLight>
<strUserCreatorNameShort>machinerfernanda</strUserCreatorNameShort>
<strDateLastAccess/>
<intDaysSinceLastAccess/>
<strLogoFileFullPath>img/logo-symbol.svg</strLogoFileFullPath>
<strBackgroundFileFullPath>img/backgrounds/vigiante-bg.jpg</strBackgroundFileFullPath>
<intUsers>-</intUsers>
<intForms>-</intForms>
<intRecords>-</intRecords>
<text/>
<value/>
<query/>
<arrPallete>
<record>
<base>00427e</base>
<lighter>f7f9fb</lighter>
<light>4d7ba5</light>
<dark>003565</dark>
<darker>003f78</darker>
</record>
</arrPallete>
</project>
<users>
<record>
<idUser>4</idUser>
<idProject>4</idProject>
<idUserLevel>4</idUserLevel>
<blnActive>1</blnActive>
<dtRegister>2026-04-20 22:16:53</dtRegister>
<strName/>
<strEmail>machinerfernanda@gmail.com</strEmail>
<dblLatitude/>
<dblLongitude/>
<strProfilePhotoPath/>
<strSkypeID/>
<strRegister>20/04/26</strRegister>
<strEmailAbbreviated>machinerfernanda</strEmailAbbreviated>
<strUserLevel>Project Manager</strUserLevel>
<strDateLastAccess>-</strDateLastAccess>
<intNumRecords>224</intNumRecords>
<strWorkgroups>General</strWorkgroups>
<idProjectWorkgroups>0</idProjectWorkgroups>
<strSkypeStatus/>
</record>
</users>
</result>]]> |
Descrição
Listar formulário de um projeto <pid>
Parâmetros de entrada
pid, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://vigiante.com/api.php?action=listprojectforms&pid=4&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: action, pid, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Forms cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<id>1</id>
<forms>
<record>
<idForm>9</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:47:05</dtCreation>
<dtLastUpdate>2026-04-23 10:47:05</dtLastUpdate>
<idMarker>1</idMarker>
<strName/>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-03-saude-e-bem-estar</strSlug>
<strCreation>23/04/2026 10:47</strCreation>
<strLastUpdate>23/04/2026 10:47</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/9/ods-03-saude-e-bem-estar</strShareURL>
<intRecords>76</intRecords>
</record>
<record>
<idForm>10</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:47:43</dtCreation>
<dtLastUpdate>2026-04-23 10:47:43</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 04 EDUCACAO</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-04-educacao</strSlug>
<strCreation>23/04/2026 10:47</strCreation>
<strLastUpdate>23/04/2026 10:47</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/10/ods-04-educacao</strShareURL>
<intRecords>6</intRecords>
</record>
<record>
<idForm>11</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:48:35</dtCreation>
<dtLastUpdate>2026-04-23 10:48:35</dtLastUpdate>
<idMarker>1</idMarker>
<strName/>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-05-igualdade-de-genero</strSlug>
<strCreation>23/04/2026 10:48</strCreation>
<strLastUpdate>23/04/2026 10:48</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/11/ods-05-igualdade-de-genero</strShareURL>
<intRecords>5</intRecords>
</record>
<record>
<idForm>12</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:48:59</dtCreation>
<dtLastUpdate>2026-04-23 10:48:59</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 06 AGUA POTAVEL_SANEAMENTO</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-06-agua-potavel-saneamento</strSlug>
<strCreation>23/04/2026 10:48</strCreation>
<strLastUpdate>23/04/2026 10:48</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/12/ods-06-agua-potavel-saneamento</strShareURL>
<intRecords>6</intRecords>
</record>
<record>
<idForm>13</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:49:47</dtCreation>
<dtLastUpdate>2026-04-23 10:49:47</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 08 TRABALHO DECENTE_CRESCIMENTO ECONOMICO</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-08-trabalho-decente-crescimento-economico</strSlug>
<strCreation>23/04/2026 10:49</strCreation>
<strLastUpdate>23/04/2026 10:49</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/13/ods-08-trabalho-decente-crescimento-economico</strShareURL>
<intRecords>18</intRecords>
</record>
<record>
<idForm>14</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:49:51</dtCreation>
<dtLastUpdate>2026-04-23 10:49:51</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 09 INDUSTRIA INOVACAO INFRAESTRUTURA</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-09-industria-inovacao-infraestrutura</strSlug>
<strCreation>23/04/2026 10:49</strCreation>
<strLastUpdate>23/04/2026 10:49</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/14/ods-09-industria-inovacao-infraestrutura</strShareURL>
<intRecords>5</intRecords>
</record>
<record>
<idForm>15</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:50:23</dtCreation>
<dtLastUpdate>2026-04-23 10:50:23</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 09 INDUSTRIA INOVACAO INFRAESTRUTURA</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-09-industria-inovacao-infraestrutura</strSlug>
<strCreation>23/04/2026 10:50</strCreation>
<strLastUpdate>23/04/2026 10:50</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/15/ods-09-industria-inovacao-infraestrutura</strShareURL>
<intRecords>5</intRecords>
</record>
<record>
<idForm>16</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:50:25</dtCreation>
<dtLastUpdate>2026-04-23 10:50:25</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 10 REDUCAO DAS DESIGUALDADES</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-10-reducao-das-desigualdades</strSlug>
<strCreation>23/04/2026 10:50</strCreation>
<strLastUpdate>23/04/2026 10:50</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/16/ods-10-reducao-das-desigualdades</strShareURL>
<intRecords>4</intRecords>
</record>
<record>
<idForm>17</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:50:58</dtCreation>
<dtLastUpdate>2026-04-23 10:50:58</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 11 CIDADES_COMUNIDADES SUSTENTAVEIS</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-11-cidades-comunidades-sustentaveis</strSlug>
<strCreation>23/04/2026 10:50</strCreation>
<strLastUpdate>23/04/2026 10:50</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/17/ods-11-cidades-comunidades-sustentaveis</strShareURL>
<intRecords>18</intRecords>
</record>
<record>
<idForm>18</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:50:59</dtCreation>
<dtLastUpdate>2026-04-23 10:50:59</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 12 CONSUMO_PRODUCAO RESPONSAVEIS</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-12-consumo-producao-responsaveis</strSlug>
<strCreation>23/04/2026 10:50</strCreation>
<strLastUpdate>23/04/2026 10:50</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/18/ods-12-consumo-producao-responsaveis</strShareURL>
<intRecords>2</intRecords>
</record>
<record>
<idForm>19</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:51:31</dtCreation>
<dtLastUpdate>2026-04-23 10:51:31</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 13 MUDANCA GLOBAL DO CLIMA</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-13-mudanca-global-do-clima</strSlug>
<strCreation>23/04/2026 10:51</strCreation>
<strLastUpdate>23/04/2026 10:51</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/19/ods-13-mudanca-global-do-clima</strShareURL>
<intRecords>3</intRecords>
</record>
<record>
<idForm>20</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:51:33</dtCreation>
<dtLastUpdate>2026-04-23 10:51:33</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 14 VIDA NA AGUA</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-14-vida-na-agua</strSlug>
<strCreation>23/04/2026 10:51</strCreation>
<strLastUpdate>23/04/2026 10:51</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/20/ods-14-vida-na-agua</strShareURL>
<intRecords>5</intRecords>
</record>
<record>
<idForm>21</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:52:11</dtCreation>
<dtLastUpdate>2026-04-23 10:52:11</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 15 VIDA TERRESTRE</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-15-vida-terrestre</strSlug>
<strCreation>23/04/2026 10:52</strCreation>
<strLastUpdate>23/04/2026 10:52</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/21/ods-15-vida-terrestre</strShareURL>
<intRecords>20</intRecords>
</record>
<record>
<idForm>22</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:52:13</dtCreation>
<dtLastUpdate>2026-04-23 10:52:13</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 16 PAZ JUSTICA_INSTITUICOES EFICAZES</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-16-paz-justica-instituicoes-eficazes</strSlug>
<strCreation>23/04/2026 10:52</strCreation>
<strLastUpdate>23/04/2026 10:52</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/22/ods-16-paz-justica-instituicoes-eficazes</strShareURL>
<intRecords>7</intRecords>
</record>
<record>
<idForm>23</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:52:51</dtCreation>
<dtLastUpdate>2026-04-23 10:52:51</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS 17 PARCERIA E MEIOS IMPLEMENTACAO</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-17-parceria-e-meios-implementacao</strSlug>
<strCreation>23/04/2026 10:52</strCreation>
<strLastUpdate>23/04/2026 10:52</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/23/ods-17-parceria-e-meios-implementacao</strShareURL>
<intRecords>2</intRecords>
</record>
<record>
<idForm>24</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:52:53</dtCreation>
<dtLastUpdate>2026-04-23 10:52:53</dtLastUpdate>
<idMarker>1</idMarker>
<strName/>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-18-igualdade-etnicoracial</strSlug>
<strCreation>23/04/2026 10:52</strCreation>
<strLastUpdate>23/04/2026 10:52</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/24/ods-18-igualdade-etnicoracial</strShareURL>
<intRecords>23</intRecords>
</record>
<record>
<idForm>26</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:53:40</dtCreation>
<dtLastUpdate>2026-04-23 10:53:40</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS_01_ERRADICACAO_DA_POBREZA</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-01-erradicacao-da-pobreza</strSlug>
<strCreation>23/04/2026 10:53</strCreation>
<strLastUpdate>23/04/2026 10:53</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/26/ods-01-erradicacao-da-pobreza</strShareURL>
<intRecords>6</intRecords>
</record>
<record>
<idForm>25</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:53:24</dtCreation>
<dtLastUpdate>2026-04-23 10:53:24</dtLastUpdate>
<idMarker>1</idMarker>
<strName>ODS_02_FOME_ZERO_E_AGRICULTURA_SUSTENTaVEL</strName>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-02-fome-zero-e-agricultura-sustentavel</strSlug>
<strCreation>23/04/2026 10:53</strCreation>
<strLastUpdate>23/04/2026 10:53</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/25/ods-02-fome-zero-e-agricultura-sustentavel</strShareURL>
<intRecords>13</intRecords>
</record>
</forms>
</result>]]> |
Descrição
Obter informações acerca do formulário <idform>. Resultado no formato XML com informações dos campos do formulário.
Parâmetros de entrada
idform, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://vigiante.com/api.php?action=listforminfo&idform=9&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: idform, idrecord, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Record cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<form>
<idForm>9</idForm>
<idProject>4</idProject>
<idDataSource>1</idDataSource>
<dtCreation>2026-04-23 10:47:05</dtCreation>
<dtLastUpdate>2026-04-23 10:47:05</dtLastUpdate>
<idMarker>1</idMarker>
<strName/>
<blnActive>1</blnActive>
<strAlias>machinerfernandagmail</strAlias>
<strSlug>ods-03-saude-e-bem-estar</strSlug>
<strCreation>23/04/2026 10:47</strCreation>
<strLastUpdate>23/04/2026 10:47</strLastUpdate>
<strMarkerFullPath>img/markers/1.png</strMarkerFullPath>
<strShareURL>https://vigiante.com/share/9/ods-03-saude-e-bem-estar</strShareURL>
<intRecords>76</intRecords>
<fields>
<record>
<idFormField>69</idFormField>
<idForm>9</idForm>
<idFormFieldType>1</idFormFieldType>
<strName>Fator</strName>
<strTip/>
<intOrder>1</intOrder>
<blnActive>1</blnActive>
<strFormFieldType>Free Text</strFormFieldType>
<blnSummary/>
</record>
<record>
<idFormField>70</idFormField>
<idForm>9</idForm>
<idFormFieldType>1</idFormFieldType>
<strName>ODS</strName>
<strTip/>
<intOrder>2</intOrder>
<blnActive>1</blnActive>
<strFormFieldType>Free Text</strFormFieldType>
<blnSummary/>
</record>
<record>
<idFormField>71</idFormField>
<idForm>9</idForm>
<idFormFieldType>1</idFormFieldType>
<strName>Classificacaode Risco</strName>
<strTip/>
<intOrder>3</intOrder>
<blnActive>1</blnActive>
<strFormFieldType>Free Text</strFormFieldType>
<blnSummary/>
</record>
<record>
<idFormField>72</idFormField>
<idForm>9</idForm>
<idFormFieldType>1</idFormFieldType>
<strName/>
<strTip/>
<intOrder>4</intOrder>
<blnActive>1</blnActive>
<strFormFieldType>Free Text</strFormFieldType>
<blnSummary/>
</record>
<record>
<idFormField>73</idFormField>
<idForm>9</idForm>
<idFormFieldType>1</idFormFieldType>
<strName>Caracterizacao do Fator</strName>
<strTip/>
<intOrder>5</intOrder>
<blnActive>1</blnActive>
<strFormFieldType>Free Text</strFormFieldType>
<blnSummary/>
</record>
</fields>
</form>
</result>]]> |
Descrição
Inserir registros de um formulário do projeto (indicado pelo parâmtro form (via GET), com dados no formato GeoJSON.
O campo idFormField da propriedade fields representa o valor do código do campo do formulário. Para obter informação acerca da estrutura de um formulário o usuário poderá executar a requisição listforminfo.
Caso processado com sucesso, como saída retorna o id do registro criado.
Parâmetros de entrada
idform, token (via GET); data (via POST)
Exemplo de Chamada
https://vigiante.com/api.php?action=insertrecords&idform=1&token=abcdefgh
Campo Data:
{"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [125.6, 10.1]
},
"properties": {
"fields": [
{"idFormField": "1", "value": "João da Silva"},
{"idFormField": "2", "value": "Avenida Presidente Vargas, 234"},
{"idFormField": "3", "value": "10"}
],
"attachments": [
{"url": "http://www.viconsaga.com.br/files/abcd.jpg", "title": "Picture 1"},
{"url": "http://www.viconsaga.com.br/files/worksheet.xlsx", "title": "Excel Worksheet"},
{"url": "http://www.viconsaga.com.br/files/workbook.pdf", "title": "User Manual"}
]
}
}
]
}
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: idform, lat, lng, data, token
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -4 |
-4Record could not be created due to user level limitation. User access level must be >= 3.
|
| -5 |
-5Form does not exist.
|
| -6 |
-6Fail! Exceeded daily creation quota (100 records/day).
|
| 1 |
11Record successfully created!
|
Descrição
Remover registro <idrecord>. Não é necessário especificar o <pid> e <userid> porque ambas informações estão vinculadas ao <token> (parâmetro obrigatório para esta função).
Parâmetros de entrada
idrecord, token
Exemplo de Chamada
https://vigiante.com/api.php?action=deleterecord&idrecord=1&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: idform, idrecord, token
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -4 |
-4Record cannot be delete due to access level limitation.
|
| -5 |
-5Record does not exist!
|
| 1 |
1Record successfully deleted!
|
Descrição
Inserir nova posição de rota de usuário em <lat> e <lng>. Não é necessário especificar o <pid> e <userid> porque ambas informações estão vinculadas ao <token> (parâmetro obrigatório para esta função).
Parâmetros de entrada
lat, lng, token
Exemplo de Chamada
https://vigiante.com/api.php?action=insertuserposition&lat=-22.965644300334535&lng=-43.17431688308716&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: lat, lng, token
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -4 |
-4User position could not be inserted due to access level limitation
|
| 1 |
1User position successfully inserted!
|
Descrição
Gerar relatório de todos os registros do projeto, em um dos seguintes formatos:
kml - Google Earth
xls - Microsoft Excel, Open Office, BrOffice
xml - eXtensible Markup Language é uma recomendação da W3C para gerar linguagens de marcação para necessidades especiais
html - Hypertext Markup Language
Resultado no formato especificado pelo parâmetro <ext>
Parâmetros de entrada
pid, ext, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://vigiante.com/api.php?action=generatereport&pid=4&ext=kml&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: pid, ext, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Report cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<result>
<id>1</id>
<detail>Report successfully generated!</detail>
<fileName>http://localhost/viconsaga/tmp/1-19-06-2014 12-58.kml</fileName>
</result>]]> |
Descrição
Obter informações de um registro <idrecord>. Resultado no formato XML com informações sobre o registro.
Parâmetros de entrada
idrecord, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://vigiante.com/api.php?action=recordinfo&idrecord=1&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: pid, lat, lng, radius, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| -5 |
-5Record does not exist!
|
| 1 |
<![CDATA[<result>
<idFormRecord>3649</idFormRecord>
<idUser>1</idUser>
<idForm>101</idForm>
<idDevice>1</idDevice>
<idShapeType>1</idShapeType>
<strCustomMarkerRGBColor>8</strCustomMarkerRGBColor>
<dtCreation>2014-05-21 02:09:42</dtCreation>
<dtLastUpdate>2014-05-21 02:09:42</dtLastUpdate>
<idProject>1</idProject>
<strFormName>CBMERJ</strFormName>
<idMarker>185</idMarker>
<blnActive>1</blnActive>
<strMarkerFileName>185.png</strMarkerFileName>
<idProjectMarker/>
<strName>Tiago Marino</strName>
<strEmail>tiagomarino@hotmail.com</strEmail>
<strCreation>21/05/2014 02:09</strCreation>
<strLastUpdate>21/05/2014 02:09</strLastUpdate>
<strMarkerFullPath>img/markers/185.png</strMarkerFullPath>
<strMarkerFullURL>http://localhost/viconsaga/img/markers/185.png</strMarkerFullURL>
<arrVertex>
<unknownNode>
<idFormRecordVertex>103251</idFormRecordVertex>
<idFormRecord>3649</idFormRecord>
<dblLatitude>-22.907548</dblLatitude>
<dblLongitude>-43.563438</dblLongitude>
<intPosition>1</intPosition>
</unknownNode>
</arrVertex>
<arrFiles/>
<strDevice>Web</strDevice>
<strDeviceFilePath>img/devices/1.png</strDeviceFilePath>
<dblLatitude>-22.907548</dblLatitude>
<dblLongitude>-43.563438</dblLongitude>
<dblDistanceFromCenterMts>-1</dblDistanceFromCenterMts>
<dblLatitudeUTM>7465995,54</dblLatitudeUTM>
<dblLongitudeUTM>647331,97</dblLongitudeUTM>
<intZoneUTM>23K</intZoneUTM>
</result>]]> |
Descrição
Obter todos os registro de um projeto <pid> a um raio <radius> de um ponto <lat>, <lng>, contendo a palavra-chave <keyword> (opcional). Resultado no formato XML com informações sobre os registros encontrado.
[OPCIONAL] Utilize o parâmetro <idusers> para retornar somente os registros criados ou atualizados por um usuário específico.
[OPCIONAL] Utilize o parâmetro <idforms> para retornar somente os registros de um formulário específico.
[OPCIONAL] Utilize o parâmetro <fromdate> para retornar somente os registros criados ou atualizados a partir de uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <todate> para retornar somente os registros criados ou atualizados até uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <datetype> para determinadar se os parâmetros <fromdate> e <todate> se referem à data de criação (=1) ou de atualização (=2).
[OPCIONAL] Utilize o parâmetro <files> para retornar somente os registros com <files> ou mais arquivos anexos.
[OPCIONAL] Utilize o parâmetro <page> para marcar a pagina (início em 0) dos registros. Caso o parâmetro seja omitido, a consulta retornará a primeira página de registros.
[OPCIONAL] Utilize o parâmetro <limit> para limitar a quantidade de registros retornados por página.
Esta consulta retorna até 100 registros por chamada.
Parâmetros de entrada
token (obrigatório quando projeto não é público), pid, lat, lng, radius, keyword (opcional), idusers (opcional), idforms (opcional), fromdate (opcional), todate (opcional), fromdate (opcional), datetype (opcional), files (opcional), page (opcional), limit (opcional)
Parâmetros da busca por raio
Exemplo de Chamada
https://vigiante.com/api.php?action=searchradius&pid=4&lat=-23.24325525&lng=-43.24325525&radius=40000000&page=0&limit=2&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: pid, lat, lng, radius, keyword, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<id>-1</id>
<detail>Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, token (for private projects)</detail>
</result>]]> |
Descrição
Proceder uma busca espacial por registros de um projeto <pid> dentro de um retângulo limitado por dois pontos com pares de coordenadas <latSW>, <lngSW>, <latNE>, <lngNE>, contendo a palavra-chave <keyword>. Resultado, registros em XML.
[OPCIONAL] Utilize o parâmetro <idusers> para retornar somente os registros criados ou atualizados por um usuário específico.
[OPCIONAL] Utilize o parâmetro <idforms> para retornar somente os registros de um formulário específico.
[OPCIONAL] Utilize o parâmetro <fromdate> para retornar somente os registros criados ou atualizados a partir de uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <todate> para retornar somente os registros criados ou atualizados até uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <datetype> para determinadar se os parâmetros <fromdate> e <todate> se referem à data de criação (=1) ou de atualização (=2).
[OPCIONAL] Utilize o parâmetro <files> para retornar somente os registros com <files> ou mais arquivos anexos.
[OPCIONAL] Utilize o parâmetro <page> para marcar a pagina (início em 0) dos registros. Caso o parâmetro seja omitido, a consulta retornará a primeira página de registros.
[OPCIONAL] Utilize o parâmetro <limit> para limitar a quantidade de registros retornados por página.
Esta consulta retorna até 100 registros por chamada.
Parâmetros de entrada
token (obrigatório quando projeto não é público), pid, latlatSW, lngSW, latNE, lngNE, keyword (opcional), idusers (opcional), idforms (opcional), fromdate (opcional), todate (opcional), fromdate (opcional), datetype (opcional), files (opcional), page (opcional), limit (opcional)
Parâmetros da busca por retângulo
Exemplo de Chamada
https://vigiante.com/api.php?action=searchrectangle&pid=4&latSW=-90&lngSW=-180&latNE=90&lngNE=180&keyword=as&limit=2&token=abcdefgh
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, [token]
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<result>
<id>-1</id>
<detail>Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, token (for private projects)</detail>
</result>]]> |
Descrição
Estabelecer o servico WFS para a utilização dos dados em outras aplicações que suportam este protocolo (QGIS, GeoServer, ESRI ArcGIS, INPE Spring...).
Utilize o parâmetro "summary" (=1) para retornar carregar registros SOMENTE com informações básicas (sem campos dos formulários).
ATENÇÃO: O carregamento dos detalhes de muitos registros implica em maior tempo para o processamento da resposta. Portanto, caso sua requisição tenha muitos registros e o sistema esteja demorando, É RECOMENDÁVEL que passe o parâmetro summary=1 para agilizar o retorno
CARREGANDO MUITOS DADOS NO QUANTUM GIS: Caso a quantidade de registros a ser carregadas seja muito grande você deve reconfigurar o parâmetro Timout no QGIS.
Para isto, clique no menu Configurações->Opões... e aumente o valor do timeout e o valor do cache de dados, conforme destacado na ilustração abaixo.
QGIS: Aumentando o timeout e cache para requisição de grandes volumes de dados.
Parâmetros de entrada
pid, email, password (email e password obrigatórios quando dados do projeto não são abertos ao público), summary (opcional)
Exemplo de Chamada
https://vigiante.com/api.php?action=wfs&pid=4&email=user@domain.com&password=12345
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: pid, email, password
|
| -2 |
-2Invalid email and/or password
|
| 1 |
<![CDATA[<?xml version="1.0"?>
<WFS_Capabilities xmlns="http://www.opengis.net/wfs" xmlns:ogc="http://www.opengis.net/ogc" xmlns:gml="http://www.opengis.net/gml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ows="http://www.opengis.net/ows" version="1.0.0">
<FeatureTypeList>
<FeatureType>
<Title>ODS 03 SAÚDE E BEM ESTAR</Title>
<Name>ods_03_saude_e_bem_estar_9</Name>
<Abstract>76 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 04 EDUCACAO</Title>
<Name>ods_04_educacao_10</Name>
<Abstract>6 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 05 IGUALDADE DE GÊNERO</Title>
<Name>ods_05_igualdade_de_genero_11</Name>
<Abstract>5 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 06 AGUA POTAVEL_SANEAMENTO</Title>
<Name>ods_06_agua_potavel_saneamento_12</Name>
<Abstract>6 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 08 TRABALHO DECENTE_CRESCIMENTO ECONOMICO</Title>
<Name>ods_08_trabalho_decente_crescimento_economico_13</Name>
<Abstract>18 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 09 INDUSTRIA INOVACAO INFRAESTRUTURA</Title>
<Name>ods_09_industria_inovacao_infraestrutura_14</Name>
<Abstract>5 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 09 INDUSTRIA INOVACAO INFRAESTRUTURA</Title>
<Name>ods_09_industria_inovacao_infraestrutura_15</Name>
<Abstract>5 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 10 REDUCAO DAS DESIGUALDADES</Title>
<Name>ods_10_reducao_das_desigualdades_16</Name>
<Abstract>4 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 11 CIDADES_COMUNIDADES SUSTENTAVEIS</Title>
<Name>ods_11_cidades_comunidades_sustentaveis_17</Name>
<Abstract>18 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 12 CONSUMO_PRODUCAO RESPONSAVEIS</Title>
<Name>ods_12_consumo_producao_responsaveis_18</Name>
<Abstract>2 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 13 MUDANCA GLOBAL DO CLIMA</Title>
<Name>ods_13_mudanca_global_do_clima_19</Name>
<Abstract>3 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 14 VIDA NA AGUA</Title>
<Name>ods_14_vida_na_agua_20</Name>
<Abstract>5 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 15 VIDA TERRESTRE</Title>
<Name>ods_15_vida_terrestre_21</Name>
<Abstract>20 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 16 PAZ JUSTICA_INSTITUICOES EFICAZES</Title>
<Name>ods_16_paz_justica_instituicoes_eficazes_22</Name>
<Abstract>7 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 17 PARCERIA E MEIOS IMPLEMENTACAO</Title>
<Name>ods_17_parceria_e_meios_implementacao_23</Name>
<Abstract>2 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS 18 IGUALDADE ÉTNICORACIAL</Title>
<Name>ods_18_igualdade_etnicoracial_24</Name>
<Abstract>23 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS_01_ERRADICACAO_DA_POBREZA</Title>
<Name>ods_01_erradicacao_da_pobreza_26</Name>
<Abstract>6 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
<FeatureType>
<Title>ODS_02_FOME_ZERO_E_AGRICULTURA_SUSTENTaVEL</Title>
<Name>ods_02_fome_zero_e_agricultura_sustentavel_25</Name>
<Abstract>13 objects</Abstract>
<SRS>EPSG:4326</SRS>
</FeatureType>
</FeatureTypeList>
</WFS_Capabilities>]]> |
Descrição
Receber dados de um sensor de monitoramento ambiental e inserir no banco de dados da plataforma
Parâmetros de entrada
- token - Verifcar na Gestão de Sensores da Plataforma
- Dados - Enviados no cabeçalho do método POST. Ex.: {"parameters":{"wind":100,"temperature":34,"humidity":97}}
Exemplo de Chamada
https://vigiante.com/api.php?action=sensor-data-insert&token=abcdefghij
POST HEADERS: {"parameters":{"wind":100,"temperature":34,"humidity":97}}
Retornos
| Código |
Descrição |
| -1 |
-1Incomplete parameters. Parameters required for this call: id, token
|
| -2 |
-2Invalid token (expired after 120 minutes of its generation).
|
| -4 |
-4User position could not be inserted due to access level limitation
|
| 1 |
|