diff --git a/_apidocs/entity-api.md b/_apidocs/entity-api.md index da8bec201..949122f75 100644 --- a/_apidocs/entity-api.md +++ b/_apidocs/entity-api.md @@ -8809,8 +8809,7 @@ You can view the full details of this API in the OpenAPI Specification file avai

Back to top

## Additional Help References -1. Reps and Certs Mapping -2. Data Dictionary +Go to SAM.gov Data Services for Reps and Certs Mapping and Data Dictionary documents. ## HTTP Response Codes @@ -12354,5 +12353,6 @@ Disclaimer: | 02/28/2023 | v4.2 | * Removed MPIN occurrences from the Data Dictionary and the "Overview" > "Sensitive (CUI) Data" section.

* Indicated that MPIN has been deprecated in the "Response Schema" > "coreData" > "entityInformation Sub Section". | 06/27/2023 | v4.3 | * Uploaded a revised Data Dictionary with updated Socio Economic Self Selections. | 08/22/2023 | v4.4 | * Uploaded a revised Data Dictionary with updated Business Types. +| 09/29/2023 | v4.5 | * Updated "Additional Help References" documentation to link to SAM.gov Data Services page.

Back to top

\ No newline at end of file diff --git a/_apidocs/exclusions-api.md b/_apidocs/exclusions-api.md index 36cd57733..994d989c2 100644 --- a/_apidocs/exclusions-api.md +++ b/_apidocs/exclusions-api.md @@ -4,7 +4,7 @@ banner-heading: SAM.gov Exclusions API --- ## Overview -The Exclusions API will allow users to request Public Exclusion Information based on various optional request parameters. +The Exclusions API will allow users to request Public Exclusion Information based on various optional request parameters. The response will be provided in the JSON format in a paginated manner. **Key Features of the Exclusion API:** @@ -30,15 +30,16 @@ Exclusions API can be accessed from Production or Alpha via the following versio * Production Version 1: https://api.sam.gov/entity-information/v1/exclusions?api_key=< value > * Production Version 2: https://api.sam.gov/entity-information/v2/exclusions?api_key=< value > * Production Version 3: https://api.sam.gov/entity-information/v3/exclusions?api_key=< value > +* Production Version 4: https://api.sam.gov/entity-information/v4/exclusions?api_key=< value > * Alpha Version 1: https://api-alpha.sam.gov/entity-information/v1/exclusions?api_key=< value > * Alpha Version 2: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< value > -* Alpha Version 3: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< value >

- +* Alpha Version 3: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< value > +* Alpha Version 4: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< value >

Generating a personal API Key: * Registered users can request for a public API on 'Account Details' page. This page can be accessed here: Account Details page on sam.gov -* Users must enter their password on ‘Account Details’ page to view the API Key information. If an incorrect password is entered, an error will be returned. -* After the API Key is generated on ‘Account Details’ page, the API Key can be viewed on the Account Details page immediately. The API Key is visible until users navigate to a different page. +* Users must enter their password on ‘Account Details’ page to view the API Key information. If an incorrect password is entered, an error will be returned. +* After the API Key is generated on ‘Account Details’ page, the API Key can be viewed on the Account Details page immediately. The API Key is visible until users navigate to a different page. * If an error is encountered during the API Key generation/retrieval, then users will receive an error message and they can try again. Generating a System Account API Key: @@ -99,129 +100,131 @@ Utilizing the Exclusion API as an extract: **Query String Parameters** -| Parameter Name | Description | Applicable Versions | -| ---- | ----------- | ----------- | -| classification | Allows a partial text or a complete text (Individual, Firm, Vessel, Special Entity Designation).

This parameter can be used inside the 'q' parameter.

Example: 'classification=Firm', 'classification=!INDIVIDUAL', 'classification=[Vessel~Special]', 'q=((classification:Vessel) OR (classification:Special))' | v1
v2
v3 | -| exclusionName | Allows a partial text or a complete text.

This parameter must not be used inside the 'q' parameter.

This parameter accepts multi-text values in any order and in any case, and will apply the AND operator between the texts.

Examples: 'exclusionName=J Roy', 'exclusionName=ROY j' | v1
v2
v3 | -| exclusionType | Allows a partial text or a complete text (a string).

Allowable values are: Ineligible (Proceedings Pending), Ineligible (Proceedings Completed), Prohibition/Restriction and Voluntary Exclusion.

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case.

Examples: 'q=exclusionType:Ineligible (Proceedings Pending)', 'exclusionType=Ineligible PENDING', 'exclusionType=[Pending~Voluntary]' | v1
v2
v3 | -| exclusionProgram | Allows a complete text (a string).

Allowable values are: Reciprocal, NonProcurement and Procurement.

This parameter can be used inside the 'q' parameter.

Examples: 'q=((exclusionProgram:Reciprocal) OR (exclusionProgram:Procurement))', 'exclusionProgram=[NonProcurement~RECIPROCAL]', 'exclusionProgram=!NonProcurement'| v1
v2
v3 | -| addressLine1 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine1=""', 'addressLine1="7th Floor, Buraengdang Building 530-14"'

NOTE: If addressLine1 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3 | -| addressLine2 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine2=""', 'addressLine2="Dapsipri, 5 Dong, Dongdaemun-K"'

NOTE: If addressLine2 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3 | -| stateProvince | Allows 2-character codes for the USA, names for foreign countries and null (a string).

Examples: 'stateProvince=AR', 'stateProvince=[VA~MICHOACÁN]', 'stateProvince=""' | v1
v2
v3 | -| country | Allows 3-character codes, numerical values and null (a string).

Examples: 'country=USA' 'country=[RUS~292~mex]', 'country=!""', 'q=((country:RUS) OR (country:292) OR (country:mex))' | v1
v2
v3 | -| zipCode | Allows 5-digit values for the USA, any value as it was provided for foreign countries and null (a string).

Example: 'zipCode=20171', 'zipCode=[901-2132~V3M 5P8~C.P. 44890]', 'zipCode=""', 'q=((zipCode:901-2132) OR (zipCode:20147))' | v1
v2
v3 | -| ueiSAM | Denotes Unique Entity Identifier SAM.

Allows 12-character values, null and also wildcard searches.

Examples: 'ueiSAM=""', 'ueiSAM=!""', 'ueiSAM=P*X*1', 'q=((ueiSAM:PMC9YQMXJZU1) OR (ueiSAM:PG4XZ77WRC21))' | v1
v2
v3 | -| excludingAgencyCode | Allows a partial text, a complete text and null (a string).

Examples: 'excludingAgencyCode=ICE', 'excludingAgencyCode=DHS-ICE', 'excludingAgencyCode=[AF~HUD~""]', 'q=((excludingAgencyCode:AF) OR (excludingAgencyCode:HUD))' | v1
v2
v3 | -| excludingAgencyName | Allows a partial text, a complete text and null (a string).

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case

Examples: 'excludingAgencyName=Of URBAN housing', 'excludingAgencyName=[Geological~Navy]', q=((excludingAgencyName:Geological) OR (excludingAgencyName:Navy)) | v1
v2
v3 | -| ctCode | Allows a complete text, null and also wild card searches (a string).

Examples: 'ctCode=*SDN*', 'ctCode=[AA~""], 'q=((ctCode:AA) OR (ctCode:03-SDN-01))' | v1
v2
v3 | -| activationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'activationDate=01/01/2019', 'activationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| creationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'creationDate=01/01/2019', 'creationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| updateDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'updateDate=01/01/2019', 'updateDate=[01/01/2019,05/29/2019]'' | v1
v2
v3 | -| terminationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'terminationDate=01/01/2019', 'terminationDate=[01/01/2019,05/29/2019]' | v1
v2
v3 | -| cageCode | Allows a complete value, null and also wild card searches (a string).

Examples: 'cageCode=0*0', 'cageCode=[0XLE0~1CM51~""]', 'q=((cageCode:0XLE0) OR (cageCode:1CM51))' | v1
v2
v3 | -| npi | Allows 1234567890 (this is masked data) and null (a string).

Examples: 'npi=1234567890', 'npi=""', 'npi=!""' | v1
v2
v3 | -| recordStatus | The API returns only Active records.

Allows a complete text (a string).

Allowable value is: Active, active

Example: 'recordStatus=active' | v1
v2
v3 | -| page | Denotes a page number.

Allowable values are 0 to 999.

Example: 'page=0' | v1
v2
v3 | -| size | Denotes the number of records returned per page.

Allowable values are 1 to 10.

Example: 'size=1' | v1
v2
v3 | -| includeSections | Allows to filter data by sections, exclusionDetails, exclusionIdentification, exclusionActions, exclusionAddress, exclusionOtherInformation and vesselDetails.

Example: 'includeSections=exclusionOtherInformation,exclusionDetails' | v1
v2
v3 | -| format | Allows user to download different file formats(csv and json are allowable values) .

Example: 'format=csv' | v1
v2
v3 | -| emailId | Allows user to get file download links sent to the email address associated to the API key used in the request. Email ID must be provided in conjunction with the format parameter.
Example: emailId= Yes
Applicable to non-SAM registrants. | v1
v2
v3 | -| ssnOrTinOrEin | Allows a 9-digit value or null.

This parameter must not be used inside the 'q' parameter.

This parameter must be used in conjunction with the exclusionName parameter.

Example: 'ssnOrTinOrEin=123456789' | v1
v2
v3 | +| Parameter Name | Description | Applicable Versions | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| classification | Allows a partial text or a complete text (Individual, Firm, Vessel, Special Entity Designation).

This parameter can be used inside the 'q' parameter.

Example: 'classification=Firm', 'classification=!INDIVIDUAL', 'classification=[Vessel~Special]', 'q=((classification:Vessel) OR (classification:Special))' | v1
v2
v3
v4 | +| exclusionName | Allows a partial text or a complete text.

This parameter must not be used inside the 'q' parameter.

This parameter accepts multi-text values in any order and in any case, and will apply the AND operator between the texts.

Examples: 'exclusionName=J Roy', 'exclusionName=ROY j' | v1
v2
v3
v4 | +| exclusionType | Allows a partial text or a complete text (a string).

Allowable values are: Ineligible (Proceedings Pending), Ineligible (Proceedings Completed), Prohibition/Restriction and Voluntary Exclusion.

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case.

Examples: 'q=exclusionType:Ineligible (Proceedings Pending)', 'exclusionType=Ineligible PENDING', 'exclusionType=[Pending~Voluntary]' | v1
v2
v3
v4 | +| exclusionProgram | Allows a complete text (a string).

Allowable values are: Reciprocal, NonProcurement and Procurement.

This parameter can be used inside the 'q' parameter.

Examples: 'q=((exclusionProgram:Reciprocal) OR (exclusionProgram:Procurement))', 'exclusionProgram=[NonProcurement~RECIPROCAL]', 'exclusionProgram=!NonProcurement' | v1
v2
v3
v4 | +| addressLine1 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine1=""', 'addressLine1="7th Floor, Buraengdang Building 530-14"'

NOTE: If addressLine1 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3
v4 | +| addressLine2 | Mainly used to search Individuals with their address. Allows a partial text, a complete text and null.

This parameter must not be used inside the 'q' parameter.

Examples: 'addressLine2=""', 'addressLine2="Dapsipri, 5 Dong, Dongdaemun-K"'

NOTE: If addressLine2 is used in a request with exclusionName, it must match 85% of an Individual's address in order for the address information to be returned in the response (not case sensitive). | v1
v2
v3
v4 | +| stateProvince | Allows 2-character codes for the USA, names for foreign countries and null (a string).

Examples: 'stateProvince=AR', 'stateProvince=[VA~MICHOACÁN]', 'stateProvince=""' | v1
v2
v3
v4 | +| country | Allows 3-character codes, numerical values and null (a string).

Examples: 'country=USA' 'country=[RUS~292~mex]', 'country=!""', 'q=((country:RUS) OR (country:292) OR (country:mex))' | v1
v2
v3
v4 | +| zipCode | Allows 5-digit values for the USA, any value as it was provided for foreign countries and null (a string).

Example: 'zipCode=20171', 'zipCode=[901-2132~V3M 5P8~C.P. 44890]', 'zipCode=""', 'q=((zipCode:901-2132) OR (zipCode:20147))' | v1
v2
v3
v4 | +| ueiSAM | Denotes Unique Entity Identifier SAM.

Allows 12-character values, null and also wildcard searches.

Examples: 'ueiSAM=""', 'ueiSAM=!""', 'ueiSAM=P*X*1', 'q=((ueiSAM:PMC9YQMXJZU1) OR (ueiSAM:PG4XZ77WRC21))' | v1
v2
v3
v4 | +| excludingAgencyCode | Allows a partial text, a complete text and null (a string).

Examples: 'excludingAgencyCode=ICE', 'excludingAgencyCode=DHS-ICE', 'excludingAgencyCode=[AF~HUD~""]', 'q=((excludingAgencyCode:AF) OR (excludingAgencyCode:HUD))' | v1
v2
v3
v4 | +| excludingAgencyName | Allows a partial text, a complete text and null (a string).

This parameter can be used inside the 'q' parameter. When not used inside the 'q' parameter, this parameter will apply the AND operator if a multi-text value is provided in any order and in any case

Examples: 'excludingAgencyName=Of URBAN housing', 'excludingAgencyName=[Geological~Navy]', q=((excludingAgencyName:Geological) OR (excludingAgencyName:Navy)) | v1
v2
v3
v4 | +| ctCode | Allows a complete text, null and also wild card searches (a string).

Examples: 'ctCode=*SDN*', 'ctCode=[AA~""], 'q=((ctCode:AA) OR (ctCode:03-SDN-01))' | v1
v2
v3
v4 | +| activationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'activationDate=01/01/2019', 'activationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| creationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'creationDate=01/01/2019', 'creationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| updateDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'updateDate=01/01/2019', 'updateDate=[01/01/2019,05/29/2019]'' | v1
v2
v3
v4 | +| terminationDate | Allows a single Date or Date range.
Formats: MM/DD/YYYY or [MM/DD/YYYY,MM/DD/YYYY]

Examples: 'terminationDate=01/01/2019', 'terminationDate=[01/01/2019,05/29/2019]' | v1
v2
v3
v4 | +| cageCode | Allows a complete value, null and also wild card searches (a string).

Examples: 'cageCode=0*0', 'cageCode=[0XLE0~1CM51~""]', 'q=((cageCode:0XLE0) OR (cageCode:1CM51))' | v1
v2
v3
v4 | +| npi | Allows 1234567890 (this is masked data) and null (a string).

Examples: 'npi=1234567890', 'npi=""', 'npi=!""' | v1
v2
v3
v4 | +| recordStatus | The API returns only Active records.

Allows a complete text (a string).

Allowable value is: Active, active

Example: 'recordStatus=active' | v1
v2
v3
v4 | +| page | Denotes a page number.

Allowable values are 0 to 999.

Example: 'page=0' | v1
v2
v3
v4 | +| size | Denotes the number of records returned per page.

Allowable values are 1 to 10.

Example: 'size=1' | v1
v2
v3
v4 | +| includeSections | Allows to filter data by sections, exclusionDetails, exclusionIdentification, exclusionActions, exclusionAddress, exclusionOtherInformation and vesselDetails.

Example: 'includeSections=exclusionOtherInformation,exclusionDetails' | v1
v2
v3
v4 | +| format | Allows user to download different file formats(csv and json are allowable values) .

Example: 'format=csv' | v1
v2
v3
v4 | +| emailId | Allows user to get file download links sent to the email address associated to the API key used in the request. Email ID must be provided in conjunction with the format parameter.
Example: emailId= Yes
Applicable to non-SAM registrants. | v1
v2
v3
v4 | +| ssnOrTinOrEin | Allows a 9-digit value or null.

This parameter must not be used inside the 'q' parameter.

This parameter must be used in conjunction with the exclusionName parameter.

Example: 'ssnOrTinOrEin=123456789' | v1
v2
v3
v4 | +| fascsaOrder | Allows Yes and No.

This parameter accepts either value, in any case.

Examples: fascsaOrder=Yes, fascsaOrder=yes, fascsaOrder=No, fascsaOrder=no | v4 | **Expected Result** API response consists of Sections, Sub-sections and Tags underneath each of the Sections or Sub-sections. There are a few placeholder elements that return ‘Currently Not Available’ until they are made available in the database. Additionally, -| Section/Sub-section/Tag | Type | Description | Applicable Versions | -|----------------------------------------------------------------------| ---- |---------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Section/Sub-section/Tag | Type | Description | Applicable Versions | +|----------------------------------------------------------------------| ---- |--------------------------------------------------------------------------------------------------------------------------------------------|----------------------| | **exclusionDetails** | -| classificationType | string | Classification Type | v1
v2
v3 | -| exclusionType | string | Exclusion Type | v1
v2
v3 | -| exclusionProgram | string | Exclusion Program | v1
v2
v3 | -| excludingAgencyCode | string | Excluding Agency Code | v1
v2
v3 | -| excludingAgencyName | string | Excluding Agency Name | v1
v2
v3 | +| classificationType | string | Classification Type | v1
v2
v3
v4 | +| exclusionType | string | Exclusion Type | v1
v2
v3
v4 | +| exclusionProgram | string | Exclusion Program | v1
v2
v3
v4 | +| excludingAgencyCode | string | Excluding Agency Code | v1
v2
v3
v4 | +| excludingAgencyName | string | Excluding Agency Name | v1
v2
v3
v4 | | **exclusionIdentification** | -| ueiSAM | string | Unique Entity Identifier SAM | v1
v2
v3 | -| cageCode | string | CAGE Code | v1
v2
v3 | -| npi | string| NPI | v1
v2
v3 | -| prefix | string | Prefix | v1
v2
v3 | -| firstName | string | First Name | v1
v2
v3 | -| middleName | string | Middle Name | v1
v2
v3 | -| lastName | string | Last Name | v1
v2
v3 | -| suffix | string | Suffix | v1
v2
v3 | -| name/entityName | string | Firm Name

NOTE: This parameter is being renamed. name is in V1 and entityName will be V2. | v1
v2
v3 | -| dnbOpenData | string | DNB Open Data | v2
v3 | +| ueiSAM | string | Unique Entity Identifier SAM | v1
v2
v3
v4 | +| cageCode | string | CAGE Code | v1
v2
v3
v4 | +| npi | string| NPI | v1
v2
v3
v4 | +| prefix | string | Prefix | v1
v2
v3
v4 | +| firstName | string | First Name | v1
v2
v3
v4 | +| middleName | string | Middle Name | v1
v2
v3
v4 | +| lastName | string | Last Name | v1
v2
v3
v4 | +| suffix | string | Suffix | v1
v2
v3
v4 | +| name/entityName | string | Firm Name

NOTE: This parameter is being renamed. name is in V1 and entityName will be V2. | v1
v2
v3
v4 | +| dnbOpenData | string | DNB Open Data | v2
v3
v4 | | **exclusionActions --> listOfActions** | -| createDate | string | Create Date | v1
v2
v3 | -| updateDate | string | Update Date | v1
v2
v3 | -| activateDate | string | Activate Date | v1
v2
v3 | -| terminationDate | string | Termination Date | v1
v2
v3 | -| terminationType | string | Termination Type | v1
v2
v3 | -| recordStatus | string | Record Status | v1
v2
v3 | -| **exclusionAddress/exclusionPrimaryAddress** | | NOTE: This section is being renamed. It is exclusionAddress in V1 and will be exclusionPrimaryAddress in V2. | | -| addressLine1 | string | Address Line 1 | v1
v2
v3 | -| addressLine2 | string | Address Line 2 | v1
v2
v3 | -| city | string | Address City | v1
v2
v3 | -| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3 | -| zipCode | string | Address Zip OR Postal Code | v1
v2
v3 | -| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3 | -| countryCode | string | Country Code | v1
v2
v3 | +| createDate | string | Create Date | v1
v2
v3
v4 | +| updateDate | string | Update Date | v1
v2
v3
v4 | +| activateDate | string | Activate Date | v1
v2
v3
v4 | +| terminationDate | string | Termination Date | v1
v2
v3
v4 | +| terminationType | string | Termination Type | v1
v2
v3
v4 | +| recordStatus | string | Record Status | v1
v2
v3
v4 | +| **exclusionAddress/exclusionPrimaryAddress** | | NOTE: This section is being renamed. It is exclusionAddress in V1 and will be exclusionPrimaryAddress in V2. | | +| addressLine1 | string | Address Line 1 | v1
v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v1
v2
v3
v4 | +| city | string | Address City | v1
v2
v3
v4 | +| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3
v4 | +| zipCode | string | Address Zip OR Postal Code | v1
v2
v3
v4 | +| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3
v4 | +| countryCode | string | Country Code | v1
v2
v3
v4 | | **exclusionSecondaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | Address City | v2
v3 | -| stateOrProvinceCode | string | Address State or Province Code | v2
v3 | -| zipCode | string | Address Zip OR Postal Code | v2
v3 | -| zipCodePlus4 | string | Address Zip Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | Address City | v2
v3
v4 | +| stateOrProvinceCode | string | Address State or Province Code | v2
v3
v4 | +| zipCode | string | Address Zip OR Postal Code | v2
v3
v4 | +| zipCodePlus4 | string | Address Zip Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **exclusionOtherInformation** | -| additionalComments | string | Additional Comments | v1
v2
v3 | -| ctCode | string | CT Code | v1
v2
v3 | -| dnbInvestigationStatus/evsInvestigationStatus | string | EVS Investigation Status

NOTE: This parameter is being renamed. dnbInvestigationStatus is in V1 and evsInvestigationStatus will be V2. | v1
v2
v3 | +| isFASCSAOrder | string | FASCSA Order Exclusion Indicator | v4 | +| additionalComments | string | Additional Comments | v1
v2
v3
v4 | +| ctCode | string | CT Code | v1
v2
v3
v4 | +| dnbInvestigationStatus/evsInvestigationStatus | string | EVS Investigation Status

NOTE: This parameter is being renamed. dnbInvestigationStatus is in V1 and evsInvestigationStatus will be V2. | v1
v2
v3
v4 | | **exclusionOtherInformation --> references --> referencesList** | -| name/exclusionName | string | Exclusion Name

NOTE: This parameter is being renamed. name is in V1 and exclusionName will be V2. | v1
v2
v3 | -| type | string | Type | v1
v2
v3 | +| name/exclusionName | string | Exclusion Name

NOTE: This parameter is being renamed. name is in V1 and exclusionName will be V2. | v1
v2
v3
v4 | +| type | string | Type | v1
v2
v3
v4 | | **exclusionOtherInformation --> moreLocations** | -| exclusionName | string | Exclusion Name | v2
v3 | -| duns | string | DUNS | v2 | -| ueiSAM | string | ueiSAM | v3 | -| cageCode | string | CAGE Code | v2
v3 | -| npi | string | NPI | v2
v3 | +| exclusionName | string | Exclusion Name | v2
v3
v4 | +| duns | string | DUNS | v2 | +| ueiSAM | string | ueiSAM | v3
v4 | +| cageCode | string | CAGE Code | v2
v3
v4 | +| npi | string | NPI | v2
v3
v4 | | **exclusionOtherInformation --> moreLocations --> primaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | City | v2
v3 | -| stateOrProvinceCode | string | State or Province Code | v2
v3 | -| zipCode | string | Zip Code | v2
v3 | -| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | City | v2
v3
v4 | +| stateOrProvinceCode | string | State or Province Code | v2
v3
v4 | +| zipCode | string | Zip Code | v2
v3
v4 | +| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **exclusionOtherInformation --> moreLocations --> secondaryAddress** | -| addressLine1 | string | Address Line 1 | v2
v3 | -| addressLine2 | string | Address Line 2 | v2
v3 | -| city | string | City | v2
v3 | -| stateOrProvinceCode | string | State or Province Code | v2
v3 | -| zipCode | string | Zip Code | v2
v3 | -| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3 | -| countryCode | string | Country Code | v2
v3 | +| addressLine1 | string | Address Line 1 | v2
v3
v4 | +| addressLine2 | string | Address Line 2 | v2
v3
v4 | +| city | string | City | v2
v3
v4 | +| stateOrProvinceCode | string | State or Province Code | v2
v3
v4 | +| zipCode | string | Zip Code | v2
v3
v4 | +| zipCodePlus4 | string | Zip Code Plus 4 | v2
v3
v4 | +| countryCode | string | Country Code | v2
v3
v4 | | **vesselDetails** | -| callSign | string | Call Sign | v1
v2
v3 | -| type | string | Type | v1
v2
v3 | -| tonnage | string | Tonnage | v1
v2
v3 | -| grt | string | GRT | v1
v2
v3 | -| flag | string | Flag | v1
v2
v3 | -| owner | string | Owner | v1
v2
v3 | +| callSign | string | Call Sign | v1
v2
v3
v4 | +| type | string | Type | v1
v2
v3
v4 | +| tonnage | string | Tonnage | v1
v2
v3
v4 | +| grt | string | GRT | v1
v2
v3
v4 | +| flag | string | Flag | v1
v2
v3
v4 | +| owner | string | Owner | v1
v2
v3
v4 | | **vesselDetails --> secondaryAddress** | -| addressLine1 | string | Address Line 1 | v1
v2
v3 Production only | -| addressLine2 | string | Address Line 2 | v1
v2
v3 Production only | -| city | string | Address City | v1
v2
v3 Production only | -| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3 Production only | -| zipCode | string | Address Zip OR Postal Code | v1
v2
v3 Production only | -| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3 Production only | -| countryCode | string | Country Code | v1
v2
v3 Production only | +| addressLine1 | string | Address Line 1 | v1
v2
v3
v4 Production only | +| addressLine2 | string | Address Line 2 | v1
v2
v3
v4 Production only | +| city | string | Address City | v1
v2
v3
v4 Production only | +| stateOrProvinceCode | string | Address State or Province Code | v1
v2
v3
v4 Production only | +| zipCode | string | Address Zip OR Postal Code | v1
v2
v3
v4 Production only | +| zipCodePlus4 | string | Address Zip Plus 4 | v1
v2
v3
v4 Production only | +| countryCode | string | Country Code | v1
v2
v3
v4 Production only |

Back to top

-## OpenAPI Specification File +## OpenAPI Specification File You can view the full details of this API in the OpenAPI Specification file available here: Open API specification file for the Exclusion API @@ -243,18 +246,18 @@ The API will return one of the following responses: 400 - Application Level Error Messages:

1. Invalid "Date" format:
v1 or v2: Date should be specified in the format: MM/dd/YYYY.
v3: "message":"Dates must be specified in the MM/DD/YYYY format.", "detail":"Any Date parameter must be provided in the MM/DD/YYYY format.".

2. Invalid Input Parameters:
v1 or v2: "title":"Invalid Input Parameters","detail":"< user-provided invalid parameter >".
v3: "message":"The search parameter, < user-provided invalid parameter > does not exist.","detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable search parameters.".

3. If ‘includeSections’, ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is sent in the "q" parameter:
v1 or v2: The parameter: ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is not permitted inside Query Param(q).
v3: "message":"The search parameters 'emailId', 'format', 'exclusionName', 'includeSections', 'addressLine1', 'addressLine2', and 'ssnOrTinOrEin' are not permitted inside Query Param(q)","detail":"Please provide these parameters separately.".

4. A null or an empty value is sent in the "q" parameter:
v1 or v2: "title":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’"
v3: "message":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’".

5. More than 100 "cageCode" values are sent:
v1 or v2: A maximum of 100 CAGE Codes is allowed.
v3: "message":"More than 100 CAGE Codes are not allowed.","detail":"Please limit the number of CAGE Codes to 100."

6. If "emailId" is sent on its own:
v1 or v2: The Parameter emailId must be provided in conjunction with the parameter format.
v3: "message":"The search parameter 'emailId' must be provided in conjunction with the search parameter 'format'.","detail":"Users can opt for receiving the requested JSON/CSV files in their emails."

7. If "includeSections" contains an invalid value:
v1 or v2: includeSections contains invalid value.
v3: "message":"The search parameter 'includeSections' contains an invalid value - < user-provided invalid parameter >,"detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable values.".

8. If "ssnOrTinOrEin" is provided on its own:
v1 or v2: ssnOrTinOrEin filter must be provided in conjunction with exclusionName.
v3: "message":"The search parameter 'ssnOrTinOrEin' must be provided in conjunction with the search parameter 'exclusionName'.","detail":"The 'ssnOrTinOrEin' parameter cannot be provided on its own.".

9. Invalid "ssnOrTinOrEin" length or "ssnOrTinOrEin" has more than one value:
v1 or v2: The search parameter, 'ssnOrTinOrEin' will only accept one complete 9 digit value (e.g.: ssnOrTinOrEin=000000000).
v3: "message":"The search parameter 'ssnOrTinOrEin' will only accept one complete 9 digit value.","detail":"An example value is 000000000.".

10. More than one "exclusionName" value is provided with "addressLine1" and "addressLine2":
v1 or v2: exclusionName will only accept one value when it is provided in conjunction with addressLine1 and addressLine2.
v3: "message":"The search parameter 'exclusionName' will only accept one value when it is provided in conjunction with 'addressLine1' and 'addressLine2'.","detail":"Use 'exclusionName' on its own or in conjunction with non-address search parameters.".

11. Invalid "recordStatus" value:
v1 or v2: "title":"Invalid input","errorCode":"IIP","detail":"Invalid input for recordStatus"
v3: "message":"The search parameter 'recordStatus' will only accept Active as the value.","detail":"Only Active records are returned.

12. "Invalid "format" value:
v1 or v2: "title":"Invalid input","detail":"Invalid Input value for format".
v3: "message":"Invalid input value for format","detail":"The allowable values are JSON and CSV."13. JSON or CSV file generation is in-progress:
v1 or v2: "title":"Extract File Generation is Still in Progress","detail":"File Processing in Progress. Please check again later ".
v3: "message":"The requested JSON or CSV file is not generated yet. Please try again later.","detail":"Larger files will take some time to process.".

14. A non-existent token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Extract File Not Found and we are not able to process your request","detail":"We are not able to find the requested file".
v3: "message":"The requested JSON or CSV file token could not be found.","detail":"Please verify the token number."

15. An expired token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Requested File is Expired and cannot be downloaded","detail":"We are not able to process your request".
v3: "message":"The requested JSON or CSV file token is expired.","detail":"Please verify the token number." + Application Level Error Messages:

1. Invalid "Date" format:
v1 or v2: Date should be specified in the format: MM/dd/YYYY.
v3 or v4: "message":"Dates must be specified in the MM/DD/YYYY format.", "detail":"Any Date parameter must be provided in the MM/DD/YYYY format.".

2. Invalid Input Parameters:
v1 or v2: "title":"Invalid Input Parameters","detail":"< user-provided invalid parameter >".
v3 or v4: "message":"The search parameter, < user-provided invalid parameter > does not exist.","detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable search parameters.".

3. If ‘includeSections’, ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is sent in the "q" parameter:
v1 or v2: The parameter: ‘emailId’, ‘format’, ‘exclusionName’, ‘includeSections’, ‘addressLine1’, ‘addressLine2’, or ‘ssnOrTinOrEin’ is not permitted inside Query Param(q).
v3 or v4: "message":"The search parameters 'emailId', 'format', 'exclusionName', 'includeSections', 'addressLine1', 'addressLine2', and 'ssnOrTinOrEin' are not permitted inside Query Param(q)","detail":"Please provide these parameters separately.".

4. A null or an empty value is sent in the "q" parameter:
v1 or v2: "title":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’"
v3 or v4: "message":"Invalid input","detail":"The value null/empty is not valid for parameter ‘Query Param (q)’".

5. More than 100 "cageCode" values are sent:
v1 or v2: A maximum of 100 CAGE Codes is allowed.
v3 or v4: "message":"More than 100 CAGE Codes are not allowed.","detail":"Please limit the number of CAGE Codes to 100."

6. If "emailId" is sent on its own:
v1 or v2: The Parameter emailId must be provided in conjunction with the parameter format.
v3 or v4: "message":"The search parameter 'emailId' must be provided in conjunction with the search parameter 'format'.","detail":"Users can opt for receiving the requested JSON/CSV files in their emails."

7. If "includeSections" contains an invalid value:
v1 or v2: includeSections contains invalid value.
v3 or v4: "message":"The search parameter 'includeSections' contains an invalid value - < user-provided invalid parameter >,"detail":"Please refer to https://open.gsa.gov/api/exclusions-api/ for a list of allowable values.".

8. If "ssnOrTinOrEin" is provided on its own:
v1 or v2: ssnOrTinOrEin filter must be provided in conjunction with exclusionName.
v3 or v4: "message":"The search parameter 'ssnOrTinOrEin' must be provided in conjunction with the search parameter 'exclusionName'.","detail":"The 'ssnOrTinOrEin' parameter cannot be provided on its own.".

9. Invalid "ssnOrTinOrEin" length or "ssnOrTinOrEin" has more than one value:
v1 or v2: The search parameter, 'ssnOrTinOrEin' will only accept one complete 9 digit value (e.g.: ssnOrTinOrEin=000000000).
v3 or v4: "message":"The search parameter 'ssnOrTinOrEin' will only accept one complete 9 digit value.","detail":"An example value is 000000000.".

10. More than one "exclusionName" value is provided with "addressLine1" and "addressLine2":
v1 or v2: exclusionName will only accept one value when it is provided in conjunction with addressLine1 and addressLine2.
v3 or v4: "message":"The search parameter 'exclusionName' will only accept one value when it is provided in conjunction with 'addressLine1' and 'addressLine2'.","detail":"Use 'exclusionName' on its own or in conjunction with non-address search parameters.".

11. Invalid "recordStatus" value:
v1 or v2: "title":"Invalid input","errorCode":"IIP","detail":"Invalid input for recordStatus"
v3 or v4: "message":"The search parameter 'recordStatus' will only accept Active as the value.","detail":"Only Active records are returned.

12. "Invalid "format" value:
v1 or v2: "title":"Invalid input","detail":"Invalid Input value for format".
v3 or v4: "message":"Invalid input value for format","detail":"The allowable values are JSON and CSV."

13. JSON or CSV file generation is in-progress:
v1 or v2: "title":"Extract File Generation is Still in Progress","detail":"File Processing in Progress. Please check again later ".
v3 or v4: "message":"The requested JSON or CSV file is not generated yet. Please try again later.","detail":"Larger files will take some time to process.".

14. A non-existent token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Extract File Not Found and we are not able to process your request","detail":"We are not able to find the requested file".
v3 or v4: "message":"The requested JSON or CSV file token could not be found.","detail":"Please verify the token number."

15. An expired token is used for downloading a JSON or a CSV file:
v1 or v2: "title":"Requested File is Expired and cannot be downloaded","detail":"We are not able to process your request".
v3 or v4: "message":"The requested JSON or CSV file token is expired.","detail":"Please verify the token number." 403 - 1. Missing API Key:
v1, v2 or v3: No api_key was supplied in request body. Please submit with a valid API key.

2. An invalid API Key:
v1, v2 or v3: An invalid API key was supplied. Please submit with a valid API key. + 1. Missing API Key:
v1, v2, v3 or v4: No api_key was supplied in request body. Please submit with a valid API key.

2. An invalid API Key:
v1, v2, v3 or v4: An invalid API key was supplied. Please submit with a valid API key. 405 - If any method other than "GET" is used:
v1, v2 or v3: Method Not Allowed. + If any method other than "GET" is used:
v1, v2, v3 or v4: Method Not Allowed. - NOTE:
Error messages in v1 and v2 are returned in this fashion: httpStatus, title, detail, errorCode, source
Error messages in v3 are returned in this fashion: Status, timestamp, message, detail, errorCode, transaction_id + NOTE:
Error messages in v1 and v2 are returned in this fashion: httpStatus, title, detail, errorCode, source
Error messages in v3 and v4 are returned in this fashion: Status, timestamp, message, detail, errorCode, transaction_id @@ -266,10 +269,10 @@ The API will return one of the following responses:
Request URL v2 Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
-v3 Production URL: COMING SOON
+v3 Production URL: https://api.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA

v2 Alpha URL: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
-v3 Alpha URL: COMING SOON
+v3 Alpha URL: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA

@@ -483,10 +486,10 @@ v2 Response:
Request URL v2 Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
-v3 Production URL: COMING SOON
+v3 Production URL: https://api.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV


v2 Alpha URL: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
-v3 Alpha URL: COMING SOON
+v3 Alpha URL: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV

@@ -526,104 +529,104 @@ Note: Public Response for one record is provided as an example
A sample record is provided here: - "excludedEntity": [ - { - "exclusionDetails": { - "classificationType": "Individual", - "exclusionType": "Ineligible (Proceedings Completed)", - "exclusionProgram": "Reciprocal", - "excludingAgencyCode": "ARMY", - "excludingAgencyName": "DEPT OF THE ARMY" - }, - "exclusionIdentification": { - "ueiSAM": null, - "cageCode": null, - "npi": null, - "prefix": "Ms.", - "firstName": "Chong", - "middleName": "Sun", - "lastName": "Hwang", - "suffix": null, - "entityName": "Ms. Chong Sun Hwang", - "dnbOpenData": null - }, - "exclusionActions": { - "listOfActions": [ - { - "createDate": "07-27-2012", - "updateDate": "07-27-2012", - "activateDate": "12-12-2011", - "terminationDate": "11-08-2029", - "terminationType": "Definite", - "recordStatus": "Active" - } - ] - }, - "exclusionPrimaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": "Dongjak-gu, Seoul", - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": "KOR" - }, - "exclusionSecondaryAddress": [], - "exclusionOtherInformation": { - "additionalComments": null, - "ctCode": "A", - "evsInvestigationStatus": null, - "references": { - "referencesList": [ - { - "exclusionName": null, - "type": null - } - ] - }, - "moreLocations": [ - { - "exclusionName": null, - "duns": null, - "cageCode": null, - "npi": null, - "primaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": null, - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": null - }, - "secondaryAddress": [ - { - "addressLine1": null, - "addressLine2": null, - "city": null, - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": null - } - ] - } - ] - }, - "vesselDetails": { - "callSign": null, - "type": null, - "tonnage": null, - "grt": null, - "flag": null, - "owner": null - } - }, - - "links": { - "selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&classification=[Individual~Special%20Entity%20Designation&excludingAgencyCode=!DOJ&country=KOR&q=CHONG&page=0&size=10", - - } +"excludedEntity": [ +{ +"exclusionDetails": { +"classificationType": "Individual", +"exclusionType": "Ineligible (Proceedings Completed)", +"exclusionProgram": "Reciprocal", +"excludingAgencyCode": "ARMY", +"excludingAgencyName": "DEPT OF THE ARMY" +}, +"exclusionIdentification": { +"ueiSAM": null, +"cageCode": null, +"npi": null, +"prefix": "Ms.", +"firstName": "Chong", +"middleName": "Sun", +"lastName": "Hwang", +"suffix": null, +"entityName": "Ms. Chong Sun Hwang", +"dnbOpenData": null +}, +"exclusionActions": { +"listOfActions": [ +{ +"createDate": "07-27-2012", +"updateDate": "07-27-2012", +"activateDate": "12-12-2011", +"terminationDate": "11-08-2029", +"terminationType": "Definite", +"recordStatus": "Active" +} +] +}, +"exclusionPrimaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": "Dongjak-gu, Seoul", +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": "KOR" +}, +"exclusionSecondaryAddress": [], +"exclusionOtherInformation": { +"additionalComments": null, +"ctCode": "A", +"evsInvestigationStatus": null, +"references": { +"referencesList": [ +{ +"exclusionName": null, +"type": null +} +] +}, +"moreLocations": [ +{ +"exclusionName": null, +"duns": null, +"cageCode": null, +"npi": null, +"primaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": null, +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": null +}, +"secondaryAddress": [ +{ +"addressLine1": null, +"addressLine2": null, +"city": null, +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": null +} +] +} +] +}, +"vesselDetails": { +"callSign": null, +"type": null, +"tonnage": null, +"grt": null, +"flag": null, +"owner": null +} +}, + +"links": { +"selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&classification=[Individual~Special%20Entity%20Designation&excludingAgencyCode=!DOJ&country=KOR&q=CHONG&page=0&size=10", + +}

@@ -649,50 +652,175 @@ Note: Public Response for one record is provided as an example
A sample record is provided here: - "excludedEntity": [ - { - "exclusionDetails": { - "classificationType": "Firm", - "exclusionType": "Ineligible (Proceedings Completed)", - "exclusionProgram": "Reciprocal", - "excludingAgencyCode": "AF", - "excludingAgencyName": "DEPT OF THE AIR FORCE" - }, - "exclusionIdentification": { - "ueiSAM": "H2XFNNKK2NZ9", - "cageCode": null, - "npi": null, - "prefix": null, - "firstName": null, - "middleName": null, - "lastName": null, - "suffix": null, - "entityName": "Shenzhen Hongdark Electronics Co., Ltd.", - "dnbOpenData": null - }, - "exclusionPrimaryAddress": { - "addressLine1": null, - "addressLine2": null, - "city": "Shenzhen", - "stateOrProvinceCode": null, - "zipCode": null, - "zipCodePlus4": null, - "countryCode": "CHN" - }, - "exclusionSecondaryAddress": [] - }, +"excludedEntity": [ +{ +"exclusionDetails": { +"classificationType": "Firm", +"exclusionType": "Ineligible (Proceedings Completed)", +"exclusionProgram": "Reciprocal", +"excludingAgencyCode": "AF", +"excludingAgencyName": "DEPT OF THE AIR FORCE" +}, +"exclusionIdentification": { +"ueiSAM": "H2XFNNKK2NZ9", +"cageCode": null, +"npi": null, +"prefix": null, +"firstName": null, +"middleName": null, +"lastName": null, +"suffix": null, +"entityName": "Shenzhen Hongdark Electronics Co., Ltd.", +"dnbOpenData": null +}, +"exclusionPrimaryAddress": { +"addressLine1": null, +"addressLine2": null, +"city": "Shenzhen", +"stateOrProvinceCode": null, +"zipCode": null, +"zipCodePlus4": null, +"countryCode": "CHN" +}, +"exclusionSecondaryAddress": [] +}, "links": { - "selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=0&size=10", - "nextLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=1&size=10" - } +"selfLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=0&size=10", +"nextLink": "https://api.sam.gov/entity-information/v2/exclusions?api_key=REPLACE_WITH_API_KEY&q=(country=KOR%20OR%20country=CHN%20OR%20country=DEU)&classification=Firm&exclusionType=[Ineligible%20(Proceedings%20Completed)~Prohibition/Restriction&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&page=1&size=10" +} +} + + +

+ + +### Example 5: Get details for FASCSA Order Exclusion records only. + +
+Request URL +v4 Production URL: https://api.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&fascsaOrder=Yes
+
+v4 Alpha URL: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&fascsaOrder=Yes
+
+
+ +
+Response (JSON Output) +Note: Public Response for one record is provided as an example
+

+ +

+{
+    "totalRecords": 16,
+
+A sample record is provided here:
+
+        {
+            "exclusionDetails": {
+                "classificationType": "Firm",
+                "exclusionType": "Prohibition/Restriction",
+                "exclusionProgram": "Reciprocal",
+                "excludingAgencyCode": "AF",
+                "excludingAgencyName": "DEPT OF THE AIR FORCE"
+            },
+            "exclusionIdentification": {
+                "ueiSAM": "J27QHBBBL1V3",
+                "cageCode": null,
+                "npi": null,
+                "prefix": null,
+                "firstName": null,
+                "middleName": null,
+                "lastName": null,
+                "suffix": null,
+                "entityName": "Foxtrot Research Corp",
+                "dnbOpenData": null
+            },
+            "exclusionActions": {
+                "listOfActions": [
+                    {
+                        "createDate": "10-31-2023",
+                        "updateDate": "10-31-2023",
+                        "activateDate": "10-30-2023",
+                        "terminationDate": null,
+                        "terminationType": "Indefinite",
+                        "recordStatus": "Active"
+                    }
+                ]
+            },
+            "exclusionPrimaryAddress": {
+                "addressLine1": null,
+                "addressLine2": null,
+                "city": null,
+                "stateOrProvinceCode": "FL",
+                "zipCode": null,
+                "zipCodePlus4": null,
+                "countryCode": "USA"
+            },
+            "exclusionSecondaryAddress": [],
+            "exclusionOtherInformation": {
+                "isFASCSAOrder": "Yes",
+                "additionalComments": null,
+                "ctCode": null,
+                "evsInvestigationStatus": null,
+                "references": {
+                    "referencesList": [
+                        {
+                            "exclusionName": null,
+                            "type": null
+                        }
+                    ]
+                },
+                "moreLocations": [
+                    {
+                        "exclusionName": null,
+                        "ueiSAM": null,
+                        "cageCode": null,
+                        "npi": null,
+                        "primaryAddress": {
+                            "addressLine1": null,
+                            "addressLine2": null,
+                            "city": null,
+                            "stateOrProvinceCode": null,
+                            "zipCode": null,
+                            "zipCodePlus4": null,
+                            "countryCode": null
+                        },
+                        "secondaryAddress": [
+                            {
+                                "addressLine1": null,
+                                "addressLine2": null,
+                                "city": null,
+                                "stateOrProvinceCode": null,
+                                "zipCode": null,
+                                "zipCodePlus4": null,
+                                "countryCode": null
+                            }
+                        ]
+                    }
+                ]
+            },
+            "vesselDetails": {
+                "callSign": null,
+                "type": null,
+                "tonnage": null,
+                "grt": null,
+                "flag": null,
+                "owner": null
+            }
+        },
+    ],
+    "links": {
+        "selfLink": "https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=0&size=10",
+        "nextLink": "https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=1&size=10"
+    }
 }

-### Example 5: To receive a file downloadable link in the email for the requested CSV results. +### Example 6: To receive a file downloadable link in the email for the requested CSV results.
Request URL Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< a valid Public API Key >&q=(country=KOR OR country=CHN OR country=DEU)&classification=Firm&exclusionType=[Ineligible (Proceedings Completed)~Prohibition/Restriction]&includeSections=exclusionDetails,exclusionIdentification,exclusionAddress&format=CSV&emailId=Y
@@ -709,7 +837,7 @@ Click to view CSV Response for one record Back to top

## Additional Information -You can view the full details of the differences between the SAM legacy API and SAM.gov API +You can view the full details of the differences between the SAM legacy API and SAM.gov API
available here: Variance Document
Disclaimer: @@ -724,46 +852,46 @@ Disclaimer: ## Contact Us * Reach out to the SAM.gov team at www.fsd.gov for inquiries and help desk support. - * Before contacting the help desk, conduct your own initial troubleshooting - * Conduct a recent review of the open.gsa.gov/api specifications - * Confirm you are using an API tool, not a browser to send the request. (FOUO & Sensitive Calls) - * Confirm you are using the username/password for the system account that created the API key in the authentication header. (Sensitive Calls) - * Confirm you used POST and not GET for this request (Sensitive Calls) - * Confirm that the API key is from a system account (FOUO & Sensitive Calls) - * Confirm that the API key being used is still active - * Confirm that the system account you are using has “read fouo” or “read sensitive” permissions as applicable (FOUO & Sensitive Calls) - * Confirm that the IP addresses registered with your system account are current - * When submitting help desk tickets for API or system connection issues, provide the following: - * The exact API requests that you were trying to send - * The exact error messages that you were receiving - * The exact dates and times when you received the errors - * Screenshots (with the actual API request and the error) [Attach to the ticket] - * The System Account ID/Name that was trying to make API calls - * Screenshots of the parameters used for API call [Attach to the ticket] - * Screenshots of the Headers used for the API call [Attach to the ticket] + * Before contacting the help desk, conduct your own initial troubleshooting + * Conduct a recent review of the open.gsa.gov/api specifications + * Confirm you are using an API tool, not a browser to send the request. (FOUO & Sensitive Calls) + * Confirm you are using the username/password for the system account that created the API key in the authentication header. (Sensitive Calls) + * Confirm you used POST and not GET for this request (Sensitive Calls) + * Confirm that the API key is from a system account (FOUO & Sensitive Calls) + * Confirm that the API key being used is still active + * Confirm that the system account you are using has “read fouo” or “read sensitive” permissions as applicable (FOUO & Sensitive Calls) + * Confirm that the IP addresses registered with your system account are current + * When submitting help desk tickets for API or system connection issues, provide the following: + * The exact API requests that you were trying to send + * The exact error messages that you were receiving + * The exact dates and times when you received the errors + * Screenshots (with the actual API request and the error) [Attach to the ticket] + * The System Account ID/Name that was trying to make API calls + * Screenshots of the parameters used for API call [Attach to the ticket] + * Screenshots of the Headers used for the API call [Attach to the ticket] * Users requesting access to the test site (alpha.sam.gov) should follow the below steps. These steps ONLY apply to alpha.sam.gov access requests. - 1. Navigate to www.fsd.gov - 2. Sign into the FSD platform using your FSD credentials - 3. Select "Create an Incident" - 4. Create an Incident -
    -
  1. System Name: System for Award Management (SAM)
    2. -
  2. Is this related to the American Rescue Plan Act?: No
    3. -
  3. Issue Type: Other
    4. -
  4. Business Type: Other
    5. -
  5. Subject (select 1): -
      -
    1. Option A: I need a role to test in alpha.sam.gov.
      2. -
    2. Option B: System account approval in alpha.sam.gov
      3. -
    -
    6. -
  6. Please describe the issue: (Copy and paste the below information into the ticket, filling in your information within the brackets) -
      -
    1. Option A: I have already navigated to alpha.sam.gov and created a user account, following the same steps for creating an account in sam.gov. I would like to conduct testing but do not have the necessary role(s) in alpha.sam.gov. The account that needs role assignment is associated with [EMAIL ADDRESS]. I request a [ROLE] role for the [DOMAIN] domain in alpha.sam.gov.
      2. -
    2. Option B: I am creating/editing a system account and have submitted my account in alpha.sam.gov for approval. I would like to request alpha.sam.gov system account review and approval for [Name of the alpha.sam.gov system account].
      3. -
    -
    7. -
+ 1. Navigate to www.fsd.gov + 2. Sign into the FSD platform using your FSD credentials + 3. Select "Create an Incident" + 4. Create an Incident +
    +
  1. System Name: System for Award Management (SAM)
    2. +
  2. Is this related to the American Rescue Plan Act?: No
    3. +
  3. Issue Type: Other
    4. +
  4. Business Type: Other
    5. +
  5. Subject (select 1): +
      +
    1. Option A: I need a role to test in alpha.sam.gov.
      2. +
    2. Option B: System account approval in alpha.sam.gov
      3. +
    +
    6. +
  6. Please describe the issue: (Copy and paste the below information into the ticket, filling in your information within the brackets) +
      +
    1. Option A: I have already navigated to alpha.sam.gov and created a user account, following the same steps for creating an account in sam.gov. I would like to conduct testing but do not have the necessary role(s) in alpha.sam.gov. The account that needs role assignment is associated with [EMAIL ADDRESS]. I request a [ROLE] role for the [DOMAIN] domain in alpha.sam.gov.
      2. +
    2. Option B: I am creating/editing a system account and have submitted my account in alpha.sam.gov for approval. I would like to request alpha.sam.gov system account review and approval for [Name of the alpha.sam.gov system account].
      3. +
    +
    7. +

Back to top

@@ -792,5 +920,6 @@ Date | Version | Description 10/21/2021 | v2.8 | * Updated Examples - Added Example 1 and Example 2 to indicate the post April 3rd, 2022 behavior.

* Added notes in the Query String Parameters, Expected Result and HTTP Response Codes sections to highlight the until and after April 3rd, 2022 behavior. 02/01/2022 | v2.9 | * Added exclusions V3 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V3.

* Updated the Example 1 and Example 2 to indicate the V3 behavior.

* Updated the section, "HTTP Response Codes" to indicate the v3 behavior.

* Update the OpenAPI Specification File to include the V3 endpoints. 04/04/2022 | v3.0 | * Provided the v3 end point for Production.

* Removed ueiDUNS occurrences from the sections, Query String Parameters, Expected Result, HTTP Response Codes and Examples. +12/01/2023 | v3.1 | A new V4 Exclusions API has been created, enabling the search and response for FASCSA Order Exclusion records. As part of this change, below are the associated changes made to this OpenGSA page:

* Added exclusions V4 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V4.

* Moved the existing Example 5 to Example 6; inserted a new Example 5 to indicate V4 behavior.

* Updated the section, “HTTP Response Codes” to indicate the v4 behavior.

* Updated the OpenAPI Specification File to include the V4 endpoints.

Back to top

diff --git a/_apidocs/exclusions-api/v1/openapi.yaml b/_apidocs/exclusions-api/v1/openapi.yaml index 7997b8065..a8b362a03 100644 --- a/_apidocs/exclusions-api/v1/openapi.yaml +++ b/_apidocs/exclusions-api/v1/openapi.yaml @@ -19,6 +19,8 @@ tags: description: Exclusions Api Controller V 2 - name: exclusions-api-controller-v-3 description: Exclusions Api Controller V 3 +- name: exclusions-api-controller-v-4 + description: Exclusions Api Controller V 4 - name: file-download-controller description: File Download Controller paths: @@ -842,4 +844,292 @@ paths: description: The resource you were trying to reach is not found content: {} deprecated: false + /entity-information/v4/download-exclusions: + get: + tags: + - exclusions-api-controller-v-4 + summary: ' download V4 exclusion extract file' + operationId: getFileFromS3UsingGET + requestBody: + description: token to download specific file + content: + '*/*': + schema: + type: string + required: false + responses: + 200: + description: Successfully downloaded file + content: + application/hal+json: + 401: + description: You are not authorized to view the resource + content: {} + 403: + description: Accessing the resource you were trying to reach is forbidden + content: {} + 404: + description: The resource you were trying to reach is not found + content: {} + deprecated: false + x-codegen-request-body-name: token + /entity-information/v4/exclusions: + get: + tags: + - exclusions-api-controller-v-4 + summary: ' get Exclusions Details' + operationId: getExclusionsDataUsingGET_2 + parameters: + - name: activationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: activationDateFrom + in: query + schema: + type: string + - name: activationDateTo + in: query + schema: + type: string + - name: addressLine1 + in: query + description: A String (1234 test Dr) + schema: + type: string + - name: addressLine2 + in: query + description: A String (1234 test Dr) + schema: + type: string + - name: cageCode + in: query + description: A String (0Y5L9, null) + schema: + type: string + - name: city + in: query + schema: + type: string + - name: cityState + in: query + schema: + type: string + - name: cityStateZipCongFlag + in: query + schema: + type: boolean + - name: classification + in: query + description: A String (Individual, Firm, Vessel, Special Entity Designation, + null) + schema: + type: string + - name: country + in: query + description: A String (USA, CAN, ARE, null) + schema: + type: string + - name: createDateFrom + in: query + schema: + type: string + - name: createDateTo + in: query + schema: + type: string + - name: creationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: ctCode + in: query + description: A String (A, ZZ, XXX, 03-SDNTK-01, null) + schema: + type: string + - name: emailId + in: query + description: Email ID + schema: + type: string + - name: exactMatch + in: query + schema: + type: boolean + - name: excludedPartyName + in: query + schema: + type: string + - name: excludingAgencyCode + in: query + description: A String (AF, DOJ, FEMA-IOD, null) + schema: + type: string + - name: excludingAgencyName + in: query + description: A String (FEDERAL, FEDERAL EMERGENCY MANAGEMENT AGENCY, null) + schema: + type: string + - name: exclusionName + in: query + description: A partial text or a complete text + schema: + type: string + - name: exclusionProgram + in: query + description: A String (Reciprocal, Non-Procurement, Procurement) + schema: + type: string + - name: exclusionType + in: query + description: A String (Ineligible (Proceedings Pending), Ineligible (Proceedings + Completed), Prohibition/Restriction, Voluntary Exclusion) + schema: + type: string + - name: format + in: query + description: Parameter used to download csv or json files + schema: + type: string + - name: includeSections + in: query + description: Schema Filtering Paramter + schema: + type: string + - name: isActive + in: query + description: A String (Y, N) + schema: + type: string + - name: isDisasterResponseParticipant + in: query + schema: + type: string + - name: legalBusinessName + in: query + schema: + type: string + - name: naicsCode + in: query + schema: + type: string + - name: npi + in: query + description: A String (1053373266, null) + schema: + type: string + - name: organizationId + in: query + schema: + type: string + - name: page + in: query + description: Page number + schema: + type: string + - name: pscCode + in: query + schema: + type: string + - name: q + in: query + description: Free text, All the above filters and their acceptable values + can be used + schema: + type: string + - name: qMode + in: query + schema: + type: string + - name: recordStatus + in: query + description: Record Status (Active, Inactive) + schema: + type: string + - name: registrationStatus + in: query + schema: + type: string + - name: size + in: query + description: Record size per page + schema: + type: string + - name: sort + in: query + schema: + type: string + - name: sortOrder + in: query + schema: + type: string + enum: + - asc + - desc + - name: ssnOrTinOrEin + in: query + description: 9 digit number or null (XXXXXXXXX, null) + schema: + type: string + - name: stateProvince + in: query + description: A String (NC, XX, null, 470105, YAMALO-NENETSKI OKR.) + schema: + type: string + - name: terminationDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: terminationDateFrom + in: query + schema: + type: string + - name: terminationDateTo + in: query + schema: + type: string + - name: title + in: query + schema: + type: string + - name: ueiSAM + in: query + description: Unique Entity Identifier SAM- 12 digit value - Replacement + for ueiSAM + schema: + type: string + - name: updateDate + in: query + description: A single Date or Date range in the format MM/DD/YYYY + schema: + type: string + - name: zipCode + in: query + description: A String (0, 41722, 21453935, 752435120, 75602-1112, null, C.P. + 44890, oo957, TQ13 9SE, Zimbabwe, P.O. Box Beirut-Hamra) + schema: + type: string + - name: fascsaOrder + in: query + description: This field is used to filter out FASCSA Orders. It accepts Yes or No and is case-insensitive. + schema: + type: string + responses: + 200: + description: Successfully retrieved list + content: + application/hal+json: + 401: + description: You are not authorized to view the resource + content: {} + 403: + description: Accessing the resource you were trying to reach is forbidden + content: {} + 404: + description: The resource you were trying to reach is not found + content: {} + deprecated: false components: {} diff --git a/_apidocs/get-opportunities-public-api.md b/_apidocs/get-opportunities-public-api.md index f847967fb..422c907b1 100644 --- a/_apidocs/get-opportunities-public-api.md +++ b/_apidocs/get-opportunities-public-api.md @@ -52,7 +52,7 @@ state| Place of Performance (State)| No |String | v2 status (Coming Soon)| Status of the opportunity
Accepts following: active, inactive, archived, cancelled, deleted | No| String | v2 zip| Place of Performance (Zip code)| No| String | v2 organizationCode| Code of associated organization | No| string | v2 -organizationName| Name of associated organization
*Note: General Search can be performed*|No| String|v2 +organizationName| Name of associated organization. This Request Parameter can be used to filter the dataset by Department Name or Subtier Name
*Note: General Search can be performed*|No| String|v2 typeOfSetAside| [Refer Set-Aside Value Section](#set-aside-values) |No |String | v2 typeOfSetAsideDescription |Set Aside code Description. See above descriptions mentioned against each of the Set Aside Code| No| String | v2 ncode| NAICS Code. This code is maximum of 6 digits| No| String | v2 @@ -573,4 +573,4 @@ Date | Version | Description -

Back to top

\ No newline at end of file +

Back to top

diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md index 447f9ece9..80650674c 100644 --- a/_apidocs/opportunities-api.md +++ b/_apidocs/opportunities-api.md @@ -161,8 +161,8 @@ WOSBSS | Women-Owned Small Business (WOSB) Program Sole Source (FAR 19.15) EDWOSB | Economically Disadvantaged WOSB (EDWOSB) Program Set-Aside (FAR 19.15) EDWOSBSS | Economically Disadvantaged WOSB (EDWOSB) Program Sole Source (FAR 19.15) LAS | Local Area Set-Aside (FAR 26.2) -IEE | Indian Economic Enterprise (IEE) Set-Aside (specific to Department of Interior) -ISBEE | Indian Small Business Economic Enterprise (ISBEE) Set-Aside (specific to Department of Interior) +IEE | Indian Economic Enterprise (IEE) Set-Aside (specific to Department of Interior and Department of Health and Human Services) +ISBEE | Indian Small Business Economic Enterprise (ISBEE) Set-Aside (specific to Department of Interior and Department of Health and Human Services) BICiv | Buy Indian Set-Aside (specific to Department of Health and Human Services, Indian Health Services) VSA | Veteran-Owned Small Business Set-Aside (specific to Department of Veterans Affairs) VSS | Veteran-Owned Small Business Sole source (specific to Department of Veterans Affairs) diff --git a/_apidocs/perdiem.md b/_apidocs/perdiem.md index 584ff8ea9..fdd85cf1c 100644 --- a/_apidocs/perdiem.md +++ b/_apidocs/perdiem.md @@ -5,7 +5,7 @@ banner-heading: Per diem API ## Overview -Per diem rates are the allowed reimbursement rates for hotel stays and meals for federal travelers. Rates are set for each of the federal government's fiscal years (October 1st to September 30th). GSA is responsible for setting the rates in the continental United States. Many businesses and other organizations adopt these rates as well. This API provides access to the current rate information. +GSA establishes the per diem reimbursement rates that federal agencies use to reimburse their employees for subsistence expenses incurred while on official travel within the continental United States. CONUS includes the 48 contiguous states and the District of Columbia. The per diem reimbursement rates consist of a maximum lodging allowance component and a meals and incidental expenses (M&IE) component. Rates for the coming federal government fiscal year (October 1st to September 30th) are typically announced in mid-August. Use of this API is subject to [Terms of Service for GSA.gov's Developer Resources](https://gsa.gov/node/78901). @@ -111,7 +111,7 @@ You can view the full details of this API in the OpenA ### About per diem rates -GSA sets rates for geographic areas it determines called _primary destinations._ Areas outside the primary destinations are covered by the same, nation-wide _standard rate._ The per diem rate database is organized by location and fiscal year. The meals value applies to the entire FY. +Most of CONUS is covered by the standard per diem rate. In addition there are several hundred non-standard areas (NSAs) that have per diem rates higher than the standard rate. Most NSAs are comprised of a key city/primary destination and the surrounding county. The per diem rate database is organized by location and fiscal year. Maximum lodging allowances in some NSAs vary seasonally, which is why they are listed by month. On the **first and last days of a trip**, the allowed meal reimbursement is **75%** of the per diem rate. diff --git a/_apidocs/ratequeryfrt.md b/_apidocs/ratequeryfrt.md new file mode 100644 index 000000000..7eeaef4d9 --- /dev/null +++ b/_apidocs/ratequeryfrt.md @@ -0,0 +1,351 @@ +--- +title: TMSS 2.0 Freight Rate Query API +banner-heading: TMSS 2.0 Freight Rate Query API +--- + + +## Introduction + +This document provides detailed technical information about the Rate query API offered by the TMSS 2.0. These services make use of industry standard methods for API authentication and connectivity, which should make it easier and faster for developers to interface Federal agency with TMSS 2.0. This API can be used to retrieve shipment cost for a regular Freight (FRT) shipment. + +

Back to top

+ +## Document Overview +This document captures the specifications for the TMSS 2.0 Rate Query API to be consumed by Federal agency customers. + +This document is organized by the following major sections: + - Getting Started + - API Description + - API Query Params + - API Expected Response + - API Specification File + - HTTP Response Codes + - API Details + - Feedback + +## Getting Started + + + +To begin using this API, you will need to register for an API Key. You can sign up for an API key below. After registration, you will need to provide this API key in the `x-api-key` HTTP header with every API request. + + +{% raw %} +
Loading signup form...
+ + +{% endraw %} + +• After registration, you will need to request the Agency Token by sending an email to transportation.programs@gsa.gov. + +• Then you will need to provide this API key in the x-api-key and Agency Token in the x-agency-token of HTTP header with every API request. + +| HTTP Header Name | Description | +| ---- | ----------- | +| x-api-key | API key from api.data.gov. For testing purposes, you can use `DEMO_KEY` as an API key. | +| x-agency-token | Agency Token provided by the FMP (Freight Management Program) team. | + + + +

Back to top

+ +## API Description + + + +This API has one primary endpoint: + +**Endpoint 1:** https://api.gsa.gov/travel/tmss/v1/ratequery/frt + + + +**Description** This API can be used to retrieve shipment cost for a regular Freight (FRT) shipment. + +**API Payload Request Parameters** + +| Request Element | Description | +| ---- | ----------- | +| agencyLocationCode | Customer Location Code | +| queryType | Tpe of Query | +| pickupDate | Pick up/ Move Date | +| sroType | Shipment/Rate Type | +| sroId | Shipment / SRO Id | +| estimatedWeight | Estimated weight of the Shipment | +| estimatedMileage | Miles | +| originZip | Pickup/ Orgin Zip code | +| destinationZip | Delivery/Destination Zip code | +| originCountryCode | Pickup/Orgin Country Code | +| destinationCountryCode | Delivery/Destination Country Code | +| originProvince | Pickup/Origin province code if the Origin country is Canada | +| destinProvince | Delivery/Destinationprovince code if the Destination country is Canada | +| accessorials | group element for entering accessorials | +| accessorialCode | accessorial code | +| quantity | Quantity | +| usage | Usage (Pickup or Delivery) | + + +**Response Object** + +| Response Element| Description | +| ---- | ----------- | +| agencyLocationCode |Customer Location Code | +| queryType |Tpe of Query | +| sroType |Shipment/SROType | +| carrierId |carrier id (data base id) for reference | +| rateId |rate id (DB id) for reference | +| rateTypeId |rate type id (DB id) for reference | +| rateType |Type of rate applied (LTL or TL) | +| ltlCostFinal |Final LTL cost calculated | +| tlCostFinal |Final TL cost calculated | +| linehaulCostFinal |Final Linehaul Cost Applied | +| scac |TSP's SCAC code | +| scacName |TSP Name | +| tenderId |Selected Rate's tende id | +| queryId |internal query id for reference/logging | +| smartWayId |To identify a TSP is Smartway TSP or not | +| smartWayScore |Integer | +| phone |TSP's phone number | +| email |TSP's Email | +| sro |Selected SRO | +| fuelSurchargeCost |Total Fuel Surcharge cost applied for this shipment query | +| fuelSurchargeEffDate |Fuels Surcharge effective Date | +| fuelSurchargeExpDate |Fuels Surcharge expiry Date | +| totalAccessorialCost |Total accessorial cost applied | +| totalEstimatedCost |Total estimated cost of the shipment (linehaulCostFinal + fuelSurchargeCost + totalAccessorialCost) | +| linehaulCalculation |Linehaul calculation formula applied | +| socioEconomicInd |TSP's social economic indicator(s) | +| originProvince |Origin province fom the request | +| originZip |Origin Zip submitted fom the request | +| destinationZip |Destination Zip fom the request | +| destinationProvince |Destination province fom the request | +| originCountryCode |Origin Country Code fom the request | +| destinationCountryCode |Destination country code fom the request | +| estimatedMileage |Estimated mileage computed | +| estimatedWeight |Estimated weight fom the request | +| pickupDate |pickup date fom the request | +| rateEffectiveDate |Rate Effective Date | +| rateExpiryDate |Rate Expiry Date | +| rateEffectiveDate |Rate Effective Date | +| accessorialsResults |Accessorials results | +| estimatedCost |total cost of the individual accessorial | +| frtAccessorialId |DB id of the accessoral code | +| unitsId |DB id of the acessorial unit type | +| quantity |applicable quantity | +| accessorialCode |accessorial code from the request | +| accessorialCost |acessorial cost in integer | +| usage |Usage from the request | + + +## API Specification File + +You can view the full details of this API in the OpenAPI Specification file available here: +[TMSS.FRT.Rate.Query.API.spec.xlsx](https://github.com/GSA/open-gsa-redesign/files/11870768/TMSS.FRT.Rate.Query.API.spec.xlsx) + + + +

Back to top

+ +## HTTP Response Codes + +The API will return one of the following responses: + +| HTTP Response Code | Description | +| ---- | ----------- | +| 200 | Successful. Data will be returned in JSON format. | +| 400 | Bad request. Verify the query string parmaters that were provided. | +| 403 | API key is not correct or was not provided. | +| 404 | Not Found +| 408 | Request Timeout +| 413 | Payload too large +| 417 | Expectation Failed +| 429 | Too many requests +| 500 | Internal Server Error +| 502 | Bad Gateway +| 503 | Service Unavailable +| 504 |Gateway Timeout + + +

Back to top

+ + +## API Details + +Request: +All request payloads must be in JSON data structure specified in the Data dictionary section of this document. + +Response: +All response must be in JSON data structure specified in the Data dictionary section of this document. + +The connection to the API endpoints is secured and authenticated using the registered token provided by the form above. + +Sample Request and Response +Request URL: https://api.gsa.gov/travel/tmss/v1/ratequery/frt + +Request Payload for a FRT Domestic Shipment: +``` +{ + "agencyLocationCode": 1312, + "queryType":"FRT", + "pickupDate": "2020-06-16", + "sroType":"General", + "sroId":"GENTL", + "estimatedWeight":1000, + "estimatedMileage":100, + "estimatedCuFt":null, + "originZip":"23059", + "destinationZip":"60611", + "originCountryCode":"US00", + "destinationCountryCode":"US00", + "originProvince":null, + "destnProvince":null, + "accessorials": [ + { + "accessorialCode": "550", + "quantity": 0, + "usage": "Pickup" + }, + { + "accessorialCode": "480" + } + ] +} +``` + +Response : +``` +[ + { + "agencyLocationCode": 1312, + "queryType": "FRT", + "sroType": "General", + "sro": "GENLTL", + "carrierId": 2425, + "rateId": 5869, + "rateTypeId": 19, + "rateType": "LTL - 1000", + "ltlCostFinal": 205.74, + "tlCostFinal": 0, + "linehaulCostFinal": "205.74", + "scac": "RDWY", + "scacName": "ROADWAY TRANSPORT", + "tenderId": "3020", + "queryId": 5675, + "smartWayId": true, + "phone": "7036237688", + "email": "test34@gmail.com", + "fuelSurchargeCost": "55.55", + "fuelSurchargeEffDate": "2023-06-14T04:00:00.000+0000", + "fuelSurchargeExpDate": "2023-06-20T04:00:00.000+0000", + "totalAccessorialCost": "702.31", + "totalEstimatedCost": "963.60", + "linehaulCalculation": "178.9 * (115.0/100 ) (Base Charge * (%LTL Surcharge/100))", + "socioEconomicInd": "v,dv,s,w,o,8a,h", + "originProvince": null, + "originZip": "23059", + "destinationZip": "60611", + "destinationProvince": null, + "originCountryCode": "US00", + "destinationCountryCode": "US00", + "estimatedMileage": 783.1, + "estimatedWeight": 1000, + "pickupDate": "2020-06-16T00:00:00.000+0000", + "rateEffectiveDate": "2018-10-01T05:00:00.000+0000", + "rateExpiryDate": "2023-10-01T04:59:59.000+0000", + "accessorialsResults": [ + { + "estimatedCost": "68.00", + "frtAccessorialId": 15, + "unitsId": null, + "quantity": 0, + "accessorialCode": "550", + "accessorialCost": 68, + "usage": "Pickup" + }, + { + "estimatedCost": "634.31", + "frtAccessorialId": 13, + "unitsId": null, + "quantity": null, + "accessorialCode": "480", + "accessorialCost": 634.3110000000001, + "usage": null + } + ] + } +] +``` +

Back to top

+ +## Feedback + +For further assistance and feedback, please contact: + +Phone: 1-866-668-3472 +Email: gsatmsshelp@gsa.gov + +

Back to top

diff --git a/_apidocs/ratequeryhhg.md b/_apidocs/ratequeryhhg.md index 97e919ec8..dce750c0e 100644 --- a/_apidocs/ratequeryhhg.md +++ b/_apidocs/ratequeryhhg.md @@ -101,7 +101,8 @@ To begin using this API, you will need to register for an API Key. You can sign {% endraw %} -• After registering for the API Key, you will need to send an email to errc@gsa.gov requesting the Agency Token (x-agency-token). You must also attach to that email a completed copy of the Memorandum Of Understanding (MOU). [Click here to download the MOU template.](https://github.com/GSA/open-gsa-redesign/files/8064702/GSA_FAS_TTL_TMSS2.Rate.Query.API.TEMPLATE.Updated.1-28-22.docx) +• After registering for the API Key, you will need to send an email to errc@gsa.gov requesting the Agency Token (x-agency-token). You must also attach to that email a completed copy of the Memorandum Of Understanding (MOU). [Click here to download the MOU template.](https://github.com/GSA/open-gsa-redesign/files/12539068/GSA_FAS_TTL_TMSS2.Rate.Query.API.TEMPLATE.Updated.9-1-23.docx) + • Every API request must have the API key in the x-api-key and Agency Token in the x-agency-token of HTTP header with every API request. diff --git a/_apidocs/sam-entity-extracts-api.md b/_apidocs/sam-entity-extracts-api.md index 24581a336..7eb89c5b3 100644 --- a/_apidocs/sam-entity-extracts-api.md +++ b/_apidocs/sam-entity-extracts-api.md @@ -93,6 +93,25 @@ E.g.: The file generated on 04/05/2022 will show 2022095. E.g.: The file for 04/06/2022 would be SAM_Exclusions_Public_Extract_V2_22096.ZIP. + + +Daily FASCSA Exclusion Extracts + + + + @@ -233,7 +252,9 @@ Curl request with username and password: curl -X POST "https://api.sam.gov/data- fileName This parameter must be used on its own. It allows users to provide the extract file name.
-Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP; fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP +Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP;
+fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP;
+fileName= FASCSAOrders23277.CSV
@@ -295,9 +316,6 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen Extract Mapping Document and Layouts:
Please refer to the following:
@@ -346,6 +368,12 @@ Effective June 2023: SAM Maste + +
  • FASCSA Exclusions files:
    • + @@ -370,6 +398,7 @@ Effective June 2023:     SAM Maste
  • https://api.sam.gov/data-services/v1/extracts?fileType=ENTITY&sensitivity=SENSITIVE&frequency=MONTHLY&date=04/2022&charset=UTF8
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=SAM_Exclusions_Public_Extract_V2_22097.ZIP
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileType=EXCLUSION&date=04/07/2022
    • +
  • https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=FASCSAOrders23306.CSV
    • @@ -389,6 +418,7 @@ Extract files with UEI Information: * Click to view     FOUO Monthly V2 Extract File * Click to view Sensitive Monthly V3 Extract File * Click to view Exclusions Public V2 Extract File
    +* Click to view FASCSA Order Exclusions Public V2 Extract File

    Back to top

    @@ -479,5 +509,7 @@ Date | Version | Description 08/08/2022 | v3.1 | * Updated to clarify the use of Controlled Unclassified Information (CUI) data.

    03/13/2023 | v3.2 | * Deleted the MPIN row from the "SAM Master Extract Mapping" file.

    * Updated row # 288 (which used to track MPIN) in the "Sensitive Extract Layout" file to indicate that the field is deprecated.

    * Removed the MPIN value from the sample "Sensitive Monthly V3 Extract File".

    06/27/2023 | v3.3 | * Updated "Effective April 2022" to "Effective June 2023".

    * Updated the "June 2023 release: SAM Master Extract Mapping" STRING Clarification tab to include the following updates:
     1. NAICS Exception String table updated to reflect January 2023
     changes
     2. SBA Business Types String table updated to include new value:
     "A4- SBA Certified Small Disadvantaged Business"

    +09/11/2023 | v3.4 | * Removed "SAM Master Extract Mapping document".

    +12/01/2023 | v3.5 | A new FASCSA Order Exclusions Extract has been created, and the V1 Extracts Download API is now enabled to download this extract. As part of this change, below are the associated changes made to this OpenGSA page:

    * Updated the Extract Calendar to include information on the new FASCSA extract.

    * Updated the Query String Parameters section to reflect an example FASCSA extract file name.

    * Updated the Extract Mapping Document and Layouts section with a new FASCSA Exclusions extract layout document.

    * Updated the Sample Extract File Names with sample FASCSA Exclusions File Names.

    * Updated the Extract Download API Sample Requests section with a sample request for a FASCSA extract.

    * Updated the Sample Extract Files section with a new FASCSA Order Exclusions Public extract file.

    Back to top

    diff --git a/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf b/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf new file mode 100644 index 000000000..4d4b9e99e Binary files /dev/null and b/_apidocs/sam-entity-extracts-api/v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf differ diff --git a/_apidocs/sam-entity-extracts-api/v1/SAM_MASTER_EXTRACT_MAPPING v7.0.xlsx b/_apidocs/sam-entity-extracts-api/v1/SAM_MASTER_EXTRACT_MAPPING v7.0.xlsx deleted file mode 100644 index 9672d463f..000000000 Binary files a/_apidocs/sam-entity-extracts-api/v1/SAM_MASTER_EXTRACT_MAPPING v7.0.xlsx and /dev/null differ diff --git a/_apidocs/sam-entity-extracts-api/v1/openapi.yaml b/_apidocs/sam-entity-extracts-api/v1/openapi.yaml index a4fdda3cf..9aab733b6 100644 --- a/_apidocs/sam-entity-extracts-api/v1/openapi.yaml +++ b/_apidocs/sam-entity-extracts-api/v1/openapi.yaml @@ -49,7 +49,7 @@ paths: - name: frequency in: query description: >- - Specifies desired Frequecy level of the extract that they wish to + Specifies desired Frequency level of the extract that they wish to download required: false schema: @@ -116,7 +116,7 @@ paths: - name: frequency in: query description: >- - Specifies desired Frequecy level of the extract that they wish to + Specifies desired Frequency level of the extract that they wish to download required: false schema: diff --git a/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv b/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv new file mode 100644 index 000000000..ab3104cf6 --- /dev/null +++ b/_apidocs/sam-entity-extracts-api/v1/sample-files/FASCSAOrders23306.csv @@ -0,0 +1,7 @@ +Classification,Name,Prefix,First,Middle,Last,Suffix,Address 1,Address 2,City,State / Province,Country,Zip Code,Unique Entity ID,CAGE,Excluding Agency,Additional Comments,Active Date,Termination Date,Creation Date,Update Date,Exclusion Type,FASCSA Order Flag +Individual,,,SAM,A,SMITH,,,,CC,DC,USA,20008,,,,,3/2/2000,Indefinite,10/30/2023,10/30/2023,Ineligible (Proceedings Completed),Y +Individual,,,TEST,,TEST,,,,WASHINGTON,DC,USA,,,,,,10/30/2023,Indefinite,10/30/2023,10/30/2023,Prohibition/Restriction,Y +Special Entity Designation,ALPHA SED TEST 032522 1,,,,,,1 FIRST ST,,CUMBERLAND,MD,USA,21532,XKL8N41334B1,,,,2/2/2002,Indefinite,3/25/2022,10/30/2023,Ineligible (Proceedings Pending),Y +Special Entity Designation,APPLE CO,,,,,,CC,,CC,DC,USA,20008,SDYRXUJT7XA5,,,"This is an exclusion record with type of ""Prohibition/Restriction"".",3/2/2000,Indefinite,10/30/2023,10/30/2023,Prohibition/Restriction,Y +Firm,FOXTROT RESEARCH CORP,,,,,,,,,FL,USA,,J27QHBBBL1V3,,AF,,10/30/2023,Indefinite,10/31/2023,10/31/2023,Prohibition/Restriction,Y +Vessel,SHIPCC,,,,,,CC,,CC,DC,USA,20008,,,,This is a voluntary exclusion.,3/2/2000,Indefinite,10/30/2023,10/30/2023,Voluntary Exclusion,Y diff --git a/_apidocs/site-scanning-api.md b/_apidocs/site-scanning-api.md index 7382ecad5..6a5b73554 100644 --- a/_apidocs/site-scanning-api.md +++ b/_apidocs/site-scanning-api.md @@ -305,7 +305,7 @@ The API will return one of the following responses: ## Download the Data Directly -In order to download all of the scan data as a flat file, the system generates two sets of CSV and JSON exports every weekend. The primary set includes scan data for all live URLs (i.e. `Final URL - Live` = TRUE). This data can be accessed at: +In order to download all of the scan data as a flat file, the system generates two sets of CSV and JSON exports every weekend. The primary set includes scan data for all live URLs (i.e. `Final URL - Live` = TRUE), but excludes machine-readable data files (e.g. XML, JSON). This data can be accessed at: * [https://api.gsa.gov/technology/site-scanning/data/weekly-snapshot.csv](https://api.gsa.gov/technology/site-scanning/data/weekly-snapshot.csv) * [https://api.gsa.gov/technology/site-scanning/data/weekly-snapshot.json](https://api.gsa.gov/technology/site-scanning/data/weekly-snapshot.json) diff --git a/data.json b/data.json index 283f496fe..040cb106c 100644 --- a/data.json +++ b/data.json @@ -1429,7 +1429,7 @@ "@type": "dcat:Distribution", "mediaType": "text/csv", "title": "data_gov_bldg_rexus.csv", - "downloadURL": "https://inventory.data.gov/dataset/04247624-1d6b-4e03-84eb-9eda1a6ea638/resource/31312431-bbdd-4ba5-87dc-e2a4680718cf/download/data_gov_bldg_rexus.csv" + "downloadURL": "https://inventory.data.gov/dataset/04247624-1d6b-4e03-84eb-9eda1a6ea638/resource/d18c8987-c34f-46d1-a8bb-669a8f5874fd/download/data_gov_bldg_rexus.csv" } ], "keyword": ["building", "gsa", "owned", "property", "real estate", "real property"], @@ -1461,7 +1461,7 @@ "@type": "dcat:Distribution", "mediaType": "text/csv", "title": "data_gov_lse_rexus.csv", - "downloadURL": "https://inventory.data.gov/dataset/2cdc97b5-3029-4ec3-b3bf-baec7948bad1/resource/24434a4d-0bb4-4ff3-9fd4-275035539c1c/download/data_gov_lse_rexus.csv" + "downloadURL": "https://inventory.data.gov/dataset/2cdc97b5-3029-4ec3-b3bf-baec7948bad1/resource/cc077dba-4530-445a-91e0-50f7519bce41/download/data_gov_lse_rexus.csv" } ], "keyword": ["building", "gsa", "owned", "property", "real estate", "real property"], @@ -2155,39 +2155,6 @@ "programCode": ["023:012"], "language": ["en-us"], "theme": ["Acquisition"] - }, { - "@type": "dcat:Dataset", - "title": "GSA Visitor Logs", - "description": "GSA provides the logs of visitors signing in and out of GSA's headquarters buildings as part of the transparency goals of the agency.", - "modified": "2016-01-07", - "accessLevel": "public", - "identifier": "GSA-136951", - "dataQuality": true, - "license": "https://creativecommons.org/publicdomain/zero/1.0/", - "rights": "N/A", - "publisher": { - "@type": "org:Organization", - "name": "General Services Administration" - }, - "accrualPeriodicity": "R/P1M", - "contactPoint": { - "@type": "vcard:Contact", - "fn": "Alton M Bigelow", - "hasEmail": "mailto:alton.bigelow@gsa.gov" - }, - "distribution": [{ - "@type": "dcat:Distribution", - "mediaType": "text/html", - "format": "text/html", - "title": "GSA Visitor Logs", - "downloadURL": "http://gsa.gov/portal/content/306965" - } - ], - "keyword": ["Building", "GSA", "Headquarters", "Visitor"], - "bureauCode": ["023:00"], - "programCode": ["023:004"], - "language": ["en-us"], - "theme": ["People"] }, { "@type": "dcat:Dataset", "title": "Inventory Reporting Information System (IRIS)", @@ -2689,7 +2656,7 @@ "@type": "dcat:Dataset", "title": "Inventory of Owned and Leased Properties (IOLP)", "description": "The Inventory of Owned and Leased Properties (IOLP) allows users to search properties owned and leased by the General Services Administration (GSA) across the United States, Puerto Rico, Guam and American Samoa.\n\nThe Owned and Leased Data Sets include the following data except where noted below for Leases:\n\n- Location Code - GSA\u2019s alphanumeric identifier for the building\n- Real Property Asset Name - Allows users to find information about a specific building \n- Installation Name - Allows users to identify whether a property is part of an installation, such as a campus\n- Owned or Leased - Indicates the building is federally owned (F) or leased (L)\n- GSA Region - GSA assigned region for building location\n- Street Address/City/State/Zip Code - Building address\n- Longitude and Latitude - Map coordinates of the building (only through .csv export)\n- Rentable Square Feet - Total rentable square feet in building\n- Available Square Feet - Vacant space in building\n- Construction Date (Owned Only) - Year built\n- Congressional District - Congressional District building is located\n- Senator/Representative/URL - Senator/Representative of the Congressional District and their URL\n- Building Status - Indicates building is active\n- Lease Number (Leased Only) - GSA\u2019s alphanumeric identifier for the lease\n- Lease Effective/Expiration Dates (Leased Only) - Date lease starts/expires\n- Real Property Asset Type - Identifies a property as land, building, or structure", - "modified": "2023-03-20T13:39:21.114Z", + "modified": "2023-11-16T21:38:25.152Z", "accessLevel": "public", "identifier": "GSA-4495", "dataQuality": true, @@ -2708,23 +2675,21 @@ "hasEmail": "mailto:valerie.butler@gsa.gov" }, "distribution": [{ - "@type": "dcat:Distribution", - "conformsTo": "http://www.isotc211.org/2005/gmd" - }, { "@type": "dcat:Distribution", "mediaType": "application/xml", "title": "IOLP19139_080123.xml", + "conformsTo": "http://www.isotc211.org/2005/gmd", "downloadURL": "https://inventory.data.gov/dataset/9a9e946e-124e-46f5-a934-e458a6c1c2b2/resource/bfbd1f68-b7d8-4822-98bb-4eceabd2c3a7/download/iolp19139_080123.xml" }, { "@type": "dcat:Distribution", "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", - "title": "IOLP Leases 8.17.23.xlsx", - "downloadURL": "https://inventory.data.gov/dataset/9a9e946e-124e-46f5-a934-e458a6c1c2b2/resource/9cdf9d68-8943-4923-99bb-d5a596f4f2e1/download/iolp-leases-8.17.23.xlsx" + "title": "IOLP Buildings 11.30.23.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/9a9e946e-124e-46f5-a934-e458a6c1c2b2/resource/fc2c814f-54ab-491b-ad7b-b4bc4714285d/download/iolp-buildings-11.30.23.xlsx" }, { "@type": "dcat:Distribution", "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", - "title": "IOLP Buildings 8.17.23.xlsx", - "downloadURL": "https://inventory.data.gov/dataset/9a9e946e-124e-46f5-a934-e458a6c1c2b2/resource/f69309ae-d71a-4d82-b92f-ae9597a2867a/download/iolp-buildings-8.17.23.xlsx" + "title": "IOLP Leases 11.30.23.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/9a9e946e-124e-46f5-a934-e458a6c1c2b2/resource/ffd2b9ff-876c-4873-acf6-c148f6c2ea89/download/iolp-leases-11.30.23.xlsx" } ], "keyword": ["BUILDING_STATUS", "City", "LEASE_EFFECTIVE_DATE", "LEASE_EXPIRATION_DATE", "Latitude", "Lease_Num", "Longitude", "STATE_CD", "STREET_ADDRESS", "Zipcode5", "geospatial"], @@ -3232,7 +3197,7 @@ "@type": "dcat:Dataset", "title": "RWA Entry & Tracking Application (RETA)", "description": "The Reimbursable Work Authorization (RWA) Entry & Tracking Application (RETA) is a web based system that serves the Public Buildings Service as a centralized repository for Reimbursable Work Authorization information. It is a national PBS RWA database warehouse with electronic interface capabilities into the NEAR RWA Database System.", - "modified": "2015-11-19", + "modified": "2023-11-27T19:54:14.144Z", "accessLevel": "public", "identifier": "GSA-5008", "dataQuality": true, @@ -3248,20 +3213,17 @@ "accrualPeriodicity": "R/P1D", "contactPoint": { "@type": "vcard:Contact", - "fn": "Mort Morton Glassberg", - "hasEmail": "mailto:william.glassberg@gsa.gov" + "fn": "Rachel Bichsel", + "hasEmail": "mailto:rachel.bichsel@gsa.gov" }, "distribution": [{ "@type": "dcat:Distribution", - "mediaType": "application/zip", - "format": "csv", - "title": "RWA Entry & Tracking Application (RETA)", - "downloadURL": "http://www.gsa.gov/dg/RETADataGov.zip" + "accessURL": "http://www.gsa.gov/rwa" } ], "keyword": ["Building", "Construction", "Historic", "Space"], - "bureauCode": ["023:05"], - "programCode": ["023:002"], + "bureauCode": ["015:11"], + "programCode": ["015:001"], "language": ["en-us"], "theme": ["Real Estate"] }, { @@ -4574,42 +4536,6 @@ "programCode": ["023:014"], "language": ["en-us"], "theme": ["Acquisition"] - }, { - "@type": "dcat:Dataset", - "title": "Federal Real Property Profile (FRPP)", - "description": "The Federal Real Property Report includes summary data for the federal government's inventory of land, building, and structure assets around the world, as of September 30th each year.", - "modified": "2016-05-10", - "accessLevel": "public", - "identifier": "GSA - 138962", - "dataQuality": true, - "license": "https://creativecommons.org/publicdomain/zero/1.0/", - "rights": "N/A", - "publisher": { - "@type": "org:Organization", - "name": "General Services Administration" - }, - "accrualPeriodicity": "R/P1Y", - "contactPoint": { - "@type": "vcard:Contact", - "fn": "Aluanda Drain", - "hasEmail": "mailto:aluanda.drain@gsa.gov" - }, - "distribution": [{ - "@type": "dcat:Distribution", - "mediaType": "text/html", - "format": "text/html", - "title": "Federal Real Property Profile (FRPP)", - "downloadURL": "http://gsa.gov/portal/content/102880" - }, { - "@type": "dcat:Distribution", - "conformsTo": "http://www.isotc211.org/2005/gmd" - } - ], - "keyword": ["FRPP", "Federal Property", "GSA", "General Services Property", "Geospatial", "NGDA Portfolio Themes", "Real Estate", "Real Property Theme", "ngda"], - "bureauCode": ["023:05"], - "programCode": ["023:003"], - "language": ["en-us"], - "theme": ["Real Estate"] }, { "@type": "dcat:Dataset", "title": "Federal Strategic Sourcing Initiative(FSSI) Wireless", @@ -5662,8 +5588,8 @@ "distribution": [{ "@type": "dcat:Distribution", "mediaType": "application/json", - "title": "EDI 8.22.json", - "downloadURL": "https://inventory.data.gov/dataset/acf8e47e-24d2-4e4d-a786-847643f101fd/resource/10fd5553-348b-498f-a14d-67576dc1eebd/download/edi-8.22.json" + "title": "EDI 11.30.json", + "downloadURL": "https://inventory.data.gov/dataset/acf8e47e-24d2-4e4d-a786-847643f101fd/resource/3ba61ef1-1b51-4761-b66e-d54ce9d7ab30/download/edi-11.30.json" } ], "keyword": ["EDI", "Enterprise Data Inventory", "GSA EDI", "JSON"], @@ -5729,7 +5655,7 @@ "mediaType": "application/json", "format": "JSON", "title": "GSA IT Reform Cost Savings/Avoidance", - "description": "GSA's August 2023 Cost Savings/Avoidance submission to satisfy the requirements set forth in OMB's Integrated Data Collection.", + "description": "GSA's November 2023 Cost Savings/Avoidance submission to satisfy the requirements set forth in OMB's Integrated Data Collection.", "conformsTo": "https://management.cio.gov/schemaexamples/costSavingsAvoidanceSchema.json", "downloadURL": "https://inventory.data.gov/dataset/57f52388-9b32-4069-925f-e0de9c5c6ea4/resource/87eb8833-7abb-432b-a272-e611c0aff04a/download/gsaitcostsavingsavoidance20151125.json" } @@ -6513,7 +6439,7 @@ "mediaType": "application/pdf", "format": "pdf", "title": "2015 GSA Common Baseline Implementation Plan and CIO Assignment Plan", - "description": "This is GSA's 2015 Common Baseline Implementation Plan and its CIO Assignment Plan per the requirements set forth in FITARA legislation. Updated April 2017. Last Major Change to version updated on March 4, 2019. Last Major change to version update on 8/5/2020. Last Major change to version update on 03/24/2022. Updated on 3/14/23 to add roles of SAOP and CPO to personnel list. Also updated new CTO name and contact info. Updated 5/11/2023 to add acting roles and delegation of authorities link. Updated 8/10/2023 to add personnel change.", + "description": "This is GSA's 2015 Common Baseline Implementation Plan and its CIO Assignment Plan per the requirements set forth in FITARA legislation. Updated April 2017. Last Major Change to version updated on March 4, 2019. Last Major change to version update on 8/5/2020. Last Major change to version update on 03/24/2022. Updated on 3/14/23 to add roles of SAOP and CPO to personnel list. Also updated new CTO name and contact info. Updated 5/11/2023 to add acting roles and delegation of authorities link. Updated most recently on 11/16/23 to update personnel changes.) MF", "downloadURL": "https://inventory.data.gov/dataset/64c56cec-4b8f-44c7-ba69-090517f9f32e/resource/87e53999-aff1-4560-8bf0-42d9dc8e4a69/download/2015gsafitaraimplementationandcioassignmentplan.pdf" } ], @@ -7621,8 +7547,8 @@ "@type": "dcat:Distribution", "mediaType": "application/json", "format": "json", - "title": "GSA FITARA Actions and Milestones 2023-08-14", - "description": "GSA's Actions and Milestones JSON file to fulfill the FITARA requirements for the August 2023 quarterly submission to OMB on August 14, 2023.", + "title": "GSA FITARA Actions and Milestones 2023-11-09", + "description": "GSA's Actions and Milestones JSON file to fulfill the FITARA requirements for the November 2023 quarterly submission to OMB on November 9, 2023.", "conformsTo": "https://management.cio.gov/schemaexamples/FITARA_milestones_schema.json", "downloadURL": "https://inventory.data.gov/dataset/cedf61aa-c4c8-4c30-8357-9d57362afe9b/resource/69cf9b0f-fe64-4ec3-a082-664d34497d5e/download/fitaramilestones.json" } @@ -8905,7 +8831,7 @@ "@type": "dcat:Dataset", "title": "FY2020 Federal Real Property Profile (FRPP) Summary Data by Installation Name", "description": "A XLSX export of summarized data for specified assets contained within the FRPP, a database of Federal Real Property for executive agencies, are not included in the detailed level dataset..", - "modified": "2022-11-10T15:37:54.612Z", + "modified": "2023-10-06T19:08:36.619Z", "accessLevel": "public", "identifier": "GSA-2021-05-13-01", "license": "https://creativecommons.org/publicdomain/zero/1.0/", @@ -11805,7 +11731,7 @@ "@type": "dcat:Dataset", "title": "FY21 Federal Real Property Profile", "description": "The Federal Real Property Report includes summary data for the federal government's inventory of land, building, and structure assets around the world.", - "modified": "2022-09-29T16:15:38.332Z", + "modified": "2023-10-06T19:13:22.373Z", "accessLevel": "public", "identifier": "GSA-2022-09-29-01", "dataQuality": true, @@ -11825,11 +11751,6 @@ "hasEmail": "mailto:stephanie.klodzen@gsa.gov" }, "distribution": [{ - "@type": "dcat:Distribution", - "mediaType": "application/xml", - "title": "FedRealPropertyProfileDataforCivilianAgencies_PublicDataset_FRPP_GSA_corrected_20230424.xml", - "downloadURL": "https://inventory.data.gov/dataset/ba12ef9a-2a84-4da7-a943-8772c176d5ff/resource/84b69557-0553-48b8-ae77-5acd9c698f8b/download/fedrealpropertyprofiledataforcivilianagencies_publicdataset_frpp_gsa_corrected_20230424.xml" - }, { "@type": "dcat:Distribution", "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "title": "FRPP_Public_Dataset_FY21_Final_02242023 (1).xlsx", @@ -11839,7 +11760,7 @@ "conformsTo": "http://www.isotc211.org/2005/gmd" } ], - "keyword": ["FRPP", "Federal Property", "General Services Property", "NGDA Portfolio Themes", "Real Property Theme", "geospatial", "gsa", "ngda", "real estate"], + "keyword": ["FRPP", "Federal Property", "General Services Property", "Real Property Theme", "geospatial", "gsa", "real estate"], "bureauCode": ["015:11"], "programCode": ["015:001"], "language": ["en-US"] @@ -12230,6 +12151,11 @@ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "title": "TotRevFY23_3rdQtr.xlsx", "downloadURL": "https://inventory.data.gov/dataset/fc20d688-f8b4-46f1-8369-ae2dbde89ef9/resource/f3d99e72-d5a8-4b4a-afef-ac2182ad8f74/download/totrevfy23_3rdqtr.xlsx" + }, { + "@type": "dcat:Distribution", + "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "title": "TotRevFY23_4thQtr.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/fc20d688-f8b4-46f1-8369-ae2dbde89ef9/resource/993874ef-c4b0-4570-89db-8dcd7e078808/download/totrevfy23_4thqtr.xlsx" } ], "keyword": ["Networx", "billing", "networx business volume", "telecommunications"], @@ -12269,6 +12195,16 @@ "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "title": "EISTotRevFY23_Q2.xlsx", "downloadURL": "https://inventory.data.gov/dataset/5691fe5b-1055-4a3c-888c-4ac52cf87f06/resource/1910f4bc-d8e4-4b67-b8c3-31f954f475c1/download/eistotrevfy23_q2.xlsx" + }, { + "@type": "dcat:Distribution", + "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "title": "EISTotRevFY23_Q3.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/5691fe5b-1055-4a3c-888c-4ac52cf87f06/resource/0cfc1588-f8ce-4c32-b82a-779704c10b9d/download/eistotrevfy23_q3.xlsx" + }, { + "@type": "dcat:Distribution", + "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "title": "EISTotRevFY23_Q4.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/5691fe5b-1055-4a3c-888c-4ac52cf87f06/resource/165c6c6d-d1ab-4d8d-8270-006a5e9cbe5c/download/eistotrevfy23_q4.xlsx" } ], "keyword": ["Business Volume", "eis", "enterprise-infrastructure", "gsa", "telecommunications"], @@ -12441,15 +12377,129 @@ "distribution": [{ "@type": "dcat:Distribution", "mediaType": "application/pdf", - "title": "ADM_545039D_CHGE_13_Delegations_of_Authority_Manual,_Chapter_9,_Office_of_GSA_IT_#CC041467.pdf", - "description": "GSA has a Delegation of Authority for services and staff offices found here. Each org has a different chapter and GSA's Office of GSA IT (GSA IT) is found in chapter 9 which is posted here.", - "downloadURL": "https://inventory.data.gov/dataset/a8552a76-8671-42d9-854a-2c8e9d17841e/resource/334abbd2-57a1-46e0-8310-061126fffab7/download/adm_545039d_chge_13_delegations_of_authority_manual_chapter_9_office_of_gsa_it_policy_-_posted_v.pdf" + "title": "ADM_5450.39D_CHGE_22_Delegations_of_Authority_Manual,_Chapter_9.docx.pdf", + "downloadURL": "https://inventory.data.gov/dataset/a8552a76-8671-42d9-854a-2c8e9d17841e/resource/7152b860-8b85-4aa1-951b-90fa951ad646/download/adm_5450.39d_chge_22_delegations_of_authority_manual_chapter_9.docx.pdf" } ], "keyword": ["authority", "delegation"], "bureauCode": ["015:11"], "programCode": ["015:001"], "language": ["en-US"] + }, { + "@type": "dcat:Dataset", + "title": "FY 2022 Federal Real Property Profile (FRPP) Public Dataset", + "description": "The Federal Real Property Profile Management System (FRPP MS) is the federal government\u2019s centralized inventory of real property under the custody and control of executive branch agencies. Due to national security and other authorized exclusions, some FRPP data is not available to the public.", + "modified": "2023-10-30T18:08:03.903Z", + "accessLevel": "public", + "identifier": "GSA-2023-10-06-01", + "describedBy": "https://www.gsa.gov/policy-regulations/policy/real-property-policy/asset-management/federal-real-property-council-frpc/frpc-guidance-library", + "describedByType": "application/pdf", + "license": "https://creativecommons.org/publicdomain/zero/1.0/", + "rights": "true", + "publisher": { + "@type": "org:Organization", + "name": "Office of Government-wide Policy", + "subOrganizationOf": { + "@type": "org:Organization", + "name": "Office of Government-wide Policy" + } + }, + "accrualPeriodicity": "R/P1Y", + "contactPoint": { + "@type": "vcard:Contact", + "fn": "Stephanie Klodzen", + "hasEmail": "mailto:stephanie.klodzen@gsa.gov" + }, + "distribution": [{ + "@type": "dcat:Distribution", + "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "title": "FRPP_Public_Dataset_FY22_Final_051012023.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/d6d3b812-2847-4886-ac1a-6e07a4b737ff/resource/4eba1f55-e992-45d6-ae43-3dc3732fc2f2/download/frpp_public_dataset_fy22_final_051012023.xlsx" + }, { + "@type": "dcat:Distribution", + "conformsTo": "http://www.isotc211.org/2005/gmd" + } + ], + "keyword": ["Civilian", "FRPP", "Federal Real Property Profile", "General Services Property", "RTF", "Real Estate", "Warehouse", "building", "geospatial", "gsa", "land", "real pro", "reduce the footprint", "structure"], + "bureauCode": ["015:11"], + "programCode": ["015:001"], + "language": ["en-US"] + }, { + "@type": "dcat:Dataset", + "title": "FY2022 Federal Real Property Profile Summary Data by Installation Name", + "description": "A XLSX export of summarized data for all DoD and specified civilian agency assets contained within the FRPP, a government-wide database of executive branch agency federal real property assets, that cannot be made public at a detailed level. Data for these records is summarized at the Installation Level.", + "modified": "2023-10-20T18:48:57.947Z", + "accessLevel": "public", + "identifier": "GSA-2023-10-20", + "describedBy": "https://www.gsa.gov/policy-regulations/policy/real-property-policy/asset-management/federal-real-property-council-frpc/frpc-guidance-library", + "describedByType": "application/pdf", + "license": "https://creativecommons.org/publicdomain/zero/1.0/", + "rights": "true", + "publisher": { + "@type": "org:Organization", + "name": "General Services Administration", + "subOrganizationOf": { + "@type": "org:Organization", + "name": "General Services Administration" + } + }, + "accrualPeriodicity": "R/P1Y", + "contactPoint": { + "@type": "vcard:Contact", + "fn": "Stephanie Klodzen", + "hasEmail": "mailto:stephanie.klodzen@gsa.gov" + }, + "distribution": [{ + "@type": "dcat:Distribution", + "mediaType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "title": "FY-2022-frpp-summarized-data-by-installation-10.10.2023.xlsx", + "downloadURL": "https://inventory.data.gov/dataset/da3e4fcd-bb9a-4d3c-bc3d-ba9bf2fbcfe9/resource/b470d8d2-13f8-46ed-83bd-70d822b27167/download/fy-2022-frpp-summarized-data-by-installation-10.10.2023.xlsx" + } + ], + "keyword": ["FRPP", "Federal Real Property Profile", "General Services Administration", "Installation Name", "building", "land", "real property"], + "bureauCode": ["015:11"], + "programCode": ["015:001"], + "language": ["en-US"] + }, { + "@type": "dcat:Dataset", + "title": "Federal Real Property Profile (FRPP)", + "description": "An ISO compliant metadata file to be used for harvesting the FRPP NGDA to the geoPlatform.", + "modified": "2023-11-16T21:39:37.158Z", + "accessLevel": "public", + "identifier": "GSA-2023-10-30-01", + "dataQuality": true, + "describedBy": "https://www.gsa.gov/policy-regulations/policy/real-property-policy/asset-management/federal-real-property-council-frpc/frpc-guidance-library", + "describedByType": "application/pdf", + "license": "https://creativecommons.org/publicdomain/zero/1.0/", + "rights": "true", + "spatial": "United States", + "publisher": { + "@type": "org:Organization", + "name": "General Services Administration", + "subOrganizationOf": { + "@type": "org:Organization", + "name": "General Services Administration" + } + }, + "accrualPeriodicity": "R/P1Y", + "contactPoint": { + "@type": "vcard:Contact", + "fn": "Stephanie Klodzen", + "hasEmail": "mailto:stephanie.klodzen@gsa.gov" + }, + "distribution": [{ + "@type": "dcat:Distribution", + "mediaType": "application/xml", + "title": "FedRealPropertyProfileDataFRPP_NGDARecord_GSA_20231011 (1).xml", + "conformsTo": "http://www.isotc211.org/2005/gmd", + "downloadURL": "https://inventory.data.gov/dataset/ebd7d483-e022-4940-8480-e7b92555754d/resource/b86810c6-f9b3-4688-aa59-fb89d172a2ba/download/fedrealpropertyprofiledatafrpp_ngdarecord_gsa_20231011-1.xml" + } + ], + "keyword": ["FRPP", "Federal Real Property Profile", "General Services Administration", "NGDA", "Real Property Theme", "building", "geospatial", "land", "real property", "structure"], + "bureauCode": ["015:11"], + "programCode": ["015:001"], + "language": ["en-US"], + "theme": ["geospatial"] } ] }