Estruturas de URLs e JSONs
Estruturas de URLs
A partir da URL base de contato dos serviços fornecida no passo anterior, um conjunto de serviços deverá ser fornecido através das seguintes URLS:
URL Base: http://localhost:8002/api/servicos/
URL Serviços Disponíveis por CPF: http://localhost:8002/api/servicos/cpf/{{ cpf }}/
URL Serviço Ativo: http://localhost:8002/api/servicos/{{ id_servico }}/
URL Avaliação Disponibilidade de Serviços por CPF: http://localhost:8002/api/servicos/cpf/{{cpf}}/avaliacao_disponibilidade/
URL Receber Solicitação Serviço: http://localhost:8002/api/servicos/{{id_servico}}/cpf/receber_solicitacao/
URL Autocompletar: http://localhost:8002/api/servicos/autocompletar/
Tipos de Campos Disponíveis
Tipo do Campo
Componente de Formulário
Booleano
Caixas de seleção (checkbox)
String
Campo de texto
Campo de texto com validação de e-mail
Integer
Campo para entrada exclusiva de números inteiros
File
Campo para upload de arquivo
Choices
Campo select com autocompletar (podem consumir Ajax, ou não)
Hidden
Campo escondido (hidden)
Date
Campo de data
Estrutura dos JSONs
Abaixo serão exibidos, a título de exemplo, os JSONs trocados com o Balcão de Serviços Digitais referentes as duas etapas do serviço de Protocolo Digital.
JSON 1ª Etapa - Protocolo Digital
{
"etapa_atual":1,
"total_etapas":2,
"nome":"Etapa 1",
"formulario":[
{
"type":"string",
"label":"Nome",
"name":"nome",
"value":"João Tomé Pinto de Souza Palhares",
"required":True,
"read_only":True,
"max_length":200,
"min_length":0,
"balcaodigital_user_info":"GOVBR_NOME",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"CPF",
"name":"cpf",
"value":"682.564.070-42",
"required":True,
"read_only":True,
"mask":"000.000.000-00",
"max_length":255,
"min_length":0,
"balcaodigital_user_info":"GOVBR_CPF",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"E-mail",
"name":"email",
"value":"None",
"required":True,
"max_length":200,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Telefone",
"name":"telefone",
"value":"None",
"required":True,
"max_length":200,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Cep",
"name":"cep",
"value":"59370000",
"required":False,
"mask":"00000-000",
"max_length":9,
"min_length":0,
"balcaodigital_user_info":"TSE_CEP",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Logradouro",
"name":"logradouro",
"value":"RUA CORONEL FRANCISCO BEZERRA,",
"required":True,
"max_length":255,
"min_length":0,
"balcaodigital_user_info":"TSE_ENDERECO",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Número",
"name":"numero",
"value":"91",
"required":True,
"max_length":255,
"min_length":0,
"balcaodigital_user_info":"TSE_NUMERO",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Complemento",
"name":"complemento",
"value":"None",
"required":False,
"max_length":255,
"min_length":0,
"balcaodigital_user_info":"TSE_COMPLEMENTO",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Bairro",
"name":"bairro",
"value":"MAJOR ARY DE PINHO",
"required":True,
"max_length":255,
"min_length":0,
"balcaodigital_user_info":"TSE_BAIRRO",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"choices",
"label":"Estado",
"name":"estado",
"value":"None",
"required":False,
"choices_resource_id":"IlByb3RvY29sYXJEb2N1bWVudG9TZXJ2aWNlUHJvdmlkZXIuY2hvaWNlc19lc3RhZG8i:1kAed4:_-JVVMhmvGp_1XEpPRQzkzF8YAk",
"filters":"null",
"lazy":True,
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"choices",
"label":"Cidade",
"name":"cidade",
"value":"None",
"required":True,
"choices_resource_id":"IlByb3RvY29sYXJEb2N1bWVudG9TZXJ2aWNlUHJvdmlkZXIuY2hvaWNlc19jaWRhZGUi:1kAed4:9Jm3UCU1KqOn9YMkwm1_bcX5Y00",
"filters":"null",
"lazy":True,
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
}
],
"fieldsets":[
{
"name":"Dados Pessoais",
"fields":[
"nome",
"cpf",
"email",
"telefone"
]
},
{
"name":"Endereço",
"fields":[
"cep",
"logradouro",
"numero",
"complemento",
"estado",
"cidade",
"bairro"
]
}
]
}JSON 2ª Etapa - Protocolo Digital
{
"etapa_atual":2,
"total_etapas":2,
"nome":"Etapa 2",
"formulario":[
{
"type":"string",
"label":"Assunto",
"name":"assunto",
"value":"None",
"required":True,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Descrição",
"name":"descricao",
"value":"None",
"required":True,
"max_length":510,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textarea",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"choices",
"label":"Campus",
"name":"campus",
"value":"None",
"required":True,
"choices_resource_id":"IlByb3RvY29sYXJEb2N1bWVudG9TZXJ2aWNlUHJvdmlkZXIuY2hvaWNlc191bmlkYWRlX29yZ2FuaXphY2lvbmFsIg:1kAegQ:FavVM78ROT0bwNUzjjcXY_KGC-M",
"filters":"null",
"avaliacao_status":"None",
"avaliacao_status_msg":"None",
"choices":{
"8":"CAMPUS APODI",
"7":"CAMPUS CAICÓ",
"13":"CAMPUS NATAL - CIDADE ALTA",
"41":"CAMPUS CANGUARETAMA",
"45":"CAMPUS CEARÁ-MIRIM",
"3":"CAMPUS CURRAIS NOVOS",
"1":"CAMPUS NATAL - CENTRAL",
"6":"CAMPUS IPANGUAÇU",
"9":"CAMPUS JOÃO CÂMARA",
"55":"CAMPUS AVANÇADO JUCURUTU",
"47":"CAMPUS AVANÇADO LAJES",
"10":"CAMPUS MACAU",
"4":"CAMPUS MOSSORÓ",
"16":"CAMPUS NOVA CRUZ",
"48":"CAMPUS AVANÇADO PARELHAS",
"15":"CAMPUS PARNAMIRIM",
"11":"CAMPUS PAU DOS FERROS",
"12":"CAMPUS SANTA CRUZ",
"17":"CAMPUS SÃO GONÇALO DO AMARANTE",
"43":"CAMPUS SÃO PAULO DO POTENGI",
"14":"CAMPUS AVANÇADO NATAL-ZONA LESTE",
"2":"CAMPUS NATAL - ZONA NORTE",
"18":"REITORIA"
}
},
{
"type":"string",
"label":"Descrição",
"name":"anexo_1_descricao",
"value":"None",
"required":False,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"file",
"label":"Anexo",
"name":"anexo_1_file",
"value":"None",
"required":False,
"label_to_file":"Anexo1",
"limit_size_in_bytes":2097152,
"allowed_extensions":[
"pdf"
],
"value_hash_sha512_link_id":"None",
"value_hash_sha512":"None",
"value_content_type":"None",
"value_original_name":"None",
"value_size_in_bytes":"None",
"value_md5_hash":"None",
"value_charset":"None",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Descrição",
"name":"anexo_2_descricao",
"value":"None",
"required":False,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"file",
"label":"Anexo",
"name":"anexo_2_file",
"value":"None",
"required":False,
"label_to_file":"Anexo2",
"limit_size_in_bytes":2097152,
"allowed_extensions":[
"pdf"
],
"value_hash_sha512_link_id":"None",
"value_hash_sha512":"None",
"value_content_type":"None",
"value_original_name":"None",
"value_size_in_bytes":"None",
"value_md5_hash":"None",
"value_charset":"None",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Descrição",
"name":"anexo_3_descricao",
"value":"None",
"required":False,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"file",
"label":"Anexo",
"name":"anexo_3_file",
"value":"None",
"required":False,
"label_to_file":"Anexo3",
"limit_size_in_bytes":2097152,
"allowed_extensions":[
"pdf"
],
"value_hash_sha512_link_id":"None",
"value_hash_sha512":"None",
"value_content_type":"None",
"value_original_name":"None",
"value_size_in_bytes":"None",
"value_md5_hash":"None",
"value_charset":"None",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Descrição",
"name":"anexo_4_descricao",
"value":"None",
"required":False,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"file",
"label":"Anexo",
"name":"anexo_4_file",
"value":"None",
"required":False,
"label_to_file":"Anexo4",
"limit_size_in_bytes":2097152,
"allowed_extensions":[
"pdf"
],
"value_hash_sha512_link_id":"None",
"value_hash_sha512":"None",
"value_content_type":"None",
"value_original_name":"None",
"value_size_in_bytes":"None",
"value_md5_hash":"None",
"value_charset":"None",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"string",
"label":"Descrição",
"name":"anexo_5_descricao",
"value":"None",
"required":False,
"max_length":100,
"min_length":0,
"balcaodigital_user_info":"None",
"widget":"textinput",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
},
{
"type":"file",
"label":"Anexo",
"name":"anexo_5_file",
"value":"None",
"required":False,
"label_to_file":"Anexo5",
"limit_size_in_bytes":2097152,
"allowed_extensions":[
"pdf"
],
"value_hash_sha512_link_id":"None",
"value_hash_sha512":"None",
"value_content_type":"None",
"value_original_name":"None",
"value_size_in_bytes":"None",
"value_md5_hash":"None",
"value_charset":"None",
"avaliacao_status":"None",
"avaliacao_status_msg":"None"
}
],
"fieldsets":[
{
"name":"Dados do Requerimento",
"fields":[
"assunto",
"descricao",
"campus"
]
},
{
"name":"Anexo 1",
"fields":[
"anexo_1_descricao",
"anexo_1_file"
]
},
{
"name":"Anexo 2",
"fields":[
"anexo_2_descricao",
"anexo_2_file"
]
},
{
"name":"Anexo 3",
"fields":[
"anexo_3_descricao",
"anexo_3_file"
]
},
{
"name":"Anexo 4",
"fields":[
"anexo_4_descricao",
"anexo_4_file"
]
},
{
"name":"Anexo 5",
"fields":[
"anexo_5_descricao",
"anexo_5_file"
]
}
]
}Last updated
Was this helpful?