Melissa Releases:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 118: Line 118:
<h3 class="h3grey">Retrieve Available Releases for Data File</h3>
<h3 class="h3grey">Retrieve Available Releases for Data File</h3>
:Use this endpoint to retrieve a list of all available data file releases, in the format <code>YYYY.MM</code>.
:Use this endpoint to retrieve a list of all available data file releases, in the format <code>YYYY.MM</code>.
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:{| class="alternate01"
:{| class="alternate01"
Line 154: Line 152:
<h3 class="h3grey">Retrieve Available Releases for Binary File</h3>
<h3 class="h3grey">Retrieve Available Releases for Binary File</h3>
:Use this endpoint to retrieve a list of all available releases, in the format <code>YYYY.MM</code>.
:Use this endpoint to retrieve a list of all available releases, in the format <code>YYYY.MM</code>.
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
Line 192: Line 188:
<h3 class="h3grey">Retrieve Available Releases for Language Interface File</h3>
<h3 class="h3grey">Retrieve Available Releases for Language Interface File</h3>
:Use this endpoint to retrieve a list of all available releases, in the format YYYY.MM
:Use this endpoint to retrieve a list of all available releases, in the format YYYY.MM
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
Line 290: Line 284:
:Example: Address Object reference data, such as mdAddrKey files for fresh and new data.
:Example: Address Object reference data, such as mdAddrKey files for fresh and new data.
:*To get the latest release, use the "Retrieve Available Releases" endpoints.
:*To get the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:{| class="alternate01"
:{| class="alternate01"
Line 309: Line 301:


:To get the latest release, use the "Retrieve Available Releases" endpoints.
:To get the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:{| class="alternate01"
:{| class="alternate01"
Line 327: Line 317:
:*Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:*Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:*To get the latest release, use the "Retrieve Available Releases" endpoints.
:*To get the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints.


:{| class="alternate01"
:{| class="alternate01"
Line 347: Line 335:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:{| class="alternate01"
:{| class="alternate01"
Line 371: Line 357:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
Line 400: Line 384:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
Line 433: Line 415:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to review the accepted <code>[[#param-hashtype|hashType]]</code> parameters.
:Refer to the [[#Request Parameters|Request Parameters]] to review the accepted <code>[[#param-hashtype|hashType]]</code> parameters.
Line 451: Line 431:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-hashtype|hashType]]</code>, <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-hashtype|hashType]]</code>, <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
Line 469: Line 447:


:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
:To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints.


:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-hashtype|hashType]]</code>, <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.
:Refer to the [[#Request Parameters|Request Parameters]] to get the <code>[[#param-hashtype|hashType]]</code>, <code>[[#param-os|os]]</code>, <code>[[#param-compiler|compiler]]</code> and <code>[[#param-architecture|architecture]]</code> to match your environment.

Revision as of 00:23, 17 March 2023

← Melissa Releases

Melissa Releases Navigation
Introduction
CLI Application
Best Practices
Service URLs
Input/Output
Request Parameters and Endpoints
  ↳  Request Parameters
  ↳  Retrieve Available Releases
  ↳  Direct Download
  ↳  Retrieve Metadata
  ↳  Using Hashes



Parameters for the Melissa Releases Web Service are primarily path parameters. Therefore the values used become part of the URL path in the requests and should be used in a specific order.

The Releases Web Browser is also available for manual downloads or reference.

URL

REST

Use URL
Secure https://releases.melissadata.net/


Request Parameters

Parameter Description
ID The License Key issued by Melissa (Encrypted)
release Release Name. This can be specified in several ways:
  • yyyy.mm OR yyyy-mm (year, month)
  • yyyy.qq (year, quarter)
  • metaReleaseName (For example, latest)
fileName Name of File
manifest Manifest Name
os Describes the target OS. Used for object binaries and language interface binaries:
  • AIX = AIX PowerPC
  • HPUX_IT = HP-UX ia64
  • HPUX_PA = HP-UX RISC
  • LINUX = Linux Redhat
  • ZLINUX = IBM zLinux
  • SOLARIS = Solaris Sparc
  • WINDOWS = Windows
  • ANY
compiler Describes the target compiler.
  • ACC3 = HP-UX native compiler
  • COM = Windows COM DLL
  • DLL = Windows standard DLL
  • GCC32 = gcc v3.2 (Linux)
  • GCC34 = gcc v3.4 (AIX, HP-UX, Linux)
  • GCC41 = gcc v4.1 (Linux)
  • GCC46 = gcc v4.6 (zLinux)
  • GCC83 = gcc v8.3 (AIX)
  • WS6 = Solaris native compiler
  • WS12 = Solaris native compiler
  • XLC6 = AIX native compiler
  • XLC12 = AIX native compiler
  • SSIS2005 = SSIS 2005 component
  • SSIS2008 = SSIS 2008 component
  • SSIS2012 = SSIS 2012 component
  • SSIS2014 = SSIS 2014 component
  • SSIS2016 = SSIS 2016 component
  • SSIS2017 = SSIS 2017 component
  • ANY
language Describes the language interface.
  • NET = .NET
  • C = C/C++
  • JAVA = Java
  • PERL = Perl
  • PHP = PHP (legacy, prior to v7)
  • PHP7 = PHP v7
  • PYTHON = Python
  • RUBY = Ruby
  • PLSQL = Oracle PL/SQL
  • MSSQL = SQL Server T-SQL
architecture Describes the target architecture (ie, ‘bitness’). Used for object binaries and language interface binaries on certain OS platforms:
  • 32BIT
  • 64BIT
  • ANY
format Desired Format of Response:
  • crLfList = (default) File list delimited by CR/LF
  • lfList = File list delimited by LF
  • comma = comma delimited list
  • tab = tab delimited list
  • json = JSON serialized list
  • xml = XML serialized list
hashType MD5, SHA1, SHA258


There are many endpoints which are determined by your environment, the product(s) you are utilizing and the reference data you would like to update.

We recommend to update using the latest manifest(s) when available; there are separate manifests for binaries/interfaces and reference data.


Retrieve Available Releases

Retrieve the latest or historical release for a given file or manifest.


Retrieve Files From Manifest

Use this endpoint to retrieve a list of download links for data or binary files for a specific release, in the format YYYY.MM. This approach is recommended to ensure the retrieval of all of the latest files in the manifest(s) for a given product.
To retrieve each manifest, use the "Retrieve Manifests" endpoints.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Endpoint 
https://releases.melissadata.com/manifest/:release/:manifest?ID=&format=
Example Output (JSON) 
[
"https://releases.melissadata.net/Download/Library/WINDOWS/COM/64BIT/2022.12/AddrObj.dll/?ID=exampleID1234",
"https://releases.melissadata.net/Download/Library/HPUX_IT/ACC3/32BIT/2022.12/libmdAddr.sl/?ID=exampleID1234"
]


Retrieve Available Releases for Data File

Use this endpoint to retrieve a list of all available data file releases, in the format YYYY.MM.
Endpoint 
https://releases.melissadata.com/releases/data/:fileName?ID=&FORMAT=
Example Output (JSON) 
[
    "2021.04",
    "2021.05",
    "2021.06",
    "2021.07",
    "2021.08",
    "2021.09",
    "2021.10",
    "2021.11",
    "2021.12",
    "2022.01",
    "2022.02",
    "2022.03",
    "2022.04",
    "2022.05",
    "2022.06",
    "2022.07",
    "2022.08",
    "2022.09",
    "2022.10",
    "2022.11",
    "2022.12"
]


Retrieve Available Releases for Binary File

Use this endpoint to retrieve a list of all available releases, in the format YYYY.MM.
Refer to the Request Parameters to get the os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.com/releases/library/:os/:compiler/:architecture/:fileName?ID=&format=
Example Output (JSON) 
[
    "2021.04",
    "2021.05",
    "2021.06",
    "2021.07",
    "2021.08",
    "2021.09",
    "2021.10",
    "2021.11",
    "2021.12",
    "2022.01",
    "2022.02",
    "2022.03",
    "2022.04",
    "2022.05",
    "2022.06",
    "2022.07",
    "2022.08",
    "2022.09",
    "2022.10",
    "2022.11",
    "2022.12"
]


Retrieve Available Releases for Language Interface File

Use this endpoint to retrieve a list of all available releases, in the format YYYY.MM
Refer to the Request Parameters to get the os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.com/releases/interface/:os/:language/:architecture/:fileName?ID=&format=
Example Output (JSON) 
[
    "2021.04",
    "2021.05",
    "2021.06",
    "2021.07",
    "2021.08",
    "2021.09",
    "2021.10",
    "2021.11",
    "2021.12",
    "2022.01",
    "2022.02",
    "2022.03",
    "2022.04",
    "2022.05",
    "2022.06",
    "2022.07",
    "2022.08",
    "2022.09",
    "2022.10",
    "2022.11",
    "2022.12"
]


Retrieve Releases From Manifest

Use this endpoint to retrieve a list of available releases, in the format YYYY.MM
To retrieve each manifest, use the "Retrieve Manifests" endpoints.
Endpoint 
https://releases.melissadata.com/manifestReleases/:manifest?ID=&format=
Example Output (JSON) 
[
    "2021.04",
    "2021.05",
    "2021.06",
    "2021.07",
    "2021.08",
    "2021.09",
    "2021.10",
    "2021.11",
    "2021.12",
    "2022.01",
    "2022.02",
    "2022.03",
    "2022.04",
    "2022.05",
    "2022.06",
    "2022.07",
    "2022.08",
    "2022.09",
    "2022.10",
    "2022.11",
    "2022.12"
]


Retrieve Manifests From Release

Use this endpoint to retrieve a list of available manifests for a given release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Endpoint 
https://releases.melissadata.com/manifestList/:release?ID=&format=
Example Output (JSON) 
[
    {"manifestName":"cgd_dvd","description":"Canadian geodata files","url":"https://releases.melissadata.net/Manifest/2022.12/cgd_dvd/?ID=exampleID1234"},
    {"manifestName":"dq_addr_bins","description":"DQT\u0027s Address Object binaries","url":"https://releases.melissadata.net/Manifest/2022.12/dq_addr_bins/?ID=exampleID1234"}
]


Direct Download

Use these endpoints to download specific files if necessary.


Download Data File

Use this endpoint to download reference data files.
Example: Address Object reference data, such as mdAddrKey files for fresh and new data.
  • To get the latest release, use the "Retrieve Available Releases" endpoints.
Endpoint 
https://releases.melissadata.net/download/data/:release/:fileName?ID=
Output 
After successful submission, you will be redirected to an automatic file download.


Download Binary File

Use this endpoint to download binary files.
Example: Address Object DLLs for the latest engine improvements.
  • Refer to the Request Parameters to get the OS, compiler and architecture to match your environment.
To get the latest release, use the "Retrieve Available Releases" endpoints.
Endpoint 
https://releases.melissadata.net/download/library/:os/:compiler/:architecture/:release/:filename?ID=&Format=
Output 
After successful submission, you will be redirected to an automatic file download.


Download Language Interface File

Use this endpoint to download language interface files.
Example: Address Object .NET wrappers to interface with the DLLs.
Endpoint 
https://releases.melissadata.net/download/library/:os/:language/:architecture/:release/:filename?ID=
Output 
After successful submission, you will be redirected to an automatic file download.


Retrieve Metadata

Retrieve metadata such as release date, file size and hashes.


Retrieve Metadata for Data File

Use this endpoint to retrieve metadata for a given file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Endpoint 
https://releases.melissadata.net/metadata/data/:release/:fileName?ID=
Example Output (JSON) 
{
    "FileName": "Congress.csv",
    "Release": "2022.12",
    "BuildDate": "2022-12",
    "FileSize": "45994",
    "MD5": "7d1901fada065fd1b144d3badb5112ce",
    "SHA1": "188f383fe3b822a2225ac53bebe4490f86b097e0",
    "SHA256": "9a945a6148834b9a3792a704898a8627388f6706f7385b847921438d468f8e38"
}


Retrieve Metadata for Binary File

Use this endpoint to retrieve metadata for a given file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Refer to the Request Parameters to get the os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.net/metaData/library/:os/:compiler/:architecture/:release/:filename?ID=&Format=
Example Output (JSON) 
{
    "FileName": "mdGeo.dll",
    "Release": "2022.12",
    "BuildNumber": "4.0.1.17333",
    "FileSize": "1640312",
    "OS": "WINDOWS",
    "Compiler": "DLL",
    "Architecture": "64BIT",
    "MD5": "d8c241620e4f8b6d304b4bb5f06a2808",
    "SHA1": "3c43dabca97b4f8bc800c8e76fe5c8f9fdb4012f",
    "SHA256":    "95652aac77b8daabea60268782157188683f0e31cddbcdca36b954d6a87d0ab1"
}


Retrieve Metadata for Language Interface File

Use this endpoint to retrieve metadata for a given file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Refer to the Request Parameters to get the os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.net/metaData/interface/:os/:language/:architecture/:release/:filename?ID=
Example Output (JSON) 
{
    "FileName": "mdAddr_cSharpCode.cs",
    "Release": "2022.12",
    "FileSize": "99079",
    "Language": "NET",
    "Architecture": "ANY",
    "MD5": "8dda5f69d5e749df45f003524e72607a",
    "SHA1": "a093e92414e6e308b991bfd96a2dab11eefc2bb8",
    "SHA256": "133f6656d1ee9433e8f09f1a948d764743169a1453eaa56fe473dc70daa77ef7"
}


Using Hashes

Use hashes to verify the integrity of your downloads and/or ensure you have the latest releases.

Generate a hash on your local machine to compare against the hash retrieved from these endpoints.


Retrieve Hash Value for Data File

Use this endpoint to retrieve a hash of a specified type for a given file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Refer to the Request Parameters to review the accepted hashType parameters.
Endpoint 
https://releases.melissadata.net/:hashType/data/:release/:fileName?ID=
Example Output (JSON) 
9a945a6148834b9a3792a704898a8627388f6706f7385b847921438d468f8e38


Retrieve Hash Value for Binary File

Use this endpoint to retrieve a hash of a specified type for a given file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Refer to the Request Parameters to get the hashType, os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.net/:hashType/library/:os/:compiler/:architecture/:release/:filename?ID=&Format=
Example Output (JSON) 
9a945a6148834b9a3792a704898a8627388f6706f7385b847921438d468f8e38


Retrieve Hash Value for Language Interface File

Use this endpoint to retrieve a hash of a specified type for a given interface file and release.
To retrieve the latest release, use the "Retrieve Available Releases" endpoints.
Refer to the Request Parameters to get the hashType, os, compiler and architecture to match your environment.
Endpoint 
https://releases.melissadata.net/:hashType/interface/:os/:language/:architecture/:release/:filename?ID=
Example Output (JSON) 
9a945a6148834b9a3792a704898a8627388f6706f7385b847921438d468f8e38
Retrieved from "http://wiki.melissadata.com/index.php?title=Melissa_Releases:Request&oldid=19588"