Veterans Affairs Forms (Independent Publisher) (Vorschau)
Greifen Sie auf die VA Forms-API zu, um PDF-Links und Metadaten für VA-Formulare zu durchsuchen, abzurufen, einschließlich Versionsverfolgung. Bleiben Sie mit den neuesten VA-Formularinformationen, suchen Sie nach Formularnummer oder Schlüsselwort, erhalten Sie detaillierte Metadaten und vieles mehr. Authentifizieren mit einem API-Token. Testen Sie in der Sandkastenumgebung, bevor Sie einen Produktions-API-Schlüssel anfordern. Verfolgen Sie den SHA256-Überarbeitungsverlauf, um die Datenintegrität sicherzustellen und PDF-Verknüpfungen zu überprüfen. Identifizieren Sie gelöschte Formulare über Metadaten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Richard Wilson |
| URL | https://www.richardawilson.com/ |
| richard.a.wilson@microsoft.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Richard Wilson |
| Webseite | https://developer.va.gov/explore/api/va-facilities |
| Datenschutzrichtlinie | https://department.va.gov/privacy/ |
| Kategorien | Personalabteilung |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| VA-API-Schlüssel | securestring | Der VA-API-Schlüssel für diese API | Richtig |
| Umwelt | Schnur | Die zu verwendende VA-API-Umgebung (Produktion oder Sandbox) | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Formular anhand des Namens abrufen |
Abrufen eines einzelnen Formulars und des vollständigen Überarbeitungsverlaufs |
| Listenformulare |
Rufen Sie alle verfügbaren VA-Formulare ab. Optional nach Formularnummer oder Titel filtern. |
Formular anhand des Namens abrufen
Abrufen eines einzelnen Formulars und des vollständigen Überarbeitungsverlaufs
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Formularname
|
form_name | True | string |
Der VA-Formularname des angeforderten Formulars. Fügen Sie bei Bedarf Präfixe und Bindestriche ein. |
Gibt zurück
Daten für ein bestimmtes VA-Formular, einschließlich des Formularversionsverlaufs.
- Body
- FormShow
Listenformulare
Rufen Sie alle verfügbaren VA-Formulare ab. Optional nach Formularnummer oder Titel filtern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Query
|
query | string |
Abrufen von Formulardaten basierend auf dem eingegebenen Formularnamen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of FormsIndex |
Definitionen
FormsIndex
Eine Auflistung der verfügbaren VA-Formulare und deren Standort.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
JSON-API-ID |
|
Typ
|
type | string |
JSON-API-Typspezifikation |
|
Formularname
|
attributes.form_name | string |
Name des VA-Formulars |
|
URL
|
attributes.url | string |
Webspeicherort des Formulars |
|
Title
|
attributes.title | string |
Titel des Formulars gemäß VA |
|
Zuerst ausgestellt am
|
attributes.first_issued_on | date |
Das Datum, an dem das Formular zuerst verfügbar wurde |
|
Letzte Überarbeitung am
|
attributes.last_revision_on | date |
Das Datum, an dem das Formular zuletzt aktualisiert wurde |
|
Seiten
|
attributes.pages | integer |
Anzahl der im Formular enthaltenen Seiten |
|
Sha256
|
attributes.sha256 | string |
Ein Sha256-Hash des Formularinhalts |
|
Letzte Änderung von Sha256
|
attributes.last_sha256_change | date |
Das Datum der letzten Sha256-Hashänderung |
|
Gültige PDF-Datei
|
attributes.valid_pdf | boolean |
Ein Flag, das angibt, ob die Formular-URL als gültiger Download bestätigt wurde |
|
Formularnutzung
|
attributes.form_usage | string |
Eine Beschreibung der Verwendung des Formulars |
|
Einführung des Formulartools
|
attributes.form_tool_intro | string |
Einführungstext zur Beschreibung des VA Online-Tools für dieses Formular |
|
Url des Formulartools
|
attributes.form_tool_url | string |
Speicherort des Onlinetools für dieses Formular |
|
Url für Formulardetails
|
attributes.form_details_url | string |
Speicherort auf www.va.gov der Infoseite für dieses Formular |
|
Formulartyp
|
attributes.form_type | string |
VA-Typ des Formulars |
|
Language
|
attributes.language | string |
Sprachcode des Formulars |
|
Gelöscht am
|
attributes.deleted_at | date-time |
Der Zeitstempel, zu dem das Formular gelöscht wurde |
|
Verwandte Formulare
|
attributes.related_forms | array of string |
Eine Auflistung anderer Formulare, die sich auf das aktuelle Formular beziehen |
|
Leistungskategorien
|
attributes.benefit_categories | array of object |
Auflistung von Leistungskategorien und Übereinstimmungen |
|
Name
|
attributes.benefit_categories.name | string |
Name der Leistungskategorie des Formulars |
|
Description
|
attributes.benefit_categories.description | string |
Beschreibung der Leistungskategorie des Formulars |
|
VA-Formularverwaltung
|
attributes.va_form_administration | string |
Die VA-Organisation, die das Formular verwaltet |
FormShow
Daten für ein bestimmtes VA-Formular, einschließlich des Formularversionsverlaufs.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
JSON-API-ID |
|
Typ
|
type | string |
JSON-API-Typspezifikation |
|
Formularname
|
attributes.form_name | string |
Name des VA-Formulars |
|
URL
|
attributes.url | string |
Webspeicherort des Formulars |
|
Title
|
attributes.title | string |
Titel des Formulars gemäß VA |
|
Zuerst ausgestellt am
|
attributes.first_issued_on | date |
Das Datum, an dem das Formular zuerst verfügbar wurde |
|
Letzte Überarbeitung am
|
attributes.last_revision_on | date |
Das Datum, an dem das Formular zuletzt aktualisiert wurde |
|
Erstellt unter
|
attributes.created_at | date-time |
Internes Feld für VA.gov Verwendung |
|
Seiten
|
attributes.pages | integer |
Anzahl der im Formular enthaltenen Seiten |
|
Sha256
|
attributes.sha256 | string |
Ein Sha256-Hash des Formularinhalts |
|
Gültige PDF-Datei
|
attributes.valid_pdf | boolean |
Ein Flag, das angibt, ob die Formular-URL als gültiger Download bestätigt wurde |
|
Formularnutzung
|
attributes.form_usage | string |
Eine Beschreibung der Verwendung des Formulars |
|
Einführung des Formulartools
|
attributes.form_tool_intro | string |
Einführungstext zur Beschreibung des VA Online-Tools für dieses Formular |
|
Url des Formulartools
|
attributes.form_tool_url | string |
Speicherort des Onlinetools für dieses Formular |
|
Url für Formulardetails
|
attributes.form_details_url | string |
Speicherort auf www.va.gov der Infoseite für dieses Formular |
|
Formulartyp
|
attributes.form_type | string |
VA-Typ des Formulars |
|
Language
|
attributes.language | string |
Sprachcode des Formulars |
|
Gelöscht am
|
attributes.deleted_at | date-time |
Der Zeitstempel, zu dem das Formular gelöscht wurde |
|
Verwandte Formulare
|
attributes.related_forms | array of string |
Eine Auflistung anderer Formulare, die sich auf das aktuelle Formular beziehen |
|
Leistungskategorien
|
attributes.benefit_categories | array of object |
Auflistung von Leistungskategorien und Übereinstimmungen |
|
Name
|
attributes.benefit_categories.name | string |
Name der Leistungskategorie des Formulars |
|
Description
|
attributes.benefit_categories.description | string |
Beschreibung der Leistungskategorie des Formulars |
|
VA-Formularverwaltung
|
attributes.va_form_administration | string |
Die VA-Organisation, die das Formular verwaltet |
|
versions
|
attributes.versions | array of object |
Der Versionsverlauf von Überarbeitungen im Formular |
|
Sha256
|
attributes.versions.sha256 | string |
Ein Sha256-Hash des Formularinhalts für diese Version |
|
Überarbeitung am
|
attributes.versions.revision_on | date |
Das Datum, an dem der Sha256-Hash berechnet wurde |