Skip to content

Commit

Permalink
Merge branch 'master' into apidoc-fsrsbulkupload
Browse files Browse the repository at this point in the history
  • Loading branch information
ritchasharmagsa authored Dec 5, 2023
2 parents 1faa7d3 + acc13bc commit d8216a2
Show file tree
Hide file tree
Showing 15 changed files with 1,272 additions and 412 deletions.
4 changes: 2 additions & 2 deletions _apidocs/entity-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8809,8 +8809,7 @@ You can view the full details of this API in the OpenAPI Specification file avai
<p><small><a href="#">Back to top</a></small></p>

## Additional Help References
1. <a href="v1/SAM_REPS_AND_CERTS_MAPPING.xlsx">Reps and Certs Mapping</a>
2. <a href="v1/SAM Functional Data Dictionary_June 23_v2.pdf" target="_blank">Data Dictionary</a>
Go to <a target="_blank" href="https://sam.gov/data-services/Data%20Dictionary/Entity%20Information">SAM.gov Data Services</a> for Reps and Certs Mapping and Data Dictionary documents.


## HTTP Response Codes
Expand Down Expand Up @@ -12354,5 +12353,6 @@ Disclaimer:
| 02/28/2023 | v4.2 | * Removed MPIN occurrences from the Data Dictionary and the "Overview" > "Sensitive (CUI) Data" section. <br><br> * 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.

<p><small><a href="#">Back to top</a></small></p>
711 changes: 420 additions & 291 deletions _apidocs/exclusions-api.md

Large diffs are not rendered by default.

290 changes: 290 additions & 0 deletions _apidocs/exclusions-api/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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: {}
4 changes: 2 additions & 2 deletions _apidocs/get-opportunities-public-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ state| Place of Performance (State)| No |String | v2
status (Coming Soon)| Status of the opportunity <br> 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 <br> *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 <br> *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
Expand Down Expand Up @@ -573,4 +573,4 @@ Date | Version | Description



<p><small><a href="#">Back to top</a></small></p>
<p><small><a href="#">Back to top</a></small></p>
4 changes: 2 additions & 2 deletions _apidocs/opportunities-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions _apidocs/perdiem.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -111,7 +111,7 @@ You can view the full details of this API in the <a href="v2/openapi.yaml">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.

Expand Down
Loading

0 comments on commit d8216a2

Please sign in to comment.