Melissa Releases:Request: Difference between revisions
Created page with "{{ MelissaReleasesNav |InputOutputCollapse= }} {{CustomTOC}} Parameters for the Melissa Releases Web Service are primarily path parameters, and as such the values used become part of the URL path in the requests, and should be used in a specific order. The [https://releases.melissadata.net/browse Releases Web Browser] is also available for manual downloads or reference. ==URL== {{URL-MelissaReleases}} ==Field Names== {| class="alternate01 sortable" !Parameter !! De..." |
No edit summary |
||
Line 5: | Line 5: | ||
{{CustomTOC}} | {{CustomTOC}} | ||
Parameters for the Melissa Releases Web Service are primarily path parameters | 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 [https://releases.melissadata.net/browse Releases Web Browser] is also available for manual downloads or reference. | The [https://releases.melissadata.net/browse Releases Web Browser] is also available for manual downloads or reference. | ||
Line 13: | Line 13: | ||
== | ==Request Parameters== | ||
{| class="alternate01 sortable" | {| class="alternate01 sortable" | ||
!Parameter !! Description | !Parameter !! Description | ||
Line 24: | Line 24: | ||
*<code>metaReleaseName</code> (For example, latest) | *<code>metaReleaseName</code> (For example, latest) | ||
|- | |- | ||
|<code>fileName</code>||Name of File | |<code id="param-filename">fileName</code>||Name of File | ||
|- | |- | ||
|<code>manifest</code>||Manifest Name | |<code id="param-manifest">manifest</code>||Manifest Name | ||
|- | |- | ||
|<code>os</code>||Describes the target OS. Used for object binaries and language interface binaries: | |<code id="param-os">os</code>||Describes the target OS. Used for object binaries and language interface binaries: | ||
*AIX = AIX PowerPC | *AIX = AIX PowerPC | ||
*HPUX_IT = HP-UX ia64 | *HPUX_IT = HP-UX ia64 | ||
Line 38: | Line 38: | ||
*ANY | *ANY | ||
|- | |- | ||
|<code>compiler</code>||Describes the target compiler. | |<code id="param-compiler">compiler</code>||Describes the target compiler. | ||
*ACC3 = HP-UX native compiler | *ACC3 = HP-UX native compiler | ||
*COM = Windows COM DLL | *COM = Windows COM DLL | ||
Line 71: | Line 71: | ||
*MSSQL = SQL Server T-SQL | *MSSQL = SQL Server T-SQL | ||
|- | |- | ||
|<code>architecture</code>||Describes the target architecture (ie, ‘bitness’). Used for object binaries and language interface binaries on certain OS platforms: | |<code id="param-architecture">architecture</code>||Describes the target architecture (ie, ‘bitness’). Used for object binaries and language interface binaries on certain OS platforms: | ||
*32BIT | *32BIT | ||
*64BIT | *64BIT | ||
Line 84: | Line 84: | ||
*xml = XML serialized list | *xml = XML serialized list | ||
|- | |- | ||
|<code>hashType</code>||MD5, SHA1, SHA258 | |<code id="param-hashtype">hashType</code>||MD5, SHA1, SHA258 | ||
|} | |} | ||
There are many endpoints which are determined by your environment, the product(s) you are utilizing | 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. | We recommend to update using the latest '''manifest(s)''' when available; there are separate manifests for binaries/interfaces and reference data. | ||
Line 98: | Line 98: | ||
<h3 class="h3grey">Retrieve Files From Manifest</h3> | <h3 class="h3grey">Retrieve Files From Manifest</h3> | ||
: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. | :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 '''manifest''', use the "Retrieve Manifests" endpoints. | :To retrieve each '''manifest''', use the "Retrieve Manifests" endpoints. | ||
Line 117: | Line 117: | ||
<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 YYYY.MM | :Use this endpoint to retrieve a list of all available data file releases, in the format <code>YYYY.MM</code>. | ||
:To retrieve each fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 153: | Line 153: | ||
<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 YYYY.MM | :Use this endpoint to retrieve a list of all available releases, in the format <code>YYYY.MM</code>. | ||
:To retrieve each fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
: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. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 193: | Line 193: | ||
: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 fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
: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. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 282: | Line 282: | ||
==Direct Download== | ==Direct Download== | ||
Use these endpoints to download specific files if necessary. | Use these endpoints to download specific files if necessary. | ||
Line 291: | Line 291: | ||
:*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 fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 306: | Line 306: | ||
: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 OS, compiler | :*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. | :To get the latest release, use the "Retrieve Available Releases" endpoints. | ||
:To retrieve each fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 325: | Line 325: | ||
: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 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 get the latest release, use the "Retrieve Available Releases" endpoints. | :*To get the latest release, use the "Retrieve Available Releases" endpoints. | ||
:To retrieve each fileName, use the "Retrieve Manifests" endpoints. | :To retrieve each <code>[[#param-filename|fileName]]</code>, use the "Retrieve Manifests" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 340: | Line 340: | ||
==Retrieve Metadata== | ==Retrieve Metadata== | ||
Retrieve metadata such as release date, file size | Retrieve metadata such as release date, file size and hashes. | ||
Line 348: | Line 348: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 372: | Line 372: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
: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. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 401: | Line 401: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
: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. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 424: | Line 424: | ||
==Using Hashes== | ==Using Hashes== | ||
Use hashes to verify the integrity of your downloads | 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. | Generate a hash on your local machine to compare against the hash retrieved from these endpoints. | ||
Line 434: | Line 434: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
:Refer to the Request Parameters to review the accepted hashType parameters. | :Refer to the [[#Request Parameters|Request Parameters]] to review the accepted <code>[[#param-hashtype|hashType]]</code> parameters. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 452: | Line 452: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
:Refer to the Request Parameters to get the hashType, | :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. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 470: | Line 470: | ||
: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 fileName, use the "Retrieve Files" endpoints. | :To retrieve the <code>[[#param-filename|fileName]]</code>, use the "Retrieve Files" endpoints. | ||
:Refer to the Request Parameters to get the hashType, | :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. | ||
:{| class="alternate01" | :{| class="alternate01" |
Revision as of 16:14, 16 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" 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
.
- To retrieve each
fileName
, use the "Retrieve Manifests" endpoints.
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
.
- To retrieve each
fileName
, use the "Retrieve Manifests" endpoints.
- 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
- To retrieve each
fileName
, use the "Retrieve Manifests" endpoints.
- 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" 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.
- To retrieve each
fileName
, use the "Retrieve Manifests" 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.
- To retrieve each
fileName
, use the "Retrieve Manifests" 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 get the latest release, use the "Retrieve Available Releases" endpoints.
- Refer to the Request Parameters to get the
- To retrieve each
fileName
, use the "Retrieve Manifests" endpoints.
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.
- To retrieve the
fileName
, use the "Retrieve Files" 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.
- To retrieve the
fileName
, use the "Retrieve Files" 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.
- To retrieve the
fileName
, use the "Retrieve Files" 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.
- To retrieve the
fileName
, use the "Retrieve Files" 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.
- To retrieve the
fileName
, use the "Retrieve Files" 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.
- To retrieve the
fileName
, use the "Retrieve Files" 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