Address Validation City, State, Zip JSON Developer Guide
User Manual:
Open the PDF directly: View PDF .
Page Count: 8
Download | |
Open PDF In Browser | View PDF |
Address Validation - City, State, Zip JSON Developer Guide July 9, 2018 Important Information UPS Developer Kit APIs Your development of an application using UPS Developer Kit APIs is governed by the UPS Technology Agreement you entered into with UPS. The following are key legal requirements from these agreements for the UPS Developer Kit APIs. For more information on all requirements for the UPS Developer Kit APIs, please refer to the UPS Technology Agreement. Defined terms used but not defined in this document have the meaning set forth in the UPS Technology Agreement. Key Legal Requirements for UPS Developer APIs Permitted Territories This document can only be used in the countries of the Permitted Territory as defined in the UPS Technology Agreement, as applicable. Use The application must not be designed to allow distribution of information received through the UPS Developer Kit APIs to third parties, other than to persons having a bona fide interest in such information (e.g., the shipper, receiver, or the third party payer, or to your service providers authorized by UPS). Consent to Use of UPS Mark All screens or forms generated by your application including information received through the UPS Developer Kit APIs must include (1) the UPS Mark positioned in reasonable proximity to the Information and of an appropriate size to readily identify the source of the Information as UPS and (2) the following language at the bottom of every screen that displays the UPS Mark: "UPS, the UPS brand mark, and the Color Brown are trademarks of United Parcel Service of America, Inc. All Rights Reserved." Except as set forth in the preceding sentence, you have no right to use the UPS Mark without the prior written approval of UPS. You shall not use the UPS Mark in association with any third party trademarks in a manner that might suggest co-branding or otherwise create potential confusion as to source or sponsorship of the application, or ownership of the UPS Mark. The UPS Mark shall be used only as provided by UPS electronically or in hard copy form. The UPS Mark may not be altered in any manner, including proportions, colors, elements, etc., or animated, morphed or otherwise distorted in perspective or dimensional appearance. The UPS Mark may not be combined with any other symbols, including words, logos, icons, graphics, photos, slogans, numbers, or other design elements. A minimum amount of empty space must surround the UPS Mark separating it from any other object, such as type, photography, borders, edges, etc. The required area of empty space around the UPS Mark must be 1/3x, where x equals the height of the UPS Mark. Copyright and Proprietary Notice In your application and any POD Letters you prepare, you must include a prominent reproduction of UPS’s copyright and proprietary notices in a form and format specified by UPS (See the Copyright section of this document). Display of Information The application must not display information concerning any other provider of shipping services or such other shipping services on any page, whether comprising one or more frames, displaying information your application receives from the UPS Developer Kit APIs. Your application must present all data within each field received through the UPS Developer Kit APIs without amendment, deletion, or modification of any type. © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary ii Notice In all communications with UPS concerning this document, please refer to the document date located on the cover. Copyright © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary The use, disclosure, reproduction, modification, transfer, or transmittal of this work for any purpose in any form or by any means without the written permission of United Parcel Service is strictly prohibited. Trademarks Some of the UPS corporate applications use United States city, state, and postal code information obtained by United Parcel Service of America, Inc. under a non-exclusive license from the United States Postal Service. © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iii Table of Contents Chapter 1: Introduction ......................................................................................................... 5 Chapter 2: Customer Integration Environment (CIE) ............................................................... 6 JSON Testing and Production URLS ..................................................................................................... 6 Chapter 3: JSON Examples ..................................................................................................... 7 AddressValidationRequest ..................................................................................................................... 7 AddressValidationResponse .................................................................................................................. 7 Appendix............................................................................................................................... 8 JSON Error Codes ................................................................................................................................... 8 © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv Address Validation City, State, Zip JSON Developer Guide July 9, 2018 Chapter 1: Introduction In this document, you will find guidance and instructions for integrating the Address Validation City, State, Zip JSON API into your application, service, or system. IMPORTANT: If this is your first time working with the UPS Developer Kit, begin with the Introduction to the UPS Developer Kit guide. This guide serves as the foundation for all API-specific developer guides. For additional API, XPath, and Error Code information, refer to the Address Validation City, State, Zip XML Developer Guide. © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 5 Address Validation City, State, Zip JSON Developer Guide July 9, 2018 Chapter 2: Customer Integration Environment (CIE) The Customer Integration Environment allows customers to test their application prior to launch. This environment is intended for integration testing of customer applications with the UPS servers. Once your application has been thoroughly tested, you should redirect the application to the UPS Production Environment. No stress testing should ever be performed by customers against any UPS systems. To access testing and production sites the user must have an Access Key. You can request an Access Key after establishing a UPS profile and associating your shipping account. System Availability The Customer Integration Environment is available 24 hours a day, 7 days a week. Note the system is occasionally down for server maintenance. JSON Testing and Production URLS All API URLs are case sensitive. Testing: https://wwwcie.ups.com/rest/AV Production: https://onlinetools.ups.com/rest/AV © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 6 Address Validation City, State, Zip JSON Developer Guide July 9, 2018 Chapter 3: JSON Examples AddressValidationRequest { "AccessRequest": { "AccessLicenseNumber": "Your Access License Number", "UserId": "Your Username", "Password": "Your Password" }, "AddressValidationRequest": { "Request": { "TransactionReference": { "CustomerContext": "Your Customer Context", }, "RequestAction": "AV" }, "Address": { "City": "ALPHARETTA", "StateProvinceCode": "GA", "PostalCode": "30005" } } } AddressValidationResponse { "AddressValidationResponse": { "Response": { "TransactionReference": { "CustomerContext": "Your Customer Context", }, "ResponseStatusCode": "1", "ResponseStatusDescription": "Success" }, "AddressValidationResult": { "Rank": "1", "Quality": "1.0", "Address": { "City": "ALPHARETTA", "StateProvinceCode": "GA" }, "PostalCodeLowEnd": "30005", "PostalCodeHighEnd": "30005" } } } © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 7 Address Validation City, State, Zip JSON Developer Guide July 9, 2018 Appendix JSON Error Codes Code 1 Description Unrecognized Error Any error, other than those listed below, causing an issue with the request. Verify the request headers are correct. Retry the request again later 2 Unknown Operation The UPS system does not understand the operation and is unable to forward the request to the correct API. Verify the request headers are correct. Check request structure. 3 Network Error Transient error indicating the network is hindering request submission. Retry the request again later. 4 JSON Syntax Error Indicates a problem with the JSON syntax. Verify your request syntax is correct. © 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 8
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : Yes Encryption : Standard V2.3 (128-bit) User Access : Print, Modify, Copy, Annotate, Fill forms, Extract, Print high-res Page Count : 8 Language : en-US Tagged PDF : Yes XMP Toolkit : 3.1-701 Producer : Microsoft® Word 2013 Creator Tool : Microsoft® Word 2013 Create Date : 2018:06:07 10:34:55-04:00 Modify Date : 2018:06:07 10:36:19-04:00 Creator : HSR0WZQ Author : HSR0WZQEXIF Metadata provided by EXIF.tools