GovGazette

{'type': 'object', '$defs': {'Identity': {'type': 'object', 'properties': {'npi': {'type': ['string', 'null'], 'description': 'Exact ten-digit National Provider Identifier, when known.'}, 'uei': {'type': ['string', 'null'], 'description': 'Exact 12-character Unique Entity ID, when known.'}, 'cage': {'type': ['string', 'null'], 'description': 'Exact five-character CAGE code, when known.'}, 'name': {'type': ['string', 'null'], 'description': 'Person or organization name; name-only matches are possible matches.'}}, 'additionalProperties': False}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['identities'], 'properties': {'generation': {'type': ['string', 'null'], 'description': 'Retained snapshot UUID; omit for the current snapshot.'}, 'identities': {'type': 'array', 'items': {'$ref': '#/$defs/Identity'}, 'description': 'One to twenty identities to compare with the dated SAM snapshot.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'Identity': {'type': 'object', 'properties': {'npi': {'type': ['string', 'null'], 'description': 'Exact ten-digit National Provider Identifier, when known.'}, 'uei': {'type': ['string', 'null'], 'description': 'Exact 12-character Unique Entity ID, when known.'}, 'cage': {'type': ['string', 'null'], 'description': 'Exact five-character CAGE code, when known.'}, 'name': {'type': ['string', 'null'], 'description': 'Person or organization name; name-only matches are possible matches.'}}, 'additionalProperties': False}, 'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'ExclusionMatch': {'type': 'object', 'required': ['identity', 'status', 'records', 'truncated'], 'properties': {'status': {'type': 'string', 'description': 'Distinguishes exact-identifier, possible-name and no-match outcomes.'}, 'records': {'type': 'array', 'items': {'$ref': '#/$defs/JsonObject'}, 'description': 'Candidate exclusion records with match basis; not a clearance decision.'}, 'identity': {'$ref': '#/$defs/Identity'}, 'truncated': {'type': 'boolean'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'results', 'coverage'], 'properties': {'results': {'type': 'array', 'items': {'$ref': '#/$defs/ExclusionMatch'}}, 'coverage': {'$ref': '#/$defs/JsonObject'}, 'generation': {'type': 'string'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['collection', 'id'], 'properties': {'id': {'type': 'string', 'description': 'Stable record ID returned by search.'}, 'collection': {'type': 'string', 'description': 'Public collection name returned by search.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained generation UUID from search for a consistent record snapshot.'}}}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'id', 'title', 'text', 'data'], 'properties': {'id': {'type': 'string'}, 'data': {'$ref': '#/$defs/JsonObject'}, 'text': {'type': 'string'}, 'title': {'type': 'string'}, 'collection': {'type': ['string', 'null'], 'description': 'Absent for curated reference records.'}, 'generation': {'type': 'string'}, 'text_length': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Total text characters; absent from internal brief notices.'}, 'text_has_more': {'type': ['boolean', 'null'], 'description': 'Whether another text chunk is available.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['collection', 'id'], 'properties': {'id': {'type': 'string', 'description': 'Stable ID of a known public record.'}, 'length': {'type': ['integer', 'null'], 'format': 'uint64', 'minimum': 0, 'description': 'Characters to return, up to 16,000.'}, 'offset': {'type': ['integer', 'null'], 'format': 'uint64', 'minimum': 0, 'description': 'Character offset for the next bounded text chunk.'}, 'collection': {'type': 'string', 'description': 'Public record collection returned by search.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained snapshot UUID; omit for the current snapshot.'}}}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'id', 'text', 'offset', 'document_kind'], 'properties': {'id': {'type': 'string'}, 'text': {'type': 'string'}, 'offset': {'type': 'integer', 'format': 'uint64', 'minimum': 0}, 'generation': {'type': 'string'}, 'provenance': {'anyOf': [{'$ref': '#/$defs/JsonObject'}, {'type': 'null'}], 'description': 'Source metadata attached to the retained record.'}, 'next_offset': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0}, 'document_kind': {'type': 'string'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['from_generation'], 'properties': {'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum changes to return, up to the service page limit.'}, 'cursor': {'type': ['string', 'null'], 'description': 'Opaque next_cursor from an earlier change page.'}, 'to_generation': {'type': ['string', 'null'], 'description': 'Newer retained snapshot UUID; omit for the current snapshot.'}, 'from_generation': {'type': 'string', 'description': 'Older retained snapshot UUID to compare.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'ExclusionChange': {'type': 'object', 'required': ['id', 'title', 'change'], 'properties': {'id': {'type': 'string'}, 'title': {'type': 'string'}, 'change': {'type': 'string'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['from_generation', 'to_generation', 'from_coverage', 'to_coverage', 'items', 'meaning'], 'properties': {'items': {'type': 'array', 'items': {'$ref': '#/$defs/ExclusionChange'}}, 'meaning': {'type': 'string'}, 'next_cursor': {'type': ['string', 'null']}, 'to_coverage': {'$ref': '#/$defs/JsonObject'}, 'from_coverage': {'$ref': '#/$defs/JsonObject'}, 'to_generation': {'type': 'string'}, 'from_generation': {'type': 'string'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'Stable exclusion record ID returned by search_exclusions or check_exclusions.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained snapshot UUID; omit for the current snapshot.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'collection', 'id', 'title', 'text', 'data', 'text_length', 'text_has_more', 'coverage', 'business_context'], 'properties': {'id': {'type': 'string'}, 'data': {'$ref': '#/$defs/JsonObject'}, 'text': {'type': 'string'}, 'title': {'type': 'string'}, 'coverage': {'$ref': '#/$defs/JsonObject', 'description': 'Dated SAM source coverage.'}, 'collection': {'type': 'string'}, 'generation': {'type': 'string'}, 'text_length': {'type': 'integer', 'format': 'uint', 'minimum': 0}, 'text_has_more': {'type': 'boolean'}, 'business_context': {'$ref': '#/$defs/JsonObject', 'description': 'Supported vendor and award links, with match basis.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['vendor_id', 'opportunity_id'], 'properties': {'vendor_id': {'type': 'string', 'description': 'Stable vendor ID returned by search.'}, 'opportunity_id': {'type': 'string', 'description': 'Stable opportunity ID returned by search.'}}}

{'type': 'object', '$defs': {'MatchRule': {'type': 'object', 'required': ['rule', 'matched'], 'properties': {'rule': {'type': 'string'}, 'matched': {'type': 'boolean'}, 'vendor_value': {'type': ['string', 'null']}, 'opportunity_value': {'type': ['string', 'null']}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'vendor_id', 'opportunity_id', 'rules', 'interpretation'], 'properties': {'rules': {'type': 'array', 'items': {'$ref': '#/$defs/MatchRule'}}, 'vendor_id': {'type': 'string'}, 'generation': {'type': 'string'}, 'interpretation': {'type': 'string'}, 'opportunity_id': {'type': 'string'}}}

{'type': 'object', 'properties': {}}

{'type': 'object', '$defs': {'SourceCoverage': {'type': 'object', 'required': ['dataset', 'source_url', 'source_date', 'sha256', 'input_rows', 'public_rows'], 'properties': {'sha256': {'type': 'string'}, 'dataset': {'type': 'string'}, 'input_rows': {'type': 'integer', 'format': 'int64'}, 'source_url': {'type': 'string'}, 'public_rows': {'type': 'integer', 'format': 'int64'}, 'source_date': {'type': 'string'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'sources', 'history'], 'properties': {'history': {'type': 'string'}, 'sources': {'type': 'array', 'items': {'$ref': '#/$defs/SourceCoverage'}}, 'generation': {'type': 'string'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'Stable opportunity ID returned by search_opportunities.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained generation UUID from search_opportunities.'}}}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'AwardSummary': {'type': 'object', 'required': ['id', 'title', 'data', 'url'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string'}, 'data': {'$ref': '#/$defs/JsonObject'}, 'title': {'type': 'string'}, 'vendor_url': {'type': ['string', 'null'], 'description': 'Vendor path when an exact recipient UEI is available.'}}}, 'RecordDetail': {'type': 'object', 'required': ['generation', 'id', 'title', 'text', 'data'], 'properties': {'id': {'type': 'string'}, 'data': {'$ref': '#/$defs/JsonObject'}, 'text': {'type': 'string'}, 'title': {'type': 'string'}, 'collection': {'type': ['string', 'null'], 'description': 'Absent for curated reference records.'}, 'generation': {'type': 'string'}, 'text_length': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Total text characters; absent from internal brief notices.'}, 'text_has_more': {'type': ['boolean', 'null'], 'description': 'Whether another text chunk is available.'}}}, 'BriefRequirements': {'type': 'object', 'required': ['text', 'scope'], 'properties': {'text': {'type': 'string'}, 'scope': {'type': 'string'}, 'source': {'anyOf': [{'$ref': '#/$defs/JsonObject'}, {'type': 'null'}], 'description': 'Notice provenance for the retained text.'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'notice', 'linked_awards', 'comparison_awards', 'relationship_basis', 'requirements', 'next_steps'], 'properties': {'notice': {'$ref': '#/$defs/RecordDetail'}, 'generation': {'type': 'string'}, 'next_steps': {'type': 'array', 'items': {'type': 'string'}}, 'requirements': {'$ref': '#/$defs/BriefRequirements'}, 'linked_awards': {'type': 'array', 'items': {'$ref': '#/$defs/AwardSummary'}}, 'comparison_awards': {'type': 'array', 'items': {'$ref': '#/$defs/AwardSummary'}}, 'relationship_basis': {'type': 'string'}}}

{'type': 'object', '$defs': {'MonitorOperation': {'enum': ['list', 'create', 'events', 'delete', 'rotate_feed', 'delete_workspace'], 'type': 'string'}, 'OpportunityQuery': {'type': 'object', 'properties': {'q': {'type': 'string', 'default': '', 'description': 'Plain-language keywords; empty returns notices matching the other filters.'}, 'after': {'type': ['string', 'null'], 'description': 'Last notice ID from next_after in the preceding page.'}, 'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum notices to return, from 1 to 50; defaults to 25.'}, 'naics': {'type': ['string', 'null'], 'description': 'Two- to six-digit NAICS industry code from a notice or the NAICS reference collection.'}, 'state': {'type': ['string', 'null'], 'description': 'State or territory code for the place of performance.'}, 'active': {'type': ['boolean', 'null'], 'description': 'Filter by source active status; this does not mean the response deadline is open.'}, 'agency': {'type': ['string', 'null'], 'description': 'Agency code on the source notice.'}, 'set_aside': {'type': ['string', 'null'], 'description': 'Official set-aside code from a notice or the set-asides reference collection.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained generation UUID from a prior result for a consistent snapshot.'}}, 'additionalProperties': False}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['operation'], 'properties': {'id': {'type': ['string', 'null'], 'description': 'Saved search UUID for events, delete, or rotate_feed.'}, 'name': {'type': ['string', 'null'], 'description': 'Human-readable name for a new saved search; at most 100 characters.'}, 'criteria': {'anyOf': [{'$ref': '#/$defs/OpportunityQuery'}, {'type': 'null'}], 'description': 'Opportunity filters for create; the server chooses the current generation.'}, 'operation': {'$ref': '#/$defs/MonitorOperation', 'description': 'Action to perform: list, create, events, delete, rotate_feed, or delete_workspace.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'id': {'type': ['string', 'null'], 'description': 'Present for create.'}, 'events': {'type': ['array', 'null'], 'items': {'$ref': '#/$defs/JsonObject'}, 'description': 'Present for events.'}, 'status': {'type': ['string', 'null'], 'description': 'Present for create.'}, 'deleted': {'type': ['boolean', 'null'], 'description': 'Present for deletion.'}, 'message': {'type': ['string', 'null'], 'description': 'Present for create.'}, 'watches': {'type': ['array', 'null'], 'items': {'$ref': '#/$defs/JsonObject'}, 'description': 'Present for list; each watch includes status, criteria and event count.'}, 'feed_path': {'type': ['string', 'null'], 'description': 'Present for create or feed rotation.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['collection'], 'properties': {'q': {'type': 'string', 'default': '', 'description': 'Plain-language search terms; empty lists the selected collection.'}, 'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum records to return, from 1 to 50.'}, 'cursor': {'type': ['string', 'null'], 'description': 'Opaque next_cursor from the preceding search page.'}, 'collection': {'type': 'string', 'description': 'Public collection name, such as opportunities, vendors, awards, exclusions, or naics.'}}}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'RecordSummary': {'type': 'object', 'required': ['id', 'title', 'url', 'data'], 'properties': {'id': {'type': 'string', 'description': 'Stable identifier for a record in this generation.'}, 'url': {'type': 'string', 'description': 'Public canonical path for the record.'}, 'data': {'$ref': '#/$defs/JsonObject', 'description': 'Source-specific fields, including provenance and official identifiers.'}, 'title': {'type': 'string', 'description': 'Human-readable record title.'}, 'summary': {'type': ['string', 'null'], 'description': 'Short searchable text, when returned by this operation.'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'collection', 'items'], 'properties': {'items': {'type': 'array', 'items': {'$ref': '#/$defs/RecordSummary'}, 'description': 'Matching public records.'}, 'collection': {'type': 'string', 'description': 'Collection searched, such as opportunities or awards.'}, 'generation': {'type': 'string', 'description': 'UUID of the snapshot used for every result on this page.'}, 'next_cursor': {'type': ['string', 'null'], 'description': 'Opaque cursor for the next page, or null at the end.'}, 'coverage_url': {'type': ['string', 'null'], 'description': 'Public source-date endpoint, when this collection supplies it.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': ['string', 'null'], 'description': 'Name, identifier, or other text to find in active exclusion records.'}, 'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum records to return, up to the service page limit.'}, 'state': {'type': ['string', 'null'], 'description': 'US state name or postal code in the exclusion record.'}, 'agency': {'type': ['string', 'null'], 'description': 'Excluding agency name or code.'}, 'cursor': {'type': ['string', 'null'], 'description': 'Opaque next_cursor from a previous search response.'}, 'country': {'type': ['string', 'null'], 'description': 'Country name or code in the exclusion record.'}, 'program': {'type': ['string', 'null'], 'description': 'Exclusion program name or code.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained snapshot UUID; omit for the current snapshot.'}, 'effective_to': {'type': ['string', 'null'], 'description': 'Include records effective on or before this ISO date.'}, 'classification': {'type': ['string', 'null'], 'description': 'Official SAM exclusion classification code or label.'}, 'effective_from': {'type': ['string', 'null'], 'description': 'Include records effective on or after this ISO date.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'RecordSummary': {'type': 'object', 'required': ['id', 'title', 'url', 'data'], 'properties': {'id': {'type': 'string', 'description': 'Stable identifier for a record in this generation.'}, 'url': {'type': 'string', 'description': 'Public canonical path for the record.'}, 'data': {'$ref': '#/$defs/JsonObject', 'description': 'Source-specific fields, including provenance and official identifiers.'}, 'title': {'type': 'string', 'description': 'Human-readable record title.'}, 'summary': {'type': ['string', 'null'], 'description': 'Short searchable text, when returned by this operation.'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'items', 'coverage'], 'properties': {'items': {'type': 'array', 'items': {'$ref': '#/$defs/RecordSummary'}}, 'coverage': {'$ref': '#/$defs/JsonObject', 'description': 'Dated source coverage, or an unavailable status.'}, 'generation': {'type': 'string'}, 'next_cursor': {'type': ['string', 'null']}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'default': '', 'description': 'Plain-language keywords; empty returns notices matching the other filters.'}, 'after': {'type': ['string', 'null'], 'description': 'Last notice ID from next_after in the preceding page.'}, 'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum notices to return, from 1 to 50; defaults to 25.'}, 'naics': {'type': ['string', 'null'], 'description': 'Two- to six-digit NAICS industry code from a notice or the NAICS reference collection.'}, 'state': {'type': ['string', 'null'], 'description': 'State or territory code for the place of performance.'}, 'active': {'type': ['boolean', 'null'], 'description': 'Filter by source active status; this does not mean the response deadline is open.'}, 'agency': {'type': ['string', 'null'], 'description': 'Agency code on the source notice.'}, 'set_aside': {'type': ['string', 'null'], 'description': 'Official set-aside code from a notice or the set-asides reference collection.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained generation UUID from a prior result for a consistent snapshot.'}}, 'additionalProperties': False}

{'type': 'object', '$defs': {'JsonObject': {'type': 'object', 'description': 'Source-specific JSON map. The envelope is stable; map keys vary by official source.'}, 'OpportunityQuery': {'type': 'object', 'properties': {'q': {'type': 'string', 'default': '', 'description': 'Plain-language keywords; empty returns notices matching the other filters.'}, 'after': {'type': ['string', 'null'], 'description': 'Last notice ID from next_after in the preceding page.'}, 'limit': {'type': ['integer', 'null'], 'format': 'uint', 'minimum': 0, 'description': 'Maximum notices to return, from 1 to 50; defaults to 25.'}, 'naics': {'type': ['string', 'null'], 'description': 'Two- to six-digit NAICS industry code from a notice or the NAICS reference collection.'}, 'state': {'type': ['string', 'null'], 'description': 'State or territory code for the place of performance.'}, 'active': {'type': ['boolean', 'null'], 'description': 'Filter by source active status; this does not mean the response deadline is open.'}, 'agency': {'type': ['string', 'null'], 'description': 'Agency code on the source notice.'}, 'set_aside': {'type': ['string', 'null'], 'description': 'Official set-aside code from a notice or the set-asides reference collection.'}, 'generation': {'type': ['string', 'null'], 'description': 'Retained generation UUID from a prior result for a consistent snapshot.'}}, 'additionalProperties': False}, 'OpportunitySummary': {'type': 'object', 'required': ['id', 'title', 'summary', 'content_hash', 'data', 'url'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string'}, 'data': {'$ref': '#/$defs/JsonObject'}, 'title': {'type': 'string'}, 'summary': {'type': 'string'}, 'content_hash': {'type': 'string', 'description': 'Hash of retained notice content for change detection.'}}}}, '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generation', 'items', 'filters', 'scope'], 'properties': {'items': {'type': 'array', 'items': {'$ref': '#/$defs/OpportunitySummary'}}, 'scope': {'type': 'string', 'description': 'Limits of this retained official-notice search.'}, 'filters': {'$ref': '#/$defs/OpportunityQuery', 'description': 'Applied search filters.'}, 'generation': {'type': 'string'}, 'next_after': {'type': ['string', 'null'], 'description': 'Last record ID for the next page, or null at the end.'}}}