index
int64 0
0
| repo_id
stringclasses 829
values | file_path
stringlengths 34
254
| content
stringlengths 6
5.38M
|
|---|---|---|---|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/rated_disabilities.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"rated_disabilities": {
"description": "Array of previously rated disabilities",
"items": {
"$ref": "rated_disability_base.json"
},
"type": "array"
}
},
"type": "object",
"required": ["rated_disabilities"]
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": ["object", "null"]
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/appeals_evidence.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"description": {
"type": "string"
},
"date": {
"type": "string"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/search.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"body": {
"description": "Complete body of search results data from Search.gov",
"properties": {
"query": {
"type": "string"
},
"web": {
"description": "Contains all of the search result related data for the query",
"properties": {
"total": {
"type": "integer"
},
"next_offset": {
"type": "integer"
},
"spelling_correction": {
"type": ["string", null]
},
"results": {
"description": "Array of search results based on query",
"items": {
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"snippet": {
"type": "string"
},
"publication_date": {
"type": ["string", null]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"text_best_bets": {
"description": "Array of text best bets",
"items": {
"type": "object"
},
"type": "array"
},
"graphic_best_bets": {
"description": "Array of graphic best bets",
"items": {
"type": "object"
},
"type": "array"
},
"health_topics": {
"description": "Array of health topics",
"items": {
"type": "object"
},
"type": "array"
},
"job_openings": {
"description": "Array of job openings",
"items": {
"type": "object"
},
"type": "array"
},
"recent_tweets": {
"description": "Array of recent tweets",
"items": {
"type": "object"
},
"type": "array"
},
"federal_register_documents": {
"description": "Array of federal register documents",
"items": {
"type": "object"
},
"type": "array"
},
"related_search_terms": {
"description": "Array of related search terms",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"meta": {
"type": "object",
"required": ["pagination"],
"properties": {
"pagination": {
"type": "object",
"description": "The details around the page numbers and per page results",
"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" }
}
}
}
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/errors.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": ["string", "object"]
},
"status": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"status",
"source",
"code",
"detail",
"title"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/triage_teams.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["triage_teams"] },
"attributes": {
"type": "object",
"$ref": "triage_team.json"
}
}
}
},
"meta": {
"type": "object",
"required": ["sort"],
"properties": {
"sort": {
"type": "object"
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/service_and_deployment_history_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
},
"properties": {
"data": {
"items": {
"properties": {
"attributes": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"branch_of_service": {
"type": ["string", null]
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"pay_grade": {
"type": ["string", null]
},
"separation_reason": {
"type": "string"
},
"discharge_status": {
"type": "string"
},
"deployments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"location": {
"type": "string"
}
}
}
}
}
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letter_beneficiary_benefit_information_dependent.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"monthly_award_amount": {
"type": "number",
"not": {
"type": "integer"
}
},
"award_effective_date": {
"type": "string"
},
"has_chapter35_eligibility": {
"type": "boolean"
},
"has_survivors_pension_award": {
"type": "boolean"
},
"has_survivors_indemnity_compensation_award": {
"type": "boolean"
},
"has_death_result_of_disability": {
"type": "boolean"
},
"service_connected_percentage": {
"type": "integer"
}
},
"type": [
"object"
]
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/enrollment.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"begin_date"
],
"additionalProperties": false,
"properties": {
"begin_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"facility_code": {
"type": "string"
},
"facility_name": {
"type": "string"
},
"participant_id": {
"type": "integer"
},
"training_type": {
"type": [
"string",
"null"
]
},
"term_id": {
"type": [
"string",
"null"
]
},
"hour_type": {
"type": [
"string",
"null"
]
},
"full_time_hours": {
"type": "integer"
},
"full_time_credit_hour_under_grad": {
"type": [
"integer",
"null"
]
},
"vacation_day_count": {
"type": [
"integer",
"null"
]
},
"on_campus_hours": {
"type": [
"number",
"null"
]
},
"online_hours": {
"type": [
"number",
"null"
]
},
"yellow_ribbon_amount": {
"type": [
"number",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"amendments": {
"type": "array",
"items": {
"$ref": "amendment.json"
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/messages_thread.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/all_triage_team.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"triage_team_id",
"name",
"station_number",
"blocked_status",
"preferred_team",
"relationship_type"
],
"properties": {
"triage_team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"station_number": {
"type": "string"
},
"blocked_status": {
"type": "boolean"
},
"preferred_team": {
"type": "boolean"
},
"relationship_type": {
"type": "string"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/prescriptions_filtered.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_base.json"
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "pagination"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"sort": {
"type": "object"
},
"filter": {
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/evss_claim_service.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["evss_claims"] },
"attributes": {
"type": "object",
"required": [
"evss_id",
"date_filed",
"min_est_date",
"max_est_date",
"open",
"waiver_submitted",
"requested_decision",
"contention_list",
"events_timeline",
"phase_change_date",
"va_representative",
"documents_needed",
"development_letter_sent",
"decision_letter_sent",
"phase",
"claim_type",
"ever_phase_back",
"current_phase_back",
"claim_type"
],
"properties": {
"evss_id": { "type": "integer" },
"date_filed": { "type": "string" },
"contention_list": { "type": "array", "items": { "type": "string" } },
"events_timeline": { "type": "array", "items": { "type": "object" } },
"min_est_date": { "type": ["string", "null"] },
"max_est_date": { "type": ["string", "null"] },
"phase_change_date": { "type": ["string", "null"] },
"open": { "type": "boolean" },
"va_representative": { "type": "string" },
"waiver_submitted": { "type": "boolean" },
"requested_decision": { "type": "boolean" },
"documents_needed": { "type": "boolean" },
"development_letter_sent": { "type": "boolean" },
"decision_letter_sent": { "type": "boolean" },
"phase": { "type": ["integer", "null"] },
"claim_type": { "type": "string" },
"ever_phase_back": { "type": "boolean" },
"current_phase_back": { "type": "boolean" },
"claim_type": { "type": ["string", "null"] }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/payment_information.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"responses": {
"description": "Array of responses of banking info",
"properties": {
"control_information": {
"properties": {
"can_update_address": {
"type": "boolean"
},
"corp_avail_indicator": {
"type": "boolean"
},
"corp_rec_found_indicator": {
"type": "boolean"
},
"has_no_bdn_payments_indicator": {
"type": "boolean"
},
"identity_indicator": {
"type": "boolean"
},
"index_indicator": {
"type": "boolean"
},
"is_competent_indicator": {
"type": "boolean"
},
"no_fiduciary_assigned_indicator": {
"type": "boolean"
},
"not_deceased_indicator": {
"type": "boolean"
}
},
"type": "object"
},
"payment_account": {
"properties": {
"account_number": {
"type": "string"
},
"account_type": {
"type": "string"
},
"financial_institution_name": {
"type": "string"
},
"financial_institution_routing_number": {
"type": "string"
}
},
"type": "object"
},
"payment_address": {
"properties": {
"address_effective_date": {
"type": ["string", "null"]
},
"address_one": {
"type": ["string", "null"]
},
"address_three": {
"type": ["string", "null"]
},
"address_two": {
"type": ["string", "null"]
},
"city": {
"type": ["string", "null"]
},
"country_name": {
"type": ["string", "null"]
},
"military_post_office_type_code": {
"type": ["string", "null"]
},
"military_state_code": {
"type": ["string", "null"]
},
"state_code": {
"type": ["string", "null"]
},
"type": {
"type": ["string", "null"]
},
"zip_code": {
"type": ["string", "null"]
},
"zip_suffix": {
"type": ["string", "null"]
}
},
"type": "object"
}
},
"type": "array"
}
},
"type": "object",
"required": ["responses"]
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/suggested_facilities.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"oneOf": [
{
"type": "object",
"properties": {
"mailing": {
"type": "object"
},
"physical": {
"type": "object",
"properties": {
"zip": {
"type": [
"string",
null
]
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": [
"string",
null
]
},
"address_1": {
"type": [
"string",
null
]
},
"address_2": {
"type": [
"string",
null
]
},
"address_3": {
"type": [
"string",
null
]
}
}
}
}
},
{
"type": "object",
"properties": {
"mailing": {
"type": "object"
},
"physical": {
"type": "object",
"properties": {
"zip": {
"type": [
"string",
null
]
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"address_1": {
"type": [
"string",
null
]
},
"address_2": {
"type": [
"string",
null
]
},
"address_3": {
"type": [
"string",
null
]
}
}
}
}
}
]
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/backend_statuses.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"reported_at": {
"type": "string"
},
"statuses": {
"description": "Array of external service statuses",
"items": {
"type": "object",
"properties": {
"service": { "type": "string" },
"service_id": { "type": "string" },
"status": { "type": "string" },
"last_incident_timestamp": { "type": ["string", null] }
}
},
"type": "array"
},
"maintenance_windows": {
"description": "Array of external service maintenance windows",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"external_service": { "type": "string" },
"start": { "type": "string" },
"end": { "type": "string" },
"description": { "type": "string" }
}
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/messages.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"oneOf": [
{
"type": "object",
"required": ["pagination"],
"properties": {
"pagination": {
"type": "object",
"required": [
"total_entries"
],
"properties": {
"total_entries": { "type": "integer" }
}
}
}
},
{
"type": "object",
"required": ["sort", "pagination"],
"properties": {
"sort": {
"type": "object"
},
"pagination": {
"type": "object",
"required": [
"total_entries"
],
"properties": {
"total_entries": { "type": "integer" }
}
}
}
}
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/evss_claim_async.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["evss_claims"] },
"attributes": {
"type": "object",
"required": [
"evss_id",
"date_filed",
"min_est_date",
"max_est_date",
"open",
"waiver_submitted",
"requested_decision",
"contention_list",
"events_timeline",
"phase_change_date",
"va_representative",
"documents_needed",
"development_letter_sent",
"decision_letter_sent",
"updated_at",
"phase",
"claim_type",
"ever_phase_back",
"current_phase_back",
"claim_type"
],
"properties": {
"evss_id": { "type": "integer" },
"date_filed": { "type": "string" },
"contention_list": { "type": "array", "items": { "type": "string" } },
"events_timeline": { "type": "array", "items": { "type": "object" } },
"min_est_date": { "type": ["string", "null"] },
"max_est_date": { "type": ["string", "null"] },
"phase_change_date": { "type": ["string", "null"] },
"open": { "type": "boolean" },
"va_representative": { "type": "string" },
"waiver_submitted": { "type": "boolean" },
"requested_decision": { "type": "boolean" },
"documents_needed": { "type": "boolean" },
"development_letter_sent": { "type": "boolean" },
"decision_letter_sent": { "type": "boolean" },
"updated_at": { "type": "string" },
"phase": { "type": ["integer", "null"] },
"claim_type": { "type": "string" },
"ever_phase_back": { "type": "boolean" },
"current_phase_back": { "type": "boolean" },
"claim_type": { "type": ["string", "null"] }
}
}
}
},
"meta": {
"type": "object",
"required": ["sync_status"],
"properties": {
"sync_status": { "enum": ["REQUESTED", "SUCCESS", "FAILED"] }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/failed_evidence_submissions.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"type": "array",
"items": {
"type": "object",
"properties": {
"acknowledgement_date": {
"type": ["string", "null"]
},
"claim_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"delete_date": {
"type": ["string", "null"]
},
"document_type": {
"type": "string"
},
"failed_date": {
"type": "string"
},
"file_name": {
"type": "string"
},
"id": {
"type": "integer"
},
"lighthouse_upload": {
"type": "boolean"
},
"tracked_item_id": {
"type": ["integer", "null"]
},
"tracked_item_display_name": {
"type": ["string", "null"]
},
"upload_status": {
"type": ["string", "null"],
"enum": ["CREATED", "QUEUED", "IN_PROGESS", "FAILED", "SUCCESS", null]
},
"va_notify_status": {
"type": ["string", "null"],
"enum": ["FAILED", "SUCCESS", null]
}
},
"required": [
"claim_id",
"created_at",
"document_type",
"failed_date",
"file_name",
"id",
"lighthouse_upload"
]
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/folders.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["folders"] },
"attributes": {
"type": "object",
"$ref": "folder.json"
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["pagination"],
"properties": {
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/intent_to_files.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"intent_to_file": {
"description": "Array of ITFs the user has been assigned",
"items": {
"$ref": "intent_to_file_base.json"
},
"type": "array"
}
},
"type": "object",
"required": ["intent_to_file"]
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": ["object", "null"]
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/states.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"states": {
"description": "Array of states",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/prescriptions.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "prescription_base.json"
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list", "sort", "pagination"],
"properties": {
"updated_at": { "type": "string" },
"failed_station_list": { "type": "string" },
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/appeals_status.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["appeals_status_models_appeals"] },
"attributes": {
"type": "object",
"required": [
"active",
"type",
"prior_decision_date",
"requested_hearing_type",
"events",
"hearings"
],
"properties": {
"active": { "type": "boolean" },
"type": { "type": "string" },
"prior_decision_date": { "type": "string" },
"requested_hearing_type": { "type": "string" },
"events": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"type",
"date"
],
"properties": {
"type": { "type": "string" },
"date": { "type": "string" }
}
}
},
"hearings": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"id",
"type",
"date"
],
"properties": {
"id": { "type": "integer" },
"type": { "type": "string" },
"date": { "type": "string" }
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/countries.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"countries": {
"description": "Array of countries",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/user_loa3.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"services",
"profile",
"in_progress_forms"
],
"properties": {
"in_progress_forms": {
"type": [
"array",
null
],
"items": {
"type": "object",
"properties": {
"form_id": {
"type": "string"
},
"last_updated": {
"type": "integer"
}
},
"required": []
}
},
"prefills_available": {
"type": [
"array",
null
]
},
"session": {
"type": "object",
"required": [
"auth_broker",
"ssoe",
"transactionid"
],
"properties": {
"auth_broker": {
"type": "string"
},
"ssoe": {
"type": "boolean"
},
"transactionid": {
"type": [
"string",
null
]
}
}
},
"services": {
"type": [
"array",
null
]
},
"user_account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": [
"string",
null
]
}
}
},
"profile": {
"type": "object",
"required": [
"email",
"first_name",
"middle_name",
"last_name",
"preferred_name",
"birth_date",
"gender",
"zip",
"last_signed_in",
"initial_sign_in",
"loa",
"multifactor",
"verified",
"sign_in",
"authn_context",
"icn",
"birls_id",
"edipi",
"sec_id",
"npi_id",
"logingov_uuid",
"idme_uuid",
"id_theft_flag"
],
"properties": {
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"middle_name": {
"type": [
"string",
null
]
},
"last_name": {
"type": "string"
},
"preferred_name": {
"type": [
"string",
null
]
},
"birth_date": {
"type": "string"
},
"gender": {
"type": [
"string",
null
]
},
"zip": {
"type": [
"string",
null
]
},
"last_signed_in": {
"type": [
"string",
null
]
},
"initial_sign_in": {
"type": [
"string",
null
]
},
"loa": {
"type": "object",
"required": [
"current",
"highest"
],
"properties": {
"current": {
"type": "integer"
},
"highest": {
"type": "integer"
}
}
},
"multifactor": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"sign_in": {
"type": "object",
"properties": {
"service_name": {
"type": "string"
},
"auth_broker": {
"type": "string"
},
"client_id": {
"type": "string"
}
}
},
"authn_context": {
"type": "string"
},
"icn": {
"type": "string"
},
"birls_id": {
"type": [
"string",
null
]
},
"edipi": {
"type": [
"string",
null
]
},
"sec_id": {
"type": [
"string",
null
]
},
"npi_id": {
"type": [
"string",
"null"
]
},
"logingov_uuid": {
"type": [
"string",
null
]
},
"idme_uuid": {
"type": [
"string",
null
]
},
"id_theft_flag": {
"type": [
"boolean",
null
]
},
"claims": {
"type": "object",
"properties": {
"coe": {
"type": "boolean"
},
"communication_preferences": {
"type": "boolean"
},
"connected_apps": {
"type": "boolean"
},
"military_history": {
"type": "boolean"
},
"payment_history": {
"type": "boolean"
},
"personal_information": {
"type": "boolean"
},
"rating_info": {
"type": "boolean"
},
"appeals": {
"type": "boolean"
},
"medical_copays": {
"type": "boolean"
},
"form526_required_identifier_presence": {
"type": "object",
"properties": {
"participant_id": {
"type": "boolean"
},
"birls_id": {
"type": "boolean"
},
"ssn": {
"type": "boolean"
},
"birth_date": {
"type": "boolean"
},
"edipi": {
"type": "boolean"
}
},
"required": [
"participant_id",
"birls_id",
"ssn",
"birth_date",
"edipi"
]
}
}
}
}
},
"va_profile": {
"type": [
"object",
"null"
],
"required": [
"status"
],
"oneOf": [
{
"properties": {
"status": {
"type": [
"string"
]
}
}
},
{
"properties": {
"status": {
"type": "string"
},
"birth_date": {
"type": "string"
},
"family_name": {
"type": "string"
},
"gender": {
"type": "string"
},
"is_cerner_patient": {
"type": "boolean"
},
"cerner_id": {
"type": "string"
},
"cerner_facility_ids": {
"type": "array"
},
"facilities": {
"type": "array"
},
"given_names": {
"type": "array"
},
"va_patient": {
"type": "boolean"
},
"mhv_account_state": {
"type": "string"
},
"active_mhv_ids": {
"type": "array"
},
"user_at_pretransitioned_oh_facility": {
"type": "boolean"
},
"user_facility_ready_for_info_alert": {
"type": "boolean"
},
"user_facility_migrating_to_oh": {
"type": "boolean"
},
"scheduling_preferences_pilot_eligible": {
"type": "boolean"
}
}
}
]
},
"veteran_status": {
"type": [
"object",
"null"
],
"required": [
"status"
],
"oneOf": [
{
"properties": {
"status": {
"type": [
"string"
]
}
}
},
{
"properties": {
"is_veteran": {
"type": "boolean"
},
"served_in_military": {
"type": "boolean"
},
"status": {
"type": "string"
}
}
}
]
},
"vet360_contact_information": {
"type": [
"object",
"null"
]
},
"onboarding": {
"show": {
"type": [
"boolean",
"null"
]
}
}
}
}
}
},
"meta": {
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": [
"array",
null
]
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/rating_info_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"service_connected_combined_degree": {
"type": "integer"
},
"user_percent_of_disability": {
"type": "integer"
},
"source_system": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/mdot_supplies.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "",
"type": "object",
"required": ["permanent_address", "supplies"],
"properties": {
"permanent_address": {
"type": "object",
"street": {
"type": "string"
},
"street2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
}
},
"temporary_address": {
"type": "object",
"street": {
"type": "string"
},
"street2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"postal_code": {
"type": "string"
}
},
"supplies": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": ["product_id"],
"properties": {
"device_name": {
"type": "string"
},
"product_name": {
"type": "string"
},
"product_group": {
"type": "string"
},
"product_id": {
"type": "string"
},
"available_for_reorder": {
"type": "boolean"
},
"last_order_date": {
"type": "string"
},
"next_availability_date": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"size": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/higher_level_review_accepted.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"enum": [ "HigherLevelReview" ]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [ "status" ],
"status": {
"enum": [
"not_yet_submitted",
"submitted",
"attempted",
"canceled"
]
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/messages_filtered.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["messages"] },
"attributes": {
"type": "object",
"$ref": "message.json"
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["filter", "pagination"],
"properties": {
"filter": {
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/disability_rating_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
},
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"combined_disability_rating": {
"type": "integer"
},
"combined_effective_date": {
"type": "string"
},
"legal_effective_date": {
"type": "string"
},
"individual_ratings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"decision": {
"type": "string"
},
"rating_percentage": {
"type": "integer"
},
"effective_date": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/message_threads_no_messages.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/intent_to_file_base.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"status"
],
"properties": {
"id": {
"type": "string"
},
"creation_date": {
"type": "string"
},
"expiration_date": {
"type": "string"
},
"participant_id": {
"type": "integer"
},
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/submit_disability_form.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"job_id": {
"type": "string"
}
},
"type": "object",
"required": ["job_id"]
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/intent_to_file.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"intent_to_file": "intent_to_file_base.json"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/disability_rating.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["disability_ratings"] },
"attributes": {
"type": "object",
"required": ["ratings", "service_connected_combined_degree"],
"properties": {
"ratings": { "type": "array" },
"service_connected_combined_degree": { "type": "string" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/prescription.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"$ref": "prescription_base.json"
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list"],
"properties": {
"updated_at": { },
"failed_station_list": { }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/address_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"address": {
"oneOf": [
{
"$ref": "address_domestic.json"
},
{
"$ref": "address_international.json"
},
{
"$ref": "address_military.json"
}
]
},
"control_information": {
"$ref": "control_information.json"
}
},
"required": [
"address",
"control_information"
],
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"attributes",
"id",
"type"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/upload_supporting_evidence.json
|
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "integer",
"examples": [
12
]
},
"created_at": {
"type": "string",
"examples": [
"2018-05-10T15:18:43.668Z"
]
},
"updated_at": {
"type": "string",
"examples": [
"2018-05-10T15:18:43.668Z"
]
},
"guid": {
"type": "string",
"examples": [
"8f68e6b2-1318-41a1-a80b-cba7d6a7b505"
]
},
"encrypted_file_data": {
"type": "string",
"examples": [
"jvJNW3DvnVJ2MG1SyO7Fj2se9cO81R8Z7QFVW0l+Zea8\n"
]
},
"encrypted_file_data_iv": {
"type": "string",
"examples": [
"QhEhcQbOOqr8oFCg\n"
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/category.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["categories"] },
"attributes": {
"type": "object",
"required": ["message_category_type"],
"properties": {
"message_category_type": {
"type": "array",
"items": { "type": "string" },
"minItems": 1,
"uniqueItems": true
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/full_name_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"first": {
"type": "string"
},
"middle": {
"type": "string"
},
"last": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/evss_claim.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["evss_claims"] },
"attributes": {
"type": "object",
"required": [
"evss_id",
"date_filed",
"min_est_date",
"max_est_date",
"open",
"waiver_submitted",
"requested_decision",
"contention_list",
"events_timeline",
"phase_change_date",
"va_representative",
"documents_needed",
"development_letter_sent",
"decision_letter_sent",
"updated_at",
"phase",
"claim_type",
"ever_phase_back",
"current_phase_back",
"claim_type"
],
"properties": {
"evss_id": { "type": "integer" },
"date_filed": { "type": "string" },
"contention_list": { "type": "array", "items": { "type": "string" } },
"events_timeline": { "type": "array", "items": { "type": "object" } },
"min_est_date": { "type": ["string", "null"] },
"max_est_date": { "type": ["string", "null"] },
"phase_change_date": { "type": ["string", "null"] },
"open": { "type": "boolean" },
"va_representative": { "type": "string" },
"waiver_submitted": { "type": "boolean" },
"requested_decision": { "type": "boolean" },
"documents_needed": { "type": "boolean" },
"development_letter_sent": { "type": "boolean" },
"decision_letter_sent": { "type": "boolean" },
"updated_at": { "type": "string" },
"phase": { "type": ["integer", "null"] },
"claim_type": { "type": "string" },
"ever_phase_back": { "type": "boolean" },
"current_phase_back": { "type": "boolean" },
"claim_type": { "type": ["string", "null"] }
}
}
}
},
"meta": {
"type": "object",
"required": ["successful_sync"],
"properties": {
"successful_sync": { "type": "boolean" }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/message_threads.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["message_threads"] },
"attributes": {
"type": "object",
"required": [
"thread_id",
"folder_id",
"message_id",
"thread_page_size",
"message_count",
"category",
"subject",
"triage_group_name",
"sent_date",
"draft_date",
"sender_id",
"sender_name",
"recipient_name",
"recipient_id",
"proxy_sender_name",
"has_attachment",
"unsent_drafts",
"unread_messages"
],
"properties": {
"thread_id": { "type": "integer" },
"folder_id": { "type": "integer" },
"message_id": { "type": "integer" },
"thread_page_size": { "type": "integer" },
"message_count": { "type": "integer" },
"category": {
"enum": [
"OTHERS",
"COVID",
"APPOINTMENTS",
"MEDICATIONS",
"TEST_RESULT",
"EDUCATION"
]
},
"subject": { "type": "string" },
"triage_group_name": { "type": ["null", "string"] },
"sent_date": { "type": ["null", "string"] },
"draft_date": { "type": ["null", "string"] },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"proxy_sender_name": { "type": ["null", "string"] },
"has_attachment": { "type": "boolean" },
"unsent_drafts": { "type": "boolean" },
"unread_messages": { "type": "boolean" }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/dependents.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"number_of_records": {
"type": "string"
},
"return_code": {
"type": "string"
},
"return_message": {
"type": "string"
},
"persons": {
"description": "a list of dependents associated with the veteran",
"items": {
"properties": {
"award_indicator": {
"type": "string"
},
"city_of_birth": {
"type": "string"
},
"current_relate_status": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"date_of_death": {
"type": "string"
},
"death_reason": {
"type": "string"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"gender": {
"type": "string"
},
"last_name": {
"type": "string"
},
"middle_name": {
"type": "string"
},
"proof_of_dependency": {
"type": "string"
},
"ptcpnt_id": {
"type": "string"
},
"related_to_vet": {
"type": "string"
},
"relationship": {
"type": "string"
},
"ssn": {
"type": "string"
},
"ssn_verify_status": {
"type": "string"
},
"state_of_birth": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/address_international.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": ["address_one", "type", "city", "country_name"],
"properties": {
"address_effective_date": {
"type": "string"
},
"address_one": {
"type": "string"
},
"address_three": {
"type": "string"
},
"address_two": {
"type": "string"
},
"type": {
"type": "string"
},
"city": {
"type": "string"
},
"country_name": {
"type": "string"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/email_address_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"email": {
"type": "string"
},
"effective_at": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/message_with_attachment.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "included"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "relationships", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages", "message_drafts"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "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": { "enum": ["attachments"] }
}
}
}
}
}
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
},
"included": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["attachments"] },
"attributes": {
"type": "object",
"required": ["message_id", "name", "attachment_size"],
"properties": {
"message_id": { "type": "integer" },
"name": { "type": "string" },
"attachment_size": { "type": "integer" }
}
},
"links": {
"type": "object",
"required": ["download"],
"properties": {
"download": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letter_beneficiary_benefit_information_veteran.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"monthly_award_amount": {
"type": "number",
"not": {
"type": "integer"
}
},
"award_effective_date": {
"type": "string"
},
"has_chapter35_eligibility": {
"type": "boolean"
},
"has_service_connected_disabilities": {
"type": "boolean"
},
"has_non_service_connected_pension": {
"type": "boolean"
},
"has_individual_unemployability_granted": {
"type": "boolean"
},
"has_special_monthly_compensation": {
"type": "boolean"
},
"has_adapted_housing": {
"type": "boolean"
},
"service_connected_percentage": {
"type": "integer"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/contestable_issues.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": ["type", "attributes"],
"properties": {
"type": {
"type": "string",
"enum": [
"contestableIssue"
]
},
"id": {
"type": ["string", "null"]
},
"attributes": {
"type": "object",
"required": [
"rating_issue_reference_id",
"rating_issue_profile_date",
"rating_issue_diagnostic_code",
"rating_decision_reference_id",
"decision_issue_id",
"approx_decision_date",
"description",
"ramp_claim_id",
"title_of_active_review",
"source_review_type",
"timely",
"latest_issues_in_chain",
"is_rating"
],
"properties": {
"rating_issue_reference_id": {
"type": ["string", "null"]
},
"rating_issue_profile_date": {
"type": ["string", "null"]
},
"rating_issue_diagnostic_code": {
"type": ["string", "null"]
},
"rating_decision_reference_id": {
"type": ["string", "null"]
},
"decision_issue_id": {
"type": ["integer", "null"]
},
"approx_decision_date": {
"type": ["string", "null"]
},
"description": {
"type": ["string", "null"]
},
"ramp_claim_id": {
"type": ["string", "null"]
},
"title_of_active_review": {
"type": ["string", "null"]
},
"source_review_type": {
"type": ["string", "null"]
},
"timely": {
"type": "boolean"
},
"latest_issues_in_chain": {
"type": "array",
"items": {
"type": "object",
"required": ["id", "approx_decision_date"],
"properties": {
"id": {
"type": ["string", "null"]
},
"approx_decision_date": {
"type": ["string", "null"]
}
}
}
},
"rating_issue_subject_text": {
"type": ["string", "null"]
},
"rating_issue_percent_number": {
"type": ["string", "null"]
},
"is_rating": {
"type": "boolean"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/evss_claims_service.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["evss_claims"] },
"attributes": {
"type": "object",
"required": [
"evss_id",
"date_filed",
"min_est_date",
"max_est_date",
"open",
"waiver_submitted",
"requested_decision",
"phase_change_date",
"documents_needed",
"development_letter_sent",
"decision_letter_sent",
"phase",
"ever_phase_back",
"current_phase_back",
"claim_type"
],
"properties": {
"evss_id": { "type": "integer" },
"date_filed": { "type": "string" },
"min_est_date": { "type": ["string", "null"] },
"max_est_date": { "type": ["string", "null"] },
"phase_change_date": { "type": ["string", "null"] },
"open": { "type": "boolean" },
"waiver_submitted": { "type": "boolean" },
"requested_decision": { "type": "boolean" },
"documents_needed": { "type": "boolean" },
"development_letter_sent": { "type": "boolean" },
"decision_letter_sent" : { "type": "boolean" },
"phase": { "type": ["integer", "null"] },
"ever_phase_back": { "type": "boolean" },
"current_phase_back": { "type": "boolean" },
"claim_type": { "type": ["string", "null"] }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/all_triage_teams.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["all_triage_teams"] },
"attributes": {
"type": "object",
"$ref": "all_triage_team.json"
}
}
}
},
"meta": {
"type": "object",
"required": ["sort"],
"properties": {
"associated_triage_groups": {
"type": "integer"
},
"friendly_triage_team_pilot_facilities": {
"type": "string"
},
"associated_blocked_triage_groups": {
"type": "integer"
},
"sort": {
"type": "object"
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/user_loa1.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"services",
"profile",
"in_progress_forms"
],
"properties": {
"in_progress_forms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"form_id": {
"type": "string"
},
"last_updated": {
"type": "integer"
}
}
}
},
"prefills_available": {
"type": [
"array",
null
]
},
"session": {
"type": "object",
"required": [
"auth_broker",
"ssoe",
"transactionid"
],
"properties": {
"auth_broker": {
"type": "string"
},
"ssoe": {
"type": "boolean"
},
"transactionid": {
"type": [
"string",
null
]
}
}
},
"services": {
"type": [
"array",
null
]
},
"user_account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": [
"string",
null
]
}
}
},
"profile": {
"type": "object",
"required": [
"email",
"first_name",
"middle_name",
"last_name",
"preferred_name",
"birth_date",
"gender",
"zip",
"last_signed_in",
"initial_sign_in",
"loa",
"multifactor",
"verified",
"sign_in",
"authn_context",
"icn",
"birls_id",
"edipi",
"sec_id",
"npi_id",
"logingov_uuid",
"idme_uuid",
"id_theft_flag"
],
"properties": {
"email": {
"type": "string"
},
"first_name": {
"type": [
"string",
null
]
},
"middle_name": {
"type": [
"string",
null
]
},
"last_name": {
"type": [
"string",
null
]
},
"preferred_name": {
"type": [
"string",
null
]
},
"birth_date": {
"type": [
"string",
null
]
},
"gender": {
"type": [
"string",
null
]
},
"zip": {
"type": [
"string",
null
]
},
"last_signed_in": {
"type": [
"string",
null
]
},
"initial_sign_in": {
"type": [
"string",
null
]
},
"loa": {
"type": "object",
"required": [
"current",
"highest"
],
"properties": {
"current": {
"type": "integer"
},
"highest": {
"type": "integer"
}
}
},
"multifactor": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"sign_in": {
"type": "object",
"properties": {
"service_name": {
"type": "string"
},
"auth_broker": {
"type": "string"
},
"client_id": {
"type": "string"
}
}
},
"authn_context": {
"type": "string"
},
"icn": {
"type": "string"
},
"birls_id": {
"type": [
"string",
null
]
},
"edipi": {
"type": [
"string",
null
]
},
"sec_id": {
"type": [
"string",
null
]
},
"npi_id": {
"type": ["string", "null"]
},
"logingov_uuid": {
"type": [
"string",
null
]
},
"idme_uuid": {
"type": [
"string",
null
]
},
"id_theft_flag": {
"type": [
"boolean",
null
]
},
"claims": {
"type": "object",
"properties": {
"coe": {
"type": "boolean"
},
"communication_preferences": {
"type": "boolean"
},
"connected_apps": {
"type": "boolean"
},
"military_history": {
"type": "boolean"
},
"payment_history": {
"type": "boolean"
},
"personal_information": {
"type": "boolean"
},
"rating_info": {
"type": "boolean"
},
"appeals": {
"type": "boolean"
},
"medical_copays": {
"type": "boolean"
},
"form526_required_identifier_presence": {
"type": "object",
"properties": {
"participant_id": {
"type": "boolean"
},
"birls_id": {
"type": "boolean"
},
"ssn": {
"type": "boolean"
},
"birth_date": {
"type": "boolean"
},
"edipi": {
"type": "boolean"
}
},
"required": [
"participant_id",
"birls_id",
"ssn",
"birth_date",
"edipi"
]
}
}
}
}
},
"va_profile": {
"type": [
"object",
"null"
]
},
"veteran_status": {
"type": [
"object",
"null"
],
"required": [
"status"
],
"oneOf": [
{
"properties": {
"status": {
"type": [
"string"
]
}
}
},
{
"properties": {
"is_veteran": {
"type": "boolean"
},
"served_in_military": {
"type": "boolean"
},
"status": {
"type": "string"
}
}
}
]
},
"vet360_contact_information": {
"type": [
"object",
"null"
]
},
"onboarding": {
"show": {
"type": [
"boolean",
"null"
]
}
}
}
}
}
},
"meta": {
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"description": "Array of the potential external service error details",
"type": "array",
"items": {
"type": "object",
"properties": {
"external_service": {
"type": "string"
},
"start_time": {
"type": "string"
},
"end_time": {
"type": [
"string",
null
]
},
"description": {
"type": "string"
},
"status": {
"type": "integer"
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/tracking.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["trackings"] },
"attributes": { "type": "object",
"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" }
}
},
"links": {
"type": "object",
"required": ["self", "prescription", "tracking_url"],
"properties": {
"self": { "type": "string" },
"prescription": { "type": "string" },
"tracking_url": { "type": "string" }
}
}
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list"],
"properties": {
"updated_at": { },
"failed_station_list": { }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/eligible_data_classes.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["eligible_data_classes"] },
"attributes": {
"type": "object",
"required": ["data_classes"],
"properties": {
"data_classes": {
"type": "array",
"items": { "type": "string" },
"minItems": 1
}
}
}
}
},
"meta": {
"type": "object",
"required": ["updated_at", "failed_station_list"],
"properties": {
"updated_at": { "type": ["string", null] },
"failed_station_list": { "type": ["string", null] }
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/control_information.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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"
}
},
"required": [
"can_update"
],
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letter_base.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"letter_type",
"name"
],
"properties": {
"name": {
"description": "Display name for the letter",
"type": "string"
},
"letter_type": {
"description": "Letter type used to pass as an argument to the letter download endpoint",
"enum": [
"commissary",
"proof_of_service",
"medicare_partd",
"minimum_essential_coverage",
"service_verification",
"civil_service",
"benefit_summary",
"benefit_verification",
"certificate_of_eligibility"
]
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letters.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"letters": {
"description": "Array of letters available for the user to download",
"items": {
"$ref": "letter_base.json"
},
"type": "array"
},
"full_name": {
"type": "string"
}
},
"type": "object",
"required": ["letters", "full_name"]
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": ["object", "null"]
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/appeals.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"appealIds": {
"type": "array"
},
"updated": {
"type": "string"
},
"active": {
"type": "boolean"
},
"incompleteHistory": {
"type": "boolean"
},
"aoj": {
"type": {
"enum": [
"vba",
"vha",
"nca",
"other"
]
}
},
"programArea": {
"type": {
"enum": [
"compensation",
"pension",
"insurance",
"loan_guaranty",
"education",
"vre",
"medical",
"burial",
"bva",
"other",
"multiple"
]
}
},
"description": {
"type": "string"
},
"type": {
"type": {
"enum": [
"original",
"post_remand",
"post_cavc_remand",
"reconsideration",
"cue"
]
}
},
"aod": {
"type": "boolean"
},
"location": {
"type": {
"enum": [
"aoj",
"bva"
]
}
},
"status": {
"type": "object",
"properties": {
"details": {
"type": "object"
},
"type": {
"type": {
"enum": [
"scheduled_hearing",
"pending_hearing_scheduling",
"on_docket",
"pending_certification_ssoc",
"pending_certification",
"pending_form9",
"pending_soc",
"stayed",
"at_vso",
"bva_development",
"decision_in_progress",
"bva_decision",
"field_grant",
"withdrawn",
"ftr",
"ramp",
"death",
"reconsideration",
"other_close",
"remand_ssoc",
"remand",
"merged"
]
}
}
}
},
"docket": {
"type": ["object", "null" ],
"properties": {
"month": {
"type": "string"
},
"docketMonth": {
"type": "string"
},
"front": {
"type": "boolean"
},
"total": {
"type": "integer"
},
"ahead": {
"type": "integer"
},
"ready": {
"type": "integer"
},
"eta": {
"type": ["string", "null"]
}
}
},
"issues": {
"type": "array",
"items": {
"$ref": "appeals_issue.json"
}
},
"alerts": {
"type": "array",
"items": {
"$ref": "appeals_alert.json"
}
},
"events": {
"type": "array",
"items": {
"$ref": "appeals_event.json"
}
},
"evidence": {
"type": "array",
"items": {
"$ref": "appeals_evidence.json"
}
}
}
}
}
}
}
},
"required": [
"data"
]
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/triage_team.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"triage_team_id",
"name",
"relation_type",
"preferred_team"
],
"properties": {
"triage_team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"relation_type": {
"type": "string"
},
"preferred_team": {
"type": "boolean"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letter.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"$ref": "letter_base.json"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/letter_beneficiary.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"benefit_information": {
"oneOf": [
{
"$ref": "letter_beneficiary_benefit_information_dependent.json"
},
{
"$ref": "letter_beneficiary_benefit_information_veteran.json"
}
]
},
"military_service": {
"items": {
"properties": {
"branch": {
"type": "string"
},
"character_of_service": {
"enum": [
"HONORABLE",
"OTHER_THAN_HONORABLE",
"UNDER_HONORABLE_CONDITIONS",
"GENERAL",
"UNCHARACTERIZED",
"UNCHARACTERIZED_ENTRY_LEVEL",
"DISHONORABLE"
]
},
"entered_date": {
"type": "string"
},
"released_date": {
"type": "string"
}
},
"required": [
"entered_date",
"released_date",
"branch",
"character_of_service"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"benefit_information",
"military_service"
],
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"attributes",
"type",
"id"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/evss_errors.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": "string"
},
"meta": {
"properties": {
"messages": {
"items": {
"properties": {
"key": {
"type": "string"
},
"severity": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"text",
"severity",
"key"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"messages"
],
"type": "object"
},
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"status",
"code",
"title",
"detail"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/folder_search.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/address_domestic.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": ["address_one", "type", "city", "state_code", "zip_code"],
"properties": {
"address_effective_date": {
"type": "string"
},
"address_one": {
"type": "string"
},
"address_three": {
"type": "string"
},
"address_two": {
"type": "string"
},
"type": {
"type": "string"
},
"city": {
"type": "string"
},
"country_name": {
"type": "string"
},
"state_code": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"zip_suffix": {
"type": "string"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/mdot_accepted.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "",
"type": "object",
"required": ["status", "order_id"],
"properties": {
"status": {
"type": "string"
},
"order_id": {
"type": "string"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/phone_number_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"number": {
"type": "string"
},
"extension": {
"type": "string"
},
"country_code": {
"type": "string"
},
"effective_date": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/preferences.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"data": {
"properties": {
"attributes": {
"preferences": {
"description": "Array of Preference and PreferenceChoice pairings",
"items": {
"properties": {
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"preferences": {
"description": "Array of PreferenceChoice codes the user selected",
"items": {
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/prescription_base.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "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": "string" },
"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" },
"pharmacy_phone_number": { "type": ["string", "null"] }
}
},
"links": {
"oneOf": [
{
"type": "object",
"required": ["self", "tracking"],
"properties": {
"self": { "type": "string" },
"tracking": { "type": "string" }
}
},
{
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/preference.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"preference_choices": {
"description": "Array of PreferenceChoice codes the user selected",
"items": {
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/message.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "relationships", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages", "message_drafts"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "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": { "enum": ["attachments"] }
}
}
}
}
}
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/contacts.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"contact_type": {
"type": "string"
},
"given_name": {
"type": [
"string",
"null"
]
},
"middle_name": {
"type": [
"string",
"null"
]
},
"family_name": {
"type": [
"string",
"null"
]
},
"relationship": {
"type": "string"
},
"address_line1": {
"type": [
"string",
"null"
]
},
"address_line2": {
"type": [
"string",
"null"
]
},
"address_line3": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
},
"primary_phone": {
"type": [
"string",
"null"
]
}
},
"required": [
"contact_type",
"given_name",
"middle_name",
"family_name",
"relationship",
"address_line1",
"address_line2",
"address_line3",
"city",
"state",
"zip_code",
"primary_phone"
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"meta": {
"type": "object"
}
},
"required": [
"data"
]
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/address_military.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"address_one", "type", "zip_code", "military_post_office_type_code", "military_state_code"
],
"properties": {
"address_effective_date": {
"type": "string"
},
"address_one": {
"type": "string"
},
"address_three": {
"type": "string"
},
"address_two": {
"type": "string"
},
"type": {
"type": "string"
},
"military_post_office_type_code": {
"type": "string"
},
"military_state_code": {
"type": "string"
},
"zip_code": {
"type": "string"
},
"zip_suffix": {
"type": "string"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/personal_information_response.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"gender": {
"type": "string"
},
"birth_date": {
"type": "string"
},
"preferred_name": {
"type": "string"
},
"gender_identity": {
"type": "object",
"description": "Gender Identity",
"properties": {
"code": {
"type": "string",
"description": "Gender Identity Code"
},
"name": {
"type": "string",
"description": "Gender Identity Name"
}
}
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/amendment.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"type"
],
"additionalProperties": false,
"properties": {
"on_campus_hours": {
"type": [
"number",
"null"
]
},
"online_hours": {
"type": [
"number",
"null"
]
},
"yellow_ribbon_amount": {
"type": "number"
},
"type": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"change_effective_date": {
"type": [
"string",
"null"
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support
|
code_files/vets-api-private/spec/support/schemas/higher_level_review.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "included"],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type",
"attributes",
"relationships"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"HigherLevelReview"
]
},
"attributes": {
"type": "object",
"required": [
"status",
"aoj",
"program_area",
"benefit_type",
"description",
"receipt_date",
"informal_conference",
"same_office",
"legacy_opt_in_approved",
"alerts",
"events"
],
"properties": {
"status": {
"type": "string"
},
"aoj": {
"type": ["string", "null"]
},
"program_area": {
"type": "string"
},
"benefit_type": {
"type": {
"enum": [
"compensation",
"pension",
"fiduciary",
"insurance",
"education",
"voc_rehab",
"loan_guaranty",
"vha",
"nca"
]
}
},
"description": {
"type": ["string", "null"]
},
"receipt_date": {
"type": ["string", "null"]
},
"informal_conference": {
"type": ["boolean", "null"]
},
"same_office": {
"type": ["boolean", "null"]
},
"legacy_opt_in_approved": {
"type": ["boolean", "null"]
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"required": ["type", "details"],
"properties": {
"type": {
"enum": ["AmaPostDecision"]
},
"details": {
"type": "object",
"required": [
"decision_date",
"available_options",
"due_date"
],
"properties": {
"decision_date": {
"type": ["string", "null"]
},
"available_options": {
"type": "array",
"items": {
"type": "string"
}
},
"due_date": {
"type": ["string", "null"]
}
}
}
}
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"required": ["type", "date"],
"properties": {
"type": {
"type": "string",
"enum": [
"hlr_request",
"hlr_request_event",
"hlr_decision_event",
"hlr_dta_error_event",
"dta_decision_event",
"hlr_other_close_event"
]
},
"date": {
"type": "string"
}
}
}
}
}
},
"relationships": {
"type": "object",
"required": [
"veteran",
"claimant",
"request_issues",
"decision_issues"
],
"properties": {
"veteran": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["type", "id"],
"properties": {
"type": {
"enum": ["Veteran"]
},
"id": {
"type": ["string", "integer"]
}
}
}
}
},
"claimant": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["type", "id"],
"properties": {
"type": {
"enum": ["Claimant"]
},
"id": {
"type": "string"
}
}
}
}
},
"request_issues": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": ["type", "id"],
"properties": {
"type": {
"enum": ["RequestIssue"]
},
"id": {
"type": ["string", "integer"]
}
}
}
}
}
},
"decision_issues": {
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": ["type", "id"],
"properties": {
"type": {
"enum": ["DecisionIssue"]
},
"id": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"included": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": {
"enum": ["Veteran"]
}
},
"attributes": {
"type": "object",
"required": [
"first_name",
"middle_name",
"last_name",
"name_suffix",
"file_number",
"ssn",
"participant_id"
],
"properties": {
"first_name": {
"type": ["string", "null"]
},
"middle_name": {
"type": ["string", "null"]
},
"last_name": {
"type": ["string", "null"]
},
"name_suffix": {
"type": ["string", "null"]
},
"file_number": {
"type": "string"
},
"ssn": {
"type": ["string", "null"]
},
"participant_id": {
"type": ["string", "null"]
}
}
}
}
},
{
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": {
"enum": ["Claimant"]
}
},
"attributes": {
"type": "object",
"required": [
"first_name",
"middle_name",
"last_name",
"payee_code",
"relationship_type"
],
"properties": {
"first_name": {
"type": ["string", "null"]
},
"middle_name": {
"type": ["string", "null"]
},
"last_name": {
"type": ["string", "null"]
},
"payee_code": {
"type": {
"enum": [
"00", "01", "02", "03", "04",
"05", "06", "07", "08", "09",
"10", "11", "12", "13", "14",
"15", "16", "17", "18", "19",
"20", "21", "22", "23", "24",
"25", "26", "27", "28", "29",
"30", "31", "32", "33", "34",
"35", "36", "37", "38", "39",
"41", "42", "43", "44", "45",
"46", "47", "48", "49", "50",
"60", "70", "71", "72", "73",
"74", "75", "76", "77", "78",
"80", "81", "82", "83", "84",
"85", "86", "87", "88", "89",
"99", null
]
}
},
"relationship_type": {
"type": ["string", "null"]
}
}
}
}
},
{
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": {
"enum": ["DecisionIssue"]
}
},
"attributes": {
"type": "object",
"required": [
"approx_decision_date",
"decision_text",
"description",
"disposition",
"finalized"
],
"properties": {
"approx_decision_date": {
"type": ["string", "null"]
},
"decision_text": {
"type": ["string", "null"]
},
"description": {
"type": "string"
},
"disposition": {
"type": ["string", "null"]
},
"finalized": {
"type": "boolean"
}
}
}
}
},
{
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": {
"enum": ["RequestIssue"]
}
},
"attributes": {
"type": "object",
"required": [
"active",
"status_description",
"diagnostic_code",
"rating_issue_id",
"rating_issue_profile_date",
"rating_decision_id",
"description",
"contention_text",
"approx_decision_date",
"category",
"notes",
"is_unidentified",
"ramp_claim_id",
"legacy_appeal_id",
"legacy_appeal_issue_id",
"decision_review_title",
"decision_issue_id",
"withdrawal_date",
"contested_issue_description",
"end_product_cleared",
"end_product_code",
"ineligible"
],
"properties": {
"active": {
"type": "boolean"
},
"status_description": {
"type": "string"
},
"diagnostic_code": {
"type": ["string", "null"]
},
"rating_issue_id": {
"type": ["string", "null"]
},
"rating_issue_profile_date": {
"type": ["string", "null"]
},
"rating_decision_id": {
"type": ["string", "null"]
},
"description": {
"type": ["string", "null"]
},
"contention_text": {
"type": "string"
},
"approx_decision_date": {
"type": "string"
},
"category": {
"type": ["string", "null"]
},
"notes": {
"type": ["string", "null"]
},
"is_unidentified": {
"type": ["boolean", "null"]
},
"ramp_claim_id": {
"type": ["string", "null"]
},
"legacy_appeal_id": {
"type": ["string", "null"]
},
"legacy_appeal_issue_id": {
"type": ["integer", "null"]
},
"decision_review_title": {
"type": ["string", "null"]
},
"decision_issue_id": {
"type": ["integer", "null"]
},
"withdrawal_date": {
"type": ["string", "null"]
},
"contested_issue_description": {
"type": ["string", "null"]
},
"end_product_cleared": {
"type": ["boolean", "null"]
},
"end_product_code": {
"type": "string"
},
"ineligible": {
"type": ["object", "null"],
"required": [
"due_to_id",
"reason",
"title_of_active_review"
],
"properties": {
"due_to_id": {
"type": "integer"
},
"reason": {
"type": "string"
},
"title_of_active_review": {
"type": "string"
}
}
}
}
}
}
}
]
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vre/ch31_case_details.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": ["object", "null"],
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"required": ["res_case_id", "is_transfered_to_cwnrs", "external_status"],
"properties": {
"res_case_id": { "type": ["integer", "null"] },
"is_transfered_to_cwnrs": { "type": ["boolean", "null"] },
"external_status": {
"type": ["object", "null"],
"properties": {
"is_discontinued": { "type": ["boolean", "null"] },
"discontinued_reason": { "type": ["string", "null"] },
"state_list": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"step_code": { "type": ["string", "null"] },
"status": { "type": ["string", "null"] }
}
}
}
}
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/vre/ch31_eligibility_status.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": ["object", "null"],
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"required": ["veteran_profile"],
"properties": {
"veteran_profile": {
"type": "object",
"required": ["first_name", "last_name", "dob", "character_of_discharge", "service_period"],
"properties": {
"first_name": { "type": ["string", "null"] },
"last_name": { "type": ["string", "null"] },
"dob": { "type": ["string", "null"] },
"character_of_discharge": { "type": ["string", "null"] },
"service_period": {
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"required": ["service_began_date", "service_end_date", "character_of_discharge"],
"properties": {
"service_began_date": { "type": ["string", "null"] },
"service_end_date": { "type": ["string", "null"] },
"character_of_discharge": { "type": ["string", "null"] }
}
}
}
}
},
"disability_rating": {
"type": "object",
"properties": {
"combined_scd": { "type": ["integer", "null"] },
"scd_details": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"code": { "type": ["string", "null"] },
"name": { "type": ["string", "null"] },
"percentage": { "type": ["string", "null"] }
}
}
}
}
},
"irnd_date": { "type": ["string", "null"] },
"eligibility_termination_date": { "type": ["string", "null"] },
"entitlement_details": {
"type": "object",
"properties": {
"max_ch31_entitlement": {
"type": "object",
"properties": {
"month": { "type": ["integer", "null"] },
"days": { "type": ["integer", "null"] }
}
},
"ch31_entitlement_remaining": {
"type": "object",
"properties": {
"month": { "type": ["integer", "null"] },
"days": { "type": ["integer", "null"] }
}
},
"entitlement_used": {
"type": "object",
"properties": {
"month": { "type": ["integer", "null"] },
"days": { "type": ["integer", "null"] }
}
}
}
},
"res_case_id": { "type": ["integer", "null"] },
"res_eligibility_recommendation": { "type": ["string", "null"] },
"qualifying_military_service_status": { "type": ["string", "null"] },
"character_of_discharge_status": { "type": ["string", "null"] },
"disability_rating_status": { "type": ["string", "null"] },
"irnd_status": { "type": ["string", "null"] },
"eligibility_termination_date_status": { "type": ["string", "null"] }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/institution_children.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"count": {
"type" : "integer"
},
"version": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
}
},
"required": ["version"]
},
"data": {
"type": "array",
"items": {
"type": "object",
"maxItems": 10,
"additionalProperties": false,
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"properties": {
"name": { "type": "string" },
"facility_code": { "type": "string" },
"type": {
"type": "string",
"enum": [
"OJT",
"PRIVATE",
"FOREIGN",
"CORRESPONDENCE",
"FLIGHT",
"FOR PROFIT",
"PUBLIC"
]
},
"address_1": { "type": ["null", "string"] },
"address_2": { "type": ["null", "string"] },
"address_3": { "type": ["null", "string"] },
"physical_city": { "type": ["null", "string"] },
"physical_state": { "type": ["null", "string"] },
"physical_country": { "type": ["null", "string"] },
"physical_zip": { "type": ["null", "string"] },
"online_only": { "type": ["null", "boolean"] },
"closure109": { "type": ["null", "boolean"] },
"preferred_provider": { "type": ["null", "boolean"] },
"distance_learning": { "type": ["null", "boolean"] },
"dod_bah": { "type": ["null", "integer"] },
"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"] },
"school_closing": { "type": ["null", "boolean"] },
"stem_offered": { "type": ["null", "boolean"] },
"independent_study": { "type": ["null", "boolean"] },
"priority_enrollment": { "type": ["null", "boolean"] },
"vet_tec_provider": { "type": "boolean" },
"parent_facility_code_id": { "type": ["null", "string"] },
"campus_type": { "type": ["null", "string"] }
},
"required": [
"name",
"facility_code",
"type",
"city",
"state",
"zip",
"country",
"locale_type",
"highest_degree",
"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",
"school_closing",
"stem_offered",
"independent_study",
"priority_enrollment",
"vet_tec_provider",
"parent_facility_code_id",
"campus_type"
]
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" }
},
"required": ["self"]
}
},
"required": ["id", "type", "attributes", "links"]
}
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" },
"first": { "type": "string" },
"prev": { "type": ["null", "string"] },
"next": { "type": ["null", "string"] },
"last": { "type": "string" }
},
"required": ["self", "first", "prev", "next", "last"]
}
},
"required": ["meta", "data", "links"]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/autocomplete.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"version": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
},
"term": { "type": "string" }
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": { "type": "integer" },
"value": { "type": "string" },
"label": { "type": "string" }
}
}
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" }
}
}
},
"required": [
"meta",
"data",
"links"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/zipcode_rate.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["zipcode_rates"] },
"attributes": {
"type": "object",
"required": [
"zip_code",
"mha_code",
"mha_name",
"mha_rate",
"mha_rate_grandfathered"],
"properties": {
"zip_code": { "type": "string" },
"mha_code": { "type": ["string", "null"] },
"mha_name": { "type": ["string", "null"] },
"mha_rate": { "type": ["number", "null"] },
"mha_rate_grandfathered": { "type": ["number", "null"] }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/institution_programs.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"count": {
"type" : "integer"
},
"facets": {
"type": "object"
},
"version": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
}
},
"required": ["version"]
},
"data": {
"type": "array",
"items": {
"type": "object",
"maxItems": 10,
"additionalProperties": false,
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"properties": {
"program_type": { "type": ["null", "string"] },
"description": { "type": "string" },
"length_in_hours": { "type": ["null", "string"] },
"length_in_weeks": { "type": ["null", "integer"] },
"facility_code": { "type": "string" },
"institution_name": { "type": ["string"] },
"institution_city": { "type": ["null", "string"] },
"institution_state": { "type": ["null", "string"] },
"institution_country": { "type": ["null", "string"] },
"preferred_provider": { "type": ["null", "boolean"] },
"tuition_amount": { "type": ["null", "integer"] },
"va_bah": { "type": ["null", "number"] },
"dod_bah": { "type": ["null", "integer"] }
},
"required": [
"description",
"institution_name",
"facility_code"
]
},
"links": {
"type": "object",
"properties": {
"website": { "type": ["null", "string"] },
"scorecard": { "type": ["null", "string"] },
"self": { "type": "string" }
},
"required": ["self"]
}
},
"required": ["id", "type", "attributes"]
}
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" },
"first": { "type": "string" },
"prev": { "type": ["null", "string"] },
"next": { "type": ["null", "string"] },
"last": { "type": "string" }
},
"required": ["self", "first", "prev", "next", "last"]
}
},
"required": ["meta", "data", "links"]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/institutions.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"count": {
"type" : "integer"
},
"facets": {
"type": "object"
},
"version": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
}
},
"required": ["version"]
},
"data": {
"type": "array",
"items": {
"type": "object",
"maxItems": 10,
"additionalProperties": false,
"properties": {
"id": { "type": "string" },
"type": { "type": "string" },
"attributes": {
"type": "object",
"properties": {
"name": { "type": "string" },
"facility_code": { "type": "string" },
"type": {
"type": "string",
"enum": [
"OJT",
"PRIVATE",
"FOREIGN",
"CORRESPONDENCE",
"FLIGHT",
"FOR PROFIT",
"PUBLIC"
]
},
"address_1": { "type": ["null", "string"] },
"address_2": { "type": ["null", "string"] },
"address_3": { "type": ["null", "string"] },
"physical_city": { "type": ["null", "string"] },
"physical_state": { "type": ["null", "string"] },
"physical_country": { "type": ["null", "string"] },
"physical_zip": { "type": ["null", "string"] },
"online_only": { "type": ["null", "boolean"] },
"closure109": { "type": ["null", "boolean"] },
"preferred_provider": { "type": ["null", "boolean"] },
"distance_learning": { "type": ["null", "boolean"] },
"dod_bah": { "type": ["null", "integer"] },
"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"] },
"school_closing": { "type": ["null", "boolean"] },
"stem_offered": { "type": ["null", "boolean"] },
"independent_study": { "type": ["null", "boolean"] },
"priority_enrollment": { "type": ["null", "boolean"] },
"vet_tec_provider": { "type": "boolean" },
"parent_facility_code_id": { "type": ["null", "string"] },
"campus_type": { "type": ["null", "string"] }
},
"required": [
"name",
"facility_code",
"type",
"city",
"state",
"zip",
"country",
"locale_type",
"highest_degree",
"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",
"school_closing",
"stem_offered",
"independent_study",
"priority_enrollment",
"vet_tec_provider",
"parent_facility_code_id",
"campus_type"
]
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" }
},
"required": ["self"]
}
},
"required": ["id", "type", "attributes", "links"]
}
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" },
"first": { "type": "string" },
"prev": { "type": ["null", "string"] },
"next": { "type": ["null", "string"] },
"last": { "type": "string" }
},
"required": ["self", "first", "prev", "next", "last"]
}
},
"required": ["meta", "data", "links"]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/calculator_constants.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": ["null", "number", "string"]
}
},
"required": [
"name",
"value"
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"required": [
"self"
]
},
"meta": {
"type": "object",
"properties": {
"version": {
"type": "null"
}
},
"required": [
"version"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas
|
code_files/vets-api-private/spec/support/schemas/gi/institution.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"version": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"created_at": {
"type": "string"
},
"preview": {
"type": "boolean"
}
}
}
},
"required": [
"version"
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"facility_code": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"OJT",
"PRIVATE",
"FOREIGN",
"CORRESPONDENCE",
"FLIGHT",
"FOR PROFIT",
"PUBLIC"
]
},
"address_1": {
"type": [
"null",
"string"
]
},
"address_2": {
"type": [
"null",
"string"
]
},
"address_3": {
"type": [
"null",
"string"
]
},
"city": {
"type": [
"null",
"string"
]
},
"physical_address_1": {
"type": [
"null",
"string"
]
},
"physical_address_2": {
"type": [
"null",
"string"
]
},
"physical_address_3": {
"type": [
"null",
"string"
]
},
"physical_city": {
"type": [
"null",
"string"
]
},
"physical_state": {
"type": [
"null",
"string"
]
},
"physical_country": {
"type": [
"null",
"string"
]
},
"physical_zip": {
"type": [
"null",
"string"
]
},
"online_only": {
"type": [
"null",
"boolean"
]
},
"distance_learning": {
"type": [
"null",
"boolean"
]
},
"dod_bah": {
"type": [
"null",
"number"
]
},
"state": {
"type": [
"null",
"string"
]
},
"zip": {
"type": [
"null",
"string"
]
},
"country": {
"type": [
"null",
"string"
]
},
"flight": {
"type": [
"null",
"boolean"
]
},
"correspondence": {
"type": [
"null",
"boolean"
]
},
"bah": {
"type": [
"null",
"number"
]
},
"cross": {
"type": [
"null",
"string"
]
},
"ope": {
"type": [
"null",
"string"
]
},
"ope6": {
"type": [
"null",
"string"
]
},
"school_system_name": {
"type": [
"null",
"string"
]
},
"school_system_code": {
"type": [
"null",
"number"
]
},
"alias": {
"type": [
"null",
"string"
]
},
"highest_degree": {
"type": [
"null",
"integer"
]
},
"locale_type": {
"type": [
"null",
"string"
]
},
"student_count": {
"type": [
"null",
"integer"
]
},
"undergrad_enrollment": {
"type": [
"null",
"integer"
]
},
"yr": {
"type": [
"null",
"boolean"
]
},
"student_veteran": {
"type": [
"null",
"boolean"
]
},
"student_veteran_link": {
"type": [
"null",
"string"
]
},
"poe": {
"type": [
"null",
"boolean"
]
},
"eight_keys": {
"type": [
"null",
"boolean"
]
},
"stem_offered": {
"type": [
"null",
"boolean"
]
},
"independent_study": {
"type": [
"null",
"boolean"
]
},
"priority_enrollment": {
"type": [
"null",
"boolean"
]
},
"dodmou": {
"type": [
"null",
"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"
]
},
"tuition_in_state": {
"type": [
"null",
"number"
]
},
"tuition_out_of_state": {
"type": [
"null",
"number"
]
},
"books": {
"type": [
"null",
"number"
]
},
"online_all": {
"type": [
"null",
"boolean"
]
},
"p911_tuition_fees": {
"type": [
"null",
"number"
]
},
"p911_recipients": {
"type": [
"null",
"integer"
]
},
"p911_yellow_ribbon": {
"type": [
"null",
"number"
]
},
"p911_yr_recipients": {
"type": [
"null",
"integer"
]
},
"accredited": {
"type": [
"null",
"boolean"
]
},
"accreditation_type": {
"type": [
"null",
"string"
]
},
"accreditation_status": {
"type": [
"null",
"string"
]
},
"caution_flag": {
"type": [
"null",
"boolean"
]
},
"caution_flag_reason": {
"type": [
"null",
"string"
]
},
"school_closing": {
"type": [
"null",
"boolean"
]
},
"school_closing_on": {
"type": [
"null",
"string"
]
},
"school_closing_message": {
"type": [
"null",
"string"
]
},
"vet_tec_provider": {
"type": "boolean"
},
"preferred_provider": {
"type": "boolean"
},
"stem_indicator": {
"type": "boolean"
},
"parent_facility_code_id": {
"type": [
"null",
"string"
]
},
"campus_type": {
"type": [
"null",
"string"
]
},
"complaints": {
"type": "object",
"properties": {
"facility_code": {
"type": [
"null",
"integer"
]
},
"financial_by_fac_code": {
"type": [
"null",
"integer"
]
},
"quality_by_fac_code": {
"type": [
"null",
"integer"
]
},
"refund_by_fac_code": {
"type": [
"null",
"integer"
]
},
"marketing_by_fac_code": {
"type": [
"null",
"integer"
]
},
"accreditation_by_fac_code": {
"type": [
"null",
"integer"
]
},
"degree_requirements_by_fac_code": {
"type": [
"null",
"integer"
]
},
"student_loans_by_fac_code": {
"type": [
"null",
"integer"
]
},
"grades_by_fac_code": {
"type": [
"null",
"integer"
]
},
"credit_transfer_by_fac_code": {
"type": [
"null",
"integer"
]
},
"credit_job_by_fac_code": {
"type": [
"null",
"integer"
]
},
"job_by_fac_code": {
"type": [
"null",
"integer"
]
},
"transcript_by_fac_code": {
"type": [
"null",
"integer"
]
},
"other_by_fac_code": {
"type": [
"null",
"integer"
]
},
"main_campus_roll_up": {
"type": [
"null",
"integer"
]
},
"financial_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"quality_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"refund_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"marketing_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"accreditation_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"degree_requirements_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"student_loans_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"grades_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"credit_transfer_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"jobs_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"transcript_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
},
"other_by_ope_id_do_not_sum": {
"type": [
"null",
"integer"
]
}
},
"required": [
"facility_code",
"financial_by_fac_code",
"quality_by_fac_code",
"refund_by_fac_code",
"marketing_by_fac_code",
"accreditation_by_fac_code",
"degree_requirements_by_fac_code",
"student_loans_by_fac_code",
"grades_by_fac_code",
"credit_transfer_by_fac_code",
"credit_job_by_fac_code",
"job_by_fac_code",
"transcript_by_fac_code",
"other_by_fac_code",
"main_campus_roll_up",
"financial_by_ope_id_do_not_sum",
"quality_by_ope_id_do_not_sum",
"refund_by_ope_id_do_not_sum",
"marketing_by_ope_id_do_not_sum",
"accreditation_by_ope_id_do_not_sum",
"degree_requirements_by_ope_id_do_not_sum",
"student_loans_by_ope_id_do_not_sum",
"grades_by_ope_id_do_not_sum",
"credit_transfer_by_ope_id_do_not_sum",
"jobs_by_ope_id_do_not_sum",
"transcript_by_ope_id_do_not_sum",
"other_by_ope_id_do_not_sum"
]
},
"yellow_ribbon_programs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division_professional_school": {
"type": [
"null",
"string"
]
},
"number_of_students": {
"type": [
"null",
"integer"
]
},
"degree_level": {
"type": [
"null",
"string"
]
},
"contribution_amount": {
"type": [
"null",
"string"
]
}
},
"required": [
"division_professional_school",
"number_of_students",
"degree_level",
"contribution_amount"
]
}
},
"facility_map": {
"type": "object",
"properties": {
"main": {
"type": "object",
"properties": {
"institution": {
"type": "object"
},
"branches": {
"type": "array",
"items": {
"type": "object"
}
},
"extensions": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"school_certifying_officials": {
"type": ["null","array"],
"items": {
"type": "object"
}
},
"programs": {
"type": ["null","array"],
"items": {
"type": "object"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"facility_code",
"type",
"city",
"state",
"zip",
"country",
"flight",
"correspondence",
"bah",
"cross",
"ope",
"locale_type",
"student_count",
"undergrad_enrollment",
"yr",
"student_veteran",
"student_veteran_link",
"poe",
"eight_keys",
"stem_offered",
"independent_study",
"priority_enrollment",
"dodmou",
"sec_702",
"vet_success_name",
"vet_success_email",
"credit_for_mil_training",
"vet_poc",
"student_vet_grp_ipeds",
"soc_member",
"highest_degree",
"retention_rate_veteran_ba",
"retention_all_students_ba",
"retention_rate_veteran_otb",
"retention_all_students_otb",
"persistance_rate_veteran_ba",
"persistance_rate_veteran_otb",
"graduation_rate_veteran",
"graduation_rate_all_students",
"transfer_out_rate_veteran",
"transfer_out_rate_all_students",
"salary_all_students",
"repayment_rate_all_students",
"avg_stu_loan_debt",
"calendar",
"tuition_in_state",
"tuition_out_of_state",
"books",
"online_all",
"p911_tuition_fees",
"p911_recipients",
"p911_yellow_ribbon",
"p911_yr_recipients",
"accredited",
"accreditation_type",
"accreditation_status",
"caution_flag",
"caution_flag_reason",
"complaints",
"school_closing",
"school_closing_on",
"school_closing_message",
"created_at",
"updated_at",
"vet_tec_provider",
"preferred_provider",
"stem_indicator",
"parent_facility_code_id",
"campus_type"
]
},
"links": {
"type": "object",
"properties": {
"website": {
"type": [
"null",
"string"
]
},
"scorecard": {
"type": [
"null",
"string"
]
},
"vet_website_link": {
"type": [
"null",
"string"
]
},
"self": {
"type": "string"
}
},
"required": [
"self"
]
}
},
"required": [
"id",
"type",
"attributes",
"links"
]
}
},
"required": [
"meta",
"data"
]
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/lac.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lac": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"lac_nm": {
"type": "string"
},
"edu_lac_type_nm": {
"type": "string"
},
"state": {
"type": "string"
},
"tests": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties" : {
"name": {
"type": "string"
},
"fee": {
"type": ["string", "null"]
}
}
}
},
"institution": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "institution.json"
}
]
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/lacs.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lacs": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"lac_nm": {
"type": "string"
},
"edu_lac_type_nm": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/lacs_with_version.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lacs": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"lac_nm": {
"type": "string"
},
"edu_lac_type_nm": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/exams.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"exams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/exams_with_version.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"exams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/institution.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"physical_address": {
"type": "object",
"properties": {
"address_1": {
"type": ["string", "null"]
},
"address_2": {
"type": ["string", "null"]
},
"address_3": {
"type": ["string", "null"]
},
"city": {
"type": ["string", "null"]
},
"state": {
"type": ["string", "null"]
},
"zip": {
"type": ["string", "null"]
},
"country": {
"type": ["string", "null"]
}
}
},
"mailing_address": {
"type": "object",
"properties": {
"address_1": {
"type": ["string", "null"]
},
"address_2": {
"type": ["string", "null"]
},
"address_3": {
"type": ["string", "null"]
},
"city": {
"type": ["string", "null"]
},
"state": {
"type": ["string", "null"]
},
"zip": {
"type": ["string", "null"]
},
"country": {
"type": ["string", "null"]
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/gi
|
code_files/vets-api-private/spec/support/schemas/gi/lcpe/exam.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"exam": {
"type": "object",
"additionalProperties": false,
"properties": {
"enriched_id": {
"type": "string"
},
"name": {
"type": "string"
},
"tests": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties" : {
"name": {
"type": "string"
},
"fee": {
"type": ["string", "null"]
},
"begin_date": {
"type": ["string", "null"]
},
"end_date": {
"type": ["string", "null"]
}
}
}
},
"institution": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "institution.json"
}
]
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/folder.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"oneOf":[{
"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" }
}
},
{
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["folders"] },
"attributes": {
"type": "object",
"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" }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}]
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/triage_teams.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["triage_teams"] },
"attributes": {
"type": "object",
"$ref": "triage_team.json"
}
}
}
},
"meta": {
"type": "object",
"required": ["sort"],
"properties": {
"sort": {
"type": "object"
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/messages_thread.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"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": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/all_triage_team.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"triage_team_id",
"name",
"station_number",
"blocked_status",
"preferred_team",
"relation_type",
"location_name",
"lead_provider_name",
"team_name",
"suggested_name_display",
"health_care_system_name",
"group_type_enum_val",
"sub_group_type_enum_val",
"group_type_patient_display",
"sub_group_type_patient_display",
"oh_triage_group"
],
"properties": {
"triage_team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"station_number": {
"type": "string"
},
"blocked_status": {
"type": "boolean"
},
"preferred_team": {
"type": "boolean"
},
"relation_type": {
"type": "string"
},
"location_name": {
"type": "string"
},
"lead_provider_name": {
"type": "string"
},
"team_name": {
"type": "string"
},
"suggested_name_display": {
"type": "string"
},
"health_care_system_name": {
"type": "string"
},
"group_type_enum_val": {
"type": "string"
},
"sub_group_type_enum_val": {
"type": "string"
},
"group_type_patient_display": {
"type": "string"
},
"sub_group_type_patient_display": {
"type": "string"
},
"oh_triage_group": {
"type": "boolean"
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/messages.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data", "meta"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["messages"] },
"attributes": {
"type": "object",
"required": [
"message_id",
"category",
"subject",
"body",
"attachment",
"sent_date",
"sender_id",
"sender_name",
"recipient_id",
"recipient_name",
"read_receipt",
"suggested_name_display",
"is_oh_message"
],
"properties": {
"message_id": { "type": "integer" },
"category": { "type": "string" },
"subject": { "type": "string" },
"body": { "type": ["null", "string"] },
"attachment": { "type": "boolean" },
"sent_date": { "type": "date-time" },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"recipient_name": { "type": "string" },
"read_receipt": { "type": ["null", "string"] },
"triage_group_name": { "type": ["null", "string"] },
"proxy_sender_name": { "type": ["null", "string"] },
"suggested_name_display": { "type": ["null", "string"] },
"is_oh_message": { "type": "boolean" }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"oneOf": [
{
"type": "object",
"required": ["pagination"],
"properties": {
"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" }
}
}
}
},
{
"type": "object",
"required": ["sort", "pagination"],
"properties": {
"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" }
}
}
}
}
]
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/folders.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["folders"] },
"attributes": {
"type": "object",
"$ref": "folder.json"
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["pagination"],
"properties": {
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/messages_filtered.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type" : "object",
"required": ["data", "meta"],
"properties": {
"data" : {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "object",
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string"},
"type": { "enum": ["messages"] },
"attributes": {
"type": "object",
"$ref": "message.json"
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
},
"links": {
"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" }
}
},
"meta": {
"type": "object",
"required": ["filter", "pagination"],
"properties": {
"filter": {
"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" }
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/message_threads_no_messages.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/category.json
|
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "object",
"required": ["id", "type", "attributes"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["categories"] },
"attributes": {
"type": "object",
"required": ["message_category_type"],
"properties": {
"message_category_type": {
"type": "array",
"items": { "type": "string" },
"minItems": 1,
"uniqueItems": true
}
}
}
}
}
}
}
|
0
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging
|
code_files/vets-api-private/spec/support/schemas/my_health/messaging/v1/message_threads.json
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": ["data"],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"required": ["id", "type", "attributes", "links"],
"properties": {
"id": { "type": "string" },
"type": { "enum": ["message_threads"] },
"attributes": {
"type": "object",
"required": [
"thread_id",
"folder_id",
"message_id",
"thread_page_size",
"message_count",
"category",
"subject",
"triage_group_name",
"sent_date",
"draft_date",
"sender_id",
"sender_name",
"recipient_name",
"recipient_id",
"proxy_sender_name",
"has_attachment",
"unsent_drafts",
"unread_messages",
"is_oh_message",
"suggested_name_display"
],
"properties": {
"thread_id": { "type": "integer" },
"folder_id": { "type": "integer" },
"message_id": { "type": "integer" },
"thread_page_size": { "type": "integer" },
"message_count": { "type": "integer" },
"category": {
"enum": [
"OTHERS",
"COVID",
"APPOINTMENTS",
"MEDICATIONS",
"TEST_RESULT",
"EDUCATION"
]
},
"subject": { "type": "string" },
"triage_group_name": { "type": ["null", "string"] },
"sent_date": { "type": ["null", "string"] },
"draft_date": { "type": ["null", "string"] },
"sender_id": { "type": "integer" },
"sender_name": { "type": "string" },
"recipient_name": { "type": "string" },
"recipient_id": { "type": "integer" },
"proxy_sender_name": { "type": ["null", "string"] },
"has_attachment": { "type": "boolean" },
"unsent_drafts": { "type": "boolean" },
"unread_messages": { "type": "boolean" },
"is_oh_message": { "type": "boolean" },
"suggested_name_display": { "type": ["null", "string"] }
}
},
"links": {
"type": "object",
"required": ["self"],
"properties": {
"self": { "type": "string" }
}
}
}
}
}
}
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.