Merge branch 'master' into IAEMOD-21279

_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: {}

_apidocs/sam-entity-extracts-api.md

@@ -93,6 +93,25 @@ E.g.: The file generated on 04/05/2022 will show 2022095.</li>
   E.g.: The file for 04/06/2022 would be SAM_Exclusions_Public_Extract_V2_22096.ZIP.
 </li></ul>
 </td>
+</tr>
+<tr>
+<td>Daily FASCSA Exclusion Extracts </td>
+<td>
+<ul>
+ <li>They are produced every day. Kindly check after 7 AM Eastern time.</li>
+ <li>The date on the .CSV file matches the date when the file was generated.</li>
+ <li>The file generated on 10/04/23 will show 23277.</li>
+ <li>These files contains all FASCSA active exclusions.</li>       
+ <li>File Naming Convention:<br>                                                                                                                                                                          
+   <b>Daily ASCII:</b>
+   <ul>
+    <li>FASCSAOrdersYYDDD.CSV (YYDDD is the Julian Date)</li>
+   </ul>
+   E.g.: The file for 10/04/2023 would be FASCSAOrders23277.CSV.
+ </li>
+</ul>
+</td>
+
 </tr>
 
 </table>
@@ -233,7 +252,9 @@ Curl request with username and password: curl -X POST "https://api.sam.gov/data-
 <tr>
 <td>fileName</td>
 <td>This parameter must be used on its own. It allows users to provide the extract file name.<br />
-Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP; fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP
+Examples: fileName=SAM_PUBLIC_MONTHLY_V2_20220406.ZIP;<br/>
+fileName= SAM_Exclusions_Public_Extract_V2_22096.ZIP;<br/>
+fileName= FASCSAOrders23277.CSV<br/>
 </td>
 </tr>
 
@@ -311,6 +332,10 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen
 <a target="_blank" rel="noopener noreferrer" href="v1/SAM_Exclusions_Public_Extract_Layout_V2.pdf">Exclusions Extract Layout</a><br>
 </li>
 
+<li><b>FASCSA Exclusions Public extract layout with the UEI data: </b><br>
+<a target="_blank" rel="noopener noreferrer" href="v1/SAM_Exclusions_Public_FASCSA_Orders_Extract_Layout_V2.pdf">FASCSA Exclusions Extract Layout</a><br>
+</li>
+
 </ul>
 </details>
 
@@ -343,6 +368,12 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen
 <ul>
 <li>SAM_Exclusions_Public_Extract_V2_22096.ZIP</li>
 <li>SAM_Exclusions_Public_Extract_V2_22097.ZIP</li>
+</ul>
+
+<li><b>FASCSA Exclusions files:</b></li>
+<ul>
+<li>FASCSAOrders23306.CSV</li>
+<li>FASCSAOrders23305.CSV</li>
 </ul></ul>
 </details>
 
@@ -367,6 +398,7 @@ Permitted values: V2 for the Public, FOUO and Exclusion extracts; V3 for the Sen
 <li>https://api.sam.gov/data-services/v1/extracts?fileType=ENTITY&sensitivity=SENSITIVE&frequency=MONTHLY&date=04/2022&charset=UTF8</li>
 <li>https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=SAM_Exclusions_Public_Extract_V2_22097.ZIP</li>
 <li>https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileType=EXCLUSION&date=04/07/2022</li>
+<li>https://api.sam.gov/data-services/v1/extracts?api_key={API KEY}&fileName=FASCSAOrders23306.CSV</li>
 </ul>
 </details>
 
@@ -386,6 +418,7 @@ Extract files with UEI Information:
 * Click to view <a href="v1/sample-files/SAM_FOUO_MONTHLY_V2_20200414.ZIP">FOUO Monthly V2 Extract File</a>
 * Click to view <a href="v1/sample-files/SAM_SENSITIVE_MONTHLY_V3_20200414.ZIP">Sensitive Monthly V3 Extract File</a>
 * Click to view <a href="v1/sample-files/SAM_Exclusions_Public_Extract_V2_22018.zip">Exclusions Public V2 Extract File</a><br>
+* Click to view <a href="v1/sample-files/FASCSAOrders23306.csv">FASCSA Order Exclusions Public V2 Extract File</a><br>
 
 <p><small><a href="#">Back to top</a></small></p>
 
@@ -477,5 +510,6 @@ Date | Version | Description
 03/13/2023 | v3.2    | * Deleted the MPIN row from the "SAM Master Extract Mapping" file.<br><br> * Updated row # 288 (which used to track MPIN) in the "Sensitive Extract Layout" file to indicate that the field is deprecated.<br><br> * Removed the MPIN value from the sample "Sensitive Monthly V3 Extract File".<br><br>
 06/27/2023 | v3.3    | * Updated "Effective April 2022" to "Effective June 2023". <br><br> * Updated the "June 2023 release: SAM Master Extract Mapping" STRING Clarification tab to include the following updates: <br>&emsp;1. NAICS Exception String table updated to reflect January 2023 <br>&emsp;changes<br>&emsp;2. SBA Business Types String table updated to include new value: <br>&emsp;"A4- SBA Certified Small Disadvantaged Business"<br><br>
 09/11/2023 | v3.4    | * Removed "SAM Master Extract Mapping document". <br><br>
+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:<br><br> * Updated the Extract Calendar to include information on the new FASCSA extract.<br><br> * Updated the Query String Parameters section to reflect an example FASCSA extract file name.<br><br> * Updated the Extract Mapping Document and Layouts section with a new FASCSA Exclusions extract layout document.<br><br> * Updated the Sample Extract File Names with sample FASCSA Exclusions File Names.<br><br> * Updated the Extract Download API Sample Requests section with a sample request for a FASCSA extract.<br><br> * Updated the Sample Extract Files section with a new FASCSA Order Exclusions Public extract file.<br><br>
 
 <p><small><a href="#">Back to top</a></small></p>