Skip to content

Instantly share code, notes, and snippets.

@hpjaj

hpjaj/Vets-API Open API spec.json

Last active December 5, 2018 14:56
Show Gist options
  • Save hpjaj/059ae5ed88eb02fc1ae4ac916ae3e320 to your computer and use it in GitHub Desktop.
Save hpjaj/059ae5ed88eb02fc1ae4ac916ae3e320 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Vets-API Open API spec.json
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "vets.gov API",
"description": "The API for managing vets.gov",
"termsOfService": "",
"contact": {
"name": "vets.gov team"
},
"license": {
"name": "Creative Commons Zero v1.0 Universal"
}
},
"tags": [
{
"name": "authentication",
"description": "Authentication operations"
},
{
"name": "user",
"description": "Current authenticated user data"
},
{
"name": "profile",
"description": "User profile information"
},
{
"name": "benefits_info",
"description": "Veteran benefits profile information"
},
{
"name": "benefits_forms",
"description": "Apply for and claim Veteran benefits"
},
{
"name": "benefits_status",
"description": "Check status of benefits claims and appeals"
},
{
"name": "form_526",
"description": "Creating and submitting compensation applications"
},
{
"name": "prescriptions",
"description": "Prescription refill/tracking operations"
},
{
"name": "health_records",
"description": "Download electronic health records"
},
{
"name": "secure_messaging",
"description": "Send and receive secure messages to health providers"
},
{
"name": "terms_and_conditions",
"description": "Terms and conditions acceptance for access to health tools"
},
{
"name": "facilities",
"description": "VA facilities, locations, hours of operation, available services"
},
{
"name": "gi_bill_institutions",
"description": "Discover institutions at which GI Bill benefits may be used"
},
{
"name": "in_progress_forms",
"description": "In-progress form operations"
},
{
"name": "site",
"description": "Site service availability and feedback"
}
],
"host": "dev-api.vets.gov",
"schemes": [
"https",
"http"
],
"basePath": "/",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": {
"authorization": {
"name": "Authorization",
"in": "header",
"description": "The authorization method and token value",
"required": true,
"type": "string"
},
"optional_authorization": {
"name": "Authorization",
"in": "header",
"description": "The authorization method and token value",
"required": false,
"type": "string"
},
"optional_page_number": {
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"description": "Page of results, greater than 0 (default: 1)"
},
"optional_page_length": {
"name": "per_page",
"in": "query",
"required": false,
"type": "integer",
"description": "number of results, between 1 and 99 (default: 10)"
},
"optional_sort": {
"name": "sort",
"in": "query",
"required": false,
"type": "string",
"description": "Comma separated sort field(s), prepend with '-' for descending"
},
"optional_filter": {
"name": "filter",
"in": "query",
"required": false,
"type": "string",
"description": "Filter on refill_status: [[refill_status][logical operator]=status]"
}
},
"paths": {
"/v0/address/countries": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Countries"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a list of the PCIU supported countries",
"operationId": "getCountries",
"tags": [
"benefits_info"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/address/states": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/States"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a list of the PCIU supported states",
"operationId": "getStates",
"tags": [
"benefits_info"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/address": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Address"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a users corp address",
"operationId": "getAddress",
"tags": [
"benefits_info"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
},
"put": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Address"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Updates a users corp address",
"operationId": "getAddress",
"tags": [
"benefits_info"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Options to include in generated PDF",
"required": true,
"schema": {
"properties": {
"type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"MILITARY"
],
"example": "DOMESTIC"
},
"address_one": {
"type": "string",
"example": "140 Rock Creek Church Rd NW"
},
"address_two": {
"type": "string",
"example": ""
},
"address_three": {
"type": "string",
"example": ""
},
"city": {
"type": "string",
"example": "Washington"
},
"state_code": {
"type": "string",
"example": "DC"
},
"zip_code": {
"type": "string",
"example": "20011"
},
"zip_suffix": {
"type": "string",
"example": "1865"
}
}
}
}
]
}
},
"/v0/appeals": {
"get": {
"responses": {
"200": {
"description": "200 passes the response from the upstream appeals API. Their swagger can be viewed here https://app.swaggerhub.com/apis/dsva-appeals/appeals-status/2.0.0#/default/appeals",
"schema": {
"$ref": "#/definitions/Appeals"
}
},
"401": {
"description": "User is not authenticated (logged in)",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden: user is not authorized for appeals",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Not found: appeals not found for user",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"422": {
"description": "Unprocessable Entity: one or more validations has failed",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"502": {
"description": "Bad Gateway: the upstream appeals app returned an invalid response (500+)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "returns list of appeals for a user",
"operationId": "getAppeals",
"tags": [
"benefits_status"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/appointments": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"appointments"
],
"properties": {
"appointments": {
"type": "array",
"items": {
"properties": {
"appointment_status_code": {
"type": "string"
},
"appointment_status_name": {
"type": "string"
},
"assigning_facility": {
"type": "string"
},
"clinic_code": {
"type": "string",
"example": "409"
},
"clinic_name": {
"type": "string",
"example": "ZZCHY WID BACK"
},
"facility_name": {
"type": "string",
"example": "CHEYENNE VAMC"
},
"facility_code": {
"type": "string",
"example": "442"
},
"local_id": {
"type": "string",
"example": "2960112.0812",
"description": "The LocalID element is an internal ID from the VistA/Source system"
},
"other_information": {
"type": "string"
},
"start_time": {
"type": "string",
"example": "1996-01-12T08:12:00",
"description": "Time is in the same timezone that the associated facility_name is in."
},
"status_code": {
"type": "string",
"example": "2"
},
"status_name": {
"type": "string",
"example": "CHECKED OUT",
"enum": [
"CHECKED IN",
"CHECKED OUT",
"NO ACTION TAKEN",
"NO-SHOW",
"NO-SHOW & AUTO RE-BOOK",
"INPATIENT APPOINTMENT",
"FUTURE",
"NON-COUNT",
"DELETED",
"ACTION REQUIRED",
"CANCELLED BY CLINIC",
"CANCELLED BY PATIENT",
"CANCELLED BY CLINIC & AUTO RE-BOOK",
"CANCELLED BY PATIENT & AUTO-REBOOK"
]
},
"type_code": {
"type": "string",
"example": "9"
},
"type_name": {
"type": "string",
"example": "REGULAR",
"enum": [
"COMPENSATION & PENSION",
"CLASS II DENTAL",
"ORGAN DONORS",
"EMPLOYEE",
"PRIMA FACIA",
"RESEARCH",
"COLLATERAL OF VET.",
"SHARING AGREEMENT",
"REGULAR",
"COMPUTER GENERATED",
"SERVICE CONNECTED"
]
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Error Occurred",
"schema": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status",
"source"
],
"properties": {
"title": {
"type": "string",
"example": "Error Occurred"
},
"detail": {
"type": "string",
"example": "General error received from iHub. Check sentry logs for details."
},
"code": {
"type": "string",
"example": "IHUB_101"
},
"status": {
"type": "string",
"example": "400"
},
"source": {
"type": "string",
"example": "IHub::Appointments::Service"
}
}
}
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"502": {
"description": "User missing ICN",
"schema": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status",
"source"
],
"properties": {
"title": {
"type": "string",
"example": "User missing ICN"
},
"detail": {
"type": "string",
"example": "The user does not have an ICN."
},
"code": {
"type": "string",
"example": "IHUB_102"
},
"status": {
"type": "string",
"example": "502"
},
"source": {
"type": "string",
"example": "IHub::Appointments::Service"
}
}
}
}
}
}
}
},
"description": "List of user appointments for the previous three months, through the upcoming six months",
"operationId": "getAppointments",
"tags": [
"appointments"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/backend_statuses/{service}": {
"get": {
"description": "Gets the status of backend service",
"operationId": "getBackendStatus",
"tags": [
"site"
],
"parameters": [
{
"name": "service",
"in": "path",
"description": "The name of the backend service",
"required": true,
"type": "string",
"enum": [
"gibs",
"facilities",
"hca",
"edu-benefits",
"evss-claims",
"appeals-status",
"user-profile",
"id-card",
"identity-proofed",
"vet360",
"rx",
"messaging",
"health-records",
"mhv-accounts",
"form-save-in-progress",
"form-prefill"
]
}
],
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Availability"
}
}
}
}
},
"/v0/health_records/refresh": {
"get": {
"description": "Retrieves patient status",
"operationId": "bbHealthRecordsRefresh",
"tags": [
"health_records"
],
"responses": {
"200": {
"description": "health records refresh response",
"schema": {
"$ref": "#/definitions/HealthRecordsRefresh"
}
},
"403": {
"description": "forbidden user",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/health_records/eligible_data_classes": {
"get": {
"description": "Retrieves a list of health care record categories",
"operationId": "bbHealthRecordsEligibleDataClasses",
"tags": [
"health_records"
],
"responses": {
"200": {
"description": "heath records eligible data classes list",
"schema": {
"$ref": "#/definitions/HealthRecordsEligibleDataClasses"
}
}
}
}
},
"/v0/health_records": {
"get": {
"description": "Retrieves a BB Report",
"operationId": "bbHealthRecordsShow",
"tags": [
"health_records"
],
"parameters": [
{
"name": "doc_type",
"in": "query",
"required": false,
"type": "string",
"enum": [
"txt",
"pdf"
],
"description": "the document type"
}
],
"responses": {
"200": {
"description": "health records show response",
"schema": {
"type": "file"
}
},
"503": {
"description": "health records backend error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
},
"post": {
"description": "Generates a new BB Report",
"operationId": "bbHealthRecordsCreate",
"tags": [
"health_records"
],
"parameters": [
{
"name": "nil",
"in": "body",
"schema": {
"required": [
"from_date",
"to_date",
"data_classes"
],
"properties": {
"from_date": {
"type": "string",
"description": "date on which records start"
},
"to_date": {
"type": "string",
"description": "date on which records end"
},
"data_classes": {
"type": "array",
"description": "list of data to be returned",
"items": {
"type": "string"
}
}
}
}
}
],
"responses": {
"202": {
"description": "health records create response"
},
"422": {
"description": "health records missing required parameter response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/burial_claims": {
"post": {
"responses": {
"200": {
"description": "Form Submitted",
"schema": {
"$ref": "#/definitions/SavedForm"
}
},
"422": {
"description": "Failed model validation(s)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit a burial benefit claim",
"operationId": "addBurialClaim",
"tags": [
"benefits_forms"
],
"parameters": [
{
"$ref": "#/parameters/optional_authorization"
},
{
"name": "form",
"in": "body",
"description": "Burial claim form data",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v0/disability_compensation_form/rated_disabilities": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/RatedDisabilities"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a list of previously rated disabilities for a veteran",
"operationId": "getRatedDisabilities",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/disability_compensation_form/suggested_conditions{params}": {
"get": {
"responses": {
"200": {
"description": "Returns a list of conditions",
"schema": {
"$ref": "#/definitions/SuggestedConditions"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Given part of a condition name (medical or lay), return a list of matching conditions",
"operationId": "getSuggestedConditions",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "name_part",
"description": "part of a condition name",
"in": "path",
"type": "string",
"required": true
}
]
}
},
"/v0/disability_compensation_form/submit": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/SubmitDisabilityForm"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit the disability compensation increase application for a veteran",
"operationId": "postSubmitForm",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/disability_compensation_form/submission_status/{job_id}": {
"get": {
"responses": {
"200": {
"description": "Returns the status of a given submission",
"schema": {
"$ref": "#/definitions/Form526JobStatus"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Check the status of a submission job",
"operationId": "getSubmissionStatus",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "job_id",
"description": "the job_id for the submission to check the status of",
"in": "path",
"type": "string",
"required": true
}
]
}
},
"/v0/education_benefits_claims/{form_type}": {
"post": {
"responses": {
"200": {
"description": "create education benefits claim response",
"schema": {
"$ref": "#/definitions/EducationBenefitsClaimData"
}
},
"422": {
"description": "Failed model validation(s)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit an education benefits claim",
"operationId": "addEducationBenefitsClaim",
"tags": [
"benefits_forms"
],
"parameters": [
{
"name": "education_benefits_claim",
"in": "body",
"description": "Education benefits form data",
"required": true,
"schema": {
"$ref": "#/definitions/EducationBenefitsClaimInput"
}
},
{
"name": "form_type",
"in": "path",
"description": "Form code. Allowed values: 1990 1995 1990e 5490",
"required": true,
"type": "string"
}
]
}
},
"/v0/feedback": {
"post": {
"responses": {
"202": {
"description": "The request has been accepted for processing",
"schema": {
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit user feedback about a given page",
"operationId": "postFeedback",
"tags": [
"site"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Options that makeup the user feedback",
"required": true,
"schema": {
"required": [
"target_page",
"description"
],
"properties": {
"target_page": {
"type": "string",
"example": "/some/page.html",
"description": "The Vets.gov webpage the user is currently on"
},
"description": {
"type": "string",
"example": "I liked this page very much!",
"description": "Text from user describing their experience"
},
"owner_email": {
"type": [
"string",
"null"
],
"example": "joe.smith@gmail.com",
"description": "Optionally provide email of the user"
}
}
}
}
]
}
},
"/v0/gi/calculator_constants": {
"get": {
"description": "Gets all calculator constants",
"operationId": "gibctCalculatorConstantsIndex",
"tags": [
"gi_bill_institutions"
],
"responses": {
"200": {
"description": "autocomplete response",
"schema": {
"$ref": "#/definitions/GibctCalculatorConstants"
}
}
}
}
},
"/v0/gi/institutions/autocomplete": {
"get": {
"description": "Retrieves institution names begining with a set of letters",
"operationId": "gibctInstitutionsAutocomplete",
"tags": [
"gi_bill_institutions"
],
"parameters": [
{
"name": "term",
"in": "query",
"required": true,
"type": "string",
"description": "start of an institution name"
}
],
"responses": {
"200": {
"description": "autocomplete response",
"schema": {
"$ref": "#/definitions/GibctInstitutionsAutocomplete"
}
}
}
}
},
"/v0/gi/institutions/search": {
"get": {
"description": "Retrieves institutions with a partial match for names, or match of city or facility code",
"operationId": "gibctInstitutionsSearch",
"tags": [
"gi_bill_institutions"
],
"parameters": [
{
"name": "term",
"in": "query",
"required": false,
"type": "string",
"description": "(partial) institution name, city, or facility code"
}
],
"responses": {
"200": {
"description": "search response",
"schema": {
"$ref": "#/definitions/GibctInstitutionsSearch"
}
}
}
}
},
"/v0/gi/institutions/{id}": {
"get": {
"description": "Get details about an institution",
"operationId": "showInstitution",
"tags": [
"gi_bill_institutions"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "facility code of the institution"
}
],
"responses": {
"200": {
"description": "show response",
"schema": {
"$ref": "#/definitions/GibctInstitution"
}
},
"404": {
"description": "Operation fails with invalid facility code",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/health_care_applications": {
"post": {
"responses": {
"200": {
"description": "submit health care application response",
"schema": {
"$ref": "#/definitions/HealthCareApplicationSubmissionResponse"
}
},
"400": {
"description": "Backend service error",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"422": {
"description": "Failed model validation(s)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit a health care application",
"operationId": "addHealthCareApplication",
"tags": [
"benefits_forms"
],
"parameters": [
{
"$ref": "#/parameters/optional_authorization"
},
{
"name": "form",
"in": "body",
"description": "Health care application form data",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v0/health_care_applications/healthcheck": {
"get": {
"description": "Check if the HCA submission service is up",
"operationId": "healthcheckHealthCareApplication",
"tags": [
"benefits_forms"
],
"responses": {
"200": {
"description": "health care application health check response",
"schema": {
"$ref": "#/definitions/HealthCareApplicationHealthcheckResponse"
}
}
}
}
},
"/v0/in_progress_forms": {
"get": {
"responses": {
"200": {
"description": "get saved form summaries",
"schema": {
"$ref": "#/definitions/SavedFormSummaries"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get Saved Form Summaries",
"operationId": "listInProgressForms",
"tags": [
"in_progress_forms"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/in_progress_forms/{id}": {
"delete": {
"responses": {
"200": {
"description": "delete form response",
"schema": {
"$ref": "#/definitions/References"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Delete form data",
"operationId": "deleteInProgressForm",
"tags": [
"in_progress_forms"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "id",
"in": "path",
"description": "ID of the form",
"required": true,
"type": "string"
}
]
},
"get": {
"responses": {
"200": {
"description": "get form response",
"schema": {
"$ref": "#/definitions/FormOutputData"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get form data",
"operationId": "getInProgressForm",
"tags": [
"in_progress_forms"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "id",
"in": "path",
"description": "ID of the form",
"required": true,
"type": "string"
}
]
},
"put": {
"responses": {
"200": {
"description": "update form response"
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Update form data",
"operationId": "updateInProgressForm",
"tags": [
"in_progress_forms"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "id",
"in": "path",
"description": "ID of the form",
"required": true,
"type": "string"
},
{
"name": "form_data",
"in": "body",
"description": "new data for the form",
"required": true,
"schema": {
"$ref": "#/definitions/FormInputData"
}
}
]
}
},
"/v0/intent_to_file": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/IntentToFiles"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a list of all Intent To File requests made by the veteran",
"operationId": "getIntentToFile",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/intent_to_file/{type}/active": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/IntentToFile"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get the current active Intent To File if the veteran has one",
"operationId": "getIntentToFileActive",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "type",
"in": "path",
"description": "ITF type. Allowed values: compensation",
"required": true,
"type": "string"
}
]
}
},
"/v0/intent_to_file/{type}": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/IntentToFile"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Creates a new Intent To File for the veteran",
"operationId": "postIntentToFile",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "type",
"in": "path",
"description": "ITF type. Allowed values: compensation",
"required": true,
"type": "string"
}
]
}
},
"/v0/letters": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Letters"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a list of available letters for a veteran",
"operationId": "getLetters",
"tags": [
"benefits_status"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/letters/beneficiary": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/LetterBeneficiary"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Returns service history, and a list of benefit options for use with POST /v0/letters",
"operationId": "getLettersBeneficiary",
"tags": [
"benefits_status"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/letters/{id}": {
"post": {
"responses": {
"200": {
"description": "Response is OK"
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Returns a letter as a PDF blob",
"operationId": "postLetter",
"tags": [
"benefits_status"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Options to include in generated PDF",
"required": false,
"schema": {
"properties": {
"hasNonServiceConnectedPension": {
"type": "boolean",
"example": true
},
"hasServiceConnectedDisabilities": {
"type": "boolean",
"example": true
},
"hasSurvivorsIndemnityCompensationAward": {
"type": "boolean",
"example": true
},
"hasSurvivorsPensionAward": {
"type": "boolean",
"example": true
},
"monthlyAwardAmount": {
"type": "number",
"example": true
},
"serviceConnectedPercentage": {
"type": "integer",
"example": true
},
"awardEffectiveDate": {
"type": "string",
"example": true
},
"hasAdaptedHousing": {
"type": [
"boolean",
"null"
],
"example": true
},
"hasChapter35Eligibility": {
"type": [
"boolean",
"null"
],
"example": true
},
"hasDeathResultOfDisability": {
"type": [
"boolean",
"null"
],
"example": true
},
"hasIndividualUnemployabilityGranted": {
"type": [
"boolean",
"null"
],
"example": true
},
"hasSpecialMonthlyCompensation": {
"type": [
"boolean",
"null"
],
"example": true
}
}
}
}
]
}
},
"/v0/maintenance_windows": {
"get": {
"description": "Get a list of scheduled maintenance windows by service",
"operationId": "getMaintenanceWindows",
"tags": [
"site"
],
"responses": {
"200": {
"description": "get list of scheduled maintenance windows",
"schema": {
"$ref": "#/definitions/MaintenanceWindows"
}
}
}
}
},
"/v0/messaging/health/folders": {
"get": {
"description": "Get a list of folders",
"operationId": "foldersIndex",
"tags": [
"secure_messaging"
],
"parameters": [
{
"$ref": "#/parameters/optional_page_number"
},
{
"$ref": "#/parameters/optional_page_length"
}
],
"responses": {
"200": {
"description": "folders response",
"schema": {
"$ref": "#/definitions/Folders"
}
}
}
},
"post": {
"description": "Create a new folder",
"operationId": "foldersCreate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "folder",
"in": "body",
"required": true,
"description": "new folder name",
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
],
"responses": {
"201": {
"description": "create folder response",
"schema": {
"$ref": "#/definitions/Folder"
}
}
}
}
},
"/v0/messaging/health/folders/{folder_id}/messages": {
"get": {
"description": "Get a list of messages in a specific folder",
"operationId": "foldersMessageIndex",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "folder_id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the folder"
},
{
"$ref": "#/parameters/optional_page_number"
},
{
"$ref": "#/parameters/optional_page_length"
}
],
"responses": {
"200": {
"description": "folder messages response",
"schema": {
"$ref": "#/definitions/Messages"
}
},
"404": {
"description": "folder show messages response error",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/folders/{id}": {
"get": {
"description": "Get information about a specific folder",
"operationId": "foldersShow",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the folder"
}
],
"responses": {
"200": {
"description": "folder show response",
"schema": {
"$ref": "#/definitions/Folder"
}
},
"404": {
"description": "folder show response error",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
},
"delete": {
"description": "Deletes a specific folder",
"operationId": "foldersDelete",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the folder"
}
],
"responses": {
"204": {
"description": "delete folder response"
},
"404": {
"description": "folder delete response error",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages/{id}/thread": {
"get": {
"description": "Gets the messages in a thread",
"operationId": "messagesThreadIndex",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "a message id in a thread"
}
],
"responses": {
"200": {
"description": "threaded messages response",
"schema": {
"$ref": "#/definitions/MessagesThread"
}
},
"404": {
"description": "message show error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages/{id}": {
"get": {
"description": "Get the message",
"operationId": "messagesShow",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "the message id"
}
],
"responses": {
"200": {
"description": "message show response",
"schema": {
"$ref": "#/definitions/Message"
}
},
"404": {
"description": "message show error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
},
"delete": {
"description": "Deletes a specific message",
"operationId": "messagesDelete",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the message"
}
],
"responses": {
"204": {
"description": "delete message response"
},
"404": {
"description": "message delete error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages": {
"post": {
"description": "creates a message",
"operationId": "messagesCreate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "message",
"in": "body",
"required": true,
"description": "body of message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
},
{
"name": "uploads",
"in": "body",
"required": false,
"description": "attachments",
"schema": {
"$ref": "#/definitions/AttachmentsInput"
}
}
],
"responses": {
"200": {
"description": "message attachments response",
"schema": {
"$ref": "#/definitions/Message"
}
},
"422": {
"description": "message creation error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages/categories": {
"get": {
"description": "Gets a list of message categories",
"operationId": "messagesCategoriesIndex",
"tags": [
"secure_messaging"
],
"responses": {
"200": {
"description": "create message categories response",
"schema": {
"$ref": "#/definitions/Categories"
}
}
}
}
},
"/v0/messaging/health/messages/{message_id}/attachments/{id}": {
"get": {
"description": "Gets a message attachment",
"operationId": "messagesAttachmentShow",
"produces": [
"application/octet-stream",
"application/pdf",
"image/png",
"image/gif",
"image/jpeg"
],
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "message_id",
"in": "path",
"required": true,
"type": "integer",
"description": "a message id"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "an attachmwnt id"
}
],
"responses": {
"200": {
"description": "message attachments response",
"schema": {
"type": "file"
}
},
"404": {
"description": "message attachments error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages/{id}/move": {
"patch": {
"description": "moves a message to a new folder",
"operationId": "messagesMove",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the message"
},
{
"name": "folder_id",
"in": "query",
"required": true,
"type": "integer",
"description": "destination folder id"
}
],
"responses": {
"204": {
"description": "message move response"
},
"404": {
"description": "move message error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/messages/{id}/reply": {
"post": {
"description": "creates a message reply",
"operationId": "messagesReply",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the message"
},
{
"name": "message",
"in": "body",
"required": true,
"description": "body of message reply",
"schema": {
"$ref": "#/definitions/MessageInput"
}
},
{
"name": "uploads",
"in": "body",
"required": false,
"description": "attachments",
"schema": {
"$ref": "#/definitions/AttachmentsInput"
}
}
],
"responses": {
"201": {
"description": "create message reply attachments response",
"schema": {
"$ref": "#/definitions/Message"
}
},
"404": {
"description": "message reply error response",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/messaging/health/message_drafts": {
"post": {
"description": "creates a message draft",
"operationId": "messageDraftsCreate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "message_draft",
"in": "body",
"required": true,
"description": "body of reply draft message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
}
],
"responses": {
"201": {
"description": "create draft message response",
"schema": {
"$ref": "#/definitions/Message"
}
}
}
}
},
"/v0/messaging/health/message_drafts/{id}": {
"put": {
"description": "update a message draft",
"operationId": "messageDraftsUpdate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "message draft id"
},
{
"name": "message_draft",
"in": "body",
"required": true,
"description": "body of reply draft message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
}
],
"responses": {
"204": {
"description": "update draft message response"
}
}
},
"patch": {
"description": "update a message draft",
"operationId": "messageDraftsUpdate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "integer",
"required": true,
"description": "message draft id"
},
{
"name": "message_draft",
"in": "body",
"required": true,
"description": "body of reply draft message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
}
],
"responses": {
"204": {
"description": "update draft message response"
}
}
}
},
"/v0/messaging/health/message_drafts/{reply_id}/replydraft": {
"post": {
"description": "creates a reply message draft",
"operationId": "messageDraftsReplyCreate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "reply_id",
"in": "path",
"type": "integer",
"required": true,
"description": "message replied to id"
},
{
"name": "message_draft",
"in": "body",
"required": true,
"description": "body of reply draft message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
}
],
"responses": {
"201": {
"description": "create reply message draft response",
"schema": {
"$ref": "#/definitions/Message"
}
}
}
}
},
"/v0/messaging/health/message_drafts/{reply_id}/replydraft/{draft_id}": {
"put": {
"description": "updates a reply message draft",
"operationId": "messageDraftsReplyUpdate",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "reply_id",
"in": "path",
"type": "integer",
"required": true,
"description": "message replied to id"
},
{
"name": "draft_id",
"in": "path",
"type": "integer",
"required": true,
"description": "message draft updated"
},
{
"name": "message_draft",
"in": "body",
"required": true,
"description": "body of reply draft message",
"schema": {
"$ref": "#/definitions/MessageInput"
}
}
],
"responses": {
"204": {
"description": "update draft message response"
}
}
}
},
"/v0/messaging/health/recipients": {
"get": {
"description": "Get a list of triageTeams",
"operationId": "triageTeamsIndex",
"tags": [
"secure_messaging"
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"description": "Page of results, greater than 0"
},
{
"name": "per_page",
"in": "query",
"required": false,
"type": "integer",
"description": "number of results, between 1 and 99"
},
{
"name": "sort",
"in": "query",
"required": false,
"type": "string",
"description": "Comma separated sort field(s), prepend field(s) with '-' for descending sort"
}
],
"responses": {
"200": {
"description": "triage team recipients response",
"schema": {
"$ref": "#/definitions/TriageTeams"
}
}
}
}
},
"/v0/pension_claims": {
"post": {
"responses": {
"200": {
"description": "Form Submitted",
"schema": {
"$ref": "#/definitions/SavedForm"
}
},
"422": {
"description": "Failed model validation(s)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit a pension benefit claim",
"operationId": "addPensionClaim",
"tags": [
"benefits_forms"
],
"parameters": [
{
"$ref": "#/parameters/optional_authorization"
},
{
"name": "form",
"in": "body",
"description": "Pension claim form data",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v0/performance_monitorings": {
"post": {
"description": "Call StatsD.measure with the passed page performance benchmarking data.",
"operationId": "postPerformanceMonitoring",
"tags": [
"performance_monitoring"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Attributes to benckmark a page's performance in StatsD",
"required": true,
"schema": {
"properties": {
"data": {
"type": "string",
"example": "{\\\"page_id\\\":\\\"/\\\",\\\"metrics\\\":[{\\\"metric\\\":\\\"totalPageLoad\\\",\\\"duration\\\":1234.56},{\\\"metric\\\":\\\"firstContentfulPaint\\\",\\\"duration\\\":123.45}]}",
"description": "\n A JSON string of metrics data. The required structure is an object with two properties: page_id (string) and metrics (array).\n\n page_id is a whitelisted path. See vets-api/lib/benchmark/whitelist.rb.\n\n The metrics property should contain an array of hashes, with each hash containing two properties: metric (string) and duration (float).\n\n For example\n {\n \"page_id\": \"/disability/\",\n \"metrics\": [\n {\n \"metric\": \"totalPageLoad\",\n \"duration\": 1234.56\n },\n {\n \"metric\": \"firstContentfulPaint\",\n \"duration\": 123.45\n }\n ]\n }\n"
}
}
}
}
],
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"page_id",
"metrics"
],
"properties": {
"page_id": {
"type": "string",
"example": "/disability/",
"description": "A unique identifier for the frontend page being benchmarked"
},
"metrics": {
"type": "array",
"description": "A collection of benchmark metrics and durations for a given page",
"items": {
"required": [
"metric",
"duration"
],
"properties": {
"metric": {
"type": "string",
"example": "frontend.page_performance.total_page_load",
"description": "Creates a namespace/bucket for what is being measured."
},
"duration": {
"example": 100.1,
"description": "Duration of benchmark measurement in milliseconds"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/v0/user/preferences/choices": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"properties": {
"data": {
"type": "array",
"$ref": "#/definitions/Preferences"
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "returns all Preference objects with associated PreferenceChoices",
"operationId": "getPreferences",
"tags": [
"preferences"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/user/preferences/choices/{code}": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Preferences"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Not found: Preference record not found",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "returns a single Preference with associated PreferenceChoices",
"operationId": "getPreference",
"tags": [
"preferences"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "code",
"in": "path",
"description": "The code for the Preference",
"required": true,
"type": "string"
}
]
}
},
"/v0/user/preferences": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"user_preferences"
],
"properties": {
"user_preferences": {
"type": "array",
"items": {
"required": [
"code",
"title",
"user_preferences"
],
"properties": {
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"user_preferences": {
"type": "array",
"description": "Array of the PreferenceChoice#codes that the user selected for the associated Preference",
"items": {
"required": [
"code",
"description"
],
"properties": {
"code": {
"type": "string",
"description": "The PreferenceChoice#code"
},
"description": {
"type": "string",
"description": "The PreferenceChoice#description"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Not found: Preference record not found",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Both creates and updates a users UserPreferences",
"operationId": "postUserPreferences",
"tags": [
"preferences"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Array of Preference and PreferenceChoice selections that the user made",
"required": true,
"schema": {
"type": "array",
"items": {
"required": [
"preference",
"user_preferences"
],
"properties": {
"preference": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The Preference#code"
}
}
},
"user_preferences": {
"type": "array",
"description": "Array of the PreferenceChoice#codes that the user selected for the associated Preference",
"items": {
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The PreferenceChoice#code"
}
}
}
}
}
}
}
}
]
}
},
"/v0/post911_gi_bill_status": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Post911GiBillStatus"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Veteran Gi Bill Status not found in EVSS",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"503": {
"description": "The backend GI Bill Status service is unavailable",
"headers": {
"Retry-After": {
"type": "string",
"format": "date"
}
},
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get the Post 911 GI Bill Status for a Veteran",
"operationId": "getPost911GiBillStatus",
"tags": [
"benefits_status"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/ppiu/payment_information": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/PPIU"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get a veterans payment information",
"operationId": "getPaymentInformation",
"tags": [
"form_526"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/preneeds/burial_forms": {
"post": {
"responses": {
"200": {
"description": "Application was submitted successfully",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"example": "MQP6Tmqi44S1y5wEWGVG"
},
"type": {
"type": "string",
"example": "preneeds_receive_applications"
},
"attributes": {
"type": "object",
"properties": {
"receive_application_id": {
"type": "string",
"example": "MQP6Tmqi44S1y5wEWGVG"
},
"tracking_number": {
"type": "string",
"example": "MQP6Tmqi44S1y5wEWGVG"
},
"return_code": {
"type": "integer",
"example": 0
},
"application_uuid": {
"type": "string",
"example": "8da5eb1a-26b4-48e3-99ca-089453472df7"
},
"return_description": {
"type": "string",
"example": "PreNeed Application Received Successfully."
},
"submitted_at": {
"type": "string",
"example": "2018-10-29T14:28:46.201Z"
}
}
}
}
}
}
}
},
"422": {
"description": "Failed model validation(s)",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Submit a pre-need burial eligibility claim",
"operationId": "addPreneedsClaim",
"tags": [
"benefits_forms"
],
"parameters": [
{
"$ref": "#/parameters/optional_authorization"
},
{
"name": "application",
"in": "body",
"description": "Pre-need burial eligibility form data",
"required": true,
"schema": {
"required": [
"applicant",
"claimant",
"hasCurrentlyBuried",
"veteran"
],
"properties": {
"applicationStatus": {
"type": "string",
"example": "example needed"
},
"hasCurrentlyBuried": {
"type": "string",
"example": "1",
"enum": [
"1",
"2",
"3"
]
},
"sendingCode": {
"type": "string",
"example": "abc"
},
"currentlyBuriedPersons": {
"type": "array",
"description": "data about claimants",
"items": {
"properties": {
"name": {
"type": "object",
"$ref": "#/definitions/PreneedName"
},
"cemeteryNumber": {
"type": "string",
"example": "234"
}
}
}
},
"preneedAttachments": {
"type": "array",
"description": "data about uploaded attachments",
"items": {
"properties": {
"confirmationCode": {
"type": "string",
"description": "uuid",
"example": "9b3ae0e1-fd58-4074-bf81-d58fb18fa86"
},
"attachmentId": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "my_file_name.pdf"
}
}
}
},
"applicant": {
"type": "object",
"properties": {
"applicantEmail": {
"type": "string",
"example": "jon.doe@example.com"
},
"applicantPhoneNumber": {
"type": "string",
"example": "5551235454"
},
"applicantRelationshipToClaimant": {
"type": "string",
"example": "Authorized Agent/Rep"
},
"completingReason": {
"type": "string",
"example": "a reason"
},
"mailingAddress": {
"type": "object",
"$ref": "#/definitions/PreneedAddress"
},
"name": {
"type": "object",
"$ref": "#/definitions/PreneedName"
}
}
},
"claimant": {
"type": "object",
"properties": {
"address": {
"type": "object",
"$ref": "#/definitions/PreneedAddress"
},
"dateOfBirth": {
"type": "string",
"example": "1960-12-30"
},
"desiredCemetery": {
"type": "string",
"example": "234"
},
"email": {
"type": "string",
"example": "jon.doe@example.com"
},
"name": {
"type": "object",
"$ref": "#/definitions/PreneedName"
},
"phoneNumber": {
"type": "string",
"example": "5551235454"
},
"relationshipToVet": {
"type": "string",
"example": "2"
},
"ssn": {
"type": "string",
"example": "234234234"
}
}
},
"veteran": {
"type": "object",
"properties": {
"address": {
"type": "object",
"$ref": "#/definitions/PreneedAddress"
},
"currentName": {
"type": "object",
"$ref": "#/definitions/PreneedName"
},
"dateOfBirth": {
"type": "string",
"example": "1960-12-30"
},
"dateOfDeath": {
"type": "string",
"example": "1990-12-30"
},
"gender": {
"type": "string",
"example": "Female"
},
"isDeceased": {
"type": "string",
"example": "yes"
},
"maritalStatus": {
"type": "string",
"example": "Single"
},
"militaryServiceNumber": {
"type": "string",
"example": "234234234"
},
"militaryStatus": {
"type": "string",
"example": "D"
},
"placeOfBirth": {
"type": "string",
"example": "140 Rock Creek Church Rd NW"
},
"serviceName": {
"type": "object",
"$ref": "#/definitions/PreneedName"
},
"serviceRecords": {
"type": "array",
"description": "data about tours of duty",
"items": {
"properties": {
"dateRange": {
"type": "object",
"properties": {
"from": {
"type": "string",
"example": "1960-12-30"
},
"to": {
"type": "string",
"example": "1970-12-30"
}
}
},
"serviceBranch": {
"type": "string",
"example": "AL"
},
"dischargeType": {
"type": "string",
"example": "2"
},
"highestRank": {
"type": "string",
"example": "General"
},
"nationalGuardState": {
"type": "string",
"example": "PR"
}
}
}
},
"ssn": {
"type": "string",
"example": "234234234"
},
"vaClaimNumber": {
"type": "string",
"example": "234234234"
}
}
}
}
}
}
]
}
},
"/v0/prescriptions": {
"get": {
"description": "Get a list of active and inactive prescriptions",
"operationId": "indexPrescriptions",
"tags": [
"prescriptions"
],
"parameters": [
{
"$ref": "#/parameters/optional_page_number"
},
{
"$ref": "#/parameters/optional_page_length"
},
{
"$ref": "#/parameters/optional_sort"
},
{
"$ref": "#/parameters/optional_filter"
}
],
"responses": {
"200": {
"description": "prescription index response",
"schema": {
"$ref": "#/definitions/Prescriptions"
}
}
}
}
},
"/v0/prescriptions/active": {
"get": {
"description": "Get a list of active prescriptions",
"operationId": "indexActivePrescriptions",
"tags": [
"prescriptions"
],
"parameters": [
{
"$ref": "#/parameters/optional_page_number"
},
{
"$ref": "#/parameters/optional_page_length"
},
{
"$ref": "#/parameters/optional_sort"
}
],
"responses": {
"200": {
"description": "active prescription index response",
"schema": {
"$ref": "#/definitions/Prescriptions"
}
}
}
}
},
"/v0/prescriptions/{id}": {
"get": {
"description": "Get details about a prescription",
"operationId": "showPrescriptions",
"tags": [
"prescriptions"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the presecription"
}
],
"responses": {
"200": {
"description": "prescription show response",
"schema": {
"$ref": "#/definitions/Prescription"
}
},
"404": {
"description": "Record not available",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/prescriptions/{id}/refill": {
"patch": {
"description": "refills a prescription",
"operationId": "refillPrescriptions",
"tags": [
"prescriptions"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the presecription"
}
],
"responses": {
"204": {
"description": "prescription refill response"
},
"400": {
"description": "prescription not refillable",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "prescription not available",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/prescriptions/{prescription_id}/trackings": {
"get": {
"description": "ship tracking information for prescription",
"operationId": "trackPrescriptions",
"tags": [
"prescriptions"
],
"parameters": [
{
"name": "prescription_id",
"in": "path",
"required": true,
"type": "integer",
"description": "id of the presecription"
}
],
"responses": {
"200": {
"description": "prescription tracking response",
"schema": {
"$ref": "#/definitions/Trackings"
}
},
"404": {
"description": "prescription not available",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/profile/addresses": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Creates a users Vet360 address",
"operationId": "postVet360Address",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "domestic_body",
"in": "body",
"description": "Attributes to create a domestic address.",
"required": true,
"schema": {
"$ref": "#/definitions/PostVet360DomesticAddress"
}
},
{
"name": "international_body",
"in": "body",
"description": "Attributes to create an international address.",
"required": true,
"schema": {
"$ref": "#/definitions/PostVet360InternationalAddress"
}
},
{
"name": "military_overseas_body",
"in": "body",
"description": "Attributes to create a military overseas address.",
"required": true,
"schema": {
"$ref": "#/definitions/PostVet360MilitaryOverseasAddress"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Updates a users existing Vet360 address",
"operationId": "putVet360Address",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "domestic_body",
"in": "body",
"description": "Attributes to update a domestic address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360DomesticAddress"
}
},
{
"name": "international_body",
"in": "body",
"description": "Attributes to update an international address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360InternationalAddress"
}
},
{
"name": "military_overseas_body",
"in": "body",
"description": "Attributes to update a military overseas address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360MilitaryOverseasAddress"
}
}
]
},
"delete": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Logically deletes a user's existing Vet360 address",
"operationId": "deleteVet360Address",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "domestic_body",
"in": "body",
"description": "Attributes of the domestic address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360DomesticAddress"
}
},
{
"name": "international_body",
"in": "body",
"description": "Attributes of the international address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360InternationalAddress"
}
},
{
"name": "military_overseas_body",
"in": "body",
"description": "Attributes of the military overseas address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360MilitaryOverseasAddress"
}
}
]
}
},
"/v0/profile/alternate_phone": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/PhoneNumber"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Gets a users alternate phone number information",
"operationId": "getAlternatePhone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
},
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/PhoneNumber"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Creates/updates a users alternate phone number information",
"operationId": "postAlternatePhone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to create/update a phone number.",
"required": true,
"schema": {
"properties": {
"number": {
"type": "string",
"example": "4445551212"
},
"extension": {
"type": "string",
"example": "101"
},
"country_code": {
"type": "string",
"example": "1"
}
}
}
}
]
}
},
"/v0/profile/email": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Email"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Gets a users email address information",
"operationId": "getEmailAddress",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
},
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/Email"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Creates/updates a users email address",
"operationId": "postEmailAddress",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to create/update an email address.",
"required": true,
"schema": {
"properties": {
"email": {
"type": "string",
"example": "john@example.com"
}
}
}
}
]
}
},
"/v0/profile/email_addresses": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Creates a users Vet360 email address",
"operationId": "postVet360EmailAddress",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to create an email address.",
"required": true,
"schema": {
"$ref": "#/definitions/PostVet360Email"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Updates a users existing Vet360 email address",
"operationId": "putVet360EmailAddress",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to update an email address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360Email"
}
}
]
},
"delete": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Deletes a users existing Vet360 email address",
"operationId": "deleteVet360EmailAddress",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes of an email address.",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360Email"
}
}
]
}
},
"/v0/profile/full_name": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"first": {
"type": "string",
"example": "Jack"
},
"middle": {
"type": "string",
"example": "Robert"
},
"last": {
"type": "string",
"example": "Smith"
},
"suffix": {
"type": "string",
"example": "Jr."
}
}
}
}
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Gets a users full name with suffix",
"operationId": "getFullName",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/initialize_vet360_id": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Initializes a vet360_id for the current user",
"operationId": "initializeVet360Id",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/person/status/{transaction_id}": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Gets an updated person transaction by ID",
"operationId": "getPersonTransactionStatusById",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "transaction_id",
"in": "path",
"description": "ID of transaction",
"required": true,
"type": "string"
}
]
}
},
"/v0/profile/personal_information": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"gender": {
"type": "string",
"example": "M"
},
"birth_date": {
"type": "string",
"format": "date",
"example": "1949-03-04"
}
}
}
}
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"502": {
"description": "Unexpected response body",
"schema": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status",
"source"
],
"properties": {
"title": {
"type": "string",
"example": "Unexpected response body"
},
"detail": {
"type": "string",
"example": "MVI service responded without a birthday or a gender."
},
"code": {
"type": "string",
"example": "MVI_BD502"
},
"status": {
"type": "string",
"example": "502"
},
"source": {
"type": "string",
"example": "V0::Profile::PersonalInformationsController"
}
}
}
}
}
}
}
},
"description": "Gets a users gender and birth date",
"operationId": "getPersonalInformation",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/primary_phone": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/PhoneNumber"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Gets a users primary phone number information",
"operationId": "getPrimaryPhone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
},
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/PhoneNumber"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/EVSSAuthError"
}
}
},
"description": "Creates/updates a users primary phone number information",
"operationId": "postPrimaryPhone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to create/update a phone number.",
"required": true,
"schema": {
"properties": {
"number": {
"type": "string",
"example": "4445551212"
},
"extension": {
"type": "string",
"example": "101"
},
"country_code": {
"type": "string",
"example": "1"
}
}
}
}
]
}
},
"/v0/profile/service_history": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"service_history"
],
"properties": {
"service_history": {
"type": "array",
"items": {
"required": [
"branch_of_service",
"begin_date"
],
"properties": {
"branch_of_service": {
"type": "string",
"example": "Air Force"
},
"begin_date": {
"type": "string",
"format": "date",
"example": "2007-04-01"
},
"end_date": {
"type": "string",
"format": "date",
"example": "2016-06-01"
},
"personnel_category_type_code": {
"type": "string",
"example": "V",
"description": "A = Regular Active, N = Guard, V = Reserve, Q = Reserve Retiree"
}
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"502": {
"description": "Unexpected response body",
"schema": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status",
"source"
],
"properties": {
"title": {
"type": "string",
"example": "Unexpected response body"
},
"detail": {
"type": "string",
"example": "EMIS service responded with something other than the expected array of service history hashes."
},
"code": {
"type": "string",
"example": "EMIS_HIST502"
},
"status": {
"type": "string",
"example": "502"
},
"source": {
"type": "string",
"example": "V0::Profile::ServiceHistoriesController"
}
}
}
}
}
}
}
},
"description": "Gets a collection of a users military service episodes",
"operationId": "getServiceHistory",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/status/{transaction_id}": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Gets an updated transaction by ID",
"operationId": "getTransactionStatusById",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "transaction_id",
"in": "path",
"description": "ID of transaction",
"required": true,
"type": "string"
}
]
}
},
"/v0/profile/status/": {
"get": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionsVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Gets the most recent transactions for a user. Response will include an array of transactions that are still in progress, or that were just updated to COMPLETED during the course of this request. The array will be empty if no transactions are pending or updated. Only the most recent transaction for each profile field will be included so there may be up to 3 (Address, Email, Telephone).",
"operationId": "getTransactionStatusesByUser",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/telephones": {
"post": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Creates a users Vet360 telephone",
"operationId": "postVet360Telephone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to create a telephone.",
"required": true,
"schema": {
"$ref": "#/definitions/PostVet360Telephone"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Updates a users existing telephone",
"operationId": "putVet360Telephone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes to update a telephone",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360Telephone"
}
}
]
},
"delete": {
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"$ref": "#/definitions/AsyncTransactionVet360"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Deletes an existing telephone",
"operationId": "deleteVet360Telephone",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "body",
"in": "body",
"description": "Attributes of a telephone",
"required": true,
"schema": {
"$ref": "#/definitions/PutVet360Telephone"
}
}
]
}
},
"/v0/profile/reference_data/countries": {
"get": {
"responses": {
"200": {
"description": "List of valid Vet360 countries",
"schema": {
"$ref": "#/definitions/Vet360Countries"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "GET Vet360 Country reference data",
"operationId": "getVet360ReferenceDataCountries",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/reference_data/states": {
"get": {
"responses": {
"200": {
"description": "List of valid Vet360 states",
"schema": {
"$ref": "#/definitions/Vet360States"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "GET Vet360 State reference data",
"operationId": "getVet360ReferenceDataStates",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/reference_data/zipcodes": {
"get": {
"responses": {
"200": {
"description": "List of valid Vet360 zipcodes",
"schema": {
"$ref": "#/definitions/Vet360Zipcodes"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "GET Vet360 Zipcode reference data",
"operationId": "getVet360ReferenceDataZipcodes",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/connected_applications": {
"get": {
"responses": {
"200": {
"description": "List of OAuth applications you have connected",
"schema": {
"$ref": "#/definitions/ConnectedApplications"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "GET OAuth Applications",
"operationId": "getConnectedApplications",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/profile/connected_applications/{application_id}": {
"delete": {
"responses": {
"204": {
"description": "the connected application's grant have been deleted"
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Delete grants for OAuth Applications",
"operationId": "deleteConnectedApplications",
"tags": [
"profile"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "application_id",
"in": "path",
"description": "ID of application",
"required": true,
"type": "string"
}
]
}
},
"/v0/search": {
"get": {
"description": "Returns a list of search results, from Search.gov, for the passed search query",
"operationId": "getSearchResults",
"tags": [
"search"
],
"parameters": [
{
"name": "query",
"in": "query",
"description": "The search term being queried",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"description": "The page number for the page of results that is being requested",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Response is OK",
"schema": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The term used to generate these search results"
},
"web": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of results available."
},
"next_offset": {
"type": "integer",
"description": "Offset for the subsequent results."
},
"spelling_correction": {
"type": [
"string",
"null"
],
"description": "Spelling correction for your search term."
},
"results": {
"type": "array",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"snippet": {
"type": "string"
},
"publication_date": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"text_best_bets": {
"type": "array",
"description": "Text best bets, which appear only when the query matches the text of the best bet’s title, description, or keywords.",
"items": {
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"graphic_best_bets": {
"type": "array",
"description": "Graphic best bets, which appear only when the query matches the text of the best bet’s title, description, or keywords.",
"items": {
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"title_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"image_alt_text": {
"type": "string"
},
"links": {
"type": "array",
"description": "An array of links in the graphic best bet. Each link contains a title and a URL",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
}
},
"health_topics": {
"type": "array",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"snippet": {
"type": "string"
},
"related_topics": {
"type": "array",
"description": "An array of topics related to the health topic. Each topic contains a title and a URL",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
},
"related_sites": {
"type": "array",
"description": "An array of sites related to the the health topic. Each site contains a title and a URL",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
}
},
"job_openings": {
"type": "array",
"items": {
"properties": {
"position_title": {
"type": "string"
},
"organization_name": {
"type": "string"
},
"rate_interval_code": {
"type": "string"
},
"minimum": {
"type": "integer",
"description": "Minimum salary of the job opening"
},
"maximum": {
"type": "integer",
"description": "Maximum salary of the job opening"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"url": {
"type": "string"
},
"org_codes": {
"type": "string"
},
"locations": {
"type": "array",
"description": "An array of locations of the job opening",
"items": {
"type": "string"
}
},
"related_sites": {
"type": "array",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
}
},
"recent_tweets": {
"type": "array",
"items": {
"properties": {
"text": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"snippet": {
"type": "string"
},
"screen_name": {
"type": "string",
"description": "Screen name of the tweet author"
},
"profile_image_url": {
"type": "string"
}
}
}
},
"recent_news": {
"type": "array",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"snippet": {
"type": "string"
},
"publication_date": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
},
"recent_video_news": {
"type": "array",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"snippet": {
"type": "string"
},
"publication_date": {
"type": "string"
},
"source": {
"type": "string"
},
"thumbnail_url": {
"type": "string"
}
}
}
},
"federal_register_documents": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"document_number": {
"type": "string"
},
"document_type": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"agency_names": {
"type": "array",
"description": "An array of agency names of the federal register document",
"items": {
"type": "string"
}
},
"page_length": {
"type": "integer"
},
"start_page": {
"type": "integer"
},
"end_page": {
"type": "integer"
},
"publication_date": {
"type": "string"
},
"comments_close_date": {
"type": "string"
}
}
}
},
"related_search_terms": {
"type": "array",
"description": "An array of related search terms, which are based on recent, common searches on the your site.",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"meta": {
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
}
}
}
},
"400": {
"description": "Error Occurred",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"429": {
"description": "Exceeded rate limit",
"schema": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status",
"source"
],
"properties": {
"title": {
"type": "string",
"example": "Exceeded rate limit"
},
"detail": {
"type": "string",
"example": "Exceeded Search.gov rate limit"
},
"code": {
"type": "string",
"example": "SEARCH_429"
},
"status": {
"type": "string",
"example": "429"
},
"source": {
"type": "string",
"example": "Search::Service"
}
}
}
}
}
}
}
}
}
},
"/sessions/mhv/new": {
"get": {
"description": "Get url for initiating SSO with MyHealtheVet",
"tags": [
"authentication"
],
"responses": {
"200": {
"description": "returns the url for invoking SAML authentication flow via MyHealtheVet",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
}
}
}
},
"/sessions/dslogon/new": {
"get": {
"description": "Get url for initiating SSO with DS Logon",
"tags": [
"authentication"
],
"responses": {
"200": {
"description": "returns the url for invoking SAML authentication flow via DS Logon",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
}
}
}
},
"/sessions/idme/new": {
"get": {
"description": "Get url for initiating SSO with Id.me",
"tags": [
"authentication"
],
"responses": {
"200": {
"description": "returns the url for invoking SAML authentication flow via Id.me",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
}
}
}
},
"/sessions/mfa/new": {
"get": {
"description": "Get url for initiating enabling multifactor authentication",
"tags": [
"authentication"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The authorization method and token value",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "returns the url to enable multifactor authentication",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
},
"401": {
"description": "Unauthorized User",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/sessions/verify/new": {
"get": {
"description": "Get url for initiating FICAM identity proofing",
"tags": [
"authentication"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The authorization method and token value",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "returns the url to initiate FICAM identity proofing flow",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
},
"401": {
"description": "Unauthorized User",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/sessions/slo/new": {
"get": {
"description": "Get url for terminating session and initiating SLO flow",
"tags": [
"authentication"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The authorization method and token value",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "returns the url to terminate the current session and initiates external SLO flow",
"schema": {
"$ref": "#/definitions/AuthenticationURL"
}
},
"401": {
"description": "Unauthorized User",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/terms_and_conditions": {
"get": {
"description": "Get the list of terms and conditions",
"operationId": "getAllTermsAndConditions",
"tags": [
"terms_and_conditions"
],
"responses": {
"200": {
"description": "get terms and conditions response",
"schema": {
"$ref": "#/definitions/TermsAndConditions"
}
}
}
}
},
"/v0/terms_and_conditions/{name}/versions/latest": {
"get": {
"description": "Get the latest version of the named terms and conditions",
"operationId": "getTermsAndConditions",
"tags": [
"terms_and_conditions"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Name of the terms",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "get named terms and conditions response",
"schema": {
"$ref": "#/definitions/TermsAndConditionsSingle"
}
},
"404": {
"description": "terms not found",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/terms_and_conditions/{name}/versions/latest/user_data": {
"get": {
"responses": {
"200": {
"description": "get user data for terms and conditions response",
"schema": {
"$ref": "#/definitions/TermsAndConditionsAcceptance"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "terms not found",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get information about the user acceptance for the named terms and conditions",
"operationId": "getTermsAndConditionsUserData",
"tags": [
"terms_and_conditions"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "name",
"in": "path",
"description": "Name of the terms",
"required": true,
"type": "string"
}
]
},
"post": {
"responses": {
"200": {
"description": "create an acceptance for the terms and conditions response",
"schema": {
"$ref": "#/definitions/TermsAndConditionsAcceptance"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "terms not found",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"422": {
"description": "errors on acceptance creation",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Create a user acceptance for the named terms and conditions",
"operationId": "createTermsAndConditionsAcceptance",
"tags": [
"terms_and_conditions"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
},
{
"name": "name",
"in": "path",
"description": "Name of the terms",
"required": true,
"type": "string"
}
]
}
},
"/v0/upload_supporting_evidence": {
"post": {
"description": "Upload a pdf or image file containing supporting evidence for form 526",
"operationId": "uploadSupportingEvidence",
"tags": [
"form_526"
],
"parameters": [
{
"name": "supporting_evidence_attachment",
"in": "body",
"description": "Object containing file name",
"required": true,
"schema": {
"properties": {
"file_data": {
"type": "string",
"example": "filename.pdf"
}
}
}
}
],
"responses": {
"200": {
"description": "Response is ok",
"schema": {
"$ref": "#/definitions/UploadSupportingEvidence"
}
},
"500": {
"description": "Bad Gateway: incorrect parameters",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/user": {
"get": {
"responses": {
"200": {
"description": "get user response",
"schema": {
"$ref": "#/definitions/UserData"
}
},
"401": {
"description": "Not authorized",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"description": "Get user data",
"operationId": "getUser",
"tags": [
"user"
],
"parameters": [
{
"$ref": "#/parameters/authorization"
}
]
}
},
"/v0/facilities/va": {
"get": {
"description": "Get facilities within a geographic bounding box",
"operationId": "indexFacilities",
"tags": [
"facilities"
],
"parameters": [
{
"name": "bbox[]",
"description": "Bounding box Lat/Long coordinates in the form minLong, minLat, maxLong, maxLat",
"in": "query",
"type": "array",
"required": true,
"collectionFormat": "multi",
"minItems": 4,
"maxItems": 4,
"items": {
"type": "number"
}
},
{
"name": "type",
"description": "Optional facility type",
"in": "query",
"type": "string",
"enum": [
"health",
"cemetery",
"benefits",
"vet_center"
]
},
{
"name": "services[]",
"description": "Optional specialty services filter that works along with `type` param. Only available for types 'benefits' and 'vet_center'.",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
}
},
{
"name": "address",
"description": "Address of search center, needed for searches involving community care providers",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful bounding box query",
"schema": {
"$ref": "#/definitions/VAFacilities"
}
},
"400": {
"description": "Invalid bounding box query",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/facilities/va/{id}": {
"get": {
"description": "Get an individual facility detail object",
"operationId": "showFacility",
"tags": [
"facilities"
],
"parameters": [
{
"name": "id",
"description": "ID of facility such as vha_648A4",
"in": "path",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "Successful facility detail lookup",
"schema": {
"$ref": "#/definitions/VAFacility"
}
},
"404": {
"description": "Non-existent facility lookup",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/facilities/suggested": {
"get": {
"description": "Given one or more facility types and a name part returns a list of suggested facilites",
"operationId": "suggestedFacilities",
"tags": [
"facilities"
],
"parameters": [
{
"name": "type[]",
"description": "facility type",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string",
"enum": [
"health",
"cemetery",
"benefits",
"vet_center",
"dod_health"
]
}
},
{
"name": "name_part",
"description": "inputed partial facility name",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns a list of facilities",
"schema": {
"$ref": "#/definitions/VAFacilities"
}
},
"400": {
"description": "Bad request: invalid type or missing name_part parameter",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/facilities/ccp/{id}": {
"get": {
"description": "Get an individual community care provider",
"operationId": "showProvider",
"tags": [
"facilities"
],
"parameters": [
{
"name": "id",
"description": "ID of facility such as ccp_1780780627",
"in": "path",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "Successful provider detail lookup",
"schema": {
"$ref": "#/definitions/CCProvider"
}
},
"400": {
"description": "Invalid id provider lookup",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Non-existent provider lookup",
"schema": {
"$ref": "#/definitions/Errors"
}
}
}
}
},
"/v0/facilities/services": {
"get": {
"description": "Get complete list of specialties/services from ppms",
"operationId": "specialties",
"tags": [
"facilities"
],
"responses": {
"200": {
"description": "Successful specialties lookup",
"schema": {
"$ref": "#/definitions/CCSpecialties"
}
}
}
}
}
},
"definitions": {
"Availability": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"name",
"is_available"
],
"properties": {
"is_available": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"example": "gibs"
}
}
}
}
}
}
},
"EducationBenefitsClaimInput": {
"required": [
"form"
],
"properties": {
"form": {
"type": "string",
"description": "Should conform to vets-json-schema (https://github.com/department-of-veterans-affairs/vets-json-schema)"
}
}
},
"EducationBenefitsClaimData": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"form": {
"type": "string"
},
"submitted_at": {
"type": "string"
},
"regional_office": {
"type": "string"
},
"confirmation_number": {
"type": "string"
}
}
}
}
}
}
},
"HealthCareApplicationSubmissionResponse": {
"required": [
"formSubmissionId",
"timestamp",
"success"
],
"properties": {
"formSubmissionId": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"HealthCareApplicationHealthcheckResponse": {
"required": [
"formSubmissionId",
"timestamp"
],
"properties": {
"formSubmissionId": {
"type": "integer"
},
"timestamp": {
"type": "string"
}
}
},
"References": {
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"SavedFormSummaries": {},
"FormOutputData": {},
"FormInputData": {
"required": [
"form_data"
],
"properties": {
"form_data": {
"type": "string"
}
}
},
"Preferences": {
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"preference_choices": {
"type": "array",
"$ref": "#/definitions/PreferenceChoices"
}
}
}
}
}
}
},
"PreferenceChoices": {
"properties": {
"data": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"Post911GiBillStatus": {
"required": [
"data",
"meta"
],
"properties": {
"meta": {
"description": "The response from the EVSS service to vets-api",
"type": "object",
"$ref": "#/definitions/Meta"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"example": "evss_gi_bill_status_gi_bill_status_responses"
},
"attributes": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "Abraham"
},
"last_name": {
"type": "string",
"example": "Lincoln"
},
"name_suffix": {
"type": [
"string",
"null"
],
"example": "Jr"
},
"date_of_birth": {
"type": [
"string",
"null"
],
"example": "1955-11-12T06:00:00.000+0000"
},
"va_file_number": {
"type": [
"string",
"null"
],
"example": "123456789"
},
"regional_processing_office": {
"type": [
"string",
"null"
],
"example": "Central Office Washington, DC"
},
"eligibility_date": {
"type": [
"string",
"null"
],
"example": "2004-10-01T04:00:00.000+0000"
},
"delimiting_date": {
"type": [
"string",
"null"
],
"example": "2015-10-01T04:00:00.000+0000"
},
"percentage_benefit": {
"type": [
"integer",
"null"
],
"example": 100
},
"veteran_is_eligible": {
"type": [
"boolean",
"null"
],
"example": false
},
"active_duty": {
"type": [
"boolean",
"null"
],
"example": false
},
"original_entitlement": {
"type": "object",
"$ref": "#/definitions/Entitlement"
},
"used_entitlement": {
"type": "object",
"$ref": "#/definitions/Entitlement"
},
"remaining_entitlement": {
"type": "object",
"$ref": "#/definitions/Entitlement"
},
"enrollments": {
"type": "array",
"items": {
"$ref": "#/definitions/Enrollment"
}
}
}
}
}
}
}
},
"Enrollment": {
"required": [
"begin_date"
],
"properties": {
"begin_date": {
"type": "string",
"example": "2012-11-01T04:00:00.000+00:00"
},
"end_date": {
"type": [
"string",
"null"
],
"example": "2012-12-01T05:00:00.000+00:00"
},
"facility_code": {
"type": [
"string",
"null"
],
"example": "12345678"
},
"facility_name": {
"type": [
"string",
"null"
],
"example": "Purdue University"
},
"participant_id": {
"type": [
"string",
"null"
],
"example": "11170323"
},
"training_type": {
"type": [
"string",
"null"
],
"example": "UNDER_GRAD"
},
"term_id": {
"type": [
"string",
"null"
],
"example": null
},
"hour_type": {
"type": [
"string",
"null"
],
"example": null
},
"full_time_hours": {
"type": [
"integer",
"null"
],
"example": 12
},
"full_time_credit_hour_under_grad": {
"type": [
"integer",
"null"
],
"example": null
},
"vacation_day_count": {
"type": [
"integer",
"null"
],
"example": 0
},
"on_campus_hours": {
"type": [
"number",
"null"
],
"example": 12
},
"online_hours": {
"type": [
"number",
"null"
],
"example": 0
},
"yellow_ribbon_amount": {
"type": [
"number",
"null"
],
"example": 0
},
"status": {
"type": [
"string",
"null"
],
"example": "Approved"
},
"amendments": {
"type": "array",
"items": {
"$ref": "#/definitions/Amendment"
}
}
}
},
"Amendment": {
"required": [
"type"
],
"properties": {
"on_campus_hours": {
"type": [
"number",
"null"
]
},
"online_hours": {
"type": [
"number",
"null"
]
},
"yellow_ribbon_amount": {
"type": [
"number",
"null"
]
},
"type": {
"type": "string"
},
"change_effective_date": {
"type": [
"string",
"null"
]
}
}
},
"Entitlement": {
"required": [
"days",
"months"
],
"properties": {
"days": {
"type": "integer"
},
"months": {
"type": "integer"
}
}
},
"Meta": {
"description": "The response from the EVSS service to vets-api",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK",
"NOT_FOUND",
"SERVER_ERROR",
"NOT_AUTHORIZED"
]
}
}
},
"PreneedAddress": {
"properties": {
"street": {
"type": "string",
"example": "140 Rock Creek Church Rd NW"
},
"street2": {
"type": "string",
"example": ""
},
"city": {
"type": "string",
"example": "Washington"
},
"country": {
"type": "string",
"example": "USA"
},
"state": {
"type": "string",
"example": "DC"
},
"postalCode": {
"type": "string",
"example": "20011"
}
}
},
"PreneedName": {
"properties": {
"first": {
"type": "string",
"example": "Jon"
},
"middle": {
"type": "string",
"example": "Bob"
},
"last": {
"type": "string",
"example": "Doe"
},
"suffix": {
"type": "string",
"example": "Jr."
},
"maiden": {
"type": "string",
"example": "Smith"
}
}
},
"AuthenticationURL": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
}
}
},
"UserData": {
"required": [
"data"
],
"allOf": [
{
"$ref": "#/definitions/Vet360ContactInformation"
},
{
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"type": "string"
}
},
"in_progress_forms": {},
"account": {
"type": "object",
"properties": {
"account_uuid": {
"type": [
"string",
"null"
],
"example": "b2fab2b5-6af0-45e1-a9e2-394347af91ef",
"description": "A UUID correlating all user identifiers. Intended to become the user's UUID."
}
}
},
"profile": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"birth_date": {
"type": "string"
},
"gender": {
"type": "string"
},
"zip": {
"type": "string"
},
"last_signed_in": {
"type": "string"
},
"loa": {
"type": "object",
"properties": {
"current": {
"type": "integer",
"format": "int32"
},
"highest": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"va_profile": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"birthdate": {
"type": "string"
},
"family_name": {
"type": "string"
},
"gender": {
"type": "string"
},
"given_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"veteran_status": {
"type": "object",
"required": [
"status"
],
"properties": {
"is_veteran": {
"type": "boolean",
"example": true
},
"status": {
"type": "string",
"enum": [
"OK",
"NOT_AUTHORIZED",
"NOT_FOUND",
"SERVER_ERROR"
],
"example": "OK"
},
"served_in_military": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
}
}
]
},
"Address": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"address": {
"properties": {
"type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"MILITARY"
],
"example": "DOMESTIC"
},
"address_effective_date": {
"type": "string",
"example": "1973-01-01T05:00:00.000+00:00"
},
"address_one": {
"type": "string",
"example": "140 Rock Creek Church Rd NW"
},
"address_two": {
"type": "string",
"example": ""
},
"address_three": {
"type": "string",
"example": ""
},
"city": {
"type": "string",
"example": "Washington"
},
"state_code": {
"type": "string",
"example": "DC"
},
"zip_code": {
"type": "string",
"example": "20011"
},
"zip_suffix": {
"type": "string",
"example": "1865"
}
}
},
"control_information": {
"properties": {
"can_update": {
"type": "boolean"
},
"corp_avail_indicator": {
"type": "boolean"
},
"corp_rec_found_indicator": {
"type": "boolean"
},
"has_no_bdn_payments_indicator": {
"type": "boolean"
},
"is_competent_indicator": {
"type": "boolean"
},
"indentity_indicator": {
"type": "boolean"
},
"index_indicator": {
"type": "boolean"
},
"no_fiduciary_assigned_indicator": {
"type": "boolean"
},
"not_deceased_indicator": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"Appeals": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array"
}
}
},
"AsyncTransactionVet360": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"transaction_status": {
"type": "string",
"enum": [
"REJECTED",
"RECEIVED",
"RECEIVED_ERROR_QUEUE",
"RECEIVED_DEAD_LETTER_QUEUE",
"COMPLETED_SUCCESS",
"COMPLETED_NO_CHANGES_DETECTED",
"COMPLETED_FAILURE"
],
"example": "RECEIVED"
},
"transaction_id": {
"type": "string",
"example": "786efe0e-fd20-4da2-9019-0c00540dba4d"
},
"type": {
"type": "string",
"enum": [
"AsyncTransaction::Vet360::AddressTransaction",
"AsyncTransaction::Vet360::EmailTransaction",
"AsyncTransaction::Vet360::InitializePersonTransaction",
"AsyncTransaction::Vet360::TelephoneTransaction"
],
"example": "AsyncTransaction::Vet360::EmailTransaction"
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CORE103"
},
"key": {
"type": "string",
"example": "_CUF_NOT_FOUND"
},
"severity": {
"type": "string",
"example": "ERROR"
},
"text": {
"type": "string",
"example": "The tx for id/criteria XZY could not be found."
}
}
}
}
}
}
}
}
}
},
"AsyncTransactionsVet360": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"transaction_status": {
"type": "string",
"enum": [
"REJECTED",
"RECEIVED",
"RECEIVED_ERROR_QUEUE",
"RECEIVED_DEAD_LETTER_QUEUE",
"COMPLETED_SUCCESS",
"COMPLETED_NO_CHANGES_DETECTED",
"COMPLETED_FAILURE"
],
"example": "RECEIVED"
},
"transaction_id": {
"type": "string",
"example": "786efe0e-fd20-4da2-9019-0c00540dba4d"
},
"type": {
"type": "string",
"enum": [
"AsyncTransaction::Vet360::AddressTransaction",
"AsyncTransaction::Vet360::EmailTransaction",
"AsyncTransaction::Vet360::InitializePersonTransaction",
"AsyncTransaction::Vet360::TelephoneTransaction"
],
"example": "AsyncTransaction::Vet360::EmailTransaction"
},
"metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "CORE103"
},
"key": {
"type": "string",
"example": "_CUF_NOT_FOUND"
},
"severity": {
"type": "string",
"example": "ERROR"
},
"text": {
"type": "string",
"example": "The tx for id/criteria XZY could not be found."
}
}
}
}
}
}
}
}
}
}
},
"HealthRecordsEligibleDataClasses": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"eligible_data_classes"
]
},
"attributes": {
"type": "object",
"required": [
"data_classes"
],
"properties": {
"data_classes": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/BbMeta"
}
}
},
"HealthRecordsRefresh": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"extract_statuses"
]
},
"attributes": {
"type": "object",
"required": [
"extract_type",
"last_updated",
"status",
"created_on",
"station_number"
],
"properties": {
"extract_type": {
"type": "string"
},
"last_updated": {
"type": [
"null",
"string"
]
},
"status": {
"type": [
"null",
"string"
]
},
"created_on": {
"type": [
"null",
"string"
]
},
"station_number": {
"type": "string"
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/BbMeta"
}
}
},
"BbMeta": {
"type": "object",
"required": [
"updated_at",
"failed_station_list"
],
"properties": {
"updated_at": {
"type": [
"null",
"string"
]
},
"failed_station_list": {
"type": [
"null",
"string"
]
}
}
},
"Countries": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"countries"
],
"properties": {
"countries": {
"type": "array",
"items": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "USA"
}
}
}
}
}
}
}
}
}
},
"ConnectedApplications": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"created": {
"type": "string"
},
"logo": {
"type": "string"
},
"grants": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"RatedDisabilities": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"rated_disabilities"
],
"properties": {
"rated_disabilities": {
"items": {
"type": "object",
"$ref": "#/definitions/RatedDisability"
}
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_disability_compensation_form_rated_disabilities_response"
}
}
}
}
},
"RatedDisability": {
"required": [
"decision_code",
"decision_text",
"name",
"effective_date",
"rated_disability_id",
"rating_decision_id",
"rating_percentage",
"related_disability_date",
"special_issues"
],
"properties": {
"decision_code": {
"type": "string",
"example": "SVCCONNCTED"
},
"decision_text": {
"type": "string",
"example": "Service Connected"
},
"name": {
"type": "string",
"example": "Diabetes mellitus0"
},
"effective_date": {
"type": "string",
"example": "2018-03-27T21:00:41.000+0000"
},
"rated_disability_id": {
"type": "string",
"example": "0"
},
"rating_decision_id": {
"type": "string",
"example": "63655"
},
"rating_percentage": {
"type": "integer",
"example": "100"
},
"related_disability_date": {
"type": "string",
"example": "2018-03-27T21:00:41.000+0000"
},
"special_issues": {
"items": {
"type": "object",
"$ref": "#/definitions/SpecialIssue"
}
}
}
},
"SpecialIssue": {
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"example": "TRM"
},
"name": {
"type": "string",
"example": "Personal Trauma PTSD"
}
}
},
"Email": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "john@example.com"
},
"effective_at": {
"type": "string",
"example": "2018-02-27T14:41:32.283Z"
}
}
}
}
}
}
},
"Errors": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
}
},
"Error": {
"required": [
"title",
"detail",
"code",
"status"
],
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"code": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"EVSSAuthError": {
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"required": [
"title",
"detail",
"code",
"status"
],
"properties": {
"title": {
"type": "string",
"example": "Forbidden"
},
"detail": {
"type": "string",
"example": "User does not have access to the requested resource due to missing values: corp_id, edipi"
},
"code": {
"type": "string",
"example": "403"
},
"status": {
"type": "string",
"example": "403"
}
}
}
}
}
},
"GibctCalculatorConstants": {
"required": [
"data",
"meta",
"links"
],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": [
"null",
"number",
"string"
]
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/GibctCalculatorConstantsMeta"
},
"links": {
"$ref": "#/definitions/GibctCalculatorConstantsSelfLinks"
}
}
},
"GibctCalculatorConstantsSelfLinks": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"type": "string"
}
}
},
"GibctCalculatorConstantsMeta": {
"type": "object",
"required": [
"version"
],
"properties": {
"version": {
"type": "null"
}
}
},
"GibctInstitutionsAutocomplete": {
"required": [
"data",
"meta",
"links"
],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"properties": {
"id": {
"type": "integer"
},
"value": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
},
"meta": {
"$ref": "#/definitions/GibctInstitutionsAutocompleteMeta"
},
"links": {
"$ref": "#/definitions/GibctInstitutionsSelfLinks"
}
}
},
"GibctInstitutionsSearch": {
"required": [
"data",
"meta",
"links"
],
"properties": {
"data": {
"type": "array",
"maxItems": 10,
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"institutions"
]
},
"links": {
"$ref": "#/definitions/GibctInstitutionsSelfLinks"
},
"attributes": {
"$ref": "#/definitions/GibctInstitutionBase",
"properties": {
"type": {
"type": "string",
"enum": [
"OJT",
"PRIVATE",
"FOREIGN",
"CORRESPONDENCE",
"FLIGHT",
"FOR PROFIT",
"PUBLIC"
]
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/GibctInstitutionsSearchMeta"
},
"links": {
"$ref": "#/definitions/GibctInstitutionsSearchLinks"
}
}
},
"GibctInstitution": {
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"institutions"
]
},
"links": {
"$ref": "#/definitions/GibctInstitutionsSelfLinks"
},
"attributes": {
"$ref": "#/definitions/GibctInstitutionBase",
"properties": {
"type": {
"type": "string",
"enum": [
"ojt",
"private",
"foreign",
"correspondence",
"flight",
"for profit",
"public"
]
},
"flight": {
"type": "boolean"
},
"correspondence": {
"type": "boolean"
},
"cross": {
"type": [
"null",
"string"
]
},
"ope": {
"type": [
"null",
"string"
]
},
"ope6": {
"type": [
"null",
"string"
]
},
"undergrad_enrollment": {
"type": [
"null",
"integer"
]
},
"student_veteran": {
"type": "boolean"
},
"student_veteran_link": {
"type": [
"null",
"string"
]
},
"dodmou": {
"type": "boolean"
},
"sec_702": {
"type": [
"null",
"boolean"
]
},
"vet_success_name": {
"type": [
"null",
"string"
]
},
"vet_success_email": {
"type": [
"null",
"string"
]
},
"credit_for_mil_training": {
"type": [
"null",
"boolean"
]
},
"vet_poc": {
"type": [
"null",
"boolean"
]
},
"student_vet_grp_ipeds": {
"type": [
"null",
"boolean"
]
},
"soc_member": {
"type": [
"null",
"boolean"
]
},
"retention_rate_veteran_ba": {
"type": [
"null",
"number"
]
},
"retention_all_students_ba": {
"type": [
"null",
"number"
]
},
"retention_rate_veteran_otb": {
"type": [
"null",
"number"
]
},
"retention_all_students_otb": {
"type": [
"null",
"number"
]
},
"persistance_rate_veteran_ba": {
"type": [
"null",
"number"
]
},
"persistance_rate_veteran_otb": {
"type": [
"null",
"number"
]
},
"graduation_rate_veteran": {
"type": [
"null",
"number"
]
},
"graduation_rate_all_students": {
"type": [
"null",
"number"
]
},
"transfer_out_rate_veteran": {
"type": [
"null",
"number"
]
},
"transfer_out_rate_all_students": {
"type": [
"null",
"number"
]
},
"salary_all_students": {
"type": [
"null",
"number"
]
},
"repayment_rate_all_students": {
"type": [
"null",
"number"
]
},
"avg_stu_loan_debt": {
"type": [
"null",
"number"
]
},
"calendar": {
"type": [
"null",
"string"
]
},
"online_all": {
"type": [
"null",
"string"
]
},
"p911_tuition_fees": {
"type": "number"
},
"p911_recipients": {
"type": "integer"
},
"p911_yellow_ribbon": {
"type": "number"
},
"p911_yr_recipients": {
"type": "integer"
},
"accredited": {
"type": "boolean"
},
"accreditation_type": {
"type": [
"null",
"string"
]
},
"accreditation_status": {
"type": [
"null",
"string"
]
},
"complaints": {
"type": "object",
"properties": {
"facility_code": {
"type": "integer"
},
"financial_by_fac_code": {
"type": "integer"
},
"quality_by_fac_code": {
"type": "integer"
},
"refund_by_fac_code": {
"type": "integer"
},
"marketing_by_fac_code": {
"type": "integer"
},
"accreditation_by_fac_code": {
"type": "integer"
},
"degree_requirements_by_fac_code": {
"type": "integer"
},
"student_loans_by_fac_code": {
"type": "integer"
},
"grades_by_fac_code": {
"type": "integer"
},
"credit_transfer_by_fac_code": {
"type": "integer"
},
"credit_job_by_fac_code": {
"type": "integer"
},
"job_by_fac_code": {
"type": "integer"
},
"transcript_by_fac_code": {
"type": "integer"
},
"other_by_fac_code": {
"type": "integer"
},
"main_campus_roll_up": {
"type": "integer"
},
"financial_by_ope_id_do_not_sum": {
"type": "integer"
},
"quality_by_ope_id_do_not_sum": {
"type": "integer"
},
"refund_by_ope_id_do_not_sum": {
"type": "integer"
},
"marketing_by_ope_id_do_not_sum": {
"type": "integer"
},
"accreditation_by_ope_id_do_not_sum": {
"type": "integer"
},
"degree_requirements_by_ope_id_do_not_sum": {
"type": "integer"
},
"student_loans_by_ope_id_do_not_sum": {
"type": "integer"
},
"grades_by_ope_id_do_not_sum": {
"type": "integer"
},
"credit_transfer_by_ope_id_do_not_sum": {
"type": "integer"
},
"jobs_by_ope_id_do_not_sum": {
"type": "integer"
},
"transcript_by_ope_id_do_not_sum": {
"type": "integer"
},
"other_by_ope_id_do_not_sum": {
"type": "integer"
}
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/GibctInstitutionsShowMeta"
}
}
},
"GibctInstitutionsAutocompleteMeta": {
"type": "object",
"required": [
"version",
"term"
],
"properties": {
"version": {
"type": "integer"
},
"term": {
"type": "string"
}
}
},
"GibctInstitutionsSearchMeta": {
"type": "object",
"required": [
"version",
"count",
"facets"
],
"properties": {
"version": {
"type": "object",
"required": [
"number",
"created_at",
"preview"
],
"properties": {
"number": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
},
"count": {
"type": "integer"
},
"facets": {
"type": "object",
"required": [
"category",
"type",
"state",
"country",
"student_vet_group",
"yellow_ribbon_scholarship",
"principles_of_excellence",
"eight_keys_to_veteran_success"
],
"properties": {
"category": {
"type": "object",
"required": [
"school",
"employer"
],
"properties": {
"school": {
"type": "integer"
},
"employer": {
"type": "integer"
}
}
},
"type": {
"type": "object",
"required": [
"correspondence",
"flight",
"foreign",
"for profit",
"ojt",
"private",
"public"
],
"properties": {
"correspondence": {
"type": "integer"
},
"flight": {
"type": "integer"
},
"foreign": {
"type": "integer"
},
"for profit": {
"type": "integer"
},
"ojt": {
"type": "integer"
},
"private": {
"type": "integer"
},
"public": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"required": [
"ak",
"al",
"ar",
"as",
"az",
"ca",
"co",
"ct",
"dc",
"de",
"fl",
"fm",
"ga",
"gu",
"hi",
"ia",
"id",
"il",
"in",
"ks",
"ky",
"la",
"ma",
"md",
"me",
"mh",
"mi",
"mn",
"mo",
"mp",
"ms",
"mt",
"nc",
"nd",
"ne",
"nh",
"nj",
"nm",
"nv",
"ny",
"oh",
"ok",
"or",
"pa",
"pr",
"pw",
"ri",
"sc",
"sd",
"tn",
"tx",
"ut",
"va",
"vi",
"vt",
"wa",
"wi",
"wv",
"wy"
],
"properties": {
"ak": {
"type": "integer"
},
"al": {
"type": "integer"
},
"ar": {
"type": "integer"
},
"as": {
"type": "integer"
},
"az": {
"type": "integer"
},
"ca": {
"type": "integer"
},
"co": {
"type": "integer"
},
"ct": {
"type": "integer"
},
"dc": {
"type": "integer"
},
"de": {
"type": "integer"
},
"fl": {
"type": "integer"
},
"fm": {
"type": "integer"
},
"ga": {
"type": "integer"
},
"gu": {
"type": "integer"
},
"hi": {
"type": "integer"
},
"ia": {
"type": "integer"
},
"id": {
"type": "integer"
},
"il": {
"type": "integer"
},
"in": {
"type": "integer"
},
"ks": {
"type": "integer"
},
"ky": {
"type": "integer"
},
"la": {
"type": "integer"
},
"ma": {
"type": "integer"
},
"md": {
"type": "integer"
},
"me": {
"type": "integer"
},
"mh": {
"type": "integer"
},
"mi": {
"type": "integer"
},
"mn": {
"type": "integer"
},
"mo": {
"type": "integer"
},
"mp": {
"type": "integer"
},
"ms": {
"type": "integer"
},
"mt": {
"type": "integer"
},
"nc": {
"type": "integer"
},
"nd": {
"type": "integer"
},
"ne": {
"type": "integer"
},
"nh": {
"type": "integer"
},
"nj": {
"type": "integer"
},
"nm": {
"type": "integer"
},
"nv": {
"type": "integer"
},
"ny": {
"type": "integer"
},
"oh": {
"type": "integer"
},
"ok": {
"type": "integer"
},
"or": {
"type": "integer"
},
"pa": {
"type": "integer"
},
"pr": {
"type": "integer"
},
"pw": {
"type": "integer"
},
"ri": {
"type": "integer"
},
"sc": {
"type": "integer"
},
"sd": {
"type": "integer"
},
"tn": {
"type": "integer"
},
"tx": {
"type": "integer"
},
"ut": {
"type": "integer"
},
"va": {
"type": "integer"
},
"vi": {
"type": "integer"
},
"vt": {
"type": "integer"
},
"wa": {
"type": "integer"
},
"wi": {
"type": "integer"
},
"wv": {
"type": "integer"
},
"wy": {
"type": "integer"
}
}
},
"country": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"count"
],
"properties": {
"name": {
"type": "string"
},
"count": {
"type": "integer"
}
}
}
},
"student_vet_group": {
"$ref": "#/definitions/null_boolean_counts"
},
"yellow_ribbon_scholarship": {
"$ref": "#/definitions/null_boolean_counts"
},
"principles_of_excellence": {
"$ref": "#/definitions/null_boolean_counts"
},
"eight_keys_to_veteran_success": {
"$ref": "#/definitions/null_boolean_counts"
}
}
}
}
},
"GibctInstitutionsShowMeta": {
"type": "object",
"required": [
"version"
],
"properties": {
"version": {
"type": "integer"
}
}
},
"GibctInstitutionsSearchLinks": {
"type": "object",
"required": [
"self",
"first",
"prev",
"next",
"last"
],
"properties": {
"self": {
"type": "string"
},
"first": {
"type": "string"
},
"prev": {
"type": [
"null",
"string"
]
},
"next": {
"type": [
"null",
"string"
]
},
"last": {
"type": "string"
}
}
},
"GibctInstitutionBase": {
"required": [
"name",
"facility_code",
"type",
"city",
"state",
"zip",
"country",
"highest_degree",
"locale_type",
"student_count",
"caution_flag",
"caution_flag_reason",
"created_at",
"updated_at",
"bah",
"tuition_in_state",
"tuition_out_of_state",
"books",
"student_veteran",
"yr",
"poe",
"eight_keys"
],
"properties": {
"name": {
"type": "string"
},
"facility_code": {
"type": "string"
},
"city": {
"type": [
"null",
"string"
]
},
"state": {
"type": [
"null",
"string"
]
},
"zip": {
"type": [
"null",
"string"
]
},
"country": {
"type": [
"null",
"string"
]
},
"highest_degree": {
"type": [
"null",
"integer"
]
},
"locale_type": {
"type": [
"null",
"string"
]
},
"student_count": {
"type": [
"null",
"integer"
]
},
"caution_flag": {
"type": [
"null",
"boolean"
]
},
"caution_flag_reason": {
"type": [
"null",
"string"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"bah": {
"type": [
"null",
"number"
]
},
"tuition_in_state": {
"type": [
"null",
"number"
]
},
"tuition_out_of_state": {
"type": [
"null",
"number"
]
},
"books": {
"type": [
"null",
"number"
]
},
"student_veteran": {
"type": [
"null",
"boolean"
]
},
"yr": {
"type": [
"null",
"boolean"
]
},
"poe": {
"type": [
"null",
"boolean"
]
},
"eight_keys": {
"type": [
"null",
"boolean"
]
}
}
},
"GibctInstitutionsSelfLinks": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"type": "string"
}
}
},
"null_boolean_counts": {
"type": "object",
"required": [
"true",
"false"
],
"properties": {
"true": {
"type": [
"null",
"integer"
]
},
"false": {
"type": [
"null",
"integer"
]
}
}
},
"Folders": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/FolderBase"
}
},
"meta": {
"$ref": "#/definitions/MetaPagination"
},
"links": {
"$ref": "#/definitions/LinksAll"
}
}
},
"Folder": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"$ref": "#/definitions/FolderBase"
}
}
},
"FolderBase": {
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"folders"
]
},
"attributes": {
"type": "object",
"$ref": "#/definitions/FolderAttributes"
},
"links": {
"$ref": "#/definitions/LinksSelf"
}
}
},
"FolderAttributes": {
"required": [
"folder_id",
"name",
"count",
"unread_count",
"system_folder"
],
"properties": {
"folder_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"count": {
"type": "integer"
},
"unread_count": {
"type": "integer"
},
"system_folder": {
"type": "boolean"
}
}
},
"LinksAll": {
"type": "object",
"required": [
"self",
"first",
"prev",
"next",
"last"
],
"properties": {
"self": {
"type": "string"
},
"first": {
"type": "string"
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
},
"last": {
"type": "string"
}
}
},
"LinksSelf": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"type": "string"
}
}
},
"LinksDownload": {
"type": "object",
"required": [
"download"
],
"properties": {
"download": {
"type": "string"
}
}
},
"LinksTracking": {
"type": "object",
"required": [
"self",
"prescription",
"tracking_url"
],
"properties": {
"self": {
"type": "string"
},
"prescription": {
"type": "string"
},
"tracking_url": {
"type": "string"
}
}
},
"Messages": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DataAttributes"
}
},
"meta": {
"$ref": "#/definitions/MetaSortPagination"
},
"links": {
"$ref": "#/definitions/LinksAll"
}
}
},
"MessagesThread": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/DataAttributes"
}
},
"meta": {
"$ref": "#/definitions/MetaSortPagination"
},
"links": {
"$ref": "#/definitions/LinksAll"
}
}
},
"Message": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"$ref": "#/definitions/DataAttributesWithRelationships"
},
"included": {
"$ref": "#/definitions/Included"
}
}
},
"Included": {
"required": [
"included"
],
"properties": {
"included": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"attachments"
]
},
"attributes": {
"type": "object",
"required": [
"message_id",
"name"
],
"properties": {
"message_id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"links": {
"$ref": "#/definitions/LinksDownload"
}
}
}
}
}
},
"DataAttributes": {
"type": "object",
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"messages",
"message_drafts"
]
},
"attributes": {
"$ref": "#/definitions/MessageAttributes"
},
"links": {
"$ref": "#/definitions/LinksSelf"
}
}
},
"DataAttributesWithRelationships": {
"type": "object",
"required": [
"id",
"type",
"attributes",
"relationships",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"messages",
"message_drafts"
]
},
"attributes": {
"$ref": "#/definitions/MessageAttributes"
},
"relationships": {
"$ref": "#/definitions/Relationships"
},
"links": {
"$ref": "#/definitions/LinksSelf"
}
}
},
"MessageAttributes": {
"type": "object",
"required": [
"message_id",
"category",
"subject",
"body",
"attachment",
"sent_date",
"sender_id",
"sender_name",
"recipient_id",
"recipient_name",
"read_receipt"
],
"properties": {
"message_id": {
"type": "integer"
},
"category": {
"type": "string"
},
"subject": {
"type": "string"
},
"body": {
"type": [
"null",
"string"
]
},
"attachment": {
"type": "boolean"
},
"sent_date": {
"type": [
"null",
"string"
]
},
"sender_id": {
"type": "integer"
},
"sender_name": {
"type": "string"
},
"recipient_id": {
"type": "integer"
},
"recipient_name": {
"type": "string"
},
"read_receipt": {
"type": [
"null",
"string"
]
}
}
},
"Relationships": {
"type": "object",
"required": [
"attachments"
],
"properties": {
"attachments": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"attachments"
]
}
}
}
}
}
}
}
},
"Categories": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"categories"
]
},
"attributes": {
"type": "object",
"required": [
"message_category_type"
],
"properties": {
"message_category_type": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"MessageInput": {
"type": "object",
"required": [
"subject",
"category",
"recipient_id",
"body"
],
"properties": {
"draft_id": {
"type": "integer"
},
"subject": {
"type": "string"
},
"category": {
"type": "string"
},
"recipient_id": {
"type": "integer"
},
"body": {
"type": "string"
}
}
},
"AttachmentsInput": {
"type": "array"
},
"MetaPagination": {
"type": "object",
"required": [
"pagination"
],
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
},
"MetaFailedStationList": {
"type": "object",
"required": [
"updated_at",
"failed_station_list"
],
"properties": {
"updated_at": {
"type": "string"
},
"failed_station_list": {
"type": "string"
}
}
},
"MetaFailedStationListSortPagination": {
"type": "object",
"required": [
"updated_at",
"failed_station_list",
"sort",
"pagination"
],
"properties": {
"updated_at": {
"type": "string"
},
"failed_station_list": {
"type": [
"null",
"string"
]
},
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
},
"MetaFilterSortPagination": {
"type": "object",
"required": [
"filter",
"sort",
"pagination"
],
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
},
"MetaSortPagination": {
"type": "object",
"required": [
"sort",
"pagination"
],
"properties": {
"pagination": {
"$ref": "#/definitions/Pagination"
}
}
},
"MetaSort": {
"type": "object",
"required": [
"sort"
],
"properties": {
"pagination": {
"$ref": "#/definitions/Sort"
}
}
},
"Filter": {
"type": "object"
},
"Sort": {
"type": "object"
},
"Pagination": {
"type": "object",
"required": [
"current_page",
"per_page",
"total_pages",
"total_entries"
],
"properties": {
"current_page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total_pages": {
"type": "integer"
},
"total_entries": {
"type": "integer"
}
}
},
"Prescriptions": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/PrescriptionBase"
}
},
"meta": {
"$ref": "#/definitions/MetaFailedStationListSortPagination"
},
"links": {
"$ref": "#/definitions/LinksAll"
}
}
},
"Prescription": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"$ref": "#/definitions/PrescriptionBase"
},
"meta": {
"$ref": "#/definitions/MetaFailedStationList"
}
}
},
"PrescriptionBase": {
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"prescriptions"
]
},
"attributes": {
"type": "object",
"required": [
"prescription_id",
"prescription_number",
"prescription_name",
"refill_status",
"refill_submit_date",
"refill_date",
"refill_remaining",
"facility_name",
"ordered_date",
"quantity",
"expiration_date",
"dispensed_date",
"station_number",
"is_refillable",
"is_trackable"
],
"properties": {
"prescription_id": {
"type": "integer"
},
"prescription_number": {
"type": "string"
},
"prescription_name": {
"type": "string"
},
"refill_status": {
"type": "string"
},
"refill_submit_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"refill_date": {
"type": "string",
"format": "date"
},
"refill_remaining": {
"type": "integer"
},
"facility_name": {
"type": "string"
},
"ordered_date": {
"type": "string",
"format": "date"
},
"quantity": {
"type": "integer"
},
"expiration_date": {
"type": "string",
"format": "date"
},
"dispensed_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"station_number": {
"type": "string"
},
"is_refillable": {
"type": "boolean"
},
"is_trackable": {
"type": "boolean"
}
}
},
"links": {
"$ref": "#/definitions/LinksSelf"
}
}
},
"Trackings": {
"required": [
"data",
"meta",
"links"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/Tracking"
}
},
"meta": {
"$ref": "#/definitions/MetaFailedStationListSortPagination"
},
"links": {
"$ref": "#/definitions/LinksAll"
}
}
},
"Tracking": {
"required": [
"id",
"type",
"attributes",
"links"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"trackings"
]
},
"attributes": {
"type": "object",
"$ref": "#/definitions/TrackingBase"
},
"links": {
"type": "object",
"$ref": "#/definitions/LinksTracking"
}
}
},
"TrackingBase": {
"required": [
"tracking_number",
"prescription_id",
"prescription_number",
"prescription_name",
"facility_name",
"rx_info_phone_number",
"ndc_number",
"shipped_date",
"delivery_service"
],
"properties": {
"tracking_number": {
"type": "string"
},
"prescription_id": {
"type": "integer"
},
"prescription_number": {
"type": "string"
},
"prescription_name": {
"type": "string"
},
"facility_name": {
"type": "string"
},
"rx_info_phone_number": {
"type": "string"
},
"ndc_number": {
"type": "string"
},
"shipped_date": {
"type": "string",
"format": "date"
},
"delivery_service": {
"type": "string"
},
"other_prescriptions": {
"type": "array",
"items": {
"$ref": "#/definitions/OtherPrescription"
}
}
}
},
"OtherPrescription": {
"required": [
"prescription_name",
"prescription_number",
"ndc_number",
"station_number"
],
"properties": {
"prescription_name": {
"type": "string"
},
"prescription_number": {
"type": "string"
},
"ndc_number": {
"type": "string"
},
"station_number": {
"type": "string"
}
}
},
"TriageTeams": {
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/TriageTeamsBase"
}
},
"meta": {
"$ref": "#/definitions/MetaSort"
}
}
},
"TriageTeamsBase": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"triage_teams"
]
},
"attributes": {
"type": "object",
"required": [
"triage_team_id",
"name",
"relation_type"
],
"properties": {
"triage_team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"relation_type": {
"type": "string"
}
}
}
}
},
"IntentToFileBase": {
"required": [
"id",
"creation_date",
"expiration_date",
"participant_id",
"source",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"example": "1"
},
"creation_date": {
"type": "string",
"example": "2018-01-21T19:53:45.810+00:00"
},
"expiration_date": {
"type": "string",
"example": "2018-02-21T19:53:45.810+00:00"
},
"participant_id": {
"type": "integer",
"example": 1
},
"source": {
"type": "string",
"example": "EBN"
},
"status": {
"type": "string",
"enum": [
"active",
"claim_recieved",
"duplicate",
"expired",
"incomplete"
],
"example": "active"
},
"type": {
"type": "string",
"enum": [
"compensation",
"pension",
"survivor"
],
"example": "compensation"
}
}
},
"IntentToFiles": {
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"intent_to_file"
],
"properties": {
"intent_to_file": {
"type": "array",
"items": {
"$ref": "#/definitions/IntentToFileBase"
}
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_intent_to_file_intent_to_files_responses"
}
}
}
}
},
"IntentToFile": {
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"intent_to_file"
],
"properties": {
"intent_to_file": {
"type": "object",
"$ref": "#/definitions/IntentToFileBase"
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_intent_to_file_intent_to_files_responses"
}
}
}
}
},
"LetterBeneficiary": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"benefit_information",
"military_service"
],
"properties": {
"benefit_information": {
"type": "object",
"properties": {
"has_non_service_connected_pension": {
"type": "boolean",
"example": true
},
"has_service_connected_disabilities": {
"type": "boolean",
"example": true
},
"has_survivors_indemnity_compensation_award": {
"type": "boolean",
"example": true
},
"has_survivors_pension_award": {
"type": "boolean",
"example": true
},
"monthly_award_amount": {
"type": "number",
"example": 123.5
},
"service_connected_percentage": {
"type": "integer",
"example": 2
},
"award_effective_date": {
"type": "string",
"example": true
},
"has_adapted_housing": {
"type": [
"boolean",
"null"
],
"example": true
},
"has_chapter35_eligibility": {
"type": [
"boolean",
"null"
],
"example": true
},
"has_death_result_of_disability": {
"type": [
"boolean",
"null"
],
"example": true
},
"has_individual_unemployability_granted": {
"type": [
"boolean",
"null"
],
"example": true
},
"has_special_monthly_compensation": {
"type": [
"boolean",
"null"
],
"example": true
}
}
},
"military_service": {
"items": {
"properties": {
"branch": {
"type": "string",
"example": "ARMY"
},
"character_of_service": {
"type": "string",
"enum": [
"HONORABLE",
"OTHER_THAN_HONORABLE",
"UNDER_HONORABLE_CONDITIONS",
"GENERAL",
"UNCHARACTERIZED",
"UNCHARACTERIZED_ENTRY_LEVEL",
"DISHONORABLE"
],
"example": "HONORABLE"
},
"entered_date": {
"type": "string",
"example": "1973-01-01T05:00:00.000+00:00"
},
"released_date": {
"type": "string",
"example": "1977-10-01T04:00:00.000+00:00"
}
}
}
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_letters_letter_beneficiary_response"
}
}
}
}
},
"Letters": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"letters",
"full_name"
],
"properties": {
"letters": {
"type": "array",
"items": {
"$ref": "#/definitions/Letter"
}
},
"full_name": {
"type": "string",
"example": "Mark Webb"
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_letters_letters_response"
}
}
}
}
},
"Letter": {
"required": [
"name",
"letter_type"
],
"properties": {
"name": {
"type": "string",
"example": "Proof of Service Letter"
},
"letter_type": {
"type": "string",
"enum": [
"commissary",
"proof_of_service",
"medicare_partd",
"minimum_essential_coverage",
"service_verification",
"civil_service",
"benefit_summary",
"benefit_verification",
"certificate_of_eligibility"
],
"example": "proof_of_service"
}
}
},
"MaintenanceWindows": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"external_service": {
"type": "string"
},
"start_time": {
"type": "string",
"format": "date"
},
"end_time": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
}
}
}
}
}
}
}
},
"PhoneNumber": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "4445551212"
},
"extension": {
"type": "string",
"example": "101"
},
"country_code": {
"type": "string",
"example": "1"
},
"effective_date": {
"type": "string",
"example": "2018-03-26T15:41:37.487Z"
}
}
}
}
}
}
},
"ControlInformation": {
"properties": {
"can_update_address": {
"type": "boolean",
"example": true
},
"corp_avail_indicator": {
"type": "boolean",
"example": true
},
"corp_rec_found_indicator": {
"type": "boolean",
"example": true
},
"has_no_bdn_payments_indicator": {
"type": "boolean",
"example": true
},
"identity_indicator": {
"type": "boolean",
"example": true
},
"index_indicator": {
"type": "boolean",
"example": true
},
"is_competent_indicator": {
"type": "boolean",
"example": true
},
"no_fiduciary_assigned_indicator": {
"type": "boolean",
"example": true
},
"not_deceased_indicator": {
"type": "boolean",
"example": true
}
}
},
"PaymentAccount": {
"properties": {
"account_number": {
"type": "string",
"example": "9876543211234"
},
"account_type": {
"type": "string",
"example": "Checking"
},
"financial_institution_name": {
"type": "string",
"example": "Comerica"
},
"financial_institution_routing_number": {
"type": "string",
"example": "042102115"
}
}
},
"PaymentAddress": {
"required": [
"type",
"address_effective_date",
"address_one"
],
"properties": {
"address_effective_date": {
"type": "string",
"example": "2018-06-07T22:47:21.873Z"
},
"address_one": {
"type": "string",
"example": "First street address line"
},
"address_two": {
"type": [
"string",
"null"
],
"example": "Second street address line"
},
"address_three": {
"type": [
"string",
"null"
],
"example": "Third street address line"
},
"city": {
"type": [
"string",
"null"
],
"example": "AdHocville"
},
"state_code": {
"type": [
"string",
"null"
],
"example": "OR"
},
"country_name": {
"type": [
"string",
"null"
],
"example": "USA"
},
"military_post_office_type_code": {
"type": [
"string",
"null"
],
"example": "Military PO"
},
"military_state_code": {
"type": [
"string",
"null"
],
"example": "AP"
},
"zip_code": {
"type": [
"string",
"null"
],
"example": "12345"
},
"zip_suffix": {
"type": [
"string",
"null"
],
"example": "6789"
},
"type": {
"type": [
"string",
"null"
],
"example": "Domestic"
}
}
},
"PPIU": {
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"responses"
],
"properties": {
"responses": {
"type": "array",
"items": {
"required": [
"control_information",
"payment_account",
"payment_address",
"payment_type"
],
"properties": {
"control_information": {
"type": "object",
"$ref": "#/definitions/ControlInformation"
},
"payment_account": {
"type": "object",
"$ref": "#/definitions/PaymentAccount"
},
"payment_address": {
"type": "object",
"$ref": "#/definitions/PaymentAddress"
},
"payment_type": {
"type": "string",
"example": "CNP"
}
}
}
}
}
},
"id": {
"type": "string",
"example": null
},
"type": {
"type": "string",
"example": "evss_ppiu_payment_information_responses"
}
}
}
}
},
"SavedForm": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"form": {
"type": "string"
},
"submitted_at": {
"type": "string"
},
"regional_office": {
"type": "array"
},
"confirmation_number": {
"type": "string"
}
}
}
}
}
}
},
"States": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"states"
],
"properties": {
"states": {
"type": "array",
"items": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "CA"
}
}
}
}
}
}
}
}
}
},
"SubmitDisabilityForm": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"example": "gZEaC2dvIOgHLEk9Sw97Og"
}
}
}
}
}
}
},
"Form526JobStatus": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"claim_id": {
"type": "integer"
},
"job_id": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"SuggestedConditions": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/DisabilityContention"
}
}
}
},
"DisabilityContention": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 460
},
"medical_term": {
"type": "string",
"example": "arteriosclerosis"
},
"lay_term": {
"type": "string",
"example": "hardened arteries"
}
}
}
}
},
"TermsAndConditions": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array"
}
},
"items": {
"$ref": "#/definitions/TermsAndConditionsBody"
}
},
"TermsAndConditionsSingle": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object"
}
}
},
"TermsAndConditionsBody": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"header_content": {
"type": "string"
},
"terms_content": {
"type": "string"
},
"yes_content": {
"type": "string"
},
"no_content": {
"type": "string"
},
"footer_content": {
"type": "string"
},
"version": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date"
},
"updated_at": {
"type": "string",
"format": "date"
}
}
}
}
},
"TermsAndConditionsAcceptance": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date"
}
}
}
}
}
}
},
"UploadSupportingEvidence": {
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"required": [
"guid"
],
"properties": {
"guid": {
"type": "string",
"example": "3c05b2f0-0715-4298-965d-f733465ed80a"
}
}
},
"id": {
"type": "string",
"example": "11"
},
"type": {
"type": "string",
"example": "supporting_evidence_attachments"
}
}
}
}
},
"VAFacilities": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/VAFacilityObject"
}
}
}
},
"VAFacility": {
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/definitions/VAFacilityObject"
}
}
},
"VAFacilityObject": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"example": "vha_999"
},
"type": {
"type": "string",
"example": "va_facilities"
},
"attributes": {
"type": "object",
"properties": {
"unique_id": {
"type": "string",
"example": "999"
},
"name": {
"type": "string",
"example": "Example VAMC"
},
"facility_type": {
"type": "string",
"example": "va_health_facility"
},
"classification": {
"type": [
"string",
"null"
],
"example": "VA Medical Center"
},
"website": {
"type": [
"string",
"null"
],
"example": "http://www.example.com"
},
"lat": {
"type": "number",
"format": "float",
"example": -122.5
},
"long": {
"type": "number",
"format": "float",
"example": 45.5
},
"address": {
"$ref": "#/definitions/FacilityAddresses"
},
"phone": {
"$ref": "#/definitions/FacilityPhones"
},
"hours": {
"$ref": "#/definitions/FacilityHours"
},
"services": {
"$ref": "#/definitions/FacilityServices"
},
"feedback": {
"$ref": "#/definitions/FacilityFeedback"
},
"access": {
"$ref": "#/definitions/FacilityAccess"
}
}
}
}
},
"FacilityAddresses": {
"type": "object",
"description": "Physical and mailing addresses for facilities",
"properties": {
"physical": {
"$ref": "#/definitions/FacilityAddress"
},
"mailing": {
"$ref": "#/definitions/FacilityAddress"
}
}
},
"FacilityAddress": {
"type": "object",
"properties": {
"address_1": {
"type": "string",
"example": "123 Fake Street"
},
"address_2": {
"type": [
"string",
"null"
],
"example": "Suite 001"
},
"address_3": {
"type": [
"string",
"null"
]
},
"city": {
"type": "string",
"example": "Anytown"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "00001"
}
}
},
"FacilityPhones": {
"type": "object",
"description": "Telephone numbers for facilities",
"properties": {
"main": {
"type": "string",
"example": "212-555-1212"
},
"fax": {
"type": "string",
"example": "212-555-1212"
},
"after_hours": {
"type": "string",
"example": "212-555-1212"
},
"patient_advocate": {
"type": "string",
"example": "212-555-1212"
},
"enrollment_coordinator": {
"type": "string",
"example": "212-555-1212"
},
"pharmacy": {
"type": "string",
"example": "212-555-1212"
},
"mental_health_clinic": {
"type": "string",
"example": "212-555-1212 x 123"
}
}
},
"FacilityHours": {
"required": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"type": "object",
"description": "Hours of operation for facilities",
"properties": {
"monday": {
"type": "string",
"example": "9am - 5pm"
},
"tuesday": {
"type": "string",
"example": "9am - 5pm"
},
"wednesday": {
"type": "string",
"example": "9am - 5pm"
},
"thursday": {
"type": "string",
"example": "9am - 5pm"
},
"friday": {
"type": "string",
"example": "9am - 5pm"
},
"saturday": {
"type": "string",
"example": "Closed"
},
"sunday": {
"type": "string",
"example": "Closed"
}
}
},
"FacilityServices": {
"type": "object",
"properties": {
"last_updated": {
"type": "string",
"format": "date",
"example": "2017-07-01"
},
"health": {
"$ref": "#/definitions/HealthFacilityServices"
}
}
},
"HealthFacilityServices": {
"type": "array",
"description": "Available services at health facilities",
"items": {
"$ref": "#/definitions/HealthServiceCategory"
}
},
"HealthServiceCategory": {
"type": "object",
"properties": {
"sl1": {
"type": "array",
"example": [
"PrimaryCare"
],
"items": {
"type": "string"
}
},
"sl2": {
"type": "array",
"example": [],
"items": {
"type": "string"
}
}
}
},
"FacilityFeedback": {
"type": "object",
"properties": {
"health": {
"$ref": "#/definitions/HealthFacilityFeedback"
}
}
},
"HealthFacilityFeedback": {
"type": "object",
"description": "Patient satisfaction scores for health facilities",
"properties": {
"primary_care_routine": {
"type": "number",
"format": "float",
"example": 95.2
},
"primary_care_urgent": {
"type": "number",
"format": "float",
"example": 89.1
},
"specialty_care_routine": {
"type": "number",
"format": "float",
"example": 78
},
"specialty_care_urgent": {
"type": "number",
"format": "float",
"example": 75.3
},
"effective_date": {
"type": "string",
"format": "date",
"example": "2017-07-01"
}
}
},
"FacilityAccess": {
"type": "object",
"properties": {
"health": {
"$ref": "#/definitions/HealthFacilityAccess"
}
}
},
"HealthFacilityAccess": {
"type": "object",
"properties": {
"primary_care": {
"$ref": "#/definitions/HealthAccessMetric"
},
"mental_health": {
"$ref": "#/definitions/HealthAccessMetric"
},
"womens_health": {
"$ref": "#/definitions/HealthAccessMetric"
},
"audiology": {
"$ref": "#/definitions/HealthAccessMetric"
},
"cardiology": {
"$ref": "#/definitions/HealthAccessMetric"
},
"gastroenterology": {
"$ref": "#/definitions/HealthAccessMetric"
},
"ophthalmology": {
"$ref": "#/definitions/HealthAccessMetric"
},
"optometry": {
"$ref": "#/definitions/HealthAccessMetric"
},
"urology": {
"$ref": "#/definitions/HealthAccessMetric"
},
"effective_date": {
"type": "string",
"format": "date",
"example": "2017-07-01"
}
}
},
"HealthAccessMetric": {
"type": "object",
"description": "Health facility wait times for new and established patients",
"properties": {
"new": {
"type": [
"number",
"null"
],
"format": "float",
"example": 10.5
},
"established": {
"type": [
"number",
"null"
],
"format": "float",
"example": 5.1
}
}
},
"CCProvider": {
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/definitions/CCProviderObject"
}
}
},
"CCProviderObject": {
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string",
"example": "ccp_179209"
},
"type": {
"type": "string",
"example": "ccp"
},
"attributes": {
"type": "object",
"properties": {
"unique_id": {
"type": "string",
"example": "179209"
},
"name": {
"type": "string",
"example": "Example doctor"
},
"address": {
"$ref": "#/definitions/CCPAddress"
},
"phone": {
"type": "string",
"example": "(800) 555-1555"
},
"fax": {
"type": "string",
"example": "(800) 555-1554"
},
"prefContact": {
"type": "string",
"example": "any"
},
"accNewPatients": {
"type": "boolean",
"example": true
},
"gender": {
"type": "string",
"example": "female"
},
"specialty": {
"$ref": "#/definitions/CCPSpecialtyNames"
}
}
}
}
},
"CCPAddress": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "123 Fake Street"
},
"city": {
"type": "string",
"example": "Anytown"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "00001"
}
}
},
"CCPSpecialtyNames": {
"type": "array",
"description": "Formatted list of specialties of a community care provider",
"items": {
"$ref": "#/definitions/CCPSpecialtyName"
}
},
"CCPSpecialtyName": {
"type": "string",
"example": "Psychoanalyst"
},
"CCSpecialties": {
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/CCSpecialtyObject"
}
}
}
},
"CCSpecialtyObject": {
"properties": {
"SpecialtyCode": {
"type": "string",
"example": "101Y00000X"
},
"Name": {
"type": "string",
"example": "Counselor - Addiction (Substance Use Disorder)"
},
"Grouping": {
"type": "string",
"example": "Behavioral Health & Social Service Providers"
},
"Classification": {
"type": "string",
"example": "Counselor"
},
"Specialization": {
"type": "string",
"example": "Addiction (Substance Use Disorder)"
},
"Description": {
"type": "string",
"example": "A provider who is trained and educated in behavior health"
}
}
},
"PostVet360DomesticAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"city",
"country_name",
"state_code",
"zip_code"
],
"properties": {
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "DOMESTIC"
},
"city": {
"type": "string",
"example": "Fulton",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "United States",
"pattern": "/[a-zA-Z ]+/"
},
"state_code": {
"type": "string",
"example": "MS",
"minLength": 2,
"maxLength": 2,
"pattern": "/[a-zA-Z ]+/"
},
"zip_code": {
"type": "string",
"example": "38843",
"maxLength": 5,
"pattern": "/[0-9]+/"
}
}
},
"PutVet360DomesticAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"city",
"country_name",
"id",
"state_code",
"zip_code"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "DOMESTIC"
},
"city": {
"type": "string",
"example": "Fulton",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "United States",
"pattern": "/[a-zA-Z ]+/"
},
"state_code": {
"type": "string",
"example": "MS",
"minLength": 2,
"maxLength": 2,
"pattern": "/[a-zA-Z ]+/"
},
"zip_code": {
"type": "string",
"example": "38843",
"maxLength": 5,
"pattern": "/[0-9]+/"
}
}
},
"PostVet360InternationalAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"international_postal_code",
"city",
"country_name"
],
"properties": {
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "INTERNATIONAL"
},
"city": {
"type": "string",
"example": "Florence",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "Italy",
"pattern": "/[a-zA-Z ]+/"
},
"international_postal_code": {
"type": "string",
"example": "12345"
}
}
},
"PutVet360InternationalAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"id",
"international_postal_code",
"city",
"country_name"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "INTERNATIONAL"
},
"city": {
"type": "string",
"example": "Florence",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "Italy",
"pattern": "/[a-zA-Z ]+/"
},
"international_postal_code": {
"type": "string",
"example": "12345"
}
}
},
"PostVet360MilitaryOverseasAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"city",
"country_name",
"state_code",
"zip_code"
],
"properties": {
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "OVERSEAS MILITARY"
},
"city": {
"type": "string",
"example": "Fulton",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "United States",
"pattern": "/[a-zA-Z ]+/"
},
"state_code": {
"type": "string",
"example": "MS",
"minLength": 2,
"maxLength": 2,
"pattern": "/[a-zA-Z ]+/"
},
"zip_code": {
"type": "string",
"example": "38843",
"maxLength": 5,
"pattern": "/[0-9]+/"
}
}
},
"PutVet360MilitaryOverseasAddress": {
"required": [
"address_line1",
"address_pou",
"address_type",
"city",
"country_name",
"id",
"state_code",
"zip_code"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd",
"maxLength": 100
},
"address_line2": {
"type": "string",
"maxLength": 100
},
"address_line3": {
"type": "string",
"maxLength": 100
},
"address_pou": {
"type": "string",
"enum": [
"RESIDENCE/CHOICE",
"CORRESPONDENCE"
],
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "OVERSEAS MILITARY"
},
"city": {
"type": "string",
"example": "Fulton",
"maxLength": 100
},
"country_name": {
"type": "string",
"example": "United States",
"pattern": "/[a-zA-Z ]+/"
},
"state_code": {
"type": "string",
"example": "MS",
"minLength": 2,
"maxLength": 2,
"pattern": "/[a-zA-Z ]+/"
},
"zip_code": {
"type": "string",
"example": "38843",
"maxLength": 5,
"pattern": "/[0-9]+/"
}
}
},
"PostVet360Email": {
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"example": "john@example.com",
"minLength": 6,
"maxLength": 255,
"pattern": "/.+@.+\\..+/i"
}
}
},
"PutVet360Email": {
"required": [
"email_address",
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"email_address": {
"type": "string",
"example": "john@example.com",
"minLength": 6,
"maxLength": 255,
"pattern": "/.+@.+\\..+/i"
}
}
},
"PostVet360Telephone": {
"required": [
"phone_number",
"area_code",
"phone_type",
"is_international",
"country_code"
],
"properties": {
"is_international": {
"type": "boolean",
"enum": [
false
],
"example": false
},
"country_code": {
"type": "string",
"enum": [
"1"
],
"example": "1"
},
"phone_number": {
"type": "string",
"example": "5551212",
"minLength": 1,
"maxLength": 14,
"pattern": "/[^a-zA-Z]+/"
},
"area_code": {
"type": "string",
"example": "303",
"minLength": 3,
"maxLength": 3,
"pattern": "/[0-9]+/"
},
"extension": {
"type": "string",
"example": "101",
"maxLength": 10
},
"phone_type": {
"type": "string",
"enum": [
"MOBILE",
"HOME",
"WORK",
"FAX",
"TEMPORARY"
],
"example": "MOBILE"
}
}
},
"PutVet360Telephone": {
"required": [
"id",
"phone_number",
"area_code",
"phone_type",
"is_international",
"country_code"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"is_international": {
"type": "boolean",
"enum": [
false
],
"example": false
},
"country_code": {
"type": "string",
"enum": [
"1"
],
"example": "1"
},
"phone_number": {
"type": "string",
"example": "5551212",
"minLength": 1,
"maxLength": 14,
"pattern": "/[^a-zA-Z]+/"
},
"area_code": {
"type": "string",
"example": "303",
"minLength": 3,
"maxLength": 3,
"pattern": "/[0-9]+/"
},
"extension": {
"type": "string",
"example": "101",
"maxLength": 10
},
"phone_type": {
"type": "string",
"enum": [
"MOBILE",
"HOME",
"WORK",
"FAX",
"TEMPORARY"
],
"example": "MOBILE"
}
}
},
"Vet360ContactInformation": {
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"vet360_contact_information": {
"type": "object",
"properties": {
"email": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 323
},
"email_address": {
"type": "string",
"example": "john@example.com"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"residential_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd"
},
"address_line2": {
"type": [
"string",
"null"
]
},
"address_line3": {
"type": [
"string",
"null"
]
},
"address_pou": {
"type": "string",
"example": "RESIDENCE/CHOICE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "DOMESTIC"
},
"city": {
"type": "string",
"example": "Fulton"
},
"country_name": {
"type": "string",
"example": "United States of America"
},
"country_code_iso2": {
"type": [
"string",
"null"
],
"example": "US"
},
"country_code_iso3": {
"type": [
"string",
"null"
],
"example": "USA"
},
"country_code_fips": {
"type": [
"string",
"null"
],
"example": "US"
},
"id": {
"type": "integer",
"example": 123
},
"international_postal_code": {
"type": [
"string",
"null"
],
"example": "54321"
},
"province": {
"type": [
"string",
"null"
]
},
"state_code": {
"type": "string",
"example": "NY"
},
"zip_code": {
"type": "string",
"example": "97062"
},
"zip_code_suffix": {
"type": [
"string",
"null"
],
"example": "1234"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"mailing_address": {
"type": "object",
"properties": {
"address_line1": {
"type": "string",
"example": "1493 Martin Luther King Rd"
},
"address_line2": {
"type": [
"string",
"null"
]
},
"address_line3": {
"type": [
"string",
"null"
]
},
"address_pou": {
"type": "string",
"example": "CORRESPONDENCE"
},
"address_type": {
"type": "string",
"enum": [
"DOMESTIC",
"INTERNATIONAL",
"OVERSEAS MILITARY"
],
"example": "DOMESTIC"
},
"city": {
"type": "string",
"example": "Fulton"
},
"country_name": {
"type": "string",
"example": "United States of America"
},
"country_code_iso2": {
"type": [
"string",
"null"
],
"example": "US"
},
"country_code_iso3": {
"type": [
"string",
"null"
],
"example": "USA"
},
"country_code_fips": {
"type": [
"string",
"null"
],
"example": "US"
},
"id": {
"type": "integer",
"example": 123
},
"international_postal_code": {
"type": [
"string",
"null"
],
"example": "54321"
},
"province": {
"type": [
"string",
"null"
]
},
"state_code": {
"type": "string",
"example": "NY"
},
"zip_code": {
"type": "string",
"example": "97062"
},
"zip_code_suffix": {
"type": [
"string",
"null"
],
"example": "1234"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"mobile_phone": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"example": "503"
},
"country_code": {
"type": "string",
"example": "1"
},
"extension": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"example": 123
},
"is_international": {
"type": "boolean"
},
"is_textable": {
"type": "boolean"
},
"is_tty": {
"type": "boolean"
},
"is_voicemailable": {
"type": "boolean"
},
"phone_number": {
"type": "string",
"example": "5551234"
},
"phone_type": {
"type": "string",
"example": "MOBILE"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"home_phone": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"example": "503"
},
"country_code": {
"type": "string",
"example": "1"
},
"extension": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"example": 123
},
"is_international": {
"type": "boolean"
},
"is_textable": {
"type": "boolean"
},
"is_tty": {
"type": "boolean"
},
"is_voicemailable": {
"type": "boolean"
},
"phone_number": {
"type": "string",
"example": "5551234"
},
"phone_type": {
"type": "string",
"example": "HOME"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"work_phone": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"example": "503"
},
"country_code": {
"type": "string",
"example": "1"
},
"extension": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"example": 123
},
"is_international": {
"type": "boolean"
},
"is_textable": {
"type": "boolean"
},
"is_tty": {
"type": "boolean"
},
"is_voicemailable": {
"type": "boolean"
},
"phone_number": {
"type": "string",
"example": "5551234"
},
"phone_type": {
"type": "string",
"example": "WORK"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"temporary_phone": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"example": "503"
},
"country_code": {
"type": "string",
"example": "1"
},
"extension": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"example": 123
},
"is_international": {
"type": "boolean"
},
"is_textable": {
"type": "boolean"
},
"is_tty": {
"type": "boolean"
},
"is_voicemailable": {
"type": "boolean"
},
"phone_number": {
"type": "string",
"example": "5551234"
},
"phone_type": {
"type": "string",
"example": "TEMPORARY"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
},
"fax_number": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"example": "503"
},
"country_code": {
"type": "string",
"example": "1"
},
"extension": {
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"example": 123
},
"is_international": {
"type": "boolean"
},
"is_textable": {
"type": "boolean"
},
"is_tty": {
"type": "boolean"
},
"is_voicemailable": {
"type": "boolean"
},
"phone_number": {
"type": "string",
"example": "5551234"
},
"phone_type": {
"type": "string",
"example": "FAX"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"effective_start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"source_date": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2018-04-21T20:09:50Z"
}
}
}
}
}
}
}
}
}
}
},
"Vet360Countries": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"countries"
],
"properties": {
"countries": {
"type": "array",
"items": {
"properties": {
"country_name": {
"type": "string",
"example": "Italy"
},
"country_code_iso3": {
"type": "string",
"example": "ITA"
}
}
}
}
}
}
}
}
}
},
"Vet360States": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"states"
],
"properties": {
"states": {
"type": "array",
"items": {
"properties": {
"state_name": {
"type": "string",
"example": "Oregon"
},
"state_code": {
"type": "string",
"example": "OR"
}
}
}
}
}
}
}
}
}
},
"Vet360Zipcodes": {
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"zipcodes"
],
"properties": {
"zipcodes": {
"type": "array",
"items": {
"properties": {
"zip_code": {
"type": "string",
"example": "97062"
}
}
}
}
}
}
}
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment