Models
We use Pydantic for defining certain models in the library.
SAM Entity
- pydantic model procurement_tools.models.entity.Address
Generic address object, used in multiple places
Show JSON schema
{ "title": "Address", "description": "Generic address object, used in multiple places", "type": "object", "properties": { "addressLine1": { "title": "Addressline1", "type": "string" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "title": "City", "type": "string" }, "stateOrProvinceCode": { "title": "Stateorprovincecode", "type": "string" }, "zipCode": { "title": "Zipcode", "type": "string" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "title": "Countrycode", "type": "string" } }, "required": [ "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ] }
- Fields:
- field address_line1: str [Required] (alias 'addressLine1')
- field address_line2: str | None [Required] (alias 'addressLine2')
- field city: str [Required]
- field country_code: str [Required] (alias 'countryCode')
- field state_or_province_code: str [Required] (alias 'stateOrProvinceCode')
- field zip_code: str [Required] (alias 'zipCode')
- field zip_code_plus4: str | None [Required] (alias 'zipCodePlus4')
- pydantic model procurement_tools.models.entity.AssertionData
Show JSON schema
{ "title": "AssertionData", "type": "object", "properties": { "goodsAndServices": { "$ref": "#/$defs/GoodsAndServices" }, "disasterReliefData": { "$ref": "#/$defs/DisasterReliefData" }, "ediInformation": { "$ref": "#/$defs/EdiInformation" } }, "$defs": { "DisasterReliefData": { "properties": { "disasterRegistryFlag": { "title": "Disasterregistryflag", "type": "string" }, "bondingFlag": { "title": "Bondingflag", "type": "string" }, "geographicalAreaServed": { "items": { "$ref": "#/$defs/GeographicalAreaServed" }, "title": "Geographicalareaserved", "type": "array" } }, "required": [ "disasterRegistryFlag", "bondingFlag", "geographicalAreaServed" ], "title": "DisasterReliefData", "type": "object" }, "EdiInformation": { "properties": { "ediInformationFlag": { "title": "Ediinformationflag", "type": "string" } }, "required": [ "ediInformationFlag" ], "title": "EdiInformation", "type": "object" }, "GeographicalAreaServed": { "properties": { "geographicalAreaServedStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatecode" }, "geographicalAreaServedStateName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatename" }, "geographicalAreaServedCountyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountycode" }, "geographicalAreaServedCountyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountyname" }, "geographicalAreaServedmetropolitanStatisticalAreaCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareacode" }, "geographicalAreaServedmetropolitanStatisticalAreaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareaname" } }, "required": [ "geographicalAreaServedStateCode", "geographicalAreaServedStateName", "geographicalAreaServedCountyCode", "geographicalAreaServedCountyName", "geographicalAreaServedmetropolitanStatisticalAreaCode", "geographicalAreaServedmetropolitanStatisticalAreaName" ], "title": "GeographicalAreaServed", "type": "object" }, "GoodsAndServices": { "properties": { "primaryNaics": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primarynaics" }, "naicsList": { "items": { "$ref": "#/$defs/Naics" }, "title": "Naicslist", "type": "array" }, "pscList": { "items": { "$ref": "#/$defs/ProductServiceCode" }, "title": "Psclist", "type": "array" } }, "required": [ "primaryNaics", "naicsList", "pscList" ], "title": "GoodsAndServices", "type": "object" }, "Naics": { "properties": { "naicsCode": { "title": "Naicscode", "type": "string" }, "naicsDescription": { "title": "Naicsdescription", "type": "string" }, "sbaSmallBusiness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbasmallbusiness" }, "naicsException": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Naicsexception" } }, "required": [ "naicsCode", "naicsDescription", "sbaSmallBusiness", "naicsException" ], "title": "Naics", "type": "object" }, "ProductServiceCode": { "properties": { "pscCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Psccode" }, "pscDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pscdescription" } }, "required": [ "pscCode", "pscDescription" ], "title": "ProductServiceCode", "type": "object" } }, "required": [ "goodsAndServices", "disasterReliefData", "ediInformation" ] }
- Fields:
- field disaster_relief_data: DisasterReliefData [Required] (alias 'disasterReliefData')
- field edi_information: EdiInformation [Required] (alias 'ediInformation')
- field goods_and_services: GoodsAndServices [Required] (alias 'goodsAndServices')
- pydantic model procurement_tools.models.entity.BusinessType
Business Types (e.g., WOSB)
Show JSON schema
{ "title": "BusinessType", "description": "Business Types (e.g., WOSB)", "type": "object", "properties": { "businessTypeCode": { "title": "Businesstypecode", "type": "string" }, "businessTypeDesc": { "title": "Businesstypedesc", "type": "string" } }, "required": [ "businessTypeCode", "businessTypeDesc" ] }
- field business_type_code: str [Required] (alias 'businessTypeCode')
- field business_type_description: str [Required] (alias 'businessTypeDesc')
- pydantic model procurement_tools.models.entity.BusinessTypes
Show JSON schema
{ "title": "BusinessTypes", "type": "object", "properties": { "businessTypeList": { "items": { "$ref": "#/$defs/BusinessType" }, "title": "Businesstypelist", "type": "array" }, "sbaBusinessTypeList": { "items": { "$ref": "#/$defs/SBABusinessType" }, "title": "Sbabusinesstypelist", "type": "array" } }, "$defs": { "BusinessType": { "description": "Business Types (e.g., WOSB)", "properties": { "businessTypeCode": { "title": "Businesstypecode", "type": "string" }, "businessTypeDesc": { "title": "Businesstypedesc", "type": "string" } }, "required": [ "businessTypeCode", "businessTypeDesc" ], "title": "BusinessType", "type": "object" }, "SBABusinessType": { "description": "SBA certifications (e.g., 8(a))", "properties": { "sbaBusinessTypeCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypecode" }, "sbaBusinessTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypedesc" }, "certificationEntryDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationentrydate" }, "certificationExitDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationexitdate" } }, "required": [ "sbaBusinessTypeCode", "sbaBusinessTypeDesc", "certificationEntryDate", "certificationExitDate" ], "title": "SBABusinessType", "type": "object" } }, "required": [ "businessTypeList", "sbaBusinessTypeList" ] }
- Fields:
- field businessTypeList: List[BusinessType] [Required]
- field sbaBusinessTypeList: List[SBABusinessType] [Required]
- pydantic model procurement_tools.models.entity.Certifications
Show JSON schema
{ "title": "Certifications", "type": "object", "properties": { "fARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Farresponses", "type": "array" }, "dFARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Dfarresponses", "type": "array" } }, "$defs": { "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "FARAnswer": { "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ], "title": "FARAnswer", "type": "object" }, "FARResponse": { "properties": { "provisionId": { "title": "Provisionid", "type": "string" }, "listOfAnswers": { "items": { "$ref": "#/$defs/FARAnswer" }, "title": "Listofanswers", "type": "array" } }, "required": [ "provisionId", "listOfAnswers" ], "title": "FARResponse", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" } }, "required": [ "fARResponses", "dFARResponses" ] }
- Fields:
- field dFARResponses: List[FARResponse] [Required]
- field fARResponses: List[FARResponse] [Required]
- pydantic model procurement_tools.models.entity.CorporateIntegrity
Show JSON schema
{ "title": "CorporateIntegrity", "type": "object", "properties": { "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "integrityRecords": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrityrecords" } }, "required": [ "legalBusinessName", "cageCode", "integrityRecords" ] }
- field cage_code: str | None [Required] (alias 'cageCode')
- field integrity_records: str | None [Required] (alias 'integrityRecords')
- field legal_business_name: str | None [Required] (alias 'legalBusinessName')
- pydantic model procurement_tools.models.entity.CorporateRelationships
Show JSON schema
{ "title": "CorporateRelationships", "type": "object", "properties": { "highestOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "immediateOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "predecessorsList": { "anyOf": [ { "items": { "$ref": "#/$defs/CorporateIntegrity" }, "type": "array" }, { "type": "null" } ], "title": "Predecessorslist" } }, "$defs": { "CorporateIntegrity": { "properties": { "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "integrityRecords": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrityrecords" } }, "required": [ "legalBusinessName", "cageCode", "integrityRecords" ], "title": "CorporateIntegrity", "type": "object" } }, "required": [ "highestOwner", "immediateOwner", "predecessorsList" ] }
- Fields:
- field highest_owner: CorporateIntegrity | None [Required] (alias 'highestOwner')
- field immediate_owner: CorporateIntegrity | None [Required] (alias 'immediateOwner')
- field predecessors_list: List[CorporateIntegrity] | None [Required] (alias 'predecessorsList')
- pydantic model procurement_tools.models.entity.DisasterReliefData
Show JSON schema
{ "title": "DisasterReliefData", "type": "object", "properties": { "disasterRegistryFlag": { "title": "Disasterregistryflag", "type": "string" }, "bondingFlag": { "title": "Bondingflag", "type": "string" }, "geographicalAreaServed": { "items": { "$ref": "#/$defs/GeographicalAreaServed" }, "title": "Geographicalareaserved", "type": "array" } }, "$defs": { "GeographicalAreaServed": { "properties": { "geographicalAreaServedStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatecode" }, "geographicalAreaServedStateName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatename" }, "geographicalAreaServedCountyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountycode" }, "geographicalAreaServedCountyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountyname" }, "geographicalAreaServedmetropolitanStatisticalAreaCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareacode" }, "geographicalAreaServedmetropolitanStatisticalAreaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareaname" } }, "required": [ "geographicalAreaServedStateCode", "geographicalAreaServedStateName", "geographicalAreaServedCountyCode", "geographicalAreaServedCountyName", "geographicalAreaServedmetropolitanStatisticalAreaCode", "geographicalAreaServedmetropolitanStatisticalAreaName" ], "title": "GeographicalAreaServed", "type": "object" } }, "required": [ "disasterRegistryFlag", "bondingFlag", "geographicalAreaServed" ] }
- Fields:
- field bonding_flag: str [Required] (alias 'bondingFlag')
- field disaster_registry_flag: str [Required] (alias 'disasterRegistryFlag')
- field geographical_area_served: List[GeographicalAreaServed] [Required] (alias 'geographicalAreaServed')
- pydantic model procurement_tools.models.entity.EdiInformation
Show JSON schema
{ "title": "EdiInformation", "type": "object", "properties": { "ediInformationFlag": { "title": "Ediinformationflag", "type": "string" } }, "required": [ "ediInformationFlag" ] }
- Fields:
- field edi_information_flag: str [Required] (alias 'ediInformationFlag')
- pydantic model procurement_tools.models.entity.Entity
Show JSON schema
{ "title": "Entity", "type": "object", "properties": { "entityRegistration": { "allOf": [ { "$ref": "#/$defs/Registration" } ], "default": null }, "coreData": { "anyOf": [ { "$ref": "#/$defs/EntityData" }, { "type": "null" } ], "default": null }, "integrityInformation": { "anyOf": [ { "$ref": "#/$defs/IntegrityInformation" }, { "type": "null" } ], "default": null }, "assertions": { "anyOf": [ { "$ref": "#/$defs/AssertionData" }, { "type": "null" } ], "default": null }, "repsAndCerts": { "anyOf": [ { "$ref": "#/$defs/RepsAndCerts" }, { "type": "null" } ], "default": null }, "pointsOfContact": { "anyOf": [ { "$ref": "#/$defs/POCData" }, { "type": "null" } ], "default": null } }, "$defs": { "Address": { "description": "Generic address object, used in multiple places", "properties": { "addressLine1": { "title": "Addressline1", "type": "string" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "title": "City", "type": "string" }, "stateOrProvinceCode": { "title": "Stateorprovincecode", "type": "string" }, "zipCode": { "title": "Zipcode", "type": "string" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "title": "Countrycode", "type": "string" } }, "required": [ "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "Address", "type": "object" }, "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "AssertionData": { "properties": { "goodsAndServices": { "$ref": "#/$defs/GoodsAndServices" }, "disasterReliefData": { "$ref": "#/$defs/DisasterReliefData" }, "ediInformation": { "$ref": "#/$defs/EdiInformation" } }, "required": [ "goodsAndServices", "disasterReliefData", "ediInformation" ], "title": "AssertionData", "type": "object" }, "BusinessType": { "description": "Business Types (e.g., WOSB)", "properties": { "businessTypeCode": { "title": "Businesstypecode", "type": "string" }, "businessTypeDesc": { "title": "Businesstypedesc", "type": "string" } }, "required": [ "businessTypeCode", "businessTypeDesc" ], "title": "BusinessType", "type": "object" }, "BusinessTypes": { "properties": { "businessTypeList": { "items": { "$ref": "#/$defs/BusinessType" }, "title": "Businesstypelist", "type": "array" }, "sbaBusinessTypeList": { "items": { "$ref": "#/$defs/SBABusinessType" }, "title": "Sbabusinesstypelist", "type": "array" } }, "required": [ "businessTypeList", "sbaBusinessTypeList" ], "title": "BusinessTypes", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Certifications": { "properties": { "fARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Farresponses", "type": "array" }, "dFARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Dfarresponses", "type": "array" } }, "required": [ "fARResponses", "dFARResponses" ], "title": "Certifications", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "CorporateIntegrity": { "properties": { "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "integrityRecords": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrityrecords" } }, "required": [ "legalBusinessName", "cageCode", "integrityRecords" ], "title": "CorporateIntegrity", "type": "object" }, "CorporateRelationships": { "properties": { "highestOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "immediateOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "predecessorsList": { "anyOf": [ { "items": { "$ref": "#/$defs/CorporateIntegrity" }, "type": "array" }, { "type": "null" } ], "title": "Predecessorslist" } }, "required": [ "highestOwner", "immediateOwner", "predecessorsList" ], "title": "CorporateRelationships", "type": "object" }, "DisasterReliefData": { "properties": { "disasterRegistryFlag": { "title": "Disasterregistryflag", "type": "string" }, "bondingFlag": { "title": "Bondingflag", "type": "string" }, "geographicalAreaServed": { "items": { "$ref": "#/$defs/GeographicalAreaServed" }, "title": "Geographicalareaserved", "type": "array" } }, "required": [ "disasterRegistryFlag", "bondingFlag", "geographicalAreaServed" ], "title": "DisasterReliefData", "type": "object" }, "EdiInformation": { "properties": { "ediInformationFlag": { "title": "Ediinformationflag", "type": "string" } }, "required": [ "ediInformationFlag" ], "title": "EdiInformation", "type": "object" }, "EntityData": { "properties": { "entityInformation": { "$ref": "#/$defs/EntityInformation" }, "physicalAddress": { "$ref": "#/$defs/Address" }, "mailingAddress": { "$ref": "#/$defs/Address" }, "congressionalDistrict": { "title": "Congressionaldistrict", "type": "string" }, "generalInformation": { "$ref": "#/$defs/EntityGeneralInformation" }, "businessTypes": { "$ref": "#/$defs/BusinessTypes" }, "financialInformation": { "$ref": "#/$defs/FinancialInformation" } }, "required": [ "entityInformation", "physicalAddress", "mailingAddress", "congressionalDistrict", "generalInformation", "businessTypes", "financialInformation" ], "title": "EntityData", "type": "object" }, "EntityGeneralInformation": { "properties": { "entityStructureCode": { "title": "Entitystructurecode", "type": "string" }, "entityStructureDesc": { "title": "Entitystructuredesc", "type": "string" }, "entityTypeCode": { "title": "Entitytypecode", "type": "string" }, "entityTypeDesc": { "title": "Entitytypedesc", "type": "string" }, "profitStructureCode": { "title": "Profitstructurecode", "type": "string" }, "organizationStructureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructurecode" }, "organizationStructureDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructuredesc" }, "stateOfIncorporationCode": { "title": "Stateofincorporationcode", "type": "string" }, "stateOfIncorporationDesc": { "title": "Stateofincorporationdesc", "type": "string" }, "countryOfIncorporationCode": { "title": "Countryofincorporationcode", "type": "string" }, "countryOfIncorporationDesc": { "title": "Countryofincorporationdesc", "type": "string" } }, "required": [ "entityStructureCode", "entityStructureDesc", "entityTypeCode", "entityTypeDesc", "profitStructureCode", "entityTypeDesc", "organizationStructureCode", "organizationStructureDesc", "stateOfIncorporationCode", "stateOfIncorporationDesc", "countryOfIncorporationCode", "countryOfIncorporationDesc" ], "title": "EntityGeneralInformation", "type": "object" }, "EntityInformation": { "properties": { "entityURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entityurl" }, "entityDivisionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionname" }, "entityDivisionNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionnumber" }, "entityStartDate": { "title": "Entitystartdate", "type": "string" }, "fiscalYearEndCloseDate": { "title": "Fiscalyearendclosedate", "type": "string" }, "submissionDate": { "title": "Submissiondate", "type": "string" } }, "required": [ "entityURL", "entityDivisionName", "entityDivisionNumber", "entityStartDate", "fiscalYearEndCloseDate", "submissionDate" ], "title": "EntityInformation", "type": "object" }, "EntitySummary": { "properties": { "ueiSAM": { "default": null, "title": "Ueisam", "type": "string" }, "cageCode": { "title": "Cagecode", "type": "string" }, "legalBusinessName": { "title": "Legalbusinessname", "type": "string" }, "physicalAddress": { "$ref": "#/$defs/Address" } }, "required": [ "cageCode", "legalBusinessName", "physicalAddress" ], "title": "EntitySummary", "type": "object" }, "FARAnswer": { "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ], "title": "FARAnswer", "type": "object" }, "FARResponse": { "properties": { "provisionId": { "title": "Provisionid", "type": "string" }, "listOfAnswers": { "items": { "$ref": "#/$defs/FARAnswer" }, "title": "Listofanswers", "type": "array" } }, "required": [ "provisionId", "listOfAnswers" ], "title": "FARResponse", "type": "object" }, "FinancialAssistanceCertifications": { "properties": { "grantsCertificationStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertificationstatus" }, "grantsCertifyingResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertifyingresponse" }, "certifierFirstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierfirstname" }, "certifierLastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierlastname" }, "certifierMiddleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifiermiddleinitial" } }, "required": [ "grantsCertificationStatus", "grantsCertifyingResponse", "certifierFirstName", "certifierLastName", "certifierMiddleInitial" ], "title": "FinancialAssistanceCertifications", "type": "object" }, "FinancialInformation": { "properties": { "creditCardUsage": { "title": "Creditcardusage", "type": "string" }, "debtSubjectToOffset": { "title": "Debtsubjecttooffset", "type": "string" } }, "required": [ "creditCardUsage", "debtSubjectToOffset" ], "title": "FinancialInformation", "type": "object" }, "GeographicalAreaServed": { "properties": { "geographicalAreaServedStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatecode" }, "geographicalAreaServedStateName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatename" }, "geographicalAreaServedCountyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountycode" }, "geographicalAreaServedCountyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountyname" }, "geographicalAreaServedmetropolitanStatisticalAreaCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareacode" }, "geographicalAreaServedmetropolitanStatisticalAreaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareaname" } }, "required": [ "geographicalAreaServedStateCode", "geographicalAreaServedStateName", "geographicalAreaServedCountyCode", "geographicalAreaServedCountyName", "geographicalAreaServedmetropolitanStatisticalAreaCode", "geographicalAreaServedmetropolitanStatisticalAreaName" ], "title": "GeographicalAreaServed", "type": "object" }, "GoodsAndServices": { "properties": { "primaryNaics": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primarynaics" }, "naicsList": { "items": { "$ref": "#/$defs/Naics" }, "title": "Naicslist", "type": "array" }, "pscList": { "items": { "$ref": "#/$defs/ProductServiceCode" }, "title": "Psclist", "type": "array" } }, "required": [ "primaryNaics", "naicsList", "pscList" ], "title": "GoodsAndServices", "type": "object" }, "IntegrityInformation": { "properties": { "entitySummary": { "anyOf": [ { "$ref": "#/$defs/EntitySummary" }, { "type": "null" } ] }, "proceedingsData": { "anyOf": [ { "$ref": "#/$defs/ProceedingsData" }, { "type": "null" } ] }, "responsibilityInformationCount": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Responsibilityinformationcount" }, "responsibilityInformationList": { "anyOf": [ { "items": { "$ref": "#/$defs/ResponsibilityInformation" }, "type": "array" }, { "type": "null" } ], "title": "Responsibilityinformationlist" }, "corporateRelationships": { "anyOf": [ { "$ref": "#/$defs/CorporateRelationships" }, { "type": "null" } ] } }, "required": [ "entitySummary", "proceedingsData", "responsibilityInformationCount", "responsibilityInformationList", "corporateRelationships" ], "title": "IntegrityInformation", "type": "object" }, "Naics": { "properties": { "naicsCode": { "title": "Naicscode", "type": "string" }, "naicsDescription": { "title": "Naicsdescription", "type": "string" }, "sbaSmallBusiness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbasmallbusiness" }, "naicsException": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Naicsexception" } }, "required": [ "naicsCode", "naicsDescription", "sbaSmallBusiness", "naicsException" ], "title": "Naics", "type": "object" }, "PDFLinks": { "properties": { "farPDF": { "title": "Farpdf", "type": "string" }, "farAndDfarsPDF": { "title": "Faranddfarspdf", "type": "string" }, "architectEngineeringPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Architectengineeringpdf" }, "financialAssistanceCertificationsPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Financialassistancecertificationspdf" } }, "required": [ "farPDF", "farAndDfarsPDF", "architectEngineeringPDF", "financialAssistanceCertificationsPDF" ], "title": "PDFLinks", "type": "object" }, "POC": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "POC", "type": "object" }, "POCData": { "properties": { "governmentBusinessPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "electronicBusinessPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "governmentBusinessAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "electronicBusinessAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "pastPerformancePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "pastPerformanceAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "required": [ "governmentBusinessPOC", "electronicBusinessPOC", "governmentBusinessAlternatePOC", "electronicBusinessAlternatePOC", "pastPerformancePOC", "pastPerformanceAlternatePOC" ], "title": "POCData", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" }, "Proceeding": { "properties": { "proceedingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdate" }, "instrumentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrumentnumber" }, "instrument": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument" }, "proceedingStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingstatecode" }, "proceedingType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingtype" }, "disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition" }, "proceedingDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdescription" } }, "required": [ "proceedingDate", "instrumentNumber", "instrument", "proceedingStateCode", "proceedingType", "disposition", "proceedingDescription" ], "title": "Proceeding", "type": "object" }, "ProceedingsData": { "properties": { "proceedingsQuestion1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion1" }, "proceedingsQuestion2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion2" }, "proceedingsQuestion3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion3" }, "proceedingsRecordCount": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Proceedingsrecordcount" }, "listOfProceedings": { "items": { "$ref": "#/$defs/Proceeding" }, "title": "Listofproceedings", "type": "array" }, "proceedingsPointsOfContact": { "anyOf": [ { "$ref": "#/$defs/ProceedingsPointsOfContact" }, { "type": "null" } ] } }, "required": [ "proceedingsQuestion1", "proceedingsQuestion2", "proceedingsQuestion3", "proceedingsRecordCount", "listOfProceedings", "proceedingsPointsOfContact" ], "title": "ProceedingsData", "type": "object" }, "ProceedingsPointsOfContact": { "properties": { "proceedingsPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "proceedingsAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "required": [ "proceedingsPOC", "proceedingsAlternatePOC" ], "title": "ProceedingsPointsOfContact", "type": "object" }, "ProductServiceCode": { "properties": { "pscCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Psccode" }, "pscDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pscdescription" } }, "required": [ "pscCode", "pscDescription" ], "title": "ProductServiceCode", "type": "object" }, "Qualifications": { "properties": { "architectEngineerResponses": { "anyOf": [ { "$ref": "#/$defs/FARResponse" }, { "type": "null" } ] } }, "required": [ "architectEngineerResponses" ], "title": "Qualifications", "type": "object" }, "Registration": { "description": "Basic registration information for an entity", "properties": { "samRegistered": { "enum": [ "Yes", "No" ], "title": "Samregistered", "type": "string" }, "ueiSAM": { "title": "Ueisam", "type": "string" }, "entityEFTIndicator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entityeftindicator" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "dodaac": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dodaac" }, "legalBusinessName": { "title": "Legalbusinessname", "type": "string" }, "dbaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dbaname" }, "purposeOfRegistrationCode": { "title": "Purposeofregistrationcode", "type": "string" }, "purposeOfRegistrationDesc": { "title": "Purposeofregistrationdesc", "type": "string" }, "registrationStatus": { "title": "Registrationstatus", "type": "string" }, "evsSource": { "title": "Evssource", "type": "string" }, "registrationDate": { "title": "Registrationdate", "type": "string" }, "lastUpdateDate": { "title": "Lastupdatedate", "type": "string" }, "registrationExpirationDate": { "title": "Registrationexpirationdate", "type": "string" }, "activationDate": { "title": "Activationdate", "type": "string" }, "ueiStatus": { "title": "Ueistatus", "type": "string" }, "ueiExpirationDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ueiexpirationdate" }, "ueiCreationDate": { "title": "Ueicreationdate", "type": "string" }, "publicDisplayFlag": { "title": "Publicdisplayflag", "type": "string" }, "exclusionStatusFlag": { "title": "Exclusionstatusflag", "type": "string" }, "exclusionURL": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Exclusionurl" }, "dnbOpenData": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dnbopendata" } }, "required": [ "samRegistered", "ueiSAM", "entityEFTIndicator", "cageCode", "dodaac", "legalBusinessName", "dbaName", "purposeOfRegistrationCode", "purposeOfRegistrationDesc", "registrationStatus", "evsSource", "registrationDate", "lastUpdateDate", "registrationExpirationDate", "activationDate", "ueiStatus", "ueiExpirationDate", "ueiCreationDate", "publicDisplayFlag", "exclusionStatusFlag", "exclusionURL", "dnbOpenData" ], "title": "Registration", "type": "object" }, "RepsAndCerts": { "properties": { "certifications": { "$ref": "#/$defs/Certifications" }, "qualifications": { "$ref": "#/$defs/Qualifications" }, "financialAssistanceCertifications": { "$ref": "#/$defs/FinancialAssistanceCertifications" }, "pdfLinks": { "$ref": "#/$defs/PDFLinks" } }, "required": [ "certifications", "qualifications", "financialAssistanceCertifications", "pdfLinks" ], "title": "RepsAndCerts", "type": "object" }, "ResponsibilityInformation": { "properties": { "recordType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtype" }, "recordTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtypedesc" }, "recordDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recorddate" }, "procurementIdOrFederalAssistanceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Procurementidorfederalassistanceid" }, "referenceIdvPiid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceidvpiid" }, "attachment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attachment" } }, "required": [ "recordType", "recordTypeDesc", "recordDate", "procurementIdOrFederalAssistanceId", "referenceIdvPiid", "attachment" ], "title": "ResponsibilityInformation", "type": "object" }, "SBABusinessType": { "description": "SBA certifications (e.g., 8(a))", "properties": { "sbaBusinessTypeCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypecode" }, "sbaBusinessTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypedesc" }, "certificationEntryDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationentrydate" }, "certificationExitDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationexitdate" } }, "required": [ "sbaBusinessTypeCode", "sbaBusinessTypeDesc", "certificationEntryDate", "certificationExitDate" ], "title": "SBABusinessType", "type": "object" } } }
- Fields:
assertions (procurement_tools.models.entity.AssertionData | None)core_data (procurement_tools.models.entity.EntityData | None)integrity_information (procurement_tools.models.entity.IntegrityInformation | None)points_of_contact (procurement_tools.models.entity.POCData | None)reps_and_certs (procurement_tools.models.entity.RepsAndCerts | None)
- field assertions: AssertionData | None = None
- field core_data: EntityData | None = None (alias 'coreData')
- field integrity_information: IntegrityInformation | None = None (alias 'integrityInformation')
- field registration: Registration = None (alias 'entityRegistration')
- field reps_and_certs: RepsAndCerts | None = None (alias 'repsAndCerts')
- pydantic model procurement_tools.models.entity.EntityData
Show JSON schema
{ "title": "EntityData", "type": "object", "properties": { "entityInformation": { "$ref": "#/$defs/EntityInformation" }, "physicalAddress": { "$ref": "#/$defs/Address" }, "mailingAddress": { "$ref": "#/$defs/Address" }, "congressionalDistrict": { "title": "Congressionaldistrict", "type": "string" }, "generalInformation": { "$ref": "#/$defs/EntityGeneralInformation" }, "businessTypes": { "$ref": "#/$defs/BusinessTypes" }, "financialInformation": { "$ref": "#/$defs/FinancialInformation" } }, "$defs": { "Address": { "description": "Generic address object, used in multiple places", "properties": { "addressLine1": { "title": "Addressline1", "type": "string" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "title": "City", "type": "string" }, "stateOrProvinceCode": { "title": "Stateorprovincecode", "type": "string" }, "zipCode": { "title": "Zipcode", "type": "string" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "title": "Countrycode", "type": "string" } }, "required": [ "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "Address", "type": "object" }, "BusinessType": { "description": "Business Types (e.g., WOSB)", "properties": { "businessTypeCode": { "title": "Businesstypecode", "type": "string" }, "businessTypeDesc": { "title": "Businesstypedesc", "type": "string" } }, "required": [ "businessTypeCode", "businessTypeDesc" ], "title": "BusinessType", "type": "object" }, "BusinessTypes": { "properties": { "businessTypeList": { "items": { "$ref": "#/$defs/BusinessType" }, "title": "Businesstypelist", "type": "array" }, "sbaBusinessTypeList": { "items": { "$ref": "#/$defs/SBABusinessType" }, "title": "Sbabusinesstypelist", "type": "array" } }, "required": [ "businessTypeList", "sbaBusinessTypeList" ], "title": "BusinessTypes", "type": "object" }, "EntityGeneralInformation": { "properties": { "entityStructureCode": { "title": "Entitystructurecode", "type": "string" }, "entityStructureDesc": { "title": "Entitystructuredesc", "type": "string" }, "entityTypeCode": { "title": "Entitytypecode", "type": "string" }, "entityTypeDesc": { "title": "Entitytypedesc", "type": "string" }, "profitStructureCode": { "title": "Profitstructurecode", "type": "string" }, "organizationStructureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructurecode" }, "organizationStructureDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructuredesc" }, "stateOfIncorporationCode": { "title": "Stateofincorporationcode", "type": "string" }, "stateOfIncorporationDesc": { "title": "Stateofincorporationdesc", "type": "string" }, "countryOfIncorporationCode": { "title": "Countryofincorporationcode", "type": "string" }, "countryOfIncorporationDesc": { "title": "Countryofincorporationdesc", "type": "string" } }, "required": [ "entityStructureCode", "entityStructureDesc", "entityTypeCode", "entityTypeDesc", "profitStructureCode", "entityTypeDesc", "organizationStructureCode", "organizationStructureDesc", "stateOfIncorporationCode", "stateOfIncorporationDesc", "countryOfIncorporationCode", "countryOfIncorporationDesc" ], "title": "EntityGeneralInformation", "type": "object" }, "EntityInformation": { "properties": { "entityURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entityurl" }, "entityDivisionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionname" }, "entityDivisionNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionnumber" }, "entityStartDate": { "title": "Entitystartdate", "type": "string" }, "fiscalYearEndCloseDate": { "title": "Fiscalyearendclosedate", "type": "string" }, "submissionDate": { "title": "Submissiondate", "type": "string" } }, "required": [ "entityURL", "entityDivisionName", "entityDivisionNumber", "entityStartDate", "fiscalYearEndCloseDate", "submissionDate" ], "title": "EntityInformation", "type": "object" }, "FinancialInformation": { "properties": { "creditCardUsage": { "title": "Creditcardusage", "type": "string" }, "debtSubjectToOffset": { "title": "Debtsubjecttooffset", "type": "string" } }, "required": [ "creditCardUsage", "debtSubjectToOffset" ], "title": "FinancialInformation", "type": "object" }, "SBABusinessType": { "description": "SBA certifications (e.g., 8(a))", "properties": { "sbaBusinessTypeCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypecode" }, "sbaBusinessTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypedesc" }, "certificationEntryDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationentrydate" }, "certificationExitDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationexitdate" } }, "required": [ "sbaBusinessTypeCode", "sbaBusinessTypeDesc", "certificationEntryDate", "certificationExitDate" ], "title": "SBABusinessType", "type": "object" } }, "required": [ "entityInformation", "physicalAddress", "mailingAddress", "congressionalDistrict", "generalInformation", "businessTypes", "financialInformation" ] }
- Fields:
- field business_types: BusinessTypes [Required] (alias 'businessTypes')
- field congressional_district: str [Required] (alias 'congressionalDistrict')
- field entity_information: EntityInformation [Required] (alias 'entityInformation')
- field financial_information: FinancialInformation [Required] (alias 'financialInformation')
- field general_information: EntityGeneralInformation [Required] (alias 'generalInformation')
- pydantic model procurement_tools.models.entity.EntityGeneralInformation
Show JSON schema
{ "title": "EntityGeneralInformation", "type": "object", "properties": { "entityStructureCode": { "title": "Entitystructurecode", "type": "string" }, "entityStructureDesc": { "title": "Entitystructuredesc", "type": "string" }, "entityTypeCode": { "title": "Entitytypecode", "type": "string" }, "entityTypeDesc": { "title": "Entitytypedesc", "type": "string" }, "profitStructureCode": { "title": "Profitstructurecode", "type": "string" }, "organizationStructureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructurecode" }, "organizationStructureDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organizationstructuredesc" }, "stateOfIncorporationCode": { "title": "Stateofincorporationcode", "type": "string" }, "stateOfIncorporationDesc": { "title": "Stateofincorporationdesc", "type": "string" }, "countryOfIncorporationCode": { "title": "Countryofincorporationcode", "type": "string" }, "countryOfIncorporationDesc": { "title": "Countryofincorporationdesc", "type": "string" } }, "required": [ "entityStructureCode", "entityStructureDesc", "entityTypeCode", "entityTypeDesc", "profitStructureCode", "entityTypeDesc", "organizationStructureCode", "organizationStructureDesc", "stateOfIncorporationCode", "stateOfIncorporationDesc", "countryOfIncorporationCode", "countryOfIncorporationDesc" ] }
- Fields:
- field country_of_incorporation_code: str [Required] (alias 'countryOfIncorporationCode')
- field country_of_incorporation_description: str [Required] (alias 'countryOfIncorporationDesc')
- field entity_structure_code: str [Required] (alias 'entityStructureCode')
- field entity_structure_description: str [Required] (alias 'entityStructureDesc')
- field entity_type_code: str [Required] (alias 'entityTypeCode')
- field entity_type_description: str [Required] (alias 'entityTypeDesc')
- field organization_structure_code: str | None [Required] (alias 'organizationStructureCode')
- field organization_structure_description: str | None [Required] (alias 'organizationStructureDesc')
- field profit_structure_code: str [Required] (alias 'profitStructureCode')
- field profit_structure_description: str [Required] (alias 'entityTypeDesc')
- field state_of_incorporation_code: str [Required] (alias 'stateOfIncorporationCode')
- field state_of_incorporation_description: str [Required] (alias 'stateOfIncorporationDesc')
- pydantic model procurement_tools.models.entity.EntityInformation
Show JSON schema
{ "title": "EntityInformation", "type": "object", "properties": { "entityURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entityurl" }, "entityDivisionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionname" }, "entityDivisionNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entitydivisionnumber" }, "entityStartDate": { "title": "Entitystartdate", "type": "string" }, "fiscalYearEndCloseDate": { "title": "Fiscalyearendclosedate", "type": "string" }, "submissionDate": { "title": "Submissiondate", "type": "string" } }, "required": [ "entityURL", "entityDivisionName", "entityDivisionNumber", "entityStartDate", "fiscalYearEndCloseDate", "submissionDate" ] }
- Fields:
- field entity_division_name: str | None [Required] (alias 'entityDivisionName')
- field entity_division_number: str | None [Required] (alias 'entityDivisionNumber')
- field entity_start_date: str [Required] (alias 'entityStartDate')
- field entity_url: str | None [Required] (alias 'entityURL')
- field fiscal_year_end_close_date: str [Required] (alias 'fiscalYearEndCloseDate')
- field submission_date: str [Required] (alias 'submissionDate')
- pydantic model procurement_tools.models.entity.EntitySummary
Show JSON schema
{ "title": "EntitySummary", "type": "object", "properties": { "ueiSAM": { "default": null, "title": "Ueisam", "type": "string" }, "cageCode": { "title": "Cagecode", "type": "string" }, "legalBusinessName": { "title": "Legalbusinessname", "type": "string" }, "physicalAddress": { "$ref": "#/$defs/Address" } }, "$defs": { "Address": { "description": "Generic address object, used in multiple places", "properties": { "addressLine1": { "title": "Addressline1", "type": "string" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "title": "City", "type": "string" }, "stateOrProvinceCode": { "title": "Stateorprovincecode", "type": "string" }, "zipCode": { "title": "Zipcode", "type": "string" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "title": "Countrycode", "type": "string" } }, "required": [ "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "Address", "type": "object" } }, "required": [ "cageCode", "legalBusinessName", "physicalAddress" ] }
- Fields:
- field cage_code: str [Required] (alias 'cageCode')
- field legal_business_name: str [Required] (alias 'legalBusinessName')
- field uei: str = None (alias 'ueiSAM')
- pydantic model procurement_tools.models.entity.FARResponse
Show JSON schema
{ "title": "FARResponse", "type": "object", "properties": { "provisionId": { "title": "Provisionid", "type": "string" }, "listOfAnswers": { "items": { "$ref": "#/$defs/FARAnswer" }, "title": "Listofanswers", "type": "array" } }, "$defs": { "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "FARAnswer": { "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ], "title": "FARAnswer", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" } }, "required": [ "provisionId", "listOfAnswers" ] }
- Fields:
- field provision_id: str [Required] (alias 'provisionId')
- pydantic model procurement_tools.models.entity.FinancialAssistanceCertifications
Show JSON schema
{ "title": "FinancialAssistanceCertifications", "type": "object", "properties": { "grantsCertificationStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertificationstatus" }, "grantsCertifyingResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertifyingresponse" }, "certifierFirstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierfirstname" }, "certifierLastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierlastname" }, "certifierMiddleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifiermiddleinitial" } }, "required": [ "grantsCertificationStatus", "grantsCertifyingResponse", "certifierFirstName", "certifierLastName", "certifierMiddleInitial" ] }
- Fields:
- field certifier_first_name: str | None [Required] (alias 'certifierFirstName')
- field certifier_last_name: str | None [Required] (alias 'certifierLastName')
- field certifier_middle_initial: str | None [Required] (alias 'certifierMiddleInitial')
- field grants_certification_status: str | None [Required] (alias 'grantsCertificationStatus')
- field grants_certifying_response: str | None [Required] (alias 'grantsCertifyingResponse')
- pydantic model procurement_tools.models.entity.FinancialInformation
Show JSON schema
{ "title": "FinancialInformation", "type": "object", "properties": { "creditCardUsage": { "title": "Creditcardusage", "type": "string" }, "debtSubjectToOffset": { "title": "Debtsubjecttooffset", "type": "string" } }, "required": [ "creditCardUsage", "debtSubjectToOffset" ] }
- field credit_card_usage: str [Required] (alias 'creditCardUsage')
- field debt_subject_to_offset: str [Required] (alias 'debtSubjectToOffset')
- pydantic model procurement_tools.models.entity.GeographicalAreaServed
Show JSON schema
{ "title": "GeographicalAreaServed", "type": "object", "properties": { "geographicalAreaServedStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatecode" }, "geographicalAreaServedStateName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedstatename" }, "geographicalAreaServedCountyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountycode" }, "geographicalAreaServedCountyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedcountyname" }, "geographicalAreaServedmetropolitanStatisticalAreaCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareacode" }, "geographicalAreaServedmetropolitanStatisticalAreaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographicalareaservedmetropolitanstatisticalareaname" } }, "required": [ "geographicalAreaServedStateCode", "geographicalAreaServedStateName", "geographicalAreaServedCountyCode", "geographicalAreaServedCountyName", "geographicalAreaServedmetropolitanStatisticalAreaCode", "geographicalAreaServedmetropolitanStatisticalAreaName" ] }
- Fields:
- field geographical_area_served_county_code: str | None [Required] (alias 'geographicalAreaServedCountyCode')
- field geographical_area_served_county_name: str | None [Required] (alias 'geographicalAreaServedCountyName')
- field geographical_area_served_state_code: str | None [Required] (alias 'geographicalAreaServedStateCode')
- field geographical_area_served_state_name: str | None [Required] (alias 'geographicalAreaServedStateName')
- field geographical_area_servedmetropolitan_statistical_area_code: str | None [Required] (alias 'geographicalAreaServedmetropolitanStatisticalAreaCode')
- field geographical_area_servedmetropolitan_statistical_area_name: str | None [Required] (alias 'geographicalAreaServedmetropolitanStatisticalAreaName')
- pydantic model procurement_tools.models.entity.GoodsAndServices
Show JSON schema
{ "title": "GoodsAndServices", "type": "object", "properties": { "primaryNaics": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primarynaics" }, "naicsList": { "items": { "$ref": "#/$defs/Naics" }, "title": "Naicslist", "type": "array" }, "pscList": { "items": { "$ref": "#/$defs/ProductServiceCode" }, "title": "Psclist", "type": "array" } }, "$defs": { "Naics": { "properties": { "naicsCode": { "title": "Naicscode", "type": "string" }, "naicsDescription": { "title": "Naicsdescription", "type": "string" }, "sbaSmallBusiness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbasmallbusiness" }, "naicsException": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Naicsexception" } }, "required": [ "naicsCode", "naicsDescription", "sbaSmallBusiness", "naicsException" ], "title": "Naics", "type": "object" }, "ProductServiceCode": { "properties": { "pscCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Psccode" }, "pscDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pscdescription" } }, "required": [ "pscCode", "pscDescription" ], "title": "ProductServiceCode", "type": "object" } }, "required": [ "primaryNaics", "naicsList", "pscList" ] }
- Fields:
- field primary_naics: str | None [Required] (alias 'primaryNaics')
- field psc_list: List[ProductServiceCode] [Required] (alias 'pscList')
- pydantic model procurement_tools.models.entity.IntegrityInformation
Show JSON schema
{ "title": "IntegrityInformation", "type": "object", "properties": { "entitySummary": { "anyOf": [ { "$ref": "#/$defs/EntitySummary" }, { "type": "null" } ] }, "proceedingsData": { "anyOf": [ { "$ref": "#/$defs/ProceedingsData" }, { "type": "null" } ] }, "responsibilityInformationCount": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Responsibilityinformationcount" }, "responsibilityInformationList": { "anyOf": [ { "items": { "$ref": "#/$defs/ResponsibilityInformation" }, "type": "array" }, { "type": "null" } ], "title": "Responsibilityinformationlist" }, "corporateRelationships": { "anyOf": [ { "$ref": "#/$defs/CorporateRelationships" }, { "type": "null" } ] } }, "$defs": { "Address": { "description": "Generic address object, used in multiple places", "properties": { "addressLine1": { "title": "Addressline1", "type": "string" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "title": "City", "type": "string" }, "stateOrProvinceCode": { "title": "Stateorprovincecode", "type": "string" }, "zipCode": { "title": "Zipcode", "type": "string" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "title": "Countrycode", "type": "string" } }, "required": [ "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "Address", "type": "object" }, "CorporateIntegrity": { "properties": { "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "integrityRecords": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrityrecords" } }, "required": [ "legalBusinessName", "cageCode", "integrityRecords" ], "title": "CorporateIntegrity", "type": "object" }, "CorporateRelationships": { "properties": { "highestOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "immediateOwner": { "anyOf": [ { "$ref": "#/$defs/CorporateIntegrity" }, { "type": "null" } ] }, "predecessorsList": { "anyOf": [ { "items": { "$ref": "#/$defs/CorporateIntegrity" }, "type": "array" }, { "type": "null" } ], "title": "Predecessorslist" } }, "required": [ "highestOwner", "immediateOwner", "predecessorsList" ], "title": "CorporateRelationships", "type": "object" }, "EntitySummary": { "properties": { "ueiSAM": { "default": null, "title": "Ueisam", "type": "string" }, "cageCode": { "title": "Cagecode", "type": "string" }, "legalBusinessName": { "title": "Legalbusinessname", "type": "string" }, "physicalAddress": { "$ref": "#/$defs/Address" } }, "required": [ "cageCode", "legalBusinessName", "physicalAddress" ], "title": "EntitySummary", "type": "object" }, "POC": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "POC", "type": "object" }, "Proceeding": { "properties": { "proceedingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdate" }, "instrumentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrumentnumber" }, "instrument": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument" }, "proceedingStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingstatecode" }, "proceedingType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingtype" }, "disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition" }, "proceedingDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdescription" } }, "required": [ "proceedingDate", "instrumentNumber", "instrument", "proceedingStateCode", "proceedingType", "disposition", "proceedingDescription" ], "title": "Proceeding", "type": "object" }, "ProceedingsData": { "properties": { "proceedingsQuestion1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion1" }, "proceedingsQuestion2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion2" }, "proceedingsQuestion3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion3" }, "proceedingsRecordCount": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Proceedingsrecordcount" }, "listOfProceedings": { "items": { "$ref": "#/$defs/Proceeding" }, "title": "Listofproceedings", "type": "array" }, "proceedingsPointsOfContact": { "anyOf": [ { "$ref": "#/$defs/ProceedingsPointsOfContact" }, { "type": "null" } ] } }, "required": [ "proceedingsQuestion1", "proceedingsQuestion2", "proceedingsQuestion3", "proceedingsRecordCount", "listOfProceedings", "proceedingsPointsOfContact" ], "title": "ProceedingsData", "type": "object" }, "ProceedingsPointsOfContact": { "properties": { "proceedingsPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "proceedingsAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "required": [ "proceedingsPOC", "proceedingsAlternatePOC" ], "title": "ProceedingsPointsOfContact", "type": "object" }, "ResponsibilityInformation": { "properties": { "recordType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtype" }, "recordTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtypedesc" }, "recordDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recorddate" }, "procurementIdOrFederalAssistanceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Procurementidorfederalassistanceid" }, "referenceIdvPiid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceidvpiid" }, "attachment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attachment" } }, "required": [ "recordType", "recordTypeDesc", "recordDate", "procurementIdOrFederalAssistanceId", "referenceIdvPiid", "attachment" ], "title": "ResponsibilityInformation", "type": "object" } }, "required": [ "entitySummary", "proceedingsData", "responsibilityInformationCount", "responsibilityInformationList", "corporateRelationships" ] }
- Fields:
- field corporate_relationships: CorporateRelationships | None [Required] (alias 'corporateRelationships')
- field entity_summary: EntitySummary | None [Required] (alias 'entitySummary')
- field proceedings_data: ProceedingsData | None [Required] (alias 'proceedingsData')
- field responsibility_information_count: str | int [Required] (alias 'responsibilityInformationCount')
- field responsibility_information_list: List[ResponsibilityInformation] | None [Required] (alias 'responsibilityInformationList')
- pydantic model procurement_tools.models.entity.Naics
Show JSON schema
{ "title": "Naics", "type": "object", "properties": { "naicsCode": { "title": "Naicscode", "type": "string" }, "naicsDescription": { "title": "Naicsdescription", "type": "string" }, "sbaSmallBusiness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbasmallbusiness" }, "naicsException": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Naicsexception" } }, "required": [ "naicsCode", "naicsDescription", "sbaSmallBusiness", "naicsException" ] }
- Fields:
- field naics_code: str [Required] (alias 'naicsCode')
- field naics_description: str [Required] (alias 'naicsDescription')
- field naics_exception: str | None [Required] (alias 'naicsException')
- field sba_small_business: str | None [Required] (alias 'sbaSmallBusiness')
- pydantic model procurement_tools.models.entity.PDFLinks
Show JSON schema
{ "title": "PDFLinks", "type": "object", "properties": { "farPDF": { "title": "Farpdf", "type": "string" }, "farAndDfarsPDF": { "title": "Faranddfarspdf", "type": "string" }, "architectEngineeringPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Architectengineeringpdf" }, "financialAssistanceCertificationsPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Financialassistancecertificationspdf" } }, "required": [ "farPDF", "farAndDfarsPDF", "architectEngineeringPDF", "financialAssistanceCertificationsPDF" ] }
- Fields:
- field architect_engineering_pdf: str | None [Required] (alias 'architectEngineeringPDF')
- field far_and_dfars_pdf: str [Required] (alias 'farAndDfarsPDF')
- field far_pdf: str [Required] (alias 'farPDF')
- field financial_assistance_certifications_pdf: str | None [Required] (alias 'financialAssistanceCertificationsPDF')
- pydantic model procurement_tools.models.entity.POC
Show JSON schema
{ "title": "POC", "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ] }
- Fields:
- field address_line1: str | None [Required] (alias 'addressLine1')
- field address_line2: str | None [Required] (alias 'addressLine2')
- field city: str | None [Required]
- field country_code: str | None [Required] (alias 'countryCode')
- field first_name: str | None [Required] (alias 'firstName')
- field last_name: str | None [Required] (alias 'lastName')
- field middle_initial: str | None [Required] (alias 'middleInitial')
- field state_or_province_code: str | None [Required] (alias 'stateOrProvinceCode')
- field title: str | None [Required]
- field zip_code: str | None [Required] (alias 'zipCode')
- field zip_code_plus4: str | None [Required] (alias 'zipCodePlus4')
- pydantic model procurement_tools.models.entity.POCData
Show JSON schema
{ "title": "POCData", "type": "object", "properties": { "governmentBusinessPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "electronicBusinessPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "governmentBusinessAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "electronicBusinessAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "pastPerformancePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "pastPerformanceAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "$defs": { "POC": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "POC", "type": "object" } }, "required": [ "governmentBusinessPOC", "electronicBusinessPOC", "governmentBusinessAlternatePOC", "electronicBusinessAlternatePOC", "pastPerformancePOC", "pastPerformanceAlternatePOC" ] }
- Fields:
electronic_business_POC (procurement_tools.models.entity.POC | None)electronic_business_alternate_POC (procurement_tools.models.entity.POC | None)government_business_POC (procurement_tools.models.entity.POC | None)government_business_alternate_POC (procurement_tools.models.entity.POC | None)past_performance_POC (procurement_tools.models.entity.POC | None)past_performance_alternate_POC (procurement_tools.models.entity.POC | None)
- field electronic_business_alternate_POC: POC | None [Required] (alias 'electronicBusinessAlternatePOC')
- pydantic model procurement_tools.models.entity.Proceeding
Show JSON schema
{ "title": "Proceeding", "type": "object", "properties": { "proceedingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdate" }, "instrumentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrumentnumber" }, "instrument": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument" }, "proceedingStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingstatecode" }, "proceedingType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingtype" }, "disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition" }, "proceedingDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdescription" } }, "required": [ "proceedingDate", "instrumentNumber", "instrument", "proceedingStateCode", "proceedingType", "disposition", "proceedingDescription" ] }
- Fields:
- field disposition: str | None [Required]
- field instrument: str | None [Required]
- field instrument_number: str | None [Required] (alias 'instrumentNumber')
- field proceeding_date: str | None [Required] (alias 'proceedingDate')
- field proceeding_description: str | None [Required] (alias 'proceedingDescription')
- field proceeding_state_code: str | None [Required] (alias 'proceedingStateCode')
- field proceeding_type: str | None [Required] (alias 'proceedingType')
- pydantic model procurement_tools.models.entity.ProceedingsData
Show JSON schema
{ "title": "ProceedingsData", "type": "object", "properties": { "proceedingsQuestion1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion1" }, "proceedingsQuestion2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion2" }, "proceedingsQuestion3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingsquestion3" }, "proceedingsRecordCount": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Proceedingsrecordcount" }, "listOfProceedings": { "items": { "$ref": "#/$defs/Proceeding" }, "title": "Listofproceedings", "type": "array" }, "proceedingsPointsOfContact": { "anyOf": [ { "$ref": "#/$defs/ProceedingsPointsOfContact" }, { "type": "null" } ] } }, "$defs": { "POC": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "POC", "type": "object" }, "Proceeding": { "properties": { "proceedingDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdate" }, "instrumentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrumentnumber" }, "instrument": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument" }, "proceedingStateCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingstatecode" }, "proceedingType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingtype" }, "disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition" }, "proceedingDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Proceedingdescription" } }, "required": [ "proceedingDate", "instrumentNumber", "instrument", "proceedingStateCode", "proceedingType", "disposition", "proceedingDescription" ], "title": "Proceeding", "type": "object" }, "ProceedingsPointsOfContact": { "properties": { "proceedingsPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "proceedingsAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "required": [ "proceedingsPOC", "proceedingsAlternatePOC" ], "title": "ProceedingsPointsOfContact", "type": "object" } }, "required": [ "proceedingsQuestion1", "proceedingsQuestion2", "proceedingsQuestion3", "proceedingsRecordCount", "listOfProceedings", "proceedingsPointsOfContact" ] }
- Fields:
- field list_of_proceedings: List[Proceeding] [Required] (alias 'listOfProceedings')
- field proceedings_points_of_contact: ProceedingsPointsOfContact | None [Required] (alias 'proceedingsPointsOfContact')
- field proceedings_question1: str | None [Required] (alias 'proceedingsQuestion1')
- field proceedings_question2: str | None [Required] (alias 'proceedingsQuestion2')
- field proceedings_question3: str | None [Required] (alias 'proceedingsQuestion3')
- field proceedings_record_count: str | int | None [Required] (alias 'proceedingsRecordCount')
- pydantic model procurement_tools.models.entity.ProceedingsPointsOfContact
Show JSON schema
{ "title": "ProceedingsPointsOfContact", "type": "object", "properties": { "proceedingsPOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] }, "proceedingsAlternatePOC": { "anyOf": [ { "$ref": "#/$defs/POC" }, { "type": "null" } ] } }, "$defs": { "POC": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "addressLine1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline1" }, "addressLine2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Addressline2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "stateOrProvinceCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stateorprovincecode" }, "zipCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcode" }, "zipCodePlus4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zipcodeplus4" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Countrycode" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "addressLine1", "addressLine2", "city", "stateOrProvinceCode", "zipCode", "zipCodePlus4", "countryCode" ], "title": "POC", "type": "object" } }, "required": [ "proceedingsPOC", "proceedingsAlternatePOC" ] }
- Fields:
- pydantic model procurement_tools.models.entity.ProductServiceCode
Show JSON schema
{ "title": "ProductServiceCode", "type": "object", "properties": { "pscCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Psccode" }, "pscDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pscdescription" } }, "required": [ "pscCode", "pscDescription" ] }
- field psc_code: str | None [Required] (alias 'pscCode')
- field psc_description: str | None [Required] (alias 'pscDescription')
- pydantic model procurement_tools.models.entity.Qualifications
Show JSON schema
{ "title": "Qualifications", "type": "object", "properties": { "architectEngineerResponses": { "anyOf": [ { "$ref": "#/$defs/FARResponse" }, { "type": "null" } ] } }, "$defs": { "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "FARAnswer": { "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ], "title": "FARAnswer", "type": "object" }, "FARResponse": { "properties": { "provisionId": { "title": "Provisionid", "type": "string" }, "listOfAnswers": { "items": { "$ref": "#/$defs/FARAnswer" }, "title": "Listofanswers", "type": "array" } }, "required": [ "provisionId", "listOfAnswers" ], "title": "FARResponse", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" } }, "required": [ "architectEngineerResponses" ] }
- field architect_engineer_responses: FARResponse | None [Required] (alias 'architectEngineerResponses')
- pydantic model procurement_tools.models.entity.Registration
Basic registration information for an entity
Show JSON schema
{ "title": "Registration", "description": "Basic registration information for an entity", "type": "object", "properties": { "samRegistered": { "enum": [ "Yes", "No" ], "title": "Samregistered", "type": "string" }, "ueiSAM": { "title": "Ueisam", "type": "string" }, "entityEFTIndicator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entityeftindicator" }, "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "dodaac": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dodaac" }, "legalBusinessName": { "title": "Legalbusinessname", "type": "string" }, "dbaName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dbaname" }, "purposeOfRegistrationCode": { "title": "Purposeofregistrationcode", "type": "string" }, "purposeOfRegistrationDesc": { "title": "Purposeofregistrationdesc", "type": "string" }, "registrationStatus": { "title": "Registrationstatus", "type": "string" }, "evsSource": { "title": "Evssource", "type": "string" }, "registrationDate": { "title": "Registrationdate", "type": "string" }, "lastUpdateDate": { "title": "Lastupdatedate", "type": "string" }, "registrationExpirationDate": { "title": "Registrationexpirationdate", "type": "string" }, "activationDate": { "title": "Activationdate", "type": "string" }, "ueiStatus": { "title": "Ueistatus", "type": "string" }, "ueiExpirationDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ueiexpirationdate" }, "ueiCreationDate": { "title": "Ueicreationdate", "type": "string" }, "publicDisplayFlag": { "title": "Publicdisplayflag", "type": "string" }, "exclusionStatusFlag": { "title": "Exclusionstatusflag", "type": "string" }, "exclusionURL": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Exclusionurl" }, "dnbOpenData": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dnbopendata" } }, "required": [ "samRegistered", "ueiSAM", "entityEFTIndicator", "cageCode", "dodaac", "legalBusinessName", "dbaName", "purposeOfRegistrationCode", "purposeOfRegistrationDesc", "registrationStatus", "evsSource", "registrationDate", "lastUpdateDate", "registrationExpirationDate", "activationDate", "ueiStatus", "ueiExpirationDate", "ueiCreationDate", "publicDisplayFlag", "exclusionStatusFlag", "exclusionURL", "dnbOpenData" ] }
- Fields:
- field activation_date: str [Required] (alias 'activationDate')
- field cage: str | None [Required] (alias 'cageCode')
- field dba_name: str | None [Required] (alias 'dbaName')
- field dodaac: str | None [Required]
- field dun_bradstreet_open_data: str | None [Required] (alias 'dnbOpenData')
- field eft: str | None [Required] (alias 'entityEFTIndicator')
- field evs_source: str [Required] (alias 'evsSource')
- field exclusion_status_flag: str [Required] (alias 'exclusionStatusFlag')
- field exclusion_url: Url | None [Required] (alias 'exclusionURL')
- field expiration_date: str [Required] (alias 'registrationExpirationDate')
- field last_update_date: str [Required] (alias 'lastUpdateDate')
- field legal_name: str [Required] (alias 'legalBusinessName')
- field public_display_flag: str [Required] (alias 'publicDisplayFlag')
- field purpose_code: str [Required] (alias 'purposeOfRegistrationCode')
- field purpose_description: str [Required] (alias 'purposeOfRegistrationDesc')
- field registered: Literal['Yes', 'No'] [Required] (alias 'samRegistered')
- field registration_date: str [Required] (alias 'registrationDate')
- field status: str [Required] (alias 'registrationStatus')
- field uei: str [Required] (alias 'ueiSAM')
- field uei_creation_date: str [Required] (alias 'ueiCreationDate')
- field uei_expiration_date: str | None [Required] (alias 'ueiExpirationDate')
- field uei_status: str [Required] (alias 'ueiStatus')
- pydantic model procurement_tools.models.entity.RepsAndCerts
Show JSON schema
{ "title": "RepsAndCerts", "type": "object", "properties": { "certifications": { "$ref": "#/$defs/Certifications" }, "qualifications": { "$ref": "#/$defs/Qualifications" }, "financialAssistanceCertifications": { "$ref": "#/$defs/FinancialAssistanceCertifications" }, "pdfLinks": { "$ref": "#/$defs/PDFLinks" } }, "$defs": { "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Certifications": { "properties": { "fARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Farresponses", "type": "array" }, "dFARResponses": { "items": { "$ref": "#/$defs/FARResponse" }, "title": "Dfarresponses", "type": "array" } }, "required": [ "fARResponses", "dFARResponses" ], "title": "Certifications", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "FARAnswer": { "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ], "title": "FARAnswer", "type": "object" }, "FARResponse": { "properties": { "provisionId": { "title": "Provisionid", "type": "string" }, "listOfAnswers": { "items": { "$ref": "#/$defs/FARAnswer" }, "title": "Listofanswers", "type": "array" } }, "required": [ "provisionId", "listOfAnswers" ], "title": "FARResponse", "type": "object" }, "FinancialAssistanceCertifications": { "properties": { "grantsCertificationStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertificationstatus" }, "grantsCertifyingResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grantscertifyingresponse" }, "certifierFirstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierfirstname" }, "certifierLastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifierlastname" }, "certifierMiddleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certifiermiddleinitial" } }, "required": [ "grantsCertificationStatus", "grantsCertifyingResponse", "certifierFirstName", "certifierLastName", "certifierMiddleInitial" ], "title": "FinancialAssistanceCertifications", "type": "object" }, "PDFLinks": { "properties": { "farPDF": { "title": "Farpdf", "type": "string" }, "farAndDfarsPDF": { "title": "Faranddfarspdf", "type": "string" }, "architectEngineeringPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Architectengineeringpdf" }, "financialAssistanceCertificationsPDF": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Financialassistancecertificationspdf" } }, "required": [ "farPDF", "farAndDfarsPDF", "architectEngineeringPDF", "financialAssistanceCertificationsPDF" ], "title": "PDFLinks", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" }, "Qualifications": { "properties": { "architectEngineerResponses": { "anyOf": [ { "$ref": "#/$defs/FARResponse" }, { "type": "null" } ] } }, "required": [ "architectEngineerResponses" ], "title": "Qualifications", "type": "object" } }, "required": [ "certifications", "qualifications", "financialAssistanceCertifications", "pdfLinks" ] }
- Fields:
- field certifications: Certifications [Required]
- field financial_assistance_certifications: FinancialAssistanceCertifications [Required] (alias 'financialAssistanceCertifications')
- field qualifications: Qualifications [Required]
- pydantic model procurement_tools.models.entity.ResponsibilityInformation
Show JSON schema
{ "title": "ResponsibilityInformation", "type": "object", "properties": { "recordType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtype" }, "recordTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordtypedesc" }, "recordDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recorddate" }, "procurementIdOrFederalAssistanceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Procurementidorfederalassistanceid" }, "referenceIdvPiid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceidvpiid" }, "attachment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attachment" } }, "required": [ "recordType", "recordTypeDesc", "recordDate", "procurementIdOrFederalAssistanceId", "referenceIdvPiid", "attachment" ] }
- Fields:
- field attachment: str | None [Required]
- field procurement_id_or_federal_assistance_id: str | None [Required] (alias 'procurementIdOrFederalAssistanceId')
- field record_date: str | None [Required] (alias 'recordDate')
- field record_type: str | None [Required] (alias 'recordType')
- field record_type_desc: str | None [Required] (alias 'recordTypeDesc')
- field reference_idv_piid: str | None [Required] (alias 'referenceIdvPiid')
- pydantic model procurement_tools.models.entity.SBABusinessType
SBA certifications (e.g., 8(a))
Show JSON schema
{ "title": "SBABusinessType", "description": "SBA certifications (e.g., 8(a))", "type": "object", "properties": { "sbaBusinessTypeCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypecode" }, "sbaBusinessTypeDesc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sbabusinesstypedesc" }, "certificationEntryDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationentrydate" }, "certificationExitDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificationexitdate" } }, "required": [ "sbaBusinessTypeCode", "sbaBusinessTypeDesc", "certificationEntryDate", "certificationExitDate" ] }
- Fields:
- field certification_entry_date: str | None [Required] (alias 'certificationEntryDate')
- field certification_exit_date: str | None [Required] (alias 'certificationExitDate')
- field sba_business_type_code: str | None [Required] (alias 'sbaBusinessTypeCode')
- field sba_business_type_description: str | None [Required] (alias 'sbaBusinessTypeDesc')
FAR Reps and Certs Answers
- pydantic model procurement_tools.models.sam_entity.far_answer.ArchitectExperience
Show JSON schema
{ "title": "ArchitectExperience", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ] }
- Fields:
- field ae_id: str | None [Required] (alias 'id')
- field annual_avg_revenue_code: str | None [Required]
- field annual_avg_revenue_description: str | None [Required]
- field experience_code: str | None [Required]
- field experience_description: str | None [Required]
- pydantic model procurement_tools.models.sam_entity.far_answer.CAGE
CAGE information about the entity’s owner
Show JSON schema
{ "title": "CAGE", "description": "CAGE information about the entity's owner", "type": "object", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ] }
- Fields:
- field cage_code: str | None [Required] (alias 'cageCode')
- field cage_id: str | None [Required] (alias 'id')
- field has_owner: str | None [Required] (alias 'hasOwner')
- field legal_business_name: str | None [Required] (alias 'legalBusinessName')
- field ncage_code: str | None [Required] (alias 'ncageCode')
- pydantic model procurement_tools.models.sam_entity.far_answer.Company
A model of a company, for use in FAR responses
Show JSON schema
{ "title": "Company", "description": "A model of a company, for use in FAR responses", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ] }
- Fields:
- field company_id: str | None [Required] (alias 'id')
- field name: str | None [Required]
- field tin: str | None [Required]
- field unique_entity_id: str | None [Required] (alias 'uniqueEntityId')
- field year_established: str | None [Required] (alias 'yearEstablished')
- pydantic model procurement_tools.models.sam_entity.far_answer.DisciplineInfo
Show JSON schema
{ "title": "DisciplineInfo", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "disciplineID": { "title": "Disciplineid", "type": "string" }, "firmNumOfEmployees": { "title": "Firmnumofemployees", "type": "string" }, "branchNumOfEmployees": { "title": "Branchnumofemployees", "type": "string" }, "disciplineDescription": { "title": "Disciplinedescription", "type": "string" } }, "required": [ "id", "disciplineID", "firmNumOfEmployees", "branchNumOfEmployees", "disciplineDescription" ] }
- Fields:
- field branchNumOfEmployees: str [Required]
- field disciplineDescription: str [Required]
- field disciplineID: str [Required]
- field discipline_info_id: str [Required] (alias 'id')
- field firmNumOfEmployees: str [Required]
- pydantic model procurement_tools.models.sam_entity.far_answer.FARAnswer
Show JSON schema
{ "title": "FARAnswer", "type": "object", "properties": { "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "questionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Questiontext" }, "answerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answerid" }, "answerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answertext" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "company": { "anyOf": [ { "$ref": "#/$defs/Company" }, { "type": "null" } ] }, "highestLevelOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "immediateOwnerCage": { "anyOf": [ { "$ref": "#/$defs/CAGE" }, { "type": "null" } ] }, "personDetails": { "anyOf": [ { "$ref": "#/$defs/Person" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "$ref": "#/$defs/PointOfContact" }, { "type": "null" } ] }, "architectExperiencesList": { "default": [], "items": { "$ref": "#/$defs/ArchitectExperience" }, "title": "Architectexperienceslist", "type": "array" }, "disciplineInfoList": { "default": [], "items": {}, "title": "Disciplineinfolist", "type": "array" }, "endProductsList": { "default": [], "items": {}, "title": "Endproductslist", "type": "array" }, "foreignGovtEntitiesList": { "default": [], "items": {}, "title": "Foreigngovtentitieslist", "type": "array" }, "formerFirmsList": { "default": [], "items": {}, "title": "Formerfirmslist", "type": "array" }, "fscInfoList": { "default": [], "items": {}, "title": "Fscinfolist", "type": "array" }, "jointVentureCompaniesList": { "default": [], "items": {}, "title": "Jointventurecompanieslist", "type": "array" }, "laborSurplusConcernsList": { "default": [], "items": {}, "title": "Laborsurplusconcernslist", "type": "array" }, "naicsList": { "default": [], "items": {}, "title": "Naicslist", "type": "array" }, "predecessorsList": { "default": [], "items": {}, "title": "Predecessorslist", "type": "array" }, "samFacilitiesList": { "default": [], "items": {}, "title": "Samfacilitieslist", "type": "array" }, "samPointsOfContactList": { "default": [], "items": {}, "title": "Sampointsofcontactlist", "type": "array" }, "servicesRevenuesList": { "default": [], "items": {}, "title": "Servicesrevenueslist", "type": "array" }, "softwareList": { "default": [], "items": {}, "title": "Softwarelist", "type": "array" }, "urlList": { "default": [], "items": {}, "title": "Urllist", "type": "array" } }, "$defs": { "ArchitectExperience": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "experience_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Code" }, "experience_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experience Description" }, "annual_avg_revenue_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Code" }, "annual_avg_revenue_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Annual Avg Revenue Description" } }, "required": [ "id", "experience_code", "experience_description", "annual_avg_revenue_code", "annual_avg_revenue_description" ], "title": "ArchitectExperience", "type": "object" }, "CAGE": { "description": "CAGE information about the entity's owner", "properties": { "cageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cagecode" }, "ncageCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ncagecode" }, "legalBusinessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legalbusinessname" }, "hasOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hasowner" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "cageCode", "ncageCode", "legalBusinessName", "hasOwner", "id" ], "title": "CAGE", "type": "object" }, "Company": { "description": "A model of a company, for use in FAR responses", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin" }, "uniqueEntityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uniqueentityid" }, "yearEstablished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Yearestablished" } }, "required": [ "id", "name", "tin", "uniqueEntityId", "yearEstablished" ], "title": "Company", "type": "object" }, "Person": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ], "title": "Person", "type": "object" }, "PointOfContact": { "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ], "title": "PointOfContact", "type": "object" } }, "required": [ "section", "questionText", "answerId", "answerText", "country", "company", "highestLevelOwnerCage", "immediateOwnerCage", "personDetails", "pointOfContact" ] }
- Fields:
company (procurement_tools.models.sam_entity.far_answer.Company | None)highest_level_owner_cage (procurement_tools.models.sam_entity.far_answer.CAGE | None)immediate_owner_cage (procurement_tools.models.sam_entity.far_answer.CAGE | None)person_details (procurement_tools.models.sam_entity.far_answer.Person | None)point_of_contact (procurement_tools.models.sam_entity.far_answer.PointOfContact | None)
- field answer_id: str | None [Required] (alias 'answerId')
- field answer_text: str | None [Required] (alias 'answerText')
- field architect_experiences_list: List[ArchitectExperience] = [] (alias 'architectExperiencesList')
- field country: str | None [Required]
- field discipline_info_list: List = [] (alias 'disciplineInfoList')
- field end_products_list: List = [] (alias 'endProductsList')
- field foreign_govt_entities_list: List = [] (alias 'foreignGovtEntitiesList')
- field former_firms_list: List = [] (alias 'formerFirmsList')
- field fsc_info_list: List = [] (alias 'fscInfoList')
- field joint_venture_companies_list: List = [] (alias 'jointVentureCompaniesList')
- field labor_surplus_concerns_list: List = [] (alias 'laborSurplusConcernsList')
- field naics_list: List = [] (alias 'naicsList')
- field point_of_contact: PointOfContact | None [Required] (alias 'pointOfContact')
- field predecessors_list: List = [] (alias 'predecessorsList')
- field question_text: str | None [Required] (alias 'questionText')
- field sam_facilities_list: List = [] (alias 'samFacilitiesList')
- field sam_points_of_contact_list: List = [] (alias 'samPointsOfContactList')
- field section: str | None [Required]
- field services_revenues_list: List = [] (alias 'servicesRevenuesList')
- field software_list: List = [] (alias 'softwareList')
- field url_list: List = [] (alias 'urlList')
- pydantic model procurement_tools.models.sam_entity.far_answer.Person
Show JSON schema
{ "title": "Person", "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "firstName", "middleInitial", "lastName", "title" ] }
- Fields:
- field first_name: str | None [Required] (alias 'firstName')
- field last_name: str | None [Required] (alias 'lastName')
- field middle_initial: str | None [Required] (alias 'middleInitial')
- field title: str | None [Required]
- pydantic model procurement_tools.models.sam_entity.far_answer.PointOfContact
Show JSON schema
{ "title": "PointOfContact", "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "middleInitial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middleinitial" }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "id": { "title": "Id", "type": "string" }, "telephoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Telephonenumber" }, "extension": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extension" }, "internationalNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internationalnumber" } }, "required": [ "firstName", "middleInitial", "lastName", "title", "id", "telephoneNumber", "extension", "internationalNumber" ] }
- Fields:
- field extension: str | None [Required]
- field international_number: str | None [Required] (alias 'internationalNumber')
- field poc_id: str [Required] (alias 'id')
- field telephone_number: str | None [Required] (alias 'telephoneNumber')
SBIR Solicitations
- pydantic model procurement_tools.models.sbir.AwardList
Show JSON schema
{ "title": "AwardList", "type": "object", "properties": { "results": { "items": { "$ref": "#/$defs/Firm" }, "title": "Results", "type": "array" } }, "$defs": { "Firm": { "description": "The firm that won a SBIR award", "properties": { "firm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firm" }, "award_title": { "title": "Award Title", "type": "string" }, "agency": { "title": "Agency", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "phase": { "title": "Phase", "type": "string" }, "program": { "title": "Program", "type": "string" }, "agency_tracking_number": { "title": "Agency Tracking Number", "type": "string" }, "contract": { "title": "Contract", "type": "string" }, "proposal_award_date": { "title": "Proposal Award Date", "type": "string" }, "contract_end_date": { "title": "Contract End Date", "type": "string" }, "solicitation_number": { "title": "Solicitation Number", "type": "string" }, "solicitation_year": { "title": "Solicitation Year", "type": "string" }, "topic_code": { "title": "Topic Code", "type": "string" }, "award_year": { "title": "Award Year", "type": "string" }, "award_amount": { "title": "Award Amount", "type": "string" }, "duns": { "title": "Duns", "type": "string" }, "hubzone_owned": { "title": "Hubzone Owned", "type": "string" }, "socially_economically_disadvantaged": { "title": "Socially Economically Disadvantaged", "type": "string" }, "women_owned": { "title": "Women Owned", "type": "string" }, "number_employees": { "title": "Number Employees", "type": "string" }, "company_url": { "title": "Company Url", "type": "string" }, "address1": { "title": "Address1", "type": "string" }, "address2": { "title": "Address2", "type": "string" }, "city": { "title": "City", "type": "string" }, "state": { "title": "State", "type": "string" }, "zip": { "title": "Zip", "type": "string" }, "poc_name": { "title": "Poc Name", "type": "string" }, "poc_title": { "title": "Poc Title", "type": "string" }, "poc_phone": { "title": "Poc Phone", "type": "string" }, "poc_email": { "title": "Poc Email", "type": "string" }, "pi_name": { "title": "Pi Name", "type": "string" }, "pi_title": { "title": "Pi Title", "type": "string" }, "pi_phone": { "title": "Pi Phone", "type": "string" }, "pi_email": { "title": "Pi Email", "type": "string" }, "ri_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Name" }, "ri_poc_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Poc Name" }, "ri_poc_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Poc Phone" }, "abstract": { "title": "Abstract", "type": "string" }, "award_link": { "title": "Award Link", "type": "string" } }, "required": [ "firm", "award_title", "agency", "branch", "phase", "program", "agency_tracking_number", "contract", "proposal_award_date", "contract_end_date", "solicitation_number", "solicitation_year", "topic_code", "award_year", "award_amount", "duns", "hubzone_owned", "socially_economically_disadvantaged", "women_owned", "number_employees", "company_url", "address1", "address2", "city", "state", "zip", "poc_name", "poc_title", "poc_phone", "poc_email", "pi_name", "pi_title", "pi_phone", "pi_email", "ri_name", "ri_poc_name", "ri_poc_phone", "abstract", "award_link" ], "title": "Firm", "type": "object" } }, "required": [ "results" ] }
- pydantic model procurement_tools.models.sbir.Firm
The firm that won a SBIR award
Show JSON schema
{ "title": "Firm", "description": "The firm that won a SBIR award", "type": "object", "properties": { "firm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firm" }, "award_title": { "title": "Award Title", "type": "string" }, "agency": { "title": "Agency", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "phase": { "title": "Phase", "type": "string" }, "program": { "title": "Program", "type": "string" }, "agency_tracking_number": { "title": "Agency Tracking Number", "type": "string" }, "contract": { "title": "Contract", "type": "string" }, "proposal_award_date": { "title": "Proposal Award Date", "type": "string" }, "contract_end_date": { "title": "Contract End Date", "type": "string" }, "solicitation_number": { "title": "Solicitation Number", "type": "string" }, "solicitation_year": { "title": "Solicitation Year", "type": "string" }, "topic_code": { "title": "Topic Code", "type": "string" }, "award_year": { "title": "Award Year", "type": "string" }, "award_amount": { "title": "Award Amount", "type": "string" }, "duns": { "title": "Duns", "type": "string" }, "hubzone_owned": { "title": "Hubzone Owned", "type": "string" }, "socially_economically_disadvantaged": { "title": "Socially Economically Disadvantaged", "type": "string" }, "women_owned": { "title": "Women Owned", "type": "string" }, "number_employees": { "title": "Number Employees", "type": "string" }, "company_url": { "title": "Company Url", "type": "string" }, "address1": { "title": "Address1", "type": "string" }, "address2": { "title": "Address2", "type": "string" }, "city": { "title": "City", "type": "string" }, "state": { "title": "State", "type": "string" }, "zip": { "title": "Zip", "type": "string" }, "poc_name": { "title": "Poc Name", "type": "string" }, "poc_title": { "title": "Poc Title", "type": "string" }, "poc_phone": { "title": "Poc Phone", "type": "string" }, "poc_email": { "title": "Poc Email", "type": "string" }, "pi_name": { "title": "Pi Name", "type": "string" }, "pi_title": { "title": "Pi Title", "type": "string" }, "pi_phone": { "title": "Pi Phone", "type": "string" }, "pi_email": { "title": "Pi Email", "type": "string" }, "ri_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Name" }, "ri_poc_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Poc Name" }, "ri_poc_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ri Poc Phone" }, "abstract": { "title": "Abstract", "type": "string" }, "award_link": { "title": "Award Link", "type": "string" } }, "required": [ "firm", "award_title", "agency", "branch", "phase", "program", "agency_tracking_number", "contract", "proposal_award_date", "contract_end_date", "solicitation_number", "solicitation_year", "topic_code", "award_year", "award_amount", "duns", "hubzone_owned", "socially_economically_disadvantaged", "women_owned", "number_employees", "company_url", "address1", "address2", "city", "state", "zip", "poc_name", "poc_title", "poc_phone", "poc_email", "pi_name", "pi_title", "pi_phone", "pi_email", "ri_name", "ri_poc_name", "ri_poc_phone", "abstract", "award_link" ] }
- Fields:
- field abstract: str [Required]
- field address1: str [Required]
- field address2: str [Required]
- field agency: str [Required]
- field agency_tracking_number: str [Required]
- field award_amount: str [Required]
- field award_link: str [Required]
- field award_title: str [Required]
- field award_year: str [Required]
- field branch: str [Required]
- field city: str [Required]
- field company_url: str [Required]
- field contract: str [Required]
- field contract_end_date: str [Required]
- field duns: str [Required]
- field firm: str | None [Required]
- field hubzone_owned: str [Required]
- field number_employees: str [Required]
- field phase: str [Required]
- field pi_email: str [Required]
- field pi_name: str [Required]
- field pi_phone: str [Required]
- field pi_title: str [Required]
- field poc_email: str [Required]
- field poc_name: str [Required]
- field poc_phone: str [Required]
- field poc_title: str [Required]
- field program: str [Required]
- field proposal_award_date: str [Required]
- field ri_name: str | None [Required]
- field ri_poc_name: str | None [Required]
- field ri_poc_phone: str | None [Required]
- field socially_economically_disadvantaged: str [Required]
- field solicitation_number: str [Required]
- field solicitation_year: str [Required]
- field state: str [Required]
- field topic_code: str [Required]
- field women_owned: str [Required]
- field zip: str [Required]
- pydantic model procurement_tools.models.sbir.Solicitation
A SBIR solicitation
Show JSON schema
{ "title": "Solicitation", "description": "A SBIR solicitation", "type": "object", "properties": { "solicitation_title": { "title": "Solicitation Title", "type": "string" }, "solicitation_number": { "title": "Solicitation Number", "type": "string" }, "program": { "title": "Program", "type": "string" }, "phase": { "title": "Phase", "type": "string" }, "agency": { "title": "Agency", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "solicitation_year": { "title": "Solicitation Year", "type": "string" }, "release_date": { "title": "Release Date", "type": "string" }, "open_date": { "title": "Open Date", "type": "string" }, "close_date": { "title": "Close Date", "type": "string" }, "application_due_date": { "items": { "type": "string" }, "title": "Application Due Date", "type": "array" }, "sbir_solicitation_link": { "title": "Sbir Solicitation Link", "type": "string" }, "solicitation_agency_url": { "title": "Solicitation Agency Url", "type": "string" }, "current_status": { "title": "Current Status", "type": "string" }, "solicitation_topics": { "items": { "$ref": "#/$defs/Topic" }, "title": "Solicitation Topics", "type": "array" } }, "$defs": { "Subtopic": { "description": "A SBIR subtopic", "properties": { "subtopic_title": { "title": "Subtopic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "subtopic_number": { "title": "Subtopic Number", "type": "string" }, "subtopic_description": { "title": "Subtopic Description", "type": "string" }, "sbir_subtopic_link": { "title": "Sbir Subtopic Link", "type": "string" } }, "required": [ "subtopic_title", "branch", "subtopic_number", "subtopic_description", "sbir_subtopic_link" ], "title": "Subtopic", "type": "object" }, "Topic": { "description": "A SBIR topic", "properties": { "topic_title": { "title": "Topic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "topic_number": { "title": "Topic Number", "type": "string" }, "topic_description": { "title": "Topic Description", "type": "string" }, "sbir_topic_link": { "title": "Sbir Topic Link", "type": "string" }, "subtopics": { "items": { "$ref": "#/$defs/Subtopic" }, "title": "Subtopics", "type": "array" } }, "required": [ "topic_title", "branch", "topic_number", "topic_description", "sbir_topic_link", "subtopics" ], "title": "Topic", "type": "object" } }, "required": [ "solicitation_title", "solicitation_number", "program", "phase", "agency", "branch", "solicitation_year", "release_date", "open_date", "close_date", "application_due_date", "sbir_solicitation_link", "solicitation_agency_url", "current_status", "solicitation_topics" ] }
- field agency: str [Required]
- field application_due_date: List[str] [Required]
- field branch: str [Required]
- field close_date: str [Required]
- field current_status: str [Required]
- field open_date: str [Required]
- field phase: str [Required]
- field program: str [Required]
- field release_date: str [Required]
- field sbir_solicitation_link: str [Required]
- field solicitation_agency_url: str [Required]
- field solicitation_number: str [Required]
- field solicitation_title: str [Required]
- field solicitation_year: str [Required]
- pydantic model procurement_tools.models.sbir.SolicitationList
A list of SBIR solicitations
Show JSON schema
{ "title": "SolicitationList", "description": "A list of SBIR solicitations", "type": "object", "properties": { "results": { "items": { "$ref": "#/$defs/Solicitation" }, "title": "Results", "type": "array" } }, "$defs": { "Solicitation": { "description": "A SBIR solicitation", "properties": { "solicitation_title": { "title": "Solicitation Title", "type": "string" }, "solicitation_number": { "title": "Solicitation Number", "type": "string" }, "program": { "title": "Program", "type": "string" }, "phase": { "title": "Phase", "type": "string" }, "agency": { "title": "Agency", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "solicitation_year": { "title": "Solicitation Year", "type": "string" }, "release_date": { "title": "Release Date", "type": "string" }, "open_date": { "title": "Open Date", "type": "string" }, "close_date": { "title": "Close Date", "type": "string" }, "application_due_date": { "items": { "type": "string" }, "title": "Application Due Date", "type": "array" }, "sbir_solicitation_link": { "title": "Sbir Solicitation Link", "type": "string" }, "solicitation_agency_url": { "title": "Solicitation Agency Url", "type": "string" }, "current_status": { "title": "Current Status", "type": "string" }, "solicitation_topics": { "items": { "$ref": "#/$defs/Topic" }, "title": "Solicitation Topics", "type": "array" } }, "required": [ "solicitation_title", "solicitation_number", "program", "phase", "agency", "branch", "solicitation_year", "release_date", "open_date", "close_date", "application_due_date", "sbir_solicitation_link", "solicitation_agency_url", "current_status", "solicitation_topics" ], "title": "Solicitation", "type": "object" }, "Subtopic": { "description": "A SBIR subtopic", "properties": { "subtopic_title": { "title": "Subtopic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "subtopic_number": { "title": "Subtopic Number", "type": "string" }, "subtopic_description": { "title": "Subtopic Description", "type": "string" }, "sbir_subtopic_link": { "title": "Sbir Subtopic Link", "type": "string" } }, "required": [ "subtopic_title", "branch", "subtopic_number", "subtopic_description", "sbir_subtopic_link" ], "title": "Subtopic", "type": "object" }, "Topic": { "description": "A SBIR topic", "properties": { "topic_title": { "title": "Topic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "topic_number": { "title": "Topic Number", "type": "string" }, "topic_description": { "title": "Topic Description", "type": "string" }, "sbir_topic_link": { "title": "Sbir Topic Link", "type": "string" }, "subtopics": { "items": { "$ref": "#/$defs/Subtopic" }, "title": "Subtopics", "type": "array" } }, "required": [ "topic_title", "branch", "topic_number", "topic_description", "sbir_topic_link", "subtopics" ], "title": "Topic", "type": "object" } }, "required": [ "results" ] }
- field results: List[Solicitation] [Required]
- pydantic model procurement_tools.models.sbir.Subtopic
A SBIR subtopic
Show JSON schema
{ "title": "Subtopic", "description": "A SBIR subtopic", "type": "object", "properties": { "subtopic_title": { "title": "Subtopic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "subtopic_number": { "title": "Subtopic Number", "type": "string" }, "subtopic_description": { "title": "Subtopic Description", "type": "string" }, "sbir_subtopic_link": { "title": "Sbir Subtopic Link", "type": "string" } }, "required": [ "subtopic_title", "branch", "subtopic_number", "subtopic_description", "sbir_subtopic_link" ] }
- Fields:
- field branch: str [Required]
- field sbir_subtopic_link: str [Required]
- field subtopic_description: str [Required]
- field subtopic_number: str [Required]
- field subtopic_title: str [Required]
- pydantic model procurement_tools.models.sbir.Topic
A SBIR topic
Show JSON schema
{ "title": "Topic", "description": "A SBIR topic", "type": "object", "properties": { "topic_title": { "title": "Topic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "topic_number": { "title": "Topic Number", "type": "string" }, "topic_description": { "title": "Topic Description", "type": "string" }, "sbir_topic_link": { "title": "Sbir Topic Link", "type": "string" }, "subtopics": { "items": { "$ref": "#/$defs/Subtopic" }, "title": "Subtopics", "type": "array" } }, "$defs": { "Subtopic": { "description": "A SBIR subtopic", "properties": { "subtopic_title": { "title": "Subtopic Title", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "subtopic_number": { "title": "Subtopic Number", "type": "string" }, "subtopic_description": { "title": "Subtopic Description", "type": "string" }, "sbir_subtopic_link": { "title": "Sbir Subtopic Link", "type": "string" } }, "required": [ "subtopic_title", "branch", "subtopic_number", "subtopic_description", "sbir_subtopic_link" ], "title": "Subtopic", "type": "object" } }, "required": [ "topic_title", "branch", "topic_number", "topic_description", "sbir_topic_link", "subtopics" ] }
- Fields:
- field branch: str [Required]
- field sbir_topic_link: str [Required]
- field topic_description: str [Required]
- field topic_number: str [Required]
- field topic_title: str [Required]