diff --git a/APIDOCS.md b/APIDOCS.md index e20689a0e..236466e65 100644 --- a/APIDOCS.md +++ b/APIDOCS.md @@ -6,11 +6,11 @@ A live example of this is available here: - Without the Swagger UI interactive documentation: https://open.gsa.gov/api/sample-api-basic/ - With the Swagger UI interactive documentation: https://open.gsa.gov/api/sample-api/ -The API documentation on open.gsa.gov is managed by the Cloud Integration Shared Services (CISS) team. +The API documentation on open.gsa.gov is managed by the GSA Office of the CTO. ## Steps to add you API documentation to the GSA API Directory -1. [Contact CISS](mailto:api.ciss@gsa.gov) and ask for access to manage API docs, sharing your GitHub ID. Your GitHub ID will have to be in the GSA GitHub organization; follow the instructions in the [GitHub Administration repository](https://github.com/GSA/GitHub-Administration) if you haven't done so yet. +1. [Contact the CTO team](mailto:cto@gsa.gov) and ask for access to manage API docs, sharing your GitHub ID. Your GitHub ID will have to be in the GSA GitHub organization; follow the instructions in the [GitHub Administration repository](https://github.com/GSA/GitHub-Administration) if you haven't done so yet. 2. Create a branch of the site from the `master` branch. Naming convention for new branch: `apidocs-apiname-YYYYMMDD` (replace `apiname` with the name of your API without spaces) @@ -34,12 +34,12 @@ The API documentation on open.gsa.gov is managed by the Cloud Integration Shared 4. Edit the `apiname.md` file with all of the information about your API. When you commit your changes to your repo in GitHub, a preview will be available of the site (with your doco) at this URL after waiting 5 min or so for the preview to build: https://federalist-ecc58765-2903-48b3-920c-5d93318ad084.app.cloud.gov/preview/gsa/open-gsa-redesign/YOUR_BRANCH_NAME/api/YOUR_API_NAME/ (insert your branch name and API name where indicated) - -5. When you are ready to publish in the API directory, [open a pull request (PR)](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the `master` branch. Email the [CISS API team](mailto:api.ciss@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. -6. The CISS team will merge your branch with `master`, resulting in your doco going to the live website. At this point, you will see your API doco at: https://open.gsa.gov/api/YOUR_API_NAME/ +5. When you are ready to publish in the API directory, [open a pull request (PR)](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the `master` branch. Email the [CTO team](mailto:cto@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. - You can also ask the CISS team to add your API to the `/_data/api-list.yml` file, which will add your API to the directory page: https://open.gsa.gov/api/ +6. The CTO team will merge your branch with `master`, resulting in your doco going to the live website. At this point, you will see your API doco at: https://open.gsa.gov/api/YOUR_API_NAME/ + + You can also ask the CTO team to add your API to the `/_data/api-list.yml` file, which will add your API to the directory page: https://open.gsa.gov/api/ ## Adding Swagger UI to your existing API documentation (with Try It Out functionality) @@ -101,5 +101,5 @@ In order to remove the API documentation: 2. In that branch, delete the relevant markdown file in the `_apidocs` [folder](https://github.com/GSA/open-gsa-redesign/tree/master/_apidocs). 3. In that branch, delete the relevant openapi yml file that is in a subfolder of the `_apidocs` [folder](https://github.com/GSA/open-gsa-redesign/tree/master/_apidocs). 4. In that branch, delete the reference to your API in [the api-list.yml file](https://github.com/GSA/open-gsa-redesign/blob/master/_data/api-list.yml) which populates the [directory page](https://open.gsa.gov/api/). -5. When you are ready to complete the removal, [open a pull request](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the master branch. [Email the CISS API team](mailto:api.ciss@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. -6. The CISS team will merge your branch with master, resulting in your documentation being deleted from the live website, and the reference to it on the directory page being removed. +5. When you are ready to complete the removal, [open a pull request](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the master branch. [Email the CTO team](mailto:cto@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. +6. The CTO team will merge your branch with master, resulting in your documentation being deleted from the live website, and the reference to it on the directory page being removed. diff --git a/Gemfile.lock b/Gemfile.lock index 07a287a97..aed170514 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -9,20 +9,21 @@ GIT GEM remote: https://rubygems.org/ specs: - Ascii85 (1.1.0) + Ascii85 (1.1.1) addressable (2.8.6) public_suffix (>= 2.0.2, < 6.0) afm (0.2.2) - async (2.8.2) - console (~> 1.10) + async (2.11.0) + console (~> 1.25, >= 1.25.2) fiber-annotation - io-event (~> 1.1) + io-event (~> 1.5, >= 1.5.1) timers (~> 4.1) + bigdecimal (3.1.8) colorator (1.1.0) concurrent-ruby (1.2.3) - console (1.23.4) + console (1.25.2) fiber-annotation - fiber-local + fiber-local (~> 1.1) json em-websocket (0.5.3) eventmachine (>= 0.12.9) @@ -37,13 +38,15 @@ GEM execjs (2.9.1) ffi (1.16.3) fiber-annotation (0.2.0) - fiber-local (1.0.0) + fiber-local (1.1.0) + fiber-storage + fiber-storage (0.1.0) forwardable-extended (2.6.0) hashery (2.1.2) hawkins (2.0.5) em-websocket (~> 0.5) jekyll (~> 3.1) - html-proofer (5.0.8) + html-proofer (5.0.9) addressable (~> 2.3) async (~> 2.1) nokogiri (~> 1.13) @@ -56,7 +59,7 @@ GEM http_parser.rb (0.8.0) i18n (1.14.1) concurrent-ruby (~> 1.0) - io-event (1.4.4) + io-event (1.5.1) jekyll (3.9.5) addressable (~> 2.4) colorator (~> 1.0) @@ -77,8 +80,8 @@ GEM nokogiri (~> 1.12) jekyll-watch (2.2.1) listen (~> 3.0) - json (2.7.1) - json-schema (4.1.1) + json (2.7.2) + json-schema (4.3.0) addressable (>= 2.8) kramdown (2.4.0) rexml @@ -89,14 +92,14 @@ GEM rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.3.6) - mini_portile2 (2.8.5) + mini_portile2 (2.8.6) multi_json (1.15.0) - nokogiri (1.16.2) + nokogiri (1.16.5) mini_portile2 (~> 2.8.2) racc (~> 1.4) - nokogiri (1.16.2-arm64-darwin) + nokogiri (1.16.5-arm64-darwin) racc (~> 1.4) - nokogiri (1.16.2-x86_64-linux) + nokogiri (1.16.5-x86_64-linux) racc (~> 1.4) pathutil (0.16.2) forwardable-extended (~> 2.6) @@ -107,10 +110,10 @@ GEM ruby-rc4 ttfunk power_assert (2.0.3) - public_suffix (5.0.4) + public_suffix (5.0.5) racc (1.7.3) rainbow (3.1.1) - rake (13.1.0) + rake (13.2.1) rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) @@ -126,7 +129,8 @@ GEM test-unit (3.6.2) power_assert timers (4.3.5) - ttfunk (1.7.0) + ttfunk (1.8.0) + bigdecimal (~> 3.1) typhoeus (1.4.1) ethon (>= 0.9.0) webrick (1.8.1) diff --git a/_apidocs/digitalgov.md b/_apidocs/digitalgov.md deleted file mode 100644 index 65cdb3fb4..000000000 --- a/_apidocs/digitalgov.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: Digital.gov Content API -banner-heading: Digital.gov Content API ---- - - -## Overview - -The Digital.gov Content API provides machine-readable access to all of the content that makes up digital.gov. - -

Back to top

- -## Getting Started - -To begin using this API, you will need to register 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 %} - -| HTTP Header Name | Description | -| ---- | ----------- | -| x-api-key | API key from api.data.gov. For sample purposes, you can use `DEMO_KEY` as an API key. | - - - - -

Back to top

- -## API Description - - -### Content APIs - - -The Digital.gov APIs might change from time to time. We will do our best to notify readers of any changes through our newsfeed and in this documentation page. - -HOME — [https://api.gsa.gov/technology/digitalgov/v1/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/index.json?api_key=DEMO_KEY) - -Communities JSON — [https://api.gsa.gov/technology/digitalgov/v1/communities/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/communities/index.json?api_key=DEMO_KEY) - -Resources JSON — [https://api.gsa.gov/technology/digitalgov/v1/resources/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/resources/index.json?api_key=DEMO_KEY) - -Blog Posts JSON — [https://api.gsa.gov/technology/digitalgov/v1/posts/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/posts/index.json?api_key=DEMO_KEY) - -Events JSON — [https://api.gsa.gov/technology/digitalgov/v1/events/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/events/index.json?api_key=DEMO_KEY) - -Single Community — [https://api.gsa.gov/technology/digitalgov/v1/communities/agile-lean/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/communities/agile-lean/index.json?api_key=DEMO_KEY) - -Single Resource — [https://api.gsa.gov/technology/digitalgov/v1/resources/omb-memos-circulars-executive-orders-and-other-policies/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/resources/omb-memos-circulars-executive-orders-and-other-policies/index.json?api_key=DEMO_KEY) - -Single Blog Post — [https://api.gsa.gov/technology/digitalgov/v1/2018/07/17/experiments-in-tweaking-agile-for-ux/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/2018/07/17/experiments-in-tweaking-agile-for-ux/index.json?api_key=DEMO_KEY) - -Single Event — [https://api.gsa.gov/technology/digitalgov/v1/event/2018/07/26/civic-service-design-tools-tactics/index.json?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/event/2018/07/26/civic-service-design-tools-tactics/index.json?api_key=DEMO_KEY) - - -### Taxonomy / Data APIs - -All Images — [https://api.gsa.gov/technology/digitalgov/v1/images/v1/json/?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/images/v1/json/?api_key=DEMO_KEY) - -All Tags — [https://api.gsa.gov/technology/digitalgov/v1/tag/v1/json/?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/tag/v1/json/?api_key=DEMO_KEY) - -All Categories — [https://api.gsa.gov/technology/digitalgov/v1/categories/v1/json/?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/categories/v1/json/?api_key=DEMO_KEY) - -All Authors — [https://api.gsa.gov/technology/digitalgov/v1/authors/v1/json/?api_key=DEMO_KEY](https://api.gsa.gov/technology/digitalgov/v1/authors/v1/json/?api_key=DEMO_KEY) - - -

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. | -| 4XX | Additional 400-level are caused by some type of error in the information submitted. | - -

Back to top

- -## 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 Digital.gov API - -

Back to top

- - -## Contact Us - -To suggest a feature or ask for help, please [file an issue in our project repository](https://github.com/GSA/digitalgov.gov/issues/) or send an email to [digitalgov@gsa.gov](mailto:digitalgov@gsa.gov). - -

Back to top

diff --git a/_apidocs/digitalgov/v1/openapi.json b/_apidocs/digitalgov/v1/openapi.json deleted file mode 100644 index e7318c3c7..000000000 --- a/_apidocs/digitalgov/v1/openapi.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "openapi": "3.0.0", - "servers": [ - { - "url": "https://api.gsa.gov/technology/digitalgov/v1/", - "description": "Digital.gov Content API" - }, - ], - "info": { - "title": "Digital.gov Content API", - "description": "The Digital.gov Content API provides machine-readable access to all of the content that makes up digital.gov.", - "contact": { - "name": "Digital.gov Team", - "url": "https://digital.gov/", - "email": "digitalgov@gsa.gov" - }, - "license": { - "name": "Creative Commons CC0 1.0 Universal", - "url": "https://creativecommons.org/publicdomain/zero/1.0/legalcode" - }, - "version": "v1" - }, - "security": [], - "paths": { - "/index.json": { - "get": { - "summary": "A list of all the sections in Digital.gov", - "description": "Returns list of all the sections in Digital.gov", - "responses": { - "200": { - "description": "List of sections" - } - } - } - }, - "/news/index.json": { - "get": { - "summary": "A list of all the digital.gov news and blog posts.", - "description": "Returns a list of all the digital.gov news and blog posts.", - "responses": { - "200": { - "description": "Returns a list of all the digital.gov news and blog posts." - } - } - } - }, - "/events/index.json": { - "get": { - "summary": "A list of all the digital.gov events.", - "description": "Returns a list of all the digital.gov events.", - "responses": { - "200": { - "description": "Returns a list of all the digital.gov events." - } - } - } - }, - "/communities/index.json": { - "get": { - "summary": "A list of all the digital.gov communities.", - "description": "Returns a list of all the digital.gov communities.", - "responses": { - "200": { - "description": "Returns a list of all the digital.gov communities." - } - } - } - }, - "/resources/index.json": { - "get": { - "summary": "All guides and resources on Digital.gov", - "description": "Returns a list of all the digital.gov resource pages", - "responses": { - "200": { - "description": "Returns a list of all the digital.gov resource pages" - } - } - } - }, - "/services/index.json": { - "get": { - "summary": "All tools and services on Digital.gov", - "description": "Returns a list of all the digital.gov tools and services pages", - "responses": { - "200": { - "description": "Returns a list of all the digital.gov tools and services pages" - } - } - } - } - }, - "components": { - "schemas": {}, - } -} diff --git a/_apidocs/entity-api.md b/_apidocs/entity-api.md index ed01841a5..59c72551c 100644 --- a/_apidocs/entity-api.md +++ b/_apidocs/entity-api.md @@ -8,7 +8,7 @@ banner-heading: SAM.gov Entity Management API diff --git a/_apidocs/exclusions-api.md b/_apidocs/exclusions-api.md index 711288056..44086e22a 100644 --- a/_apidocs/exclusions-api.md +++ b/_apidocs/exclusions-api.md @@ -259,24 +259,21 @@ The API will return one of the following responses: ## Examples -### Example 1: Post April 3rd 2022, get me all the Firms whose Physical Address is in Virginia. +### Example 1: Post April 3, 2022, get me all the firms whose physical address is in Virginia.
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: https://api.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
+Production URL: https://api.sam.gov/entity-information/v4/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: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA
+Alpha URL: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< PUBLIC API Key >&classification=Firm&stateProvince=VA

Response (JSON Output) -Note: Both v2 and v3 Public Responses for one record are provided as samples.
+This is an example public response for one record. 

-v2 Response:

 {
   "totalRecords": 1,
   "excludedEntity": [
@@ -323,6 +320,7 @@ v2 Response:

       },
       "exclusionSecondaryAddress": [],
       "exclusionOtherInformation": {
+        "isFASCSAOrder": "No",
         "additionalComments": "Supreme Foodservice GmbH and Supreme Foodservice FZE",
         "ctCode": null,
         "evsInvestigationStatus": null,
@@ -337,7 +335,7 @@ v2 Response:

         "moreLocations": [
           {
             "exclusionName": "Supreme Fuels GmbH & Co. KG, Frankfurt am Main (D), Zweigniederlassung Glarus (480015629)- Zwinglistrasse 6 , GLARUS , GL ,8750,CHE",
-            "duns": "480015629",
+            "ueiSAM": "XLLLJD1L9SE3",
             "cageCode": null,
             "npi": null,
             "primaryAddress": {
@@ -373,79 +371,119 @@ v2 Response:

       }
     }
   ],
-  


-  v3 Response:

+
+ +

+
+ +### Example 2: Post April 3, 2022, get me all the firms in a CSV file format. +
+Request URL +Production URL: https://api.sam.gov/entity-information/v4/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV

+
+Alpha URL: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
+
+
+ +
+Response +This is an example public response for one record. +

+Extract File will be available for download with url: https://api.sam.gov/entity-information/v4/download-exclusions?api_key=REPLACE_WITH_API_KEY&token=< TOKEN > in some time. If you have requested for an email notification, you will receive it once the file is ready for download.

+Download the CSV file using the token: +https://api.sam.gov/entity-information/v4/download-exclusions?api_key=< PUBLIC API KEY >&token=< TOKEN >

+

+

+View an example CSV response for one record Sample CSV Response. +

+
+ +### Example 3: Get individual or special entity designation exclusion records that are not excluded by DOJ, that belong to Korea and that contain CHONG anywhere in the response. +
+Request URL +Production URL: https://api.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&classification=[Individual~Special Entity Designation]&excludingAgencyCode=!DOJ&country=KOR&q=CHONG
+
+Alpha URL: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< a valid Public API Key >&classification=[Individual~Special Entity Designation]&excludingAgencyCode=!DOJ&country=KOR&q=CHONG
+
+
+ +
+Response (JSON Output) +This is an example public response for one record. +

+ +

 {
-  "totalRecords": 1,
+  "totalRecords": 5,
   "excludedEntity": [
     {
       "exclusionDetails": {
-        "classificationType": "Firm",
-        "exclusionType": "Ineligible (Proceedings Pending)",
+        "classificationType": "Individual",
+        "exclusionType": "Ineligible (Proceedings Completed)",
         "exclusionProgram": "Reciprocal",
-        "excludingAgencyCode": "DLA",
-        "excludingAgencyName": "DEFENSE LOGISTICS AGENCY"
+        "excludingAgencyCode": "ARMY",
+        "excludingAgencyName": "DEPT OF THE ARMY"
       },
       "exclusionIdentification": {
-        "ueiSAM": "KQKWLLDBMDL5",
+        "ueiSAM": null,
         "cageCode": null,
         "npi": null,
-        "prefix": null,
-        "firstName": null,
-        "middleName": null,
-        "lastName": null,
+        "prefix": "Ms.",
+        "firstName": "Chong",
+        "middleName": "Sun",
+        "lastName": "Hwang",
         "suffix": null,
-        "entityName": "Supreme Fuels GmbH & Co. KG",
+        "entityName": "Ms. Chong Sun Hwang",
         "dnbOpenData": null
       },
       "exclusionActions": {
         "listOfActions": [
           {
-            "createDate": "03-19-2015",
-            "updateDate": "03-19-2015",
-            "activateDate": "03-13-2015",
-            "terminationDate": null,
-            "terminationType": "Indefinite",
+            "createDate": "07-27-2012",
+            "updateDate": "07-27-2012",
+            "activateDate": "12-12-2011",
+            "terminationDate": "11-08-2029",
+            "terminationType": "Definite",
             "recordStatus": "Active"
           }
         ]
       },
       "exclusionPrimaryAddress": {
-        "addressLine1": "Rembrandtstr. 17",
+        "addressLine1": null,
         "addressLine2": null,
-        "city": "Frankfurt am Main",
+        "city": "Dongjak-gu, Seoul",
         "stateOrProvinceCode": null,
-        "zipCode": "60596",
+        "zipCode": null,
         "zipCodePlus4": null,
-        "countryCode": "DEU"
+        "countryCode": "KOR"
       },
       "exclusionSecondaryAddress": [],
       "exclusionOtherInformation": {
-        "additionalComments": "Supreme Foodservice GmbH and Supreme Foodservice FZE",
-        "ctCode": null,
+        "additionalComments": null,
+        "ctCode": "A",
         "evsInvestigationStatus": null,
         "references": {
           "referencesList": [
             {
-              "exclusionName": "Supreme Fuels GmbH & Co. KG, Frankfurt am Main (D), Zweigniederlassung Glarus (480015629)- Zwinglistrasse 6 , GLARUS , GL ,8750,CHE",
-              "type": "Cross-Reference"
+              "exclusionName": null,
+              "type": null
             }
           ]
         },
         "moreLocations": [
           {
-            "exclusionName": "Supreme Fuels GmbH & Co. KG, Frankfurt am Main (D), Zweigniederlassung Glarus (480015629)- Zwinglistrasse 6 , GLARUS , GL ,8750,CHE",
-            "ueiSAM": "XLLLJD1L9SE3",
+            "exclusionName": null,
+            "duns": null,
             "cageCode": null,
             "npi": null,
             "primaryAddress": {
-              "addressLine1": "Zwinglistrasse 6",
+              "addressLine1": null,
               "addressLine2": null,
-              "city": "GLARUS",
-              "stateOrProvinceCode": "GL",
-              "zipCode": "8750",
+              "city": null,
+              "stateOrProvinceCode": null,
+              "zipCode": null,
               "zipCodePlus4": null,
-              "countryCode": "CHE"
+              "countryCode": null
             },
             "secondaryAddress": [
               {
@@ -471,246 +509,95 @@ v2 Response:

       }
     }
   ],
-
- -

-
- -### Example 2: Post April 3rd 2022, get me all the Firms in a CSV file format. -
-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: 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: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< PUBLIC API Key >&classification=Firm&format=CSV
-
-
- -
-Response -Note: Both v2 and v3 Public Responses for one record are provided as samples.
-

-v2 Response:
-Extract File will be available for download with url: https://api.sam.gov/entity-information/v2/download-exclusions?api_key=REPLACE_WITH_API_KEY&token=< TOKEN > in some time. If you have requested for an email notification, you will receive it once the file is ready for download.

-Downloading the CSV file using the Token: -https://api.sam.gov/entity-information/v2/download-exclusions?api_key=< PUBLIC API KEY >&token=< TOKEN >

-Click to view CSV Response for one record Sample CSV Response. -

-

-v3 Response:
-Click to view CSV Response for one record Sample CSV Response. -

-
- -### Example 3: Get Individual or Special Entity Designation Exclusion records that are not excluded by DOJ, that belong to Korea and that contain CHONG anywhere in the response. -
-Request URL -Production URL: https://api.sam.gov/entity-information/v2/exclusions?api_key=< a valid Public API Key >&classification=[Individual~Special Entity Designation]&excludingAgencyCode=!DOJ&country=KOR&q=CHONG
-
-Alpha URL: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< a valid Public API Key >&classification=[Individual~Special Entity Designation]&excludingAgencyCode=!DOJ&country=KOR&q=CHONG
-
-
- -
-Response (JSON Output) -Note: Public Response for one record is provided as an example
-

- -

-{
-  "totalRecords": 5,
-
-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",
-
+  "links": {
+    "selfLink": "https://api.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&classification=[Individual~Special%20Entity%20Designation]&excludingAgencyCode=!DOJ&country=KOR&q=CHONG&page=0&size=10"
+  }
 }

-### Example 4: Get details and address of the Ineligible (Proceedings Completed) or Prohibition/Restriction type of Firm Exclusion records that belong to Korea, China or Germany, by using the "q" parameter. +### Example 4: Get details and address of the ineligible (proceedings completed) or prohibition/restriction type of firm exclusion records that belong to Korea, China or Germany, by using the "q" parameter.
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
+Production URL: https://api.sam.gov/entity-information/v4/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

-Alpha URL: https://api-alpha.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
+Alpha URL: https://api-alpha.sam.gov/entity-information/v4/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

Response (JSON Output) -Note: Public Response for one record is provided as an example
+This is an example public response for one record. 

 {
   "totalRecords": 63,
-
-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": []
-},
-
-"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"
-}
+  "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/v4/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/v4/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. +### 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
+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
+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
+This is an example public response for one record.

 {
     "totalRecords": 16,
-
-A sample record is provided here:
-
-        {
+    "excludedEntity": [
+    {
             "exclusionDetails": {
                 "classificationType": "Firm",
                 "exclusionType": "Prohibition/Restriction",
@@ -805,8 +692,8 @@ A sample record is provided here:
         },
     ],
     "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"
+        "selfLink": "https://api.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=0&size=10",
+        "nextLink": "https://api.sam.gov/entity-information/v4/exclusions?api_key=REPLACE_WITH_API_KEY&fascsaOrder=Yes&page=1&size=10"
     }
 }
@@ -817,15 +704,15 @@ A sample record is provided here: ### 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
+Production URL: https://api.sam.gov/entity-information/v4/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

-Alpha URL: https://api-alpha.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
+Alpha URL: https://api-alpha.sam.gov/entity-information/v4/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

Response -Click to view CSV Response for one record Sample CSV Response
+View an example CSV response for one record Sample CSV Response.

Back to top

@@ -915,6 +802,7 @@ Date | Version | Description 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. -02/29/2024 | v3.2 | *Updated Getting Started section to remove deprecated endpoint versions. +02/29/2024 | v3.2 | * Updated Getting Started section to remove deprecated endpoint versions. +03/14/2024 | v3.3 | * Replaced Examples section with v4 requests and responses.

Back to top

diff --git a/_apidocs/exclusions-api/v4/exclusion-sample-csv-1.xlsx b/_apidocs/exclusions-api/v4/exclusion-sample-csv-1.xlsx new file mode 100644 index 000000000..74ca6882e Binary files /dev/null and b/_apidocs/exclusions-api/v4/exclusion-sample-csv-1.xlsx differ diff --git a/_apidocs/exclusions-api/v4/v4-CSV.xlsx b/_apidocs/exclusions-api/v4/v4-CSV.xlsx new file mode 100644 index 000000000..28b4b032e Binary files /dev/null and b/_apidocs/exclusions-api/v4/v4-CSV.xlsx differ diff --git a/_apidocs/opportunities-api.md b/_apidocs/opportunities-api.md index 4b60c0bed..dda92a3d1 100644 --- a/_apidocs/opportunities-api.md +++ b/_apidocs/opportunities-api.md @@ -368,7 +368,7 @@ Please use v3 for the following APIs to utilize “Requirement strategies(farCas * /opps/v2/api/createAndPublish * /opps/v2/api/update/{opportunityId} -**Above v2 endpoints will be retired from alpha and prod (TBD) ** +**The above v2 endpoints will be retired from both alpha and production on October 31, 2024. ** ## Contract Opportunity Management API Request and Responses @@ -8955,5 +8955,6 @@ Date | Version | Description 12/12/2023| v1.27| Updated the setAside titile descriptions for WOSB,WOSBSS,EDWOSB,EDWOSBSS. 12/12/2023| v1.28| Updated the setAside titile descriptions for IEE, ISBEE. 12/13/2023| v1.29| Updated the api's list for Award Amount error messages. +03/22/2024| v1.30| The retirement date for the V2 endpoints(create, createAndPublished and update) has been updated in both the alpha and production environments. Please adjust your implementations accordingly.

Back to top

diff --git a/_apidocs/ratequeryhhg.md b/_apidocs/ratequeryhhg.md index dce750c0e..3787c5ef3 100644 --- a/_apidocs/ratequeryhhg.md +++ b/_apidocs/ratequeryhhg.md @@ -1,6 +1,6 @@ --- title: TMSS 2.0 ratequeryhhg API -banner-heading: ratequeryhhg API +banner-heading: TMSS 2.0 HHG Rate Query API --- @@ -8,7 +8,6 @@ banner-heading: ratequeryhhg API This document provides detailed technical information about the Rate query API offered by TMSS 2.0 at the request of Federal Civilian Agencies. 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 Household Goods (HHG) shipment or for an Extended Storage (EXSTG) 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. @@ -16,11 +15,8 @@ This document captures the specifications for the TMSS 2.0 Rate Query API to be 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 @@ -103,426 +99,497 @@ To begin using this API, you will need to register for an API Key. You can sign • 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. - -| 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 ERRC team. | - - -

Back to top

## API Description -This API has one primary endpoint: +This API has one primary endpoint and an optional endpoint: -**Endpoint 1:** https://api.gsa.gov/travel/tmss/v1/ratequery/hhg - - +Every API request must have the API key in the x-api-key and Agency Token in the x-agency-token (only for the primary endpoint) of HTTP header with every API request. -**Description** This API can be used to retrieve shipment cost for a regular Household Goods (HHG) shipment or for an Extended Storage (EXSTG) shipment. - -**API Payload Query Parameters** - -| Request Payload Fields | Description | -| ---- | ----------- | -| agencyLocationCode | Customer Location Code | -| queryType | Tpe of Query | -| pickupDate | Pick up/ Move Date | -| shipmentType | Shipment/Rate Type | -| sroId | Shipment / SRO Id | -| containerizedShipments | To pull only Containerized Shipment costs | -| originCountryCode | Pickup/Orgin Country Code | -| originZip | Pickup/ Orgin Zip code | -| originProvince | Pickup/Origin province code if the Origin country is Canada | -| destinationCountryCode | Delivery/Destination Country Code | -| destinationZip | Delivery/Destination Zip code | -| destinationProvince | Delivery/Destinationprovince code if the Destination country is Canada | -| estimatedWeight | Estimated weight of the Shipment | -| vehicleClass | Class of the Vehicle | -| miles | Miles| -| uabWeight | UAB weight in lbs | - - -**Expected Response** - -| Response Object | Description | -| ---- | ----------- | -| agencyLocationCode | Customer Location Code | -| queryType | Tpe of Query | -| pickupDate | Pick up/ Move Date | -| shipmentType | Shipment/Rate Type | -| sroId | Shipment / SRO Id | -| containerizedShipments | To pull only Containerized Shipment costs | -| vehicleClass | Class of the Vehicle | -| estimatedWeight | Estimated weight of the Shipment | -| originZip | Pickup/ Orgin Zip code | -| originProvince | Pickup/Origin province code if the Origin country is Canada | -| destinationZip | Delivery/Destination Zip code | -| destinationProvince | Delivery/Destinationprovince code if the Destination country is Canada | -| originCountryCode | Pickup/Orgin Country Code | -| destinationCountryCode | Delivery/Destination Country Code | -| miles | Miles only for USA to Canada | -| uabWeight | UAB weight in lbs | -| rateId | Integer | -| queryId | Integer | -| rateType | Type of Rate | -| scac | TSP's SCAC code | -| zefflag | Zero Emission Footprint indicator for the TSP | -| companyName | Name of the TSP | -| telephone | TSP's contact phone number | -| socioEconomicInd | TSP's Socio Economic Indicator | -| tender | Tender Id used in the selected rate | -| csi | Customer Satisfaction Index of the TSP | -| vi | Value Index of the TSP | -| surfacePercentage | Linehaul Discount applied towards Surface Charge | -| surfaceCharge | Surface Charge | -| uabPercentage | UAB discount applied | -| uabCharge | UAB Cost | -| vehicleCharge | Vehicle Transporation Cost | -| totalCharge | Total Transportation Cost | -| sitRatePercentage | SIT Rate discount applied | -| accrlRatePercentage | Accessorial Rate discount applied | -| destThirtyDayCharge | Standard SIT cost for 30 days at Destination | -| destSixtyDayCharge | Standard SIT cost for 60 days at Destination | -| destNinetyDayCharge | Standard SIT cost for 90 days at Destination | -| sitOrigin1stDayCharge | SIT cost at Origin for the 1st Day | -| sitOriginAddnlDayCharge | SIT cost at Origin for each additional day | -| sitOriginDlvOutUnder50milesCharge | SIT cost at Origin for delivery out under 50 miles | -| sitDest1stDayCharge | SIT cost at Destination for the 1st Day | -| sitDestAddnlDayCharge | SIT cost at Destination for each additional day | -| sitDestDlvOutUnder50milesCharge | SIT cost at Destination for delivery out under 50 miles | -| originThirtyDayCharge | Standard SIT cost for 30 days at Origin | -| originSixtyDayCharge | Standard SIT cost for 60 days at Origin | -| originNinetyDayCharge | Standard SIT cost for 90 days at Origin | -| exsPackagingCharge | Extended Storage Packing Charge | -| exsMonthlyStorageCharge | Extended Storage Delivery over 50 miles cost| -| exsWarehouseCharge | Extended Storage Warehouse Charge | -| exsTotal1MonthCharge | Extended Storage 1 month Charge | -| exsTotal6MonthCharge | Extended Storage 6 month Charge | -| exsTotal12MonthCharge | Extended Storage 12 month Charge | -| exsDeliveryWithin50Miles | Extended Storage Delivery within 50 miles cost | -| exsDeliveryHandlingOut | Extended Storage Delivery handling out cost | -| exsDeliveryOver50Miles | Extended Storage Delivery over 50 miles cost | -| exsDiscountApplied | Extended Storage Rate discount applied | -| rateEffectiveDate | Rate Effective Date | -| rateExpiryDate | Rate Expiry Date | - - - -## API Specification File - -You can view the full details of this API in the OpenAPI Specification file available here: -[TMSS HHG Rate Query API spec.xlsx](https://github.com/GSA/open-gsa-redesign/files/8064723/TMSS.HHG.Rate.Query.API.spec.xlsx) +| HTTP Header Name | Description | Notes | +| ---- | ----------- | ----------- | +| x-api-key | API key from api.data.gov. For testing purposes, you can use `DEMO_KEY` as an API key. | For both Primary and Optional endpoints | +| x-agency-token | Agency Token provided by the ERRC team. | Only for Primary endpoint | +**Primary Endpoint:** https://api.gsa.gov/travel/tmss/v1/ratequery/hhg +**API Method:** POST + + + **Description** This API can be used to retrieve shipment cost for a regular Household Goods (HHG) shipment or for an Extended Storage (EXSTG) shipment. + Request: + All request payloads for ptimary endpoint 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. + + **API Payload Query Parameters** + + | Request Payload Fields | Description | + | ---- | ----------- | + | agencyLocationCode | Customer Location Code | + | queryType | Tpe of Query | + | pickupDate | Pick up/ Move Date | + | shipmentType | Shipment/Rate Type | + | sroId | Shipment / SRO Id | + | containerizedShipments | To pull only Containerized Shipment costs | + | originCountryCode | Pickup/Orgin Country Code | + | originZip | Pickup/ Orgin Zip code | + | originProvince | Pickup/Origin province code if the Origin country is Canada | + | destinationCountryCode | Delivery/Destination Country Code | + | destinationZip | Delivery/Destination Zip code | + | destinationProvince | Delivery/Destinationprovince code if the Destination country is Canada | + | estimatedWeight | Estimated weight of the Shipment | + | vehicleClass | Class of the Vehicle | + | miles | Miles| + | uabWeight | UAB weight in lbs | + + + **Expected Response** + + | Response Object | Description | + | ---- | ----------- | + | agencyLocationCode | Customer Location Code | + | queryType | Type of Query | + | pickupDate | Pick up/ Move Date | + | shipmentType | Shipment/Rate Type | + | sroId | Shipment / SRO Id | + | containerizedShipments | To pull only Containerized Shipment costs | + | vehicleClass | Class of the Vehicle | + | estimatedWeight | Estimated weight of the Shipment | + | originZip | Pickup/ Orgin Zip code | + | originProvince | Pickup/Origin province code if the Origin country is Canada | + | destinationZip | Delivery/Destination Zip code | + | destinationProvince | Delivery/Destinationprovince code if the Destination country is Canada | + | originCountryCode | Pickup/Orgin Country Code | + | destinationCountryCode | Delivery/Destination Country Code | + | miles | Miles only for USA to Canada | + | uabWeight | UAB weight in lbs | + | rateId | Integer | + | queryId | Integer | + | rateType | Type of Rate | + | scac | TSP's SCAC code | + | zefflag | Zero Emission Footprint indicator for the TSP | + | companyName | Name of the TSP | + | telephone | TSP's contact phone number | + | socioEconomicInd | TSP's Socio Economic Indicator | + | tender | Tender Id used in the selected rate | + | csi | Customer Satisfaction Index of the TSP | + | vi | Value Index of the TSP | + | surfacePercentage | Linehaul Discount applied towards Surface Charge | + | surfaceCharge | Surface Charge | + | uabPercentage | UAB discount applied | + | uabCharge | UAB Cost | + | vehicleCharge | Vehicle Transporation Cost | + | totalCharge | Total Transportation Cost | + | sitRatePercentage | SIT Rate discount applied | + | accrlRatePercentage | Accessorial Rate discount applied | + | destThirtyDayCharge | Standard SIT cost for 30 days at Destination | + | destSixtyDayCharge | Standard SIT cost for 60 days at Destination | + | destNinetyDayCharge | Standard SIT cost for 90 days at Destination | + | sitOrigin1stDayCharge | SIT cost at Origin for the 1st Day | + | sitOriginAddnlDayCharge | SIT cost at Origin for each additional day | + | sitOriginDlvOutUnder50milesCharge | SIT cost at Origin for delivery out under 50 miles | + | sitDest1stDayCharge | SIT cost at Destination for the 1st Day | + | sitDestAddnlDayCharge | SIT cost at Destination for each additional day | + | sitDestDlvOutUnder50milesCharge | SIT cost at Destination for delivery out under 50 miles | + | originThirtyDayCharge | Standard SIT cost for 30 days at Origin | + | originSixtyDayCharge | Standard SIT cost for 60 days at Origin | + | originNinetyDayCharge | Standard SIT cost for 90 days at Origin | + | exsPackagingCharge | Extended Storage Packing Charge | + | exsMonthlyStorageCharge | Extended Storage Delivery over 50 miles cost| + | exsWarehouseCharge | Extended Storage Warehouse Charge | + | exsTotal1MonthCharge | Extended Storage 1 month Charge | + | exsTotal6MonthCharge | Extended Storage 6 month Charge | + | exsTotal12MonthCharge | Extended Storage 12 month Charge | + | exsDeliveryWithin50Miles | Extended Storage Delivery within 50 miles cost | + | exsDeliveryHandlingOut | Extended Storage Delivery handling out cost | + | exsDeliveryOver50Miles | Extended Storage Delivery over 50 miles cost | + | exsDiscountApplied | Extended Storage Rate discount applied | + | rateEffectiveDate | Rate Effective Date | + | rateExpiryDate | Rate Expiry Date | + +

Back to top

+ + + **Sample Request and Response for the primary endpoint:** + + Request URL: https://api.gsa.gov/travel/tmss/v1/ratequery/hhg + + + Request Payload for a HHG Domestic Shipment: + ``` + { + "agencyLocationCode": 697, + "queryType":"HHG", + "pickupDate":"2020-04-12", + "shipmentType":"General", + "sroId":"GENRL", + "containerizedShipments":false, + "vehicleClass":"Class 1", + "estimatedWeight": 10000, + "originZip":"32714", + "originProvince":null, + "destinationZip":"23059", + "destinationProvince":null, + "originCountryCode":"US00", + "destinationCountryCode":"US00", + "miles": 0, + "uabWeight":0 + } + ``` + + Response for a HHG Domestic Shipment: + ``` + { + "agencyLocationCode": 697, + "queryType": "HHG", + "pickupDate": "2020-04-12T00:00:00.000+0000", + "shipmentType": "General", + "sroId": "GENRL", + "containerizedShipments": false, + "vehicleClass": "Class 1", + "estimatedWeight": 10000, + "originZip": "32714", + "originProvince": null, + "destinationZip": "23059", + "destinationProvince": null, + "originCountryCode": "US00", + "destinationCountryCode": "US00", + "miles": 740, + "uabWeight": 0, + "rateId": 14486562, + "queryId": 4944, + "rateType": "M", + "scac": "HTSQ", + "zefflag": false, + "companyName": "HILLDRUP MOVING &", + "telephone": "703-221-7155", + "socioEconomicInd": null, + "tender": "HT20", + "csi": "111.62", + "vi": "108.4768", + "surfacePercentage": 43, + "surfaceCharge": "8562.52", + "uabPercentage": 0, + "uabCharge": "0.00", + "vehicleCharge": "888.00", + "totalCharge": "9450.52", + "sitRatePercentage": 56, + "accrlRatePercentage": 0, + "destThirtyDayCharge": "4119.36", + "destSixtyDayCharge": "5110.56", + "destNinetyDayCharge": "6101.76", + "sitOrigin1stDayCharge": "784.56", + "sitOriginAddnlDayCharge": "33.04", + "sitOriginDlvOutUnder50milesCharge": "2376.64", + "sitDest1stDayCharge": "784.56", + "sitDestAddnlDayCharge": "33.04", + "sitDestDlvOutUnder50milesCharge": "2376.64", + "originThirtyDayCharge": "4371.92", + "originSixtyDayCharge": "5463.92", + "originNinetyDayCharge": "6555.92", + "exsPackagingCharge": null, + "exsMonthlyStorageCharge": null, + "exsWarehouseCharge": null, + "exsTotal1MonthCharge": null, + "exsTotal6MonthCharge": null, + "exsTotal12MonthCharge": null, + "exsDeliveryWithin50Miles": null, + "exsDeliveryHandlingOut": null, + "exsDeliveryOver50Miles": null, + "exsDiscountApplied": null, + "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", + "rateExpiryDate": "2020-04-30T04:00:00.000+0000" + } + ``` +

Back to top

+ + Request Payload for a HHG International Shipment: + ``` + { + "agencyLocationCode": 1730, + "queryType":"HHG", + "pickupDate":"2020-04-12", + "shipmentType":"General", + "sroId":"GENRL", + "containerizedShipments":false, + "vehicleClass":"Class 1", + "estimatedWeight": 10000, + "originZip":"32714", + "originProvince":null, + "destinationZip":null, + "destinationProvince":null, + "originCountryCode":"US00", + "destinationCountryCode":"1250", + "miles":0, + "uabWeight":150 + } + ``` + + Response for a HHG International Shipment: + ``` + { + "agencyLocationCode": 1730, + "queryType": "HHG", + "pickupDate": "2020-04-12T00:00:00.000+0000", + "shipmentType": "General", + "sroId": "GENRL", + "containerizedShipments": false, + "vehicleClass": "Class 1", + "estimatedWeight": 10000, + "originZip": "32714", + "originProvince": null, + "destinationZip": null, + "destinationProvince": null, + "originCountryCode": "US00", + "destinationCountryCode": "1250", + "miles": 0, + "uabWeight": 150, + "rateId": 14183679, + "queryId": 4945, + "rateType": "G", + "scac": "SDHR", + "zefflag": false, + "companyName": "SUDDATH RELOCATION SERVICES, I", + "telephone": "800-365-5463", + "socioEconomicInd": null, + "tender": "GS05", + "csi": "109.02", + "vi": "115.6721", + "surfacePercentage": 250, + "surfaceCharge": "21392.50", + "uabPercentage": 1600, + "uabCharge": "1262.82", + "vehicleCharge": "7000.00", + "totalCharge": "29655.32", + "sitRatePercentage": 120, + "accrlRatePercentage": 100, + "destThirtyDayCharge": "990.00", + "destSixtyDayCharge": "1284.00", + "destNinetyDayCharge": "1578.00", + "sitOrigin1stDayCharge": "0.00", + "sitOriginAddnlDayCharge": "0.00", + "sitOriginDlvOutUnder50milesCharge": "1294.80", + "sitDest1stDayCharge": "0.00", + "sitDestAddnlDayCharge": "0.00", + "sitDestDlvOutUnder50milesCharge": "360.00", + "originThirtyDayCharge": "2390.40", + "originSixtyDayCharge": "3002.40", + "originNinetyDayCharge": "3614.40", + "exsPackagingCharge": null, + "exsMonthlyStorageCharge": null, + "exsWarehouseCharge": null, + "exsTotal1MonthCharge": null, + "exsTotal6MonthCharge": null, + "exsTotal12MonthCharge": null, + "exsDeliveryWithin50Miles": null, + "exsDeliveryHandlingOut": null, + "exsDeliveryOver50Miles": null, + "exsDiscountApplied": null, + "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", + "rateExpiryDate": "2020-04-30T04:00:00.000+0000" + } + ``` +

Back to top

+ + Request Payload for a HHG Extended Storage Shipment: + ``` + { + "agencyLocationCode": 1730, + "queryType":"HHG", + "pickupDate":"2020-04-12", + "shipmentType":"Extended Storage", + "sroId":"EXSTG", + "containerizedShipments":false, + "estimatedWeight": 10000, + "originZip":"32714", + "originProvince":null, + "destinationZip":null, + "destinationProvince":null, + "originCountryCode":"US00", + "destinationCountryCode":"US00" + } + ``` + + Response for a HHG Extended Storage Shipment: + ``` + { + "agencyLocationCode": 1730, + "queryType": "HHG", + "pickupDate": "2020-04-12T00:00:00.000+0000", + "shipmentType": "Extended Storage", + "sroId": "EXSTG", + "containerizedShipments": false, + "vehicleClass": null, + "estimatedWeight": 10000, + "originZip": "32714", + "originProvince": null, + "destinationZip": null, + "destinationProvince": null, + "originCountryCode": "US00", + "destinationCountryCode": "US00", + "miles": 0, + "uabWeight": null, + "rateId": 12691288, + "queryId": 4199, + "rateType": "G", + "scac": "SVLM", + "zefflag": true, + "companyName": "Stevens Moving & Storage, Inc.", + "telephone": "800-955-5421", + "socioEconomicInd": "w,s", + "tender": "SX01", + "csi": null, + "vi": null, + "surfacePercentage": null, + "surfaceCharge": null, + "uabPercentage": null, + "uabCharge": null, + "vehicleCharge": null, + "totalCharge": null, + "sitRatePercentage": null, + "accrlRatePercentage": null, + "destThirtyDayCharge": null, + "destSixtyDayCharge": null, + "destNinetyDayCharge": null, + "sitOrigin1stDayCharge": null, + "sitOriginAddnlDayCharge": null, + "sitOriginDlvOutUnder50milesCharge": null, + "sitDest1stDayCharge": null, + "sitDestAddnlDayCharge": null, + "sitDestDlvOutUnder50milesCharge": null, + "originThirtyDayCharge": null, + "originSixtyDayCharge": null, + "originNinetyDayCharge": null, + "exsPackagingCharge": "4800.00", + "exsMonthlyStorageCharge": "500.00", + "exsWarehouseCharge": "600.00", + "exsTotal1MonthCharge": "5900.00", + "exsTotal6MonthCharge": "8400.00", + "exsTotal12MonthCharge": "11400.00", + "exsDeliveryWithin50Miles": "2800.00", + "exsDeliveryHandlingOut": "400.00", + "exsDeliveryOver50Miles": "4019.74", + "exsDiscountApplied": 51, + "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", + "rateExpiryDate": "2020-04-30T04:00:00.000+0000" + } + ```

Back to top

-## HTTP Response Codes - -The API will return one of the following responses: +**Optional Endpoint:** https://api.gsa.gov/travel/tmss/v1/uspslookup/?cityName= -| 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 +**API Method:** GET +**Description:** This API can be used to lookup/search city name or Zip codes. Use the keyword **cityName=** to pass the query param. -

Back to top

- - -## API Details +**API-KEY:** API-KEY obtained for the primary endpoint can be used and must be passed as a HTTP header name **x-api-key** . + + **API Query Parameters:** + + This API must be used by including at least one of the following params + - the City Name or a biginning letter of the city name or a few beginning letters of the City Name + - Zip code or a beginning digit of a zip code or a few beginning digits of a Zip code -Request: -All request payloads must be in JSON data structure specified in the Data dictionary section of this document. + **Expected Response** + + | Response Object | Description | + | ---- | ----------- | + | uspsZipId | TMSS 2.0 data ref ID | + | zipCode | Zip Code | + | zipClassificationCode | ZIP classification codes (P - PO Box, U - unclassified, " " - no classification) | + | cityName | City Name | + | cityAbbrev | City Abbrevation (if availabale) | + | stateAbbrev | State Code | + | countyNo | County Number | + | countyName | County Name | + | createdDate | Initial Data creation Date | + | updateProgram | Update Program (internal use) | + | updateId | For internal use | + | updateDate | Date of last updation (internal use) | + | stateId | For internal use | + +

Back to top

+ + **Sample Request and Response for the optional endpoint:** -Response: -All response must be in JSON data structure specified in the Data dictionary section of this document. + Request: https://api.data.gov/TEST/travel/tmss/v1/uspslookup/?cityName=Glen -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/hhg + Response: + { + "uspsZipId": 4536, + "zipCode": "03238", + "zipClassificationCode": "P", + "cityName": "GLENCLIFF", + "cityAbbrev": "", + "stateAbbrev": "NH", + "countyNo": "009", + "countyName": "GRAFTON", + "createdDate": "2019-05-03T16:57:05.000+00:00", + "updateProgram": "Manual Data Load Feb. 3 2024", + "updateId": null, + "updateDate": "2024-02-03T17:41:29.000+00:00", + "stateId": null + }, + { + "uspsZipId": 4845, + "zipCode": "03838", + "zipClassificationCode": "", + "cityName": "GLEN", + "cityAbbrev": "", + "stateAbbrev": "NH", + "countyNo": "003", + "countyName": "CARROLL", + "createdDate": "2019-05-03T16:57:05.000+00:00", + "updateProgram": "Manual Data Load Feb. 3 2024", + "updateId": null, + "updateDate": "2024-02-03T17:41:31.000+00:00", + "stateId": null + } ... + + +

Back to top

-Request Payload for a HHG Domestic Shipment: -``` -{ - "agencyLocationCode": 697, - "queryType":"HHG", - "pickupDate":"2020-04-12", - "shipmentType":"General", - "sroId":"GENRL", - "containerizedShipments":false, - "vehicleClass":"Class 1", - "estimatedWeight": 10000, - "originZip":"32714", - "originProvince":null, - "destinationZip":"23059", - "destinationProvince":null, - "originCountryCode":"US00", - "destinationCountryCode":"US00", - "miles": 0, - "uabWeight":0 -} -``` +## API Specification File + + You can view the full details of this API in the API Specification file available here: + [TMSS HHG Rate Query API spec.xlsx](https://github.com/GSA/open-gsa-redesign/files/8064723/TMSS.HHG.Rate.Query.API.spec.xlsx) -Response for a HHG Domestic Shipment: -``` -{ - "agencyLocationCode": 697, - "queryType": "HHG", - "pickupDate": "2020-04-12T00:00:00.000+0000", - "shipmentType": "General", - "sroId": "GENRL", - "containerizedShipments": false, - "vehicleClass": "Class 1", - "estimatedWeight": 10000, - "originZip": "32714", - "originProvince": null, - "destinationZip": "23059", - "destinationProvince": null, - "originCountryCode": "US00", - "destinationCountryCode": "US00", - "miles": 740, - "uabWeight": 0, - "rateId": 14486562, - "queryId": 4944, - "rateType": "M", - "scac": "HTSQ", - "zefflag": false, - "companyName": "HILLDRUP MOVING &", - "telephone": "703-221-7155", - "socioEconomicInd": null, - "tender": "HT20", - "csi": "111.62", - "vi": "108.4768", - "surfacePercentage": 43, - "surfaceCharge": "8562.52", - "uabPercentage": 0, - "uabCharge": "0.00", - "vehicleCharge": "888.00", - "totalCharge": "9450.52", - "sitRatePercentage": 56, - "accrlRatePercentage": 0, - "destThirtyDayCharge": "4119.36", - "destSixtyDayCharge": "5110.56", - "destNinetyDayCharge": "6101.76", - "sitOrigin1stDayCharge": "784.56", - "sitOriginAddnlDayCharge": "33.04", - "sitOriginDlvOutUnder50milesCharge": "2376.64", - "sitDest1stDayCharge": "784.56", - "sitDestAddnlDayCharge": "33.04", - "sitDestDlvOutUnder50milesCharge": "2376.64", - "originThirtyDayCharge": "4371.92", - "originSixtyDayCharge": "5463.92", - "originNinetyDayCharge": "6555.92", - "exsPackagingCharge": null, - "exsMonthlyStorageCharge": null, - "exsWarehouseCharge": null, - "exsTotal1MonthCharge": null, - "exsTotal6MonthCharge": null, - "exsTotal12MonthCharge": null, - "exsDeliveryWithin50Miles": null, - "exsDeliveryHandlingOut": null, - "exsDeliveryOver50Miles": null, - "exsDiscountApplied": null, - "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", - "rateExpiryDate": "2020-04-30T04:00:00.000+0000" -} -``` - -Request Payload for a HHG International Shipment: -``` - { - "agencyLocationCode": 1730, - "queryType":"HHG", - "pickupDate":"2020-04-12", - "shipmentType":"General", - "sroId":"GENRL", - "containerizedShipments":false, - "vehicleClass":"Class 1", - "estimatedWeight": 10000, - "originZip":"32714", - "originProvince":null, - "destinationZip":null, - "destinationProvince":null, - "originCountryCode":"US00", - "destinationCountryCode":"1250", - "miles":0, - "uabWeight":150 -} -``` - -Response for a HHG International Shipment: -``` - { - "agencyLocationCode": 1730, - "queryType": "HHG", - "pickupDate": "2020-04-12T00:00:00.000+0000", - "shipmentType": "General", - "sroId": "GENRL", - "containerizedShipments": false, - "vehicleClass": "Class 1", - "estimatedWeight": 10000, - "originZip": "32714", - "originProvince": null, - "destinationZip": null, - "destinationProvince": null, - "originCountryCode": "US00", - "destinationCountryCode": "1250", - "miles": 0, - "uabWeight": 150, - "rateId": 14183679, - "queryId": 4945, - "rateType": "G", - "scac": "SDHR", - "zefflag": false, - "companyName": "SUDDATH RELOCATION SERVICES, I", - "telephone": "800-365-5463", - "socioEconomicInd": null, - "tender": "GS05", - "csi": "109.02", - "vi": "115.6721", - "surfacePercentage": 250, - "surfaceCharge": "21392.50", - "uabPercentage": 1600, - "uabCharge": "1262.82", - "vehicleCharge": "7000.00", - "totalCharge": "29655.32", - "sitRatePercentage": 120, - "accrlRatePercentage": 100, - "destThirtyDayCharge": "990.00", - "destSixtyDayCharge": "1284.00", - "destNinetyDayCharge": "1578.00", - "sitOrigin1stDayCharge": "0.00", - "sitOriginAddnlDayCharge": "0.00", - "sitOriginDlvOutUnder50milesCharge": "1294.80", - "sitDest1stDayCharge": "0.00", - "sitDestAddnlDayCharge": "0.00", - "sitDestDlvOutUnder50milesCharge": "360.00", - "originThirtyDayCharge": "2390.40", - "originSixtyDayCharge": "3002.40", - "originNinetyDayCharge": "3614.40", - "exsPackagingCharge": null, - "exsMonthlyStorageCharge": null, - "exsWarehouseCharge": null, - "exsTotal1MonthCharge": null, - "exsTotal6MonthCharge": null, - "exsTotal12MonthCharge": null, - "exsDeliveryWithin50Miles": null, - "exsDeliveryHandlingOut": null, - "exsDeliveryOver50Miles": null, - "exsDiscountApplied": null, - "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", - "rateExpiryDate": "2020-04-30T04:00:00.000+0000" - } -``` - -Request Payload for a HHG Extended Storage Shipment: -``` -{ - "agencyLocationCode": 1730, - "queryType":"HHG", - "pickupDate":"2020-04-12", - "shipmentType":"Extended Storage", - "sroId":"EXSTG", - "containerizedShipments":false, - "estimatedWeight": 10000, - "originZip":"32714", - "originProvince":null, - "destinationZip":null, - "destinationProvince":null, - "originCountryCode":"US00", - "destinationCountryCode":"US00" -} -``` -Response for a HHG Extended Storage Shipment: -``` -{ - "agencyLocationCode": 1730, - "queryType": "HHG", - "pickupDate": "2020-04-12T00:00:00.000+0000", - "shipmentType": "Extended Storage", - "sroId": "EXSTG", - "containerizedShipments": false, - "vehicleClass": null, - "estimatedWeight": 10000, - "originZip": "32714", - "originProvince": null, - "destinationZip": null, - "destinationProvince": null, - "originCountryCode": "US00", - "destinationCountryCode": "US00", - "miles": 0, - "uabWeight": null, - "rateId": 12691288, - "queryId": 4199, - "rateType": "G", - "scac": "SVLM", - "zefflag": true, - "companyName": "Stevens Moving & Storage, Inc.", - "telephone": "800-955-5421", - "socioEconomicInd": "w,s", - "tender": "SX01", - "csi": null, - "vi": null, - "surfacePercentage": null, - "surfaceCharge": null, - "uabPercentage": null, - "uabCharge": null, - "vehicleCharge": null, - "totalCharge": null, - "sitRatePercentage": null, - "accrlRatePercentage": null, - "destThirtyDayCharge": null, - "destSixtyDayCharge": null, - "destNinetyDayCharge": null, - "sitOrigin1stDayCharge": null, - "sitOriginAddnlDayCharge": null, - "sitOriginDlvOutUnder50milesCharge": null, - "sitDest1stDayCharge": null, - "sitDestAddnlDayCharge": null, - "sitDestDlvOutUnder50milesCharge": null, - "originThirtyDayCharge": null, - "originSixtyDayCharge": null, - "originNinetyDayCharge": null, - "exsPackagingCharge": "4800.00", - "exsMonthlyStorageCharge": "500.00", - "exsWarehouseCharge": "600.00", - "exsTotal1MonthCharge": "5900.00", - "exsTotal6MonthCharge": "8400.00", - "exsTotal12MonthCharge": "11400.00", - "exsDeliveryWithin50Miles": "2800.00", - "exsDeliveryHandlingOut": "400.00", - "exsDeliveryOver50Miles": "4019.74", - "exsDiscountApplied": 51, - "rateEffectiveDate": "2020-01-01T05:00:00.000+0000", - "rateExpiryDate": "2020-04-30T04:00:00.000+0000" - } -``` + + +

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

## Feedback diff --git a/_config.yml b/_config.yml index 27c5c119a..977b68cba 100644 --- a/_config.yml +++ b/_config.yml @@ -3,7 +3,7 @@ title: GSA Open Technology description: Open source code, data and APIs from GSA. baseurl: "" # the subpath of your site, e.g. /blog/ url: "https://open.gsa.gov" # the base hostname & protocol for your site -logo: /assets/img/site-logo.png +logo: /assets/img/gsa_logo.svg feature_image: /assets/img/feature-background.jpg sass: @@ -40,29 +40,6 @@ analytics: agency: GSA # Change this to your agency subagency: Digital Service # Change this to your agency - -forms: -- type: newsletter - heading: Sign up to receive updates from our team - url: https://docs.google.com/a/gsa.gov/forms/d/e/1FAIpQLSdTKaMGI8PGKdR7VjuRRMtvOiA-uiD5fqqsFoyN1g2SXoLTqQ/formResponse - button: Subscribe - privacypolicy: Your privacy and security are important to us. We'll only share your information as described in the GSA Privacy and Security Notice - fields: - - type: email - name: entry.474991268 - label: Email Address - -- type: Save the Date - heading: - url: https://docs.google.com/forms/d/e/1FAIpQLSdc5fHkh5_NOV_k251P_lQayb8JbbzF1iRSIM-cu-loBTPDdg/formResponse - button: Submit - privacypolicy: - fields: - - type: email - name: entry.1045781291 - label: Email Address - - footer: image: /assets/img/gsa-logo-dark.jpg image-alt: GSA @@ -72,8 +49,11 @@ markdown: kramdown include: - _navigation.json exclude: + - 'APIDOCS.md' - 'README.md' - 'LICENSE.md' + - 'CONTRIBUTING.md' + - 'SECURITY.md' - 'Rakefile' - 'Gemfile' - 'Gemfile.lock' diff --git a/_data/api-list.yml b/_data/api-list.yml index e40f9666e..55af1631a 100644 --- a/_data/api-list.yml +++ b/_data/api-list.yml @@ -19,23 +19,14 @@ - title: Data.gov CKAN API description: The government-wide data catalog available at Data.gov. url: https://open.gsa.gov/api/datadotgov/ -- title: Digital.gov API - description: Content API for the Digital.gov website. - url: https://open.gsa.gov/api/digitalgov/ -- title: eMuseum API - description: This API delivers search information and images from The Museum System (TMS) & eMuseum to GSA.gov. - url: https://gsa.github.io/eMuseum-API/ - title: Federal Procurement Data System - FPDS API description: SOAP and XML web services are used in FPDS-NG to provide interoperability with various federal procurement systems. url: https://www.fpds.gov/fpdsng_cms/index.php/en/worksite.html - title: Fleet Vehicles API description: GSA Fleet Drive-thru offers two reports through an API for GSA Fleet Leasing customers. url: https://www.gsa.gov/buying-selling/products-services/transportation-logistics-services/vehicle-leasing/gsa-fleet-drivethru -- title: Go.USA.gov API - description: Go.USA.gov is a URL shortener for government employees. The API can shorten, preview, and show clicks on short URLs. - url: https://go.usa.gov/api - title: GSA IT Collect Public API - description: The IT Collect API provides a way for the general public to access government-wide IT Portfolio Management and other related IT data sources. + description: The IT Collect API provides a way for the general public to access government-wide IT Portfolio Management and other related IT data sources. url: https://open.gsa.gov/api/itcollect/ - title: GSA.gov Content API description: The GSA.gov content API is an XML feed which supplies the public with a means to extract data out of the GSA.gov website. When the API returns multiple content items, it list them with the newest item(s) first, and oldest last. diff --git a/_data/code.yml b/_data/code.yml index 7d7334e47..9873ea8ce 100644 --- a/_data/code.yml +++ b/_data/code.yml @@ -1,21 +1,21 @@ - title: tech.gsa.gov - body: An open source website built using Jekyll and hosted on Federalist where you can learn more about the CTO Office and technology at GSA. + body: An open source website built using Hugo and hosted on cloud.gov Pages where you can learn more about the CTO Office and technology at GSA. tags: - GSA - CTO category: Code url: https://github.com/GSA/cto-website - title: open.gsa.gov - body: An open source website built using Jekyll and hosted on Federalist offer GSA's open assets - data, APIs, and code. + body: An open source website built using Jekyll and hosted on cloud.gov Pages offer GSA's open assets - data, APIs, and code. tags: - GSA - CTO category: Code url: https://github.com/GSA/open-gsa-redesign - title: Data.gov - body: 'Data.gov is an open data website that is based on two robust open source projects: CKAN and WordPress. + body: 'Data.gov is an open data website that is based on two robust open source projects: CKAN and Eleventy. The data catalog at catalog.data.gov is powered by CKAN, while the content seen - at Data.gov is powered by WordPress.' + at Data.gov is powered by the static-site generator Eleventy.' license: https://github.com/GSA/data.gov/blob/master/LICENSE.md openSourceProject: 1 governmentWideReuseProject: 1 diff --git a/_data/events.yml b/_data/events.yml deleted file mode 100644 index edb0bd473..000000000 --- a/_data/events.yml +++ /dev/null @@ -1,39 +0,0 @@ -- title: Data Science Code-along Day - date: October 20, 2017 - location: Washington, DC - txt: A hands-on learning day focused on GSA data science practioners - link: /events/data-science-codealong - image: /assets/img/event-images/CodeAlong_HeroImage-bluebg.png - featured: yes -- title: Grace Hopper Day Hackathon - date: December 10, 2016 - location: Washington, DC - txt: A hackathon day honoring Grace Hopper on her 110th birthday focused on women in tech - link: /events/grace-hopper-hackathon - image: /assets/img/event-images/grace-hopper-event.jpg - featured: -# - title: Earth Day Hackathon -# date: April 22, 2016 -# location: Washington, DC -# txt: GSA hosted the first ever Government-wide Earth Day Hackathon -# link: /events/earth-day-hackathon -# image: /assets/img/event-images/earth-day-event.png -# featured: -# - title: Digital Innovation Hackathon -# date: Fall 2015 -# location: Washington, DC -# txt: A hackathon day honoring Grace Hopper on her 110th birthday -# link: /events/digital-innovation-hackathon-fall2015 -# image: /assets/img/event-images/digital-innovation-event-fall2016.jpg -# featured: -# - title: Digital Innovation Hackathon -# date: Spring 2015 -# location: Washington, DC -# txt: GSA hosted open source coders and designers at our first ever Digital Innovation Hack-a-thon -# link: /events/digital-innovation-hackathon -# image: /assets/img/event-images/WashingtonDC.jpg -# featured: - - - - #to feature an event (display above the Past Events) add the 'featured: yes' parameter to your event (no quotes) diff --git a/_data/navbar.yml b/_data/navbar.yml index 3432adf9e..2507b2ae4 100755 --- a/_data/navbar.yml +++ b/_data/navbar.yml @@ -23,9 +23,3 @@ assigned: permalink: /code/ show_in_menu: true show_in_footer: false - - - text: Events - href: pages/events.md - permalink: /events/ - show_in_menu: true - show_in_footer: false diff --git a/_data/search.yml b/_data/search.yml index be71cb7df..c240640f7 100644 --- a/_data/search.yml +++ b/_data/search.yml @@ -11590,16 +11590,6 @@ contact: email: github-admins@gsa.gov url: https://github.com/GSA/data-json -- title: eMuseum-API - body: API documentation for the eMuseum API - license: https://github.com/GSA/eMuseum-API/blob/gh-pages/LICENSE - openSourceProject: 1 - governmentWideReuseProject: 1 - tags: - - GSA - contact: - email: github-admins@gsa.gov - url: https://github.com/GSA/eMuseum-API - title: seo body: Resources and Materials for Search Engine Optimization for .Gov Websites license: https://github.com/GSA/seo/blob/master/LICENSE @@ -13059,26 +13049,10 @@ body: The Discovery API drives the Discovery Market Research Tool. It contains information on various GSA services contracts and the awarded vendors, such as their contracting history, their eligibility for contract awards, and their small business designations. url: https://discovery.gsa.gov/api/ category: APIs -- title: eMuseum API - body: This API delivers search information and images from The Museum System (TMS) & eMuseum to GSA.gov. - url: https://gsa.github.io/eMuseum-API/ - category: APIs - tags: - - API - - Fine arts - - TMS - title: Federal Procurement Data System - FPDS API body: SOAP and XML web services are used in FPDS-NG to provide interoperability with various federal procurement systems. url: https://www.fpds.gov/fpdsng_cms/index.php/en/worksite.html category: APIs -- title: Go.USA.gov API - body: Go.USA.gov is a URL shortener for government employees. The API can shorten, preview, and show clicks on short URLs. - url: https://go.usa.gov/api - category: APIs - tags: - - API - - URL shortener - - Sharing - title: GSA.gov Content API body: The GSA.gov content API is an XML feed which supplies the public with a means to extract data out of the GSA.gov website. When the API returns multiple content items, it list them with the newest item(s) first, and oldest last. url: https://www.gsa.gov/about-us/gsa-content-api diff --git a/_includes/code-along-table.md b/_includes/code-along-table.md deleted file mode 100644 index 1624a6c5a..000000000 --- a/_includes/code-along-table.md +++ /dev/null @@ -1,63 +0,0 @@ - -
-
-
-
-
-

Code-along with Us

-
-

Data Science Edition

-

GSA is excited to announce a code-along event focused on Data Science. There will be several training classes for GSA staff to take ranging from Python, R and Statistics to version control and data visualizations. More info will be announce soon! Be the first to receive updates by submitting your email in the form below. This event is open to federal GSA staff only. -

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Rm. 1425Rm. 1420
Registration8 - 9AM
Session 19- 10:30AMIntro to R - Raed SolimanOpen source/version control - Jeff Fredrickson/Joe Castle
Session 210:45 - 12:15PMIntro to Python - Raed SolimanIntro to Tableau - Walter Mehra
Lunch12:15 - 1PM
Session 31- 2:30PMIntro to Statistics - Raed SolimanAPIs - Ryan Day
Session 42:25 - 4:15PMData Viz - Paul TsagaroulisIntro to MicroStrategy - Walter Mehra
-{% include save-the-date.html %} diff --git a/_includes/events.html b/_includes/events.html deleted file mode 100644 index 3d65defb1..000000000 --- a/_includes/events.html +++ /dev/null @@ -1,23 +0,0 @@ - {% for event in site.data.events %} - {% unless event.featured %} - {% assign third = forloop.index | modulo: 3 %} {% if third == 1 %} -
- {% else %} -
- {% endif %} -
- -
- -
-

{{ event.title }}

-

{{ event.date }}

-

{{ event.location }}

-

- {{ event.txt }}... -

- event details -
-
-
- {% endunless %} {% endfor %} diff --git a/_includes/featured-event.html b/_includes/featured-event.html deleted file mode 100644 index 6dfb6225b..000000000 --- a/_includes/featured-event.html +++ /dev/null @@ -1,23 +0,0 @@ - {% for event in site.data.events %} {% if event.featured %} -
-
-

Featured Event

-
-
- -
- -
-

{{ event.title }}

-

{{ event.date }}

-

{{ event.location }}

-

- {{ event.txt }}... -

- event details -
-
-
- {% endif %} {% endfor %} -
-
diff --git a/_includes/footer.html b/_includes/footer.html index 5be5e6bf2..560eae661 100755 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,6 +1,6 @@