Melissa Releases:Request: Difference between revisions
No edit summary |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 19: | Line 19: | ||
|<code>ID</code>||The License Key issued by Melissa (Encrypted) | |<code>ID</code>||The License Key issued by Melissa (Encrypted) | ||
|- | |- | ||
|<code>release</code>||Release Name. This can be specified in several ways: | |<code id="param-release">release</code>||Release Name. This can be specified in several ways: | ||
*<code>yyyy.mm</code> OR <code>yyyy-mm</code> (year, month) | *<code>yyyy.mm</code> OR <code>yyyy-mm</code> (year, month) | ||
*<code>yyyy.qq</code> (year, quarter) | *<code>yyyy.qq</code> (year, quarter) | ||
Line 90: | Line 90: | ||
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. | 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 | We recommend to update using the latest <code>[[#param-manifest|manifest]]</code>(s) when available; there are separate manifests for binaries/interfaces and reference data. | ||
Line 100: | Line 100: | ||
:Use this endpoint to retrieve a list of download links for data or binary files for a specific release, in the format <code>YYYY.MM</code>. This approach is recommended to ensure the retrieval of all of the latest files in the '''manifest(s)''' for a given product. | :Use this endpoint to retrieve a list of download links for data or binary files for a specific release, in the format <code>YYYY.MM</code>. 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 | :To retrieve each <code>[[#param-manifest|manifest]]</code>, use the "[[#Retrieve Manifests From Release|Retrieve Manifests From Release]]" endpoint. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
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>. | ||
:{| 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>. | ||
: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 191: | Line 187: | ||
<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 <code>YYYY.MM</code>. | ||
: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 229: | Line 223: | ||
<h3 class="h3grey">Retrieve Releases From Manifest</h3> | <h3 class="h3grey">Retrieve Releases From Manifest</h3> | ||
:Use this endpoint to retrieve a list of available releases, in the format YYYY.MM | :Use this endpoint to retrieve a list of available releases, in the format <code>YYYY.MM</code>. | ||
:To retrieve each manifest, use the "Retrieve Manifests" | :To retrieve each <code>[[#param-manifest|manifest]]</code>, use the "[[#Retrieve Manifests From Release|Retrieve Manifests From Release]]" endpoint. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 267: | Line 261: | ||
:Use this endpoint to retrieve a list of available manifests for a given 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. | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 289: | Line 283: | ||
: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 | :*To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 306: | Line 298: | ||
:Example: Address Object DLLs for the latest engine improvements. | :Example: Address Object DLLs for the latest engine improvements. | ||
:*Refer to the Request Parameters to get the | :*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 retrieve | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 326: | Line 316: | ||
:Example: Address Object .NET wrappers to interface with the DLLs. | :Example: Address Object .NET wrappers to interface with the DLLs. | ||
:*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 | :*To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 346: | Line 334: | ||
:Use this endpoint to retrieve metadata for a given file and release. | :Use this endpoint to retrieve metadata for a given file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 370: | Line 356: | ||
:Use this endpoint to retrieve metadata for a given file and release. | :Use this endpoint to retrieve metadata for a given file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" 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 399: | Line 383: | ||
:Use this endpoint to retrieve metadata for a given file and release. | :Use this endpoint to retrieve metadata for a given file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" 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 432: | Line 414: | ||
:Use this endpoint to retrieve a hash of a specified type for a given file and release. | :Use this endpoint to retrieve a hash of a specified type for a given file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" 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 450: | Line 430: | ||
:Use this endpoint to retrieve a hash of a specified type for a given file and release. | :Use this endpoint to retrieve a hash of a specified type for a given file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" 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 468: | Line 446: | ||
:Use this endpoint to retrieve a hash of a specified type for a given interface file and release. | :Use this endpoint to retrieve a hash of a specified type for a given interface file and release. | ||
:To retrieve the latest | :To retrieve the latest <code>[[#param-release|release]]</code>, use the "[[#Retrieve Available Releases|Retrieve Available Releases]]" 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. |
Latest revision as of 18:35, 21 March 2023
Melissa Releases Navigation | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
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:
|
fileName |
Name of File |
manifest |
Manifest Name |
os |
Describes the target OS. Used for object binaries and language interface binaries:
|
compiler |
Describes the target compiler.
|
language |
Describes the language interface.
|
architecture |
Describes the target architecture (ie, ‘bitness’). Used for object binaries and language interface binaries on certain OS platforms:
|
format |
Desired Format of Response:
|
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 From Release" endpoint.
- 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
andarchitecture
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
andarchitecture
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 From Release" endpoint.
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 retrieve the latest
release
, use the "Retrieve Available Releases" endpoints.
- To retrieve the latest
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
andarchitecture
to match your environment.
- Refer to the Request Parameters to get the
- To retrieve 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.
- Refer to the Request Parameters to get the
os
,compiler
andarchitecture
to match your environment. - To retrieve the latest
release
, use the "Retrieve Available Releases" endpoints.
- Refer to the Request Parameters to get the
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
andarchitecture
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
andarchitecture
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
andarchitecture
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
andarchitecture
to match your environment.
Endpoint https://releases.melissadata.net/:hashType/interface/:os/:language/:architecture/:release/:filename?ID=
Example Output (JSON) 9a945a6148834b9a3792a704898a8627388f6706f7385b847921438d468f8e38