dcavbv.api.post Open in urlscan Pro
52.86.16.148  Public Scan

Form analysis
0 forms found in the DOM

Text Content

2020 SP1 (9.1)2020 SP2 (9.2)2021 (10)2021 SP1 (10.1)2022 (11.0)2022 SP1
(11.1)2022 SP1 (11.1)
Search
 * Introduction
   * Authorization
   * Response codes
   * Error response body format
 * Access rights service
   * get
     Users
   * get
     User groups
   * get
     Workstations
   * get
     Workstation groups
   * get
     Functions
 * Accounting dispatch service
   * get
     Get accounting dispatch data
   * post
     Import accounting dispatch data
 * Accounting forms service
   * get
     Get accounting form data
 * Accounting rates service
   * get
     Accounting agreement types
   * get
     Accounting agreements
   * get
     Accounting stream types
   * get
     Accounting periods
   * get
     Accounting action types
   * get
     Accounting operator groups
   * get
     Allowed partnerships for document capture
   * get
     Verification note reasons
   * get
     Verification note reason categories
   * get
     Terminal dues rates
   * get
     Calculated IPKs
   * get
     Parcel bill rates
   * get
     Direct parcel rates
   * get
     Returned parcel rates
   * get
     Transit parcel rates
   * get
     Air conveyance charges
   * get
     A decouvert groups and charges
   * get
     Closed transit charges
 * Accounting transactions service
   * get
     Get accounting transactions
 * Authorization serivce
   * post
     Authorizes IPS mobile user
 * Consignment import service
   * post
     Create and close consignments
 * Dispatch import service
   * post
     Import dispatch
   * post
     add receptacles to dispatch
 * DNL service
   * get
     Get Delivery Notification Lists
 * EAD check service
   * post
     Perform mail item EAD check
   * get
     Perform receptacle EAD check
 * EDI data service
   * get
     EDI information from EMSEVT
   * get
     EDI information from PREDES/RESDES
   * get
     EDI information from PRECON/RESCON/CARDIT/RESDIT
 * Import service
   * post
     Import mail items
 * Inquiry service
   * post
     Import mail item inquiries
 * Receptacles service
   * post
     Import receptacles
   * get
     Get receptacle data
   * get
     Security checks
   * post
     Import receptacles and mail items
   * post
     Import sampled receptacles
 * Reference data service
   * get
     Mail categories
   * get
     Mail classes
   * get
     Mail item categories
   * get
     Mail subclasses
   * get
     Conveyance types
   * get
     Product types
   * get
     Receptacle content formats
   * get
     Receptacle types
   * get
     Conditions
   * get
     Postal statuses
   * get
     Service indicators
   * get
     Event types
   * get
     State indicators
   * get
     Currencies
   * get
     Countries
   * get
     Customs office types
   * get
     Customs release statuses
   * get
     Sampling rules
   * get
     Postal operators
   * get
     Airlines
   * get
     IMPCs
   * get
     Locations
   * get
     Location types
   * get
     Location statuses
   * get
     Own offices
   * get
     Retention reasons
   * get
     Transport companies
 * Reprint forms and labels service
   * get
     Consignment forms
   * get
     Dispatch forms
   * get
     Inner bag forms and labels
   * get
     Receptacle forms and labels
 * Track and trace service
   * get
     Track and trace mail items
 * Verification notes service






IPS API FOR DEVELOPERS (11.1.0)

Download OpenAPI specification:Download

E-mail: contact@example.com URL: http://example.com/contact License: Internal
Terms of Service


IPS API for Developers.

Universal Postal Union
International Bureau
Weltpoststrasse 4
3000 Bern 15
Switzerland


INTRODUCTION

The IPS API offers GET and POST methods to request IPS data or to import data
into IPS. It can be used both in SOAP and RESTful mode.

This API reference explains each of the API endpoints, with example REST
requests and responses included.

Note: The HTTP requests in the reference are in format
https://[hostname:port]/IPSAPIService/xxx. This format may vary in your own
environment, depending on whether HTTP or HTTPS is used, and on the name of the
web application specified during installation.


AUTHORIZATION

To use the IPS API, you need to include a token with each call (a GUID that is
associated with one or more API operations). You can create new IPS API tokens
using the IPS API Management App and associate them with the API methods you
want to use. Fore more information, see the IPS API Administrator Guide.


RESPONSE CODES

The table below gives an overview of the HTTP response codes. For more specific
error information, see the relevant endpoint reference page.

Code Meaning 200 Success 400 Bad Request -- data in the request body is invalid
401 Unauthorized -- authorization failed 500 Internal Server Error -- an
exception occurred

If an error or a code other than HTTP 200 is returned, see the response body for
details. The format of a JSON error response body is shown below.


ERROR RESPONSE BODY FORMAT

    {
      Errors: [
        {
          "Code": 1,
          "Message": "Error message 1"
        },
        {
          "Code": 2,
          "Message": "Error message 2"
        }
      ]
    }