Visualização de Registros Criar/Editar Registro Menu Usuário Edit My Account Project Stats Tools Batch Geocoder Coordinates Conversor Data Importer Project Management Configuration and Appearance Events Log Manage Users Manage Forms Data Sources - Scripts Android Vicon SAGA Mobile Vicon Mobile - Guia de Referência Exercícios Práticos Criação e Consulta Vicon Web Criação Vicon Mobile + Consulta QGIS Extras Tipos de dados Níveis e Permissões de Usuários Tutorial PGORH/CBMERJ Vicon API Termos de Uso
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://viconsaga.com.br/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://viconsaga.com.br/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 <?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://viconsaga.com.br/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 <?xml version="1.0"?> <result> <id>1</id> <project> <idProject>4</idProject> <idUserCreator>9</idUserCreator> <strUserCreatorEmail>xavier.lageop@gmail.com</strUserCreatorEmail> <strUserCreatorName/> <blnActive>1</blnActive> <dtDateCreation>2014-09-19 12:03:09</dtDateCreation> <strName/> <txtDescription/> <strAlias>educacaolibertaria</strAlias> <strAddress/> <dblLatitude>-22.7981</dblLatitude> <dblLongitude>-43.199</dblLongitude> <idCountry>30</idCountry> <idCSSTheme>1</idCSSTheme> <strThemeName>united</strThemeName> <strRGBColor>004060</strRGBColor> <strGoogleAnalyticsID/> <strSkypeID/> <strLogoFile/> <strBackgroundFile>0059.jpg</strBackgroundFile> <idProjectUserViewScope>3</idProjectUserViewScope> <idProjectUserEditScope>3</idProjectUserEditScope> <blnAllowAllView>1</blnAllowAllView> <blnAllowFormShare>1</blnAllowFormShare> <intAllowJoinAsLevel>1</intAllowJoinAsLevel> <blnMobileAllowEditCoordinates>1</blnMobileAllowEditCoordinates> <intBackupFrequencyDays>30</intBackupFrequencyDays> <dtBackupLastExecution>2024-11-09 00:04:21</dtBackupLastExecution> <intRecordClusterRadiusMts>0</intRecordClusterRadiusMts> <blnMapClusterer>1</blnMapClusterer> <blnQRPublicAccess>0</blnQRPublicAccess> <blnBlockReportVisitors>0</blnBlockReportVisitors> <intMarkerSizePx>16</intMarkerSizePx> <strCountryName>Brazil</strCountryName> <strLanguageCode>br</strLanguageCode> <strCurrencySymbol>BRL</strCurrencySymbol> <strDateCreation>19/09/14</strDateCreation> <strBackupLastExecution>09/11/2024 00:04</strBackupLastExecution> <strBackupNextExecution>09/12/2024</strBackupNextExecution> <strURL>https://viconsaga.com.br/?idProject=4</strURL> <strURLExternal>https://viconsaga.com.br/educacaolibertaria</strURLExternal> <strURLEmbed>https://viconsaga.com.br/educacaolibertaria-embed</strURLEmbed> <strRGBColorDark>00131d</strRGBColorDark> <strRGBColorLight>e6ecef</strRGBColorLight> <strUserCreatorNameShort>xavier.lageop</strUserCreatorNameShort> <strDateLastAccess/> <intDaysSinceLastAccess/> <strLogoFileFullPath>img/logo.png</strLogoFileFullPath> <strBackgroundFileFullPath>projects/4/0059.jpg</strBackgroundFileFullPath> <intUsers>-</intUsers> <intForms>-</intForms> <intRecords>-</intRecords> <text/> <value/> <query/> <arrPallete> <record> <base>004060</base> <lighter>f7f9fa</lighter> <light>4d7990</light> <dark>00334d</dark> <darker>003d5b</darker> </record> </arrPallete> </project> <users> <record> <idUser>4085</idUser> <idProject>4</idProject> <idUserLevel>1</idUserLevel> <blnActive>1</blnActive> <dtRegister>2016-04-20 12:59:44</dtRegister> <strName>API User</strName> <strEmail>user@domain.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>20/04/16</strRegister> <strEmailAbbreviated>user</strEmailAbbreviated> <strUserLevel>Visualization</strUserLevel> <strDateLastAccess>-</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>3087</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2015-11-23 12:46:56</dtRegister> <strName>Rosangela</strName> <strEmail>r.sangelag@hotmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>23/11/15</strRegister> <strEmailAbbreviated>r.sangelag</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>23/11/15 14:01</strDateLastAccess> <intNumRecords>2</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1341</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-25 16:18:33</dtRegister> <strName>Filipe Silva</strName> <strEmail>filipenjord@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>25/11/14</strRegister> <strEmailAbbreviated>filipenjord</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>09/12/14 22:21</strDateLastAccess> <intNumRecords>1</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1340</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-25 16:17:55</dtRegister> <strName>Fernanda Santos</strName> <strEmail>fernanda.guilherme8@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>25/11/14</strRegister> <strEmailAbbreviated>fernanda.guilherme8</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>09/12/14 19:29</strDateLastAccess> <intNumRecords>2</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1339</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-25 16:17:03</dtRegister> <strName>Roberta Medeiros</strName> <strEmail>robertamlmedeiros@hotmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>25/11/14</strRegister> <strEmailAbbreviated>robertamlmedeiros</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>08/12/14 20:49</strDateLastAccess> <intNumRecords>6</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1334</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-20 14:38:14</dtRegister> <strName>OscarFirme</strName> <strEmail>oscarfirme@yahoo.com.br</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>20/11/14</strRegister> <strEmailAbbreviated>oscarfirme</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>20/11/14 14:39</strDateLastAccess> <intNumRecords>1</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1327</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-11 13:53:11</dtRegister> <strName>Leonardo Oliveira da Silva</strName> <strEmail>leugeo25@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>11/11/14</strRegister> <strEmailAbbreviated>leugeo25</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>18/12/14 00:00</strDateLastAccess> <intNumRecords>2</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1325</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-11-06 15:20:49</dtRegister> <strName>Flavio</strName> <strEmail>flaviomb15@hotmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>06/11/14</strRegister> <strEmailAbbreviated>flaviomb15</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>-</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1320</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:03:47</dtRegister> <strName>Thayanne</strName> <strEmail>thayannefroes4@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>thayannefroes4</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>09/12/14 11:20</strDateLastAccess> <intNumRecords>1</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1319</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:03:10</dtRegister> <strName>Rafael</strName> <strEmail>rafael.paschoa92@hotmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>rafael.paschoa92</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>08/12/14 11:54</strDateLastAccess> <intNumRecords>1</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1318</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:02:32</dtRegister> <strName>Caio</strName> <strEmail>caiocruzeiror@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>caiocruzeiror</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>10/11/14 20:17</strDateLastAccess> <intNumRecords>5</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1317</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:02:01</dtRegister> <strName>Mauricio</strName> <strEmail>omauriciohernandez@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>omauriciohernandez</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>12/11/14 17:06</strDateLastAccess> <intNumRecords>1</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1316</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:01:19</dtRegister> <strName>Vitor</strName> <strEmail>vitor4068@oi.com.br</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>vitor4068</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>08/12/14 11:53</strDateLastAccess> <intNumRecords>3</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1315</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 15:00:38</dtRegister> <strName>Monique</strName> <strEmail>monique.patricia.sousa@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>monique.patricia.sousa</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>08/12/14 18:48</strDateLastAccess> <intNumRecords>2</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>1314</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-21 14:59:25</dtRegister> <strName>Silvia </strName> <strEmail>silviat.alexandre@hotmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>21/10/14</strRegister> <strEmailAbbreviated>silviat.alexandre</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>-</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>22</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-10-14 17:47:31</dtRegister> <strName/> <strEmail>profgoess@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>14/10/14</strRegister> <strEmailAbbreviated>profgoess</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>-</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>13</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-09-19 12:09:27</dtRegister> <strName/> <strEmail>biajacques91@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>19/09/14</strRegister> <strEmailAbbreviated>biajacques91</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>30/09/14 16:01</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>12</idUser> <idProject>4</idProject> <idUserLevel>4</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-09-19 12:08:58</dtRegister> <strName>ANDRESSA </strName> <strEmail>andressakne@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>19/09/14</strRegister> <strEmailAbbreviated>andressakne</strEmailAbbreviated> <strUserLevel>Project Manager</strUserLevel> <strDateLastAccess>17/11/14 15:31</strDateLastAccess> <intNumRecords>2</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>11</idUser> <idProject>4</idProject> <idUserLevel>3</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-09-19 12:08:47</dtRegister> <strName/> <strEmail>historiador_ufrj@yahoo.com.br</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>19/09/14</strRegister> <strEmailAbbreviated>historiador_ufrj</strEmailAbbreviated> <strUserLevel>View, Edit, Insert, Delete</strUserLevel> <strDateLastAccess>18/02/24 19:05</strDateLastAccess> <intNumRecords>0</intNumRecords> <strWorkgroups>General</strWorkgroups> <idProjectWorkgroups>0</idProjectWorkgroups> <strSkypeStatus/> </record> <record> <idUser>9</idUser> <idProject>4</idProject> <idUserLevel>4</idUserLevel> <blnActive>1</blnActive> <dtRegister>2014-09-19 12:03:09</dtRegister> <strName/> <strEmail>xavier.lageop@gmail.com</strEmail> <dblLatitude/> <dblLongitude/> <strProfilePhotoPath/> <strSkypeID/> <strRegister>19/09/14</strRegister> <strEmailAbbreviated>xavier.lageop</strEmailAbbreviated> <strUserLevel>Project Manager</strUserLevel> <strDateLastAccess>05/08/19 22:24</strDateLastAccess> <intNumRecords>11</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://viconsaga.com.br/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 <?xml version="1.0"?> <result> <id>1</id> <forms> <record> <idForm>8</idForm> <idProject>4</idProject> <idDataSource>1</idDataSource> <dtCreation>2014-09-22 11:32:40</dtCreation> <dtLastUpdate>2014-09-22 11:32:40</dtLastUpdate> <idMarker>1</idMarker> <strName/> <blnActive>1</blnActive> <strAlias>educacaolibertaria</strAlias> <strCreation>22/09/2014 11:32</strCreation> <strLastUpdate>22/09/2014 11:32</strLastUpdate> <strMarkerFullPath>img/markers/1.png</strMarkerFullPath> <strShareURL>https://viconsaga.com.br/share/8</strShareURL> <intRecords>9</intRecords> </record> <record> <idForm>9</idForm> <idProject>4</idProject> <idDataSource>1</idDataSource> <dtCreation>2014-10-12 08:43:31</dtCreation> <dtLastUpdate>2014-10-12 08:43:31</dtLastUpdate> <idMarker>1</idMarker> <strName/> <blnActive>1</blnActive> <strAlias>educacaolibertaria</strAlias> <strCreation>12/10/2014 08:43</strCreation> <strLastUpdate>12/10/2014 08:43</strLastUpdate> <strMarkerFullPath>img/markers/1.png</strMarkerFullPath> <strShareURL>https://viconsaga.com.br/share/9</strShareURL> <intRecords>18</intRecords> </record> <record> <idForm>10</idForm> <idProject>4</idProject> <idDataSource>1</idDataSource> <dtCreation>2014-10-12 08:44:17</dtCreation> <dtLastUpdate>2014-10-12 08:44:17</dtLastUpdate> <idMarker>1</idMarker> <strName/> <blnActive>1</blnActive> <strAlias>educacaolibertaria</strAlias> <strCreation>12/10/2014 08:44</strCreation> <strLastUpdate>12/10/2014 08:44</strLastUpdate> <strMarkerFullPath>img/markers/1.png</strMarkerFullPath> <strShareURL>https://viconsaga.com.br/share/10</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://viconsaga.com.br/api.php?action=listforminfo&idform=8&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 <?xml version="1.0"?> <result> <form> <idForm>8</idForm> <idProject>4</idProject> <idDataSource>1</idDataSource> <dtCreation>2014-09-22 11:32:40</dtCreation> <dtLastUpdate>2014-09-22 11:32:40</dtLastUpdate> <idMarker>1</idMarker> <strName/> <blnActive>1</blnActive> <strAlias>educacaolibertaria</strAlias> <strCreation>22/09/2014 11:32</strCreation> <strLastUpdate>22/09/2014 11:32</strLastUpdate> <strMarkerFullPath>img/markers/1.png</strMarkerFullPath> <strShareURL>https://viconsaga.com.br/share/8</strShareURL> <intRecords>9</intRecords> <fields> <record> <idFormField>1312</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName/> <strTip/> <intOrder>1</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1309</idFormField> <idForm>8</idForm> <idFormFieldType>4</idFormFieldType> <strName/> <strTip/> <intOrder>2</intOrder> <blnActive>1</blnActive> <strFormFieldType>Multi Choice</strFormFieldType> <blnSummary/> <alternatives> <record> <idFormFieldAlternative>27</idFormFieldAlternative> <idFormField>1309</idFormField> <strAlternative>ENTIDADE BENEFICA</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>81</idFormFieldAlternative> <idFormField>1309</idFormField> <strAlternative>ENTIDADE MALEFICA</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>28</idFormFieldAlternative> <idFormField>1309</idFormField> <strAlternative>EVENTO (ACONTECIMENTO) BENEFICO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>82</idFormFieldAlternative> <idFormField>1309</idFormField> <strAlternative>EVENTO MALEFICO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> </alternatives> </record> <record> <idFormField>1310</idFormField> <idForm>8</idForm> <idFormFieldType>4</idFormFieldType> <strName>ASPECTO(S) DOMINANTE(S)</strName> <strTip/> <intOrder>3</intOrder> <blnActive>1</blnActive> <strFormFieldType>Multi Choice</strFormFieldType> <blnSummary/> <alternatives> <record> <idFormFieldAlternative>49</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>BIOTICO/FAUNA</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>50</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>BIOTICO/FLORA</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>51</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>BIOTICO/MICRO-ORGANISMOS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>71</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>CRIACAO DE ANIMAIS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>52</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>ECONOMICO/AGRICOLA</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>53</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>ECONOMICO/COMERCIAL</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>55</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>ECONOMICO/INDUSTRIAL</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>6417</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>ECONOMICO/TRANSPORTE</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>56</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>ECONOMICO/TURISMO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>48</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>FISICO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>70</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/ADMINISTRATIVO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>73</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/CIENTIF&#xC3;&#x8D;CO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>72</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/EDUCATIVO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>58</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/LAZER ARTISTICO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>59</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/LAZER ESPORTIVO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>60</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/LAZER FESTIVO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>61</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>SOCIAL/RELIGIOSO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>65</idFormFieldAlternative> <idFormField>1310</idFormField> <strAlternative>OUTRO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> </alternatives> </record> <record> <idFormField>1314</idFormField> <idForm>8</idForm> <idFormFieldType>4</idFormFieldType> <strName/> <strTip/> <intOrder>4</intOrder> <blnActive>1</blnActive> <strFormFieldType>Multi Choice</strFormFieldType> <blnSummary/> <alternatives> <record> <idFormFieldAlternative>77</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>FOTOGRAFIAS/IMAGENS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>79</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>MAPAS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>80</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>OUTROS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>75</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>TEXTO PROPRIO</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>76</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>TEXTOS COLETADOS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> <record> <idFormFieldAlternative>78</idFormFieldAlternative> <idFormField>1314</idFormField> <strAlternative>VIDEOS</strAlternative> <blnPublic>0</blnPublic> <intOrder>1</intOrder> </record> </alternatives> </record> <record> <idFormField>1300</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>NOME DA ESCOLA A QUE PERTENCE O ALUNO </strName> <strTip>NOME OFICIAL COMPLETO</strTip> <intOrder>5</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1301</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName/> <strTip>INCLUSIVE CEP, SE POSSIVEL</strTip> <intOrder>6</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1315</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>BAIRRO</strName> <strTip>EX.: BONSUCESSO</strTip> <intOrder>7</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1316</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>LOCALIDADE</strName> <strTip/> <intOrder>8</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1302</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName/> <strTip>DIRETORA, COORDENADORA</strTip> <intOrder>9</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1303</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>TELEFONE(S)</strName> <strTip>INCLUIR AREA CODIGO</strTip> <intOrder>10</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1304</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>ALUNO PARTICIPANTE</strName> <strTip>NOME COMPLETO</strTip> <intOrder>11</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1307</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName/> <strTip/> <intOrder>12</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1317</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>BAIRRO DO ALUNO</strName> <strTip>EX.: ILHA DO GOVERNADOR</strTip> <intOrder>13</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1318</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>LOCALIDADE DO ALUNO</strName> <strTip>EXS: BANCARIOS, COCOTA, JEQUIA</strTip> <intOrder>14</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1308</idFormField> <idForm>8</idForm> <idFormFieldType>1</idFormFieldType> <strName>TELEFONE</strName> <strTip>INCLUIR AREA CODIGO</strTip> <intOrder>15</intOrder> <blnActive>1</blnActive> <strFormFieldType>Free Text</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1306</idFormField> <idForm>8</idForm> <idFormFieldType>2</idFormFieldType> <strName>ANOS DE IDADE</strName> <strTip>ANOS COMPLETADOS</strTip> <intOrder>16</intOrder> <blnActive>1</blnActive> <strFormFieldType>Numeric</strFormFieldType> <blnSummary/> </record> <record> <idFormField>1305</idFormField> <idForm>8</idForm> <idFormFieldType>2</idFormFieldType> <strName> ESCOLARIDADE</strName> <strTip/> <intOrder>17</intOrder> <blnActive>1</blnActive> <strFormFieldType>Numeric</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://viconsaga.com.br/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://viconsaga.com.br/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://viconsaga.com.br/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://viconsaga.com.br/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 <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://viconsaga.com.br/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 <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://viconsaga.com.br/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 <?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://viconsaga.com.br/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 <?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://viconsaga.com.br/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 <?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>PERCEP&#xC7;&#xD5;ES AMBIENTAIS ENSINO M&#xC9;DIO</Title> <Name>percepcoes_ambientais_ensino_medio_8</Name> <Abstract>9 objects</Abstract> <SRS>EPSG:4326</SRS> </FeatureType> <FeatureType> <Title>PERCEP&#xC7;&#xD5;ES AMBIENTAIS GRADUA&#xC7;&#xC3;O</Title> <Name>percepcoes_ambientais_graduacao_9</Name> <Abstract>18 objects</Abstract> <SRS>EPSG:4326</SRS> </FeatureType> <FeatureType> <Title>PERCEP&#xC7;&#xD5;ES AMBIENTAIS P&#xD3;S GRADUA&#xC7;&#xC3;O</Title> <Name>percepcoes_ambientais_pos_graduacao_10</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://viconsaga.com.br/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