Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /api/info endpoint #5

Closed
wants to merge 2 commits into from
Closed

Add /api/info endpoint #5

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
859803d
Add /api/info endpoint
Feb 17, 2018
e34989e
Add /api/info endpoint to docs
bobo333 Feb 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add /api/info endpoint to docs
  • Loading branch information
@bobo333
bobo333 committed Feb 17, 2018
commit e34989e826a0c7fadd5379c911af83d48f00d277
25 changes: 25 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The API exposes the following methods:
+-------------+---------------------------------------------+
| inquiry | Lookup a matching address given a zip9. |
+-------------+---------------------------------------------+
| info | Get USPS AMS library information |
+-------------+---------------------------------------------+

Validate
~~~~~~~~
Expand Down Expand Up @@ -324,6 +326,29 @@ Usage::

The output is exactly identical to the validate method so it won't be reproduced here.

Info
~~~~

This method returns information about the USPS AMS library underlying the API. Specifically

- `apiVersion`
- `dataExpireDays`
- `libraryExpireDays`

There are no query parameters.

Usage::

/api/info

Output::

{
"apiVersion" : "3.03.05.N",
"dataExpireDays" : 103,
"libraryExpireDays" : 529
}

Batch API Methods
-----------------

Expand Down