Global Name:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
Line 9: Line 9:
A response is the result of a request. This consists of returned results codes and parsed name elements.
A response is the result of a request. This consists of returned results codes and parsed name elements.


Depending on the protocol used to make the request, the response will be in a certain protocol. Global Name supports four possible response protcools: SOAP, JSON, XML, and REST.
Depending on the protocol used to make the request, the response will be in a certain protocol. Global Name supports the JSON, JSONP, SOAP, and XML protocols.
 
 
==Field Names==
This is a list of the response field names and their protocol naming conventions.
 
{| class="alternate01 sortable"
!Field Name !! Level !! JSON/XML
|-
|Version||rowspan="4" valign="center"|Request||Version
|-
|Transmission Reference||TransmissionReference
|-
|Transmission Results||TransmissionResults
|-
|Total Records||TotalRecords
|-
|Record ID||rowspan="15" valign="center"|Record||RecordID
|-
|Results||Results
|-
|Company||Company
|-
|Name Prefix||Prefix
|-
|Name First||NameFirst
|-
|Name Middle||NameMiddle
|-
|Name Last||NameLast
|-
|Name Suffix||NameSuffix
|-
|Gender||Gender
|-
|Name Prefix 2||Prefix2
|-
|Name First 2||NameFirst2
|-
|Name Middle 2||NameMiddle2
|-
|Name Last 2||NameLast2
|-
|Name Suffix 2||NameSuffix2
|-
|Gender 2||Gender2
|}
 
 
==Response Elements==
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
 
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value that is the current revision number of Global Name.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Version>'''''string'''''</Version></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Transmission Results</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.
 
:For a complete list of error codes, see [[Result Code Details:#Global Name|Global Name Result Codes]].
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|-
|SOAP/XML||<code><TransmissionResults>'''''string'''''</TransmissionResults></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Total Records</h3>
:This is a string value that is the total number of records returned with the response.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|-
|SOAP/XML||<code><TotalRecords>'''''string'''''</TotalRecords></code>
|}
 
 
==Response Record Elements==
JSON will only contain the Records element.
 
:{| class="alternate01"
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|-
|SOAP||
|-
|XML||
|}
 
Each of the following elements are returned for each record in the Response Array.
 
 
<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|-
|SOAP/XML||<code><RecordID>'''''string'''''</RecordID></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.
 
:For a complete list of codes, see [[Result Code Details#Global Name|Global Name Result Codes]].
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Results>'''''string'''''</Results></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Company</h3>
:This is a string value of the standardized company name.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Company":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Company>'''''string'''''</Company></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NamePrefix</h3>
:This is a string value of the first prefix (such as “Mr.” or “Dr.”) from an inputted full name.
 
:If the FullName input property contained a single name, the prefix, if any, will be returned here. If two names were passed, the first of the two prefixes will be returned by this property.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Prefix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Prefix>'''''string'''''</Prefix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameFirst</h3>
:This is a string value of the first name from an inputted full name.
 
:If the FullName input property contained a single name, the first name, if any, will be returned here. If two names were passed, the first of the two first names will be returned by this property.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameFirst":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameFirst>'''''string'''''</NameFirst></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameMiddle</h3>
:This is a string value of the middle name from an inputted full name.
 
:If the FullName input property contained a single name, the middle name, if any, will be returned here. If two names were passed, the first of the two middle names will be returned by this property.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameMiddle":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameMiddle>'''''string'''''</NameMiddle></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameLast</h3>
:This is a string value of the last name from an inputted full name.
 
:If the FullName input property contained a single name, the last name, if any, will be returned here. If two names were passed, the first of the two last names will be returned by this property.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameLast":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameLast>'''''string'''''</NameLast></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameSuffix</h3>
:This is a string value of the first suffix (such as “Jr.” or “III”) from an inputted full name.
 
:If the FullName input property contained a single name, the suffix, if any, will be returned here. If two names were passed, the first of the two suffixes will be returned by this property.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameSuffix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameSuffix>'''''string'''''</NameSuffix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Gender</h3>
:This is a one-character string value indicating the gender of the first name from the input.
 
:{|class="alternate01" cellspacing="0"
!Code!!Description
|-
|M||Male
|-
|F||Female
|-
|U||Unknown first name or no first name present
|-
|N||A neutral first name
|}
 
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Gender":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Gender>'''''string'''''</Gender></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NamePrefix2</h3>
:This is a string value of the second prefix (such as “Mr.” or “Dr.”) from an inputted full name.
 
:If the FullName input property contained multiple names, the second prefix will be returned here.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Prefix2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Prefix2>'''''string'''''</Prefix2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameFirst2</h3>
:This is a string value of the second first name from an inputted full name.
 
:If the FullName input property contained multiple names, the second first name will be returned here.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameFirst2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameFirst2>'''''string'''''</NameFirst2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameMiddle2</h3>
:This is a string value of the second middle name from an inputted full name.
 
:If the FullName input property contained multiple names, the second middle name, if any, will be returned here.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameMiddle2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameMiddle2>'''''string'''''</NameMiddle2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameLast2</h3>
:This is a string value of the second last name from an inputted full name.
 
:If the FullName input property contained multiple names, the second last name, if any, will be returned here.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameLast2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameLast2>'''''string'''''</NameLast2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameSuffix2</h3>
:This is a string value of the second suffix (such as “Jr.” or “III”) from an inputted full name.
 
:If the FullName input property contained multiple names, the second suffix, if any, will be returned here.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameSuffix2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameSuffix2>'''''string'''''</NameSuffix2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Gender2</h3>
:This is a one-character string value indicating the gender of the inputted full name.
 
:If the FullName input property contained multiple names, the gender of the second name will be returned here.
 
:{|class="alternate01" cellspacing="0"
!Code!!Description
|-
|M||Male
|-
|F||Female
|-
|U||Unknown first name or no first name present
|-
|N||A neutral first name
|}
 
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Gender2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Gender2>'''''string'''''</Gender2></code>
|}




[[Category:Global Name]]
[[Category:Global Name]]
[[Category:Reference]]
[[Category:Reference]]

Revision as of 18:48, 13 October 2016

← Global Name

Global Name Navigation
Introduction
Licensing
Input/Request
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch JSON
Batch SOAP
Batch XML
Result Codes
Result Code Use
Global Name Result Codes
Sample Code



Response

A response is the result of a request. This consists of returned results codes and parsed name elements.

Depending on the protocol used to make the request, the response will be in a certain protocol. Global Name supports the JSON, JSONP, SOAP, and XML protocols.


Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name Level JSON/XML
Version Request Version
Transmission Reference TransmissionReference
Transmission Results TransmissionResults
Total Records TotalRecords
Record ID Record RecordID
Results Results
Company Company
Name Prefix Prefix
Name First NameFirst
Name Middle NameMiddle
Name Last NameLast
Name Suffix NameSuffix
Gender Gender
Name Prefix 2 Prefix2
Name First 2 NameFirst2
Name Middle 2 NameMiddle2
Name Last 2 NameLast2
Name Suffix 2 NameSuffix2
Gender 2 Gender2


Response Elements

The following elements are the basic options for each request. These apply to the entire response, not the individual records.

Version

This is a string value that is the current revision number of Global Name.
Protocol Syntax
JSON "Version":"string"
SOAP/XML <Version>string</Version>


Transmission Reference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax
JSON "TransmissionReference":"string"
SOAP/XML <TransmissionReference>string</TransmissionReference>


Transmission Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.
For a complete list of error codes, see Global Name Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"
SOAP/XML <TransmissionResults>string</TransmissionResults>


Total Records

This is a string value that is the total number of records returned with the response.
Protocol Syntax
JSON "TotalRecords":"string"
SOAP/XML <TotalRecords>string</TotalRecords>


Response Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
SOAP
XML

Each of the following elements are returned for each record in the Response Array.


Record ID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax
JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>


Results

This is a string value with comma delimited status, error codes, and change codes for the record.
For a complete list of codes, see Global Name Result Codes.
Protocol Syntax
JSON "Results":"string"
SOAP/XML <Results>string</Results>


Company

This is a string value of the standardized company name.
Protocol Syntax
JSON "Company":"string"
SOAP/XML <Company>string</Company>


NamePrefix

This is a string value of the first prefix (such as “Mr.” or “Dr.”) from an inputted full name.
If the FullName input property contained a single name, the prefix, if any, will be returned here. If two names were passed, the first of the two prefixes will be returned by this property.
Protocol Syntax
JSON "Prefix":"string"
SOAP/XML <Prefix>string</Prefix>


NameFirst

This is a string value of the first name from an inputted full name.
If the FullName input property contained a single name, the first name, if any, will be returned here. If two names were passed, the first of the two first names will be returned by this property.
Protocol Syntax
JSON "NameFirst":"string"
SOAP/XML <NameFirst>string</NameFirst>


NameMiddle

This is a string value of the middle name from an inputted full name.
If the FullName input property contained a single name, the middle name, if any, will be returned here. If two names were passed, the first of the two middle names will be returned by this property.
Protocol Syntax
JSON "NameMiddle":"string"
SOAP/XML <NameMiddle>string</NameMiddle>


NameLast

This is a string value of the last name from an inputted full name.
If the FullName input property contained a single name, the last name, if any, will be returned here. If two names were passed, the first of the two last names will be returned by this property.
Protocol Syntax
JSON "NameLast":"string"
SOAP/XML <NameLast>string</NameLast>


NameSuffix

This is a string value of the first suffix (such as “Jr.” or “III”) from an inputted full name.
If the FullName input property contained a single name, the suffix, if any, will be returned here. If two names were passed, the first of the two suffixes will be returned by this property.
Protocol Syntax
JSON "NameSuffix":"string"
SOAP/XML <NameSuffix>string</NameSuffix>


Gender

This is a one-character string value indicating the gender of the first name from the input.
Code Description
M Male
F Female
U Unknown first name or no first name present
N A neutral first name


Protocol Syntax
JSON "Gender":"string"
SOAP/XML <Gender>string</Gender>


NamePrefix2

This is a string value of the second prefix (such as “Mr.” or “Dr.”) from an inputted full name.
If the FullName input property contained multiple names, the second prefix will be returned here.
Protocol Syntax
JSON "Prefix2":"string"
SOAP/XML <Prefix2>string</Prefix2>


NameFirst2

This is a string value of the second first name from an inputted full name.
If the FullName input property contained multiple names, the second first name will be returned here.
Protocol Syntax
JSON "NameFirst2":"string"
SOAP/XML <NameFirst2>string</NameFirst2>


NameMiddle2

This is a string value of the second middle name from an inputted full name.
If the FullName input property contained multiple names, the second middle name, if any, will be returned here.
Protocol Syntax
JSON "NameMiddle2":"string"
SOAP/XML <NameMiddle2>string</NameMiddle2>


NameLast2

This is a string value of the second last name from an inputted full name.
If the FullName input property contained multiple names, the second last name, if any, will be returned here.
Protocol Syntax
JSON "NameLast2":"string"
SOAP/XML <NameLast2>string</NameLast2>


NameSuffix2

This is a string value of the second suffix (such as “Jr.” or “III”) from an inputted full name.
If the FullName input property contained multiple names, the second suffix, if any, will be returned here.
Protocol Syntax
JSON "NameSuffix2":"string"
SOAP/XML <NameSuffix2>string</NameSuffix2>


Gender2

This is a one-character string value indicating the gender of the inputted full name.
If the FullName input property contained multiple names, the gender of the second name will be returned here.
Code Description
M Male
F Female
U Unknown first name or no first name present
N A neutral first name


Protocol Syntax
JSON "Gender2":"string"
SOAP/XML <Gender2>string</Gender2>
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Name:Response&oldid=11769"