Veterans Affairs Forms (Editora Independente) (Pré-visualização)
Acesse a API do VA Forms para pesquisar, recuperar links PDF e metadados para formulários VA, incluindo o controle de versão. Mantenha-se atualizado com as informações mais recentes do formulário VA, pesquise por número de formulário ou palavra-chave, obtenha metadados detalhados e muito mais. Autentique-se usando um token de API. Teste no ambiente de área restrita antes de solicitar uma chave de API de produção. Acompanhe o histórico de revisões do SHA256 para garantir a integridade dos dados e validar links PDF. Identifique formulários excluídos por meio de metadados.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Richard Wilson |
| URL | https://www.richardawilson.com/ |
| richard.a.wilson@microsoft.com |
| Metadados do conector | |
|---|---|
| Editora | Richard Wilson |
| Sítio Web | https://developer.va.gov/explore/api/va-facilities |
| Política de privacidade | https://department.va.gov/privacy/ |
| Categorias | Recursos Humanos |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API VA | securestring | A chave de API VA para esta api | Verdade |
| Meio Ambiente | cadeia (de caracteres) | O ambiente de API VA a ser usado (Production ou Sandbox) | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Listar formulários |
Recupere todos os formulários VA disponíveis. Opcionalmente, filtre por número de formulário ou título. |
| Obter formulário por nome |
Recuperar um único formulário e seu histórico de revisão completo |
Listar formulários
Recupere todos os formulários VA disponíveis. Opcionalmente, filtre por número de formulário ou título.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Query
|
query | string |
Recupere dados de formulário com base no nome do formulário inserido. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of FormsIndex |
Obter formulário por nome
Recuperar um único formulário e seu histórico de revisão completo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do Formulário
|
form_name | True | string |
O nome do formulário VA do formulário que está sendo solicitado. Inclua prefixos e hífenes quando necessário. |
Devoluções
Dados para um formulário VA específico, incluindo o histórico de versões do formulário.
- Body
- FormShow
Definições
FormsIndex
Uma lista dos formulários VA disponíveis e sua localização.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificador da API JSON |
|
Tipo
|
type | string |
Especificação do tipo de API JSON |
|
Nome do Formulário
|
attributes.form_name | string |
Nome do formulário VA |
|
Endereço URL
|
attributes.url | string |
Localização Web do formulário |
|
Title
|
attributes.title | string |
Título do formulário dado por VA |
|
Emitido pela primeira vez em
|
attributes.first_issued_on | date |
A data em que o formulário ficou disponível pela primeira vez |
|
Última revisão em
|
attributes.last_revision_on | date |
A data em que o formulário foi atualizado pela última vez |
|
Páginas
|
attributes.pages | integer |
Número de páginas contidas no formulário |
|
Sha256
|
attributes.sha256 | string |
Um hash sha256 do conteúdo do formulário |
|
Última alteração do Sha256
|
attributes.last_sha256_change | date |
A data da última alteração de hash sha256 |
|
PDF válido
|
attributes.valid_pdf | boolean |
Um sinalizador que indica se o URL do formulário foi confirmado como um download válido |
|
Utilização do formulário
|
attributes.form_usage | string |
Uma descrição da forma como o formulário deve ser utilizado |
|
Introdução à ferramenta de formulário
|
attributes.form_tool_intro | string |
Texto introdutório que descreve a ferramenta em linha VA para este formulário |
|
URL da ferramenta de formulário
|
attributes.form_tool_url | string |
Localização da ferramenta em linha para este formulário |
|
Url de detalhes do formulário
|
attributes.form_details_url | string |
Localização em www.va.gov da página de informações deste formulário |
|
Tipo de formulário
|
attributes.form_type | string |
VA Tipo do formulário |
|
Linguagem
|
attributes.language | string |
Código linguístico do formulário |
|
Suprimido em
|
attributes.deleted_at | date-time |
O carimbo de data/hora no qual o formulário foi excluído |
|
Formulários relacionados
|
attributes.related_forms | array of string |
Uma lista de outros formulários relacionados com o formulário atual |
|
Categorias de benefícios
|
attributes.benefit_categories | array of object |
Lista de categorias de benefícios e correspondência |
|
Nome
|
attributes.benefit_categories.name | string |
Nome da categoria de benefícios do formulário |
|
Description
|
attributes.benefit_categories.description | string |
Descrição da categoria de benefícios do formulário |
|
Administração de formulários VA
|
attributes.va_form_administration | string |
A organização de VA que administra o formulário |
FormShow
Dados para um formulário VA específico, incluindo o histórico de versões do formulário.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificador da API JSON |
|
Tipo
|
type | string |
Especificação do tipo de API JSON |
|
Nome do Formulário
|
attributes.form_name | string |
Nome do formulário VA |
|
Endereço URL
|
attributes.url | string |
Localização Web do formulário |
|
Title
|
attributes.title | string |
Título do formulário dado por VA |
|
Emitido pela primeira vez em
|
attributes.first_issued_on | date |
A data em que o formulário ficou disponível pela primeira vez |
|
Última revisão em
|
attributes.last_revision_on | date |
A data em que o formulário foi atualizado pela última vez |
|
Criado em
|
attributes.created_at | date-time |
Campo interno para uso VA.gov |
|
Páginas
|
attributes.pages | integer |
Número de páginas contidas no formulário |
|
Sha256
|
attributes.sha256 | string |
Um hash sha256 do conteúdo do formulário |
|
PDF válido
|
attributes.valid_pdf | boolean |
Um sinalizador que indica se o URL do formulário foi confirmado como um download válido |
|
Utilização do formulário
|
attributes.form_usage | string |
Uma descrição da forma como o formulário deve ser utilizado |
|
Introdução à ferramenta de formulário
|
attributes.form_tool_intro | string |
Texto introdutório que descreve a ferramenta em linha VA para este formulário |
|
URL da ferramenta de formulário
|
attributes.form_tool_url | string |
Localização da ferramenta em linha para este formulário |
|
Url de detalhes do formulário
|
attributes.form_details_url | string |
Localização em www.va.gov da página de informações deste formulário |
|
Tipo de formulário
|
attributes.form_type | string |
VA Tipo do formulário |
|
Linguagem
|
attributes.language | string |
Código linguístico do formulário |
|
Suprimido em
|
attributes.deleted_at | date-time |
O carimbo de data/hora no qual o formulário foi excluído |
|
Formulários relacionados
|
attributes.related_forms | array of string |
Uma lista de outros formulários relacionados ao formulário atual |
|
Categorias de benefícios
|
attributes.benefit_categories | array of object |
Lista de categorias de benefícios e correspondência |
|
Nome
|
attributes.benefit_categories.name | string |
Nome da categoria de benefícios do formulário |
|
Description
|
attributes.benefit_categories.description | string |
Descrição da categoria de benefícios do formulário |
|
Administração de formulários VA
|
attributes.va_form_administration | string |
A organização de VA que administra o formulário |
|
versions
|
attributes.versions | array of object |
O histórico de versões das revisões do formulário |
|
Sha256
|
attributes.versions.sha256 | string |
Um hash sha256 do conteúdo do formulário para essa versão |
|
Revisão em
|
attributes.versions.revision_on | date |
A data em que o hash sha256 foi calculado |