Veterans Affairs Forms (onafhankelijke uitgever) (preview)
Open de VA Forms-API om PDF-koppelingen en metagegevens voor VA-formulieren te zoeken, op te halen, inclusief versietracking. Blijf op de hoogte met de meest recente VA-formuliergegevens, zoek op formuliernummer of trefwoord, ontvang gedetailleerde metagegevens en meer. Verifiëren met behulp van een API-token. Test in de sandbox-omgeving voordat u een productie-API-sleutel aanvraagt. Volg de revisiegeschiedenis van SHA256 om de gegevensintegriteit te garanderen en PDF-koppelingen te valideren. Verwijderde formulieren identificeren via metagegevens.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Richard Wilson |
| URL | https://www.richardawilson.com/ |
| E-mailen | richard.a.wilson@microsoft.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Richard Wilson |
| Webpagina | https://developer.va.gov/explore/api/va-facilities |
| Privacybeleid | https://department.va.gov/privacy/ |
| Categorieën | Personeel |
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| VA API-sleutel | beveiligde string | De VA-API-sleutel voor deze API | Klopt |
| Milieu | touw | De VA-API-omgeving die moet worden gebruikt (productie of sandbox) | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Formulier ophalen op naam |
Eén formulier en de volledige revisiegeschiedenis ophalen |
| Lijstformulieren |
Haal alle beschikbare VA-formulieren op. U kunt eventueel filteren op formuliernummer of titel. |
Formulier ophalen op naam
Eén formulier en de volledige revisiegeschiedenis ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Formuliernaam
|
form_name | True | string |
De va-formuliernaam van het formulier dat wordt aangevraagd. Voeg waar nodig voor- en afbreekstreepjes toe. |
Retouren
Gegevens voor een bepaald VA-formulier, inclusief versiegeschiedenis van formulieren.
- Body
- FormShow
Lijstformulieren
Haal alle beschikbare VA-formulieren op. U kunt eventueel filteren op formuliernummer of titel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Query
|
query | string |
Formuliergegevens ophalen op basis van de ingevoerde formuliernaam. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
gegevens
|
data | array of FormsIndex |
Definities
FormsIndex
Een lijst met beschikbare VA-formulieren en hun locatie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
id | string |
JSON-API-id |
|
Typologie
|
type | string |
Specificatie van JSON-API-type |
|
Formuliernaam
|
attributes.form_name | string |
Naam van het VA-formulier |
|
URL
|
attributes.url | string |
Weblocatie van het formulier |
|
Title
|
attributes.title | string |
Titel van het formulier zoals opgegeven door VA |
|
Eerste uitgegeven op
|
attributes.first_issued_on | date |
De datum waarop het formulier voor het eerst beschikbaar werd |
|
Laatste revisie op
|
attributes.last_revision_on | date |
De datum waarop het formulier voor het laatst is bijgewerkt |
|
Pagina's
|
attributes.pages | integer |
Aantal pagina's in het formulier |
|
Sha256
|
attributes.sha256 | string |
Een sha256-hash van de formulierinhoud |
|
Laatste sha256-wijziging
|
attributes.last_sha256_change | date |
De datum van de laatste sha256-hashwijziging |
|
Geldig pdf-bestand
|
attributes.valid_pdf | boolean |
Een vlag die aangeeft of de formulier-URL is bevestigd als een geldige download |
|
Formuliergebruik
|
attributes.form_usage | string |
Een beschrijving van hoe het formulier moet worden gebruikt |
|
Inleiding formulierhulpmiddel
|
attributes.form_tool_intro | string |
Inleidende tekst met een beschrijving van het ONLINE VA-hulpprogramma voor dit formulier |
|
Url van formulierhulpmiddel
|
attributes.form_tool_url | string |
Locatie van het onlinehulpmiddel voor dit formulier |
|
Url voor formulierdetails
|
attributes.form_details_url | string |
Locatie op www.va.gov van de infopagina voor dit formulier |
|
Formuliertype
|
attributes.form_type | string |
VA-type van het formulier |
|
Language
|
attributes.language | string |
Taalcode van het formulier |
|
Verwijderd op
|
attributes.deleted_at | date-time |
De tijdstempel waarop het formulier is verwijderd |
|
Verwante formulieren
|
attributes.related_forms | array of string |
Een lijst met andere formulieren die betrekking hebben op het huidige formulier |
|
Voordeelcategorieën
|
attributes.benefit_categories | array of object |
Vermelding van voordeelcategorieën en overeenkomst |
|
Naam
|
attributes.benefit_categories.name | string |
Naam van de voordeelcategorie van het formulier |
|
Description
|
attributes.benefit_categories.description | string |
Beschrijving van de voordeelcategorie van het formulier |
|
VA-formulierbeheer
|
attributes.va_form_administration | string |
De VA-organisatie die het formulier beheert |
FormShow
Gegevens voor een bepaald VA-formulier, inclusief versiegeschiedenis van formulieren.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
id | string |
JSON-API-id |
|
Typologie
|
type | string |
Specificatie van JSON-API-type |
|
Formuliernaam
|
attributes.form_name | string |
Naam van het VA-formulier |
|
URL
|
attributes.url | string |
Weblocatie van het formulier |
|
Title
|
attributes.title | string |
Titel van het formulier zoals opgegeven door VA |
|
Eerste uitgegeven op
|
attributes.first_issued_on | date |
De datum waarop het formulier voor het eerst beschikbaar werd |
|
Laatste revisie op
|
attributes.last_revision_on | date |
De datum waarop het formulier voor het laatst is bijgewerkt |
|
Gemaakt op
|
attributes.created_at | date-time |
Intern veld voor VA.gov gebruik |
|
Pagina's
|
attributes.pages | integer |
Aantal pagina's in het formulier |
|
Sha256
|
attributes.sha256 | string |
Een sha256-hash van de formulierinhoud |
|
Geldig pdf-bestand
|
attributes.valid_pdf | boolean |
Een vlag die aangeeft of de formulier-URL is bevestigd als een geldige download |
|
Formuliergebruik
|
attributes.form_usage | string |
Een beschrijving van hoe het formulier moet worden gebruikt |
|
Inleiding formulierhulpmiddel
|
attributes.form_tool_intro | string |
Inleidende tekst met een beschrijving van het ONLINE VA-hulpprogramma voor dit formulier |
|
Url van formulierhulpmiddel
|
attributes.form_tool_url | string |
Locatie van het onlinehulpmiddel voor dit formulier |
|
Url voor formulierdetails
|
attributes.form_details_url | string |
Locatie op www.va.gov van de infopagina voor dit formulier |
|
Formuliertype
|
attributes.form_type | string |
VA-type van het formulier |
|
Language
|
attributes.language | string |
Taalcode van het formulier |
|
Verwijderd op
|
attributes.deleted_at | date-time |
De tijdstempel waarop het formulier is verwijderd |
|
Verwante formulieren
|
attributes.related_forms | array of string |
Een lijst met andere formulieren die betrekking hebben op het huidige formulier |
|
Voordeelcategorieën
|
attributes.benefit_categories | array of object |
Vermelding van voordeelcategorieën en overeenkomst |
|
Naam
|
attributes.benefit_categories.name | string |
Naam van de voordeelcategorie van het formulier |
|
Description
|
attributes.benefit_categories.description | string |
Beschrijving van de voordeelcategorie van het formulier |
|
VA-formulierbeheer
|
attributes.va_form_administration | string |
De VA-organisatie die het formulier beheert |
|
versions
|
attributes.versions | array of object |
De versiegeschiedenis van revisies naar het formulier |
|
Sha256
|
attributes.versions.sha256 | string |
Een sha256-hash van de formulierinhoud voor die versie |
|
Revisie op
|
attributes.versions.revision_on | date |
De datum waarop de sha256-hash is berekend |