Bloquear Região

Route (Rota)

Método	Rota	Descrição
PUT	`/webservice/student/form/field/update`	Atualiza um campo do 'Form Builder'

Headers (Cabeçalho)

Param	Tipo	Descrição	Obrigatório
Accept	`String`	application/json	Sim
Content-Type	`String`	application/json	Sim
secret	`String`	*Secret Key	Sim
token	`String`	**Webservice Token	Sim

*Para conseguir a Secret Key acesse sua Plataforma, abra o Menu, vá na área de Usuários e acesse Webservice, lá você terá a lista de usuários com suas respectivas Secret Key

** Token gerado pela rota de autenticação

Body params (Parâmetros)

Param	Tipo	Descrição	Obrigatório
type	`String`	city, state, country	Não
name	`String`	Nome a ser buscado para inserção	Não

Exemplos

cURL

				
					curl --location 'https://sua.plataforma.com/geographic/save' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_secret}}' \
--header 'token: {{._webservice_token}}' \
--data '{
  "type": "country",
  "name": "Argentina"
}'

Node.js

				
					const axios = require('axios');
let data = JSON.stringify({
  "type": "country",
  "name": "Argentina"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.com/geographic/save',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'secret': '{{._webservice_secret}}', 
    'token': '{{._webservice_token}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

				
					<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{._webservice_secret}}',
  'token' => '{{._webservice_token}}'
];
$body = '{
  "type": "country",
  "name": "Argentina"
}';
$request = new Request('POST', 'https://sua.plataforma.com/geographic/save', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Request (Requisição) e Response (Respostas)

Bloqueio de Cidade

- Request (Bloqueio de Cidade)

				
					{
	"type": "city",
	"name": "Divinópolis"
}

- Response (Bloqueio de Cidade)

				
					{
  "message": "Salvo",
  "status": 200,
  "data": {
    "id": 1,
    "name": "Divinópolis, Microrregião Divinópolis, Região Geográfica Intermediária de Divinópolis, MG, Região Sudeste, Brasil",
    "details": "Divinópolis, Microrregião Divinópolis, Região Geográfica Intermediária de Divinópolis, MG, Região Sudeste, Brasil",
    "place_id": 15628725,
    "type": "city",
    "address": {
      "city": "Divinópolis",
      "county": "Microrregião Divinópolis",
      "state_district": "Região Geográfica Intermediária de Divinópolis",
      "state": "MG",
      "country": "Brasil",
      "country_code": "br"
    }
  }
}

Bloqueio de Estado

- Request (Bloqueio de Estado)

				
					{
	"type": "state",
	"name": "PE"
}

- Response (Bloqueio de Estado)

				
					{
  "message": "Salvo",
  "status": 200,
  "data": {
    "id": 2,
    "name": "PE, Região Nordeste, Brasil",
    "details": "PE, Região Nordeste, Brasil",
    "place_id": 15628194,
    "type": "administrative",
    "address": {
      "state": "PE",
      "country": "Brasil",
      "country_code": "br"
    }
  }
}

Bloqueio de País

- Request (Bloqueio de País)

				
					{
	"type": "country",
	"name": "Argentina"
}

- Response (Bloqueio de País)

				
					{
  "message": "Salvo",
  "status": 200,
  "data": {
    "id": 3,
    "name": "Argentina",
    "details": "Argentina",
    "place_id": 15625702,
    "type": "administrative",
    "address": {
      "country": "Argentina",
      "country_code": "ar"
    }
  }
}