| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | name(+) | 0;1 | FREE TEXT | B | User friendly name for the web service entry. The name should be prefixed with a package prefix (ex. XOBW TESTER WEB SERVICE). The value must be unique compared to the NAME field value of the other entries in this file. | |
| .02 | type(+) | 0;2 | SET OF CODES | 1:SOAP 2:REST | ||
| .03 | date registered | 0;3 | DATE-TIME | This field indicates the date the web service was registered into VistA, usually via the GENPORT^XOBWLIB or REGREST^XOBWLIB deployment time APIs. | ||
| 100 | proxy class name | 100;1 | FREE TEXT | Name of the CacheObject class for the web service client proxy (i.e HTTP port class). This name should include package indicator. (Example: hwsc.TesterWebServiceHttpPort where 'hwsc' is the package indicator.) This field should only be entered via the API $$GENPORT^XOBWD(...). For an example of how to call the API, see the post-init for the HealtheVet Web Services Client (HWSC) install. (Routine XOBWPST and specifically the GENPORT tag.) | ||
| 200 | context root(+) | 200;1 | FREE TEXT | This field contains the web service context root. This field should only be entered via the API $$GENPORT^XOBWD(...). The value of this field is derived from the wsdl file. (The 'location' attribute of the 'wsdlsoap:address' element of the wsdl is the source.) For an example of how to call the API, see the post-init for the HealtheVet Web Services Client install. (Routine XOBWPST and specifically the GENPORT tag.) | ||
| 201 | availability resource | 201;1 | FREE TEXT | Enter the portion of a URL to append following the service's context root, for availability testing. For SOAP web services this could be an additional portion of the URL to reach the service's WSDL document, e.g., '?wsdl' (without quotes); for REST web services this could the additional portion of the URL to reach a safe resource to perform an HTTP GET against for the purpose of checking service availability. | ||
| 300 | wsdl | 300;0 | WORD-PROCESSING |
Not Referenced