Summary Table

Categories	Total Count
PII	0
URL	0
DNS	0
EKL	0
IP	0
PORT	0
VsID	0
CF	0
AI	0
VPD	0
PL	0
Other	0

File Content

{
"swagger": "2.0",
"info": {
"description": "VA Tool Set for the VA staff",
"version": "3.0.0-SNAPSHOT",
"title": "VA Tool Set"
},
"basePath": "/VarUtilityServices/v3/rest",
"tags": [{
"name": "custom-messages"
}, {
"name": "custom-text-form"
}, {
"name": "direct-booking-eligibility-criteriasite{site-code}"
}, {
"name": "institutions"
}, {
"name": "request-eligibility-criteriasite{site-code}"
}],
"schemes": ["http", "https"],
"paths": {
"/custom-messages/site/{site-code}": {
"get": {
"tags": ["custom-messages"],
"summary": "Retrieves the custom messages for a provided site code",
"description": "",
"operationId": "fetchCustomMessages",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"put": {
"tags": ["custom-messages"],
"summary": "Saves the custom messages for a provided site code",
"description": "",
"operationId": "saveCustomMessages",
"consumes": ["application/xml", "application/json"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "custom messages to custom",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"delete": {
"tags": ["custom-messages"],
"summary": "Deletes the custom messages for a provided site code",
"description": "",
"operationId": "deleteCustomMessages",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-messages/default-message/message-id/{message-id}": {
"get": {
"tags": ["custom-messages"],
"summary": "Retrieves the default custom message for a provided message type",
"description": "",
"operationId": "fetchDefaultMessage",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "message-id",
"in": "path",
"description": "message id",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomMessage"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-text-form/custom-messages/site/{site-code}": {
"delete": {
"tags": ["custom-text-form"],
"summary": "Deletes the custom message for a provided site code",
"description": "",
"operationId": "deleteCustomMessages",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-text-form/site/{site-code}": {
"get": {
"tags": ["custom-text-form"],
"summary": "Retrieves the custom text form for a provided site code",
"description": "",
"operationId": "fetchCustomTextForm",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomTextForm"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"put": {
"tags": ["custom-text-form"],
"summary": "Saves a new custom text form for a provided site code",
"description": "",
"operationId": "saveCustomTextForm",
"consumes": ["application/xml", "application/json"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "custom text form to save",
"required": true,
"schema": {
"$ref": "#/definitions/CustomTextForm"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomTextForm"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"delete": {
"tags": ["custom-text-form"],
"summary": "Deletes the custom text form for a provided site code",
"description": "",
"operationId": "deleteCustomTextForm",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomTextForm"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-text-form/default-message/message-id/{message-id}": {
"get": {
"tags": ["custom-text-form"],
"summary": "Retrieves the default message for a provided message type",
"description": "",
"operationId": "fetchDefaultMessage",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "message-id",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomMessage"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-text-form/default-custom-friendly-text/site/{site-code}": {
"get": {
"tags": ["custom-text-form"],
"summary": "Retrieves the custom friendly text for a provided site code",
"description": "",
"operationId": "fetchDCustomFriendlyText",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomFriendlyText"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/custom-text-form/custom-friendly-text/site/{site-code}": {
"put": {
"tags": ["custom-text-form"],
"summary": "Saves a new custom friendly text for a provided site code",
"description": "",
"operationId": "saveCustomFriendlyText",
"consumes": ["application/xml", "application/json"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "custom friendly text to save",
"required": true,
"schema": {
"$ref": "#/definitions/CustomFriendlyText"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/CustomFriendlyText"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"delete": {
"tags": ["custom-text-form"],
"summary": "Deletes the custom friendly text for a provided site code",
"description": "",
"operationId": "deleteCustomFriendlyText",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomFriendlyText"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/direct-booking-eligibility-criteria/site/{site-code}": {
"get": {
"tags": ["direct-booking-eligibility-criteriasite{site-code}"],
"summary": "Retrieves the patient history options for a provided facility",
"description": "",
"operationId": "fetchPatientHistoryOptions",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DirectBookingEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"post": {
"tags": ["direct-booking-eligibility-criteriasite{site-code}"],
"summary": "Saves a new patient history option for a provided facility",
"description": "",
"operationId": "savePatientHistoryOptions",
"consumes": ["application/json", "application/xml"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "direct booking eligibility criteria to save",
"required": true,
"schema": {
"$ref": "#/definitions/DirectBookingEligibilityCriteria"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DirectBookingEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/direct-booking-eligibility-criteria/site/{site-code}/id/{id}": {
"put": {
"tags": ["direct-booking-eligibility-criteriasite{site-code}"],
"summary": "Updates the patient history options for a provided facility",
"description": "",
"operationId": "updatePatientHistoryOptions",
"consumes": ["application/json", "application/xml"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "direct booking eligibility criteria to update",
"required": true,
"schema": {
"$ref": "#/definitions/DirectBookingEligibilityCriteria"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}, {
"name": "id",
"in": "path",
"description": "direct booking eligibility criteria id",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DirectBookingEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/institutions/site/{site-code}": {
"get": {
"tags": ["institutions"],
"summary": "Retrieves the institutions for a provided site code",
"description": "",
"operationId": "fetchInstitutions",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Institution"
}
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/request-eligibility-criteria/site/{site-code}": {
"get": {
"tags": ["request-eligibility-criteriasite{site-code}"],
"summary": "Retrieves the request eligibility criteria for a provided facility",
"description": "",
"operationId": "fetchRequestEligibilityCriteria",
"produces": ["application/xml", "application/json"],
"parameters": [{
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RequestEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
},
"post": {
"tags": ["request-eligibility-criteriasite{site-code}"],
"summary": "Saves a new request eligibility criteria for a provided facility",
"description": "",
"operationId": "savedRequestEligibilityCriteria",
"consumes": ["application/json", "application/xml"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "request eligibility criteria to save",
"required": true,
"schema": {
"$ref": "#/definitions/RequestEligibilityCriteria"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RequestEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
},
"/request-eligibility-criteria/site/{site-code}/id/{id}": {
"put": {
"tags": ["request-eligibility-criteriasite{site-code}"],
"summary": "Updates the request eligibility criteria for a provided facility",
"description": "",
"operationId": "updateRequestEligibilityCriteria",
"consumes": ["application/json", "application/xml"],
"produces": ["application/xml", "application/json"],
"parameters": [{
"in": "body",
"name": "body",
"description": "request eligibility criteria to update",
"required": true,
"schema": {
"$ref": "#/definitions/RequestEligibilityCriteria"
}
}, {
"name": "site-code",
"in": "path",
"description": "site code",
"required": true,
"type": "string"
}, {
"name": "id",
"in": "path",
"description": "request eligibility criteria id",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RequestEligibilityCriteria"
}
}
},
"security": [{
"JwtRbacRestricted": ["Staff"]
}]
}
}
},
"securityDefinitions": {
"JwtResourceRestricted": {
"type": "apiKey",
"name": "authorization",
"in": "header"
},
"JwtRbacRestricted": {
"type": "apiKey",
"name": "authorization",
"in": "header"
}
},
"definitions": {
"AtomLink": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"xml": {
"attribute": true
}
},
"title": {
"type": "string",
"xml": {
"attribute": true
}
},
"href": {
"type": "string",
"format": "uri",
"xml": {
"attribute": true
}
},
"type": {
"type": "string",
"xml": {
"attribute": true
}
},
"hreflang": {
"type": "string",
"xml": {
"attribute": true
}
},
"length": {
"type": "string",
"xml": {
"attribute": true
}
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
}
},
"xml": {
"name": "link",
"namespace": "http://www.w3.org/2005/Atom"
}
},
"CustomMessage": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"siteCode": {
"type": "string"
},
"messageId": {
"type": "string"
},
"messageText": {
"type": "string"
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
},
"link": {
"type": "array",
"xml": {
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"xml": {
"name": "link"
},
"$ref": "#/definitions/AtomLink"
}
}
}
},
"CustomTextForm": {
"type": "object",
"properties": {
"siteCode": {
"type": "string"
},
"userFriendlyText": {
"type": "string"
},
"customMessages": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomMessage"
}
}
}
},
"CustomFriendlyText": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"siteCode": {
"type": "string"
},
"friendlyText": {
"type": "string"
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
},
"link": {
"type": "array",
"xml": {
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"xml": {
"name": "link"
},
"$ref": "#/definitions/AtomLink"
}
}
}
},
"CoreSetting": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"typeOfCare": {
"type": "string"
},
"patientHistoryRequired": {
"type": "string"
},
"patientHistoryDuration": {
"type": "integer",
"format": "int32"
},
"stopCodes": {
"type": "array",
"items": {
"$ref": "#/definitions/StopCode"
}
},
"canCancel": {
"type": "boolean"
},
"submittedRequestLimit": {
"type": "integer",
"format": "int32"
},
"enterpriseSubmittedRequestLimit": {
"type": "integer",
"format": "int32"
}
}
},
"DirectBookingEligibilityCriteria": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"coreSettings": {
"type": "array",
"items": {
"$ref": "#/definitions/CoreSetting"
}
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
},
"link": {
"type": "array",
"xml": {
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"xml": {
"name": "link"
},
"$ref": "#/definitions/AtomLink"
}
}
}
},
"StopCode": {
"type": "object",
"properties": {
"primary": {
"type": "string"
},
"secondary": {
"type": "string"
}
}
},
"Institution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"parentName": {
"type": "string"
},
"childName": {
"type": "string"
},
"divisionName": {
"type": "string"
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
},
"link": {
"type": "array",
"xml": {
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"xml": {
"name": "link"
},
"$ref": "#/definitions/AtomLink"
}
}
}
},
"CustomRequestSetting": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"typeOfCare": {
"type": "string"
},
"patientHistoryRequired": {
"type": "string"
},
"patientHistoryDuration": {
"type": "integer",
"format": "int32"
},
"stopCodes": {
"type": "array",
"items": {
"$ref": "#/definitions/StopCode"
}
},
"canCancel": {
"type": "boolean"
},
"submittedRequestLimit": {
"type": "integer",
"format": "int32"
},
"enterpriseSubmittedRequestLimit": {
"type": "integer",
"format": "int32"
},
"supported": {
"type": "boolean"
},
"schedulingDays": {
"type": "array",
"items": {
"$ref": "#/definitions/SchedulingDay"
}
}
}
},
"RequestEligibilityCriteria": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"requestSettings": {
"type": "array",
"items": {
"$ref": "#/definitions/CoreSetting"
}
},
"customRequestSettings": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomRequestSetting"
}
},
"objectType": {
"type": "string",
"xml": {
"name": "object-type"
}
},
"link": {
"type": "array",
"xml": {
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"xml": {
"name": "link"
},
"$ref": "#/definitions/AtomLink"
}
}
}
},
"SchedulingDay": {
"type": "object",
"properties": {
"day": {
"type": "string",
"enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
},
"canSchedule": {
"type": "boolean"
},
"startTime": {
"type": "string"
},
"endTime": {
"type": "string"
}
}
}
}
}