SSN Name Match:Response: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{ SSNWebServiceNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes, Social Security Numbers, and appended geographic information. Depending on the protocol used to make the request, the response will be in a certain protocol. SSN Web Service supports JSON and REST protocols. ==Field Names== This is a list of the response field names and their protocol naming conventions. {| class="alternate01 so..." |
No edit summary |
||
| Line 48: | Line 48: | ||
|- | |- | ||
|JSON||<code>"TransmissionResults":"'''''string'''''"</code> | |JSON||<code>"TransmissionResults":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><TransmissionResults>string</TransmissionResults></code> | |||
|} | |} | ||
| Line 58: | Line 60: | ||
|- | |- | ||
|JSON||<code>"TransmissionReference":"'''''string'''''"</code> | |JSON||<code>"TransmissionReference":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><TransmissionReference>string</TransmissionReference></code> | |||
|} | |} | ||
| Line 68: | Line 72: | ||
|- | |- | ||
|JSON||<code>"Version":"'''''string'''''"</code> | |JSON||<code>"Version":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><Version>string</Version></code> | |||
|} | |} | ||
| Line 78: | Line 84: | ||
|- | |- | ||
|JSON||<code>"TotalRecords":"'''''string'''''"</code> | |JSON||<code>"TotalRecords":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><TotalRecords>string</TotalRecords></code> | |||
|} | |} | ||
| Line 100: | Line 108: | ||
|- | |- | ||
|JSON||<code>"RecordID":"'''''string'''''"</code> | |JSON||<code>"RecordID":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><RecordID>string</RecordID></code> | |||
|} | |} | ||
| Line 110: | Line 120: | ||
|- | |- | ||
|JSON||<code>"SSN":"'''''string'''''"</code> | |JSON||<code>"SSN":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><SSN>string</SSN></code> | |||
|} | |} | ||
| Line 120: | Line 132: | ||
|- | |- | ||
|JSON||<code>"IssuingState":"'''''string'''''"</code> | |JSON||<code>"IssuingState":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><IssuingState>string</IssuingState></code> | |||
|} | |} | ||
| Line 132: | Line 146: | ||
|- | |- | ||
|JSON||<code>"Results":"'''''string'''''"</code> | |JSON||<code>"Results":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><Results>string</Results></code> | |||
|} | |} | ||
| Line 142: | Line 158: | ||
|- | |- | ||
|JSON||<code>"ResultsFromDataSource":"'''''string'''''"</code> | |JSON||<code>"ResultsFromDataSource":"'''''string'''''"</code> | ||
|- | |||
|XML||<code><ResultsFromDataSource>string</ResultsFromDataSource></code> | |||
|} | |} | ||
Revision as of 00:19, 25 February 2023
| SSN Name Match Navigation | ||||
|---|---|---|---|---|
| ||||
| ||||
| ||||
| ||||
| Sample Code |
A response is the result of a request. This consists of returned results codes, Social Security Numbers, and appended geographic information.
Depending on the protocol used to make the request, the response will be in a certain protocol. SSN Web Service supports JSON and REST protocols.
Field Names
This is a list of the response field names and their protocol naming conventions.
| Field Name | Level | JSON |
|---|---|---|
| Transmission Results | Response (Base) | TransmissionResults |
| Transmission Reference | TransmissionReference | |
| Version | Version | |
| Total Records | TotalRecords | |
| Record ID | Record | RecordID |
| Social Security Number | SSN | |
| Issuing State | IssuingState | |
| Results | Results | |
| Results From Data Source | ResultsFromDataSource |
Response Elements
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
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 Result Codes.
Protocol Syntax JSON "TransmissionResults":"string"XML <TransmissionResults>string</TransmissionResults>
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"XML <TransmissionReference>string</TransmissionReference>
Version
- This is a string value that is the current revision number of the SSN Web Service.
Protocol Syntax JSON "Version":"string"XML <Version>string</Version>
Total Records
- Displays the total number of records returned.
Protocol Syntax JSON "TotalRecords":"string"XML <TotalRecords>string</TotalRecords>
Response Record Elements
JSON will only contain the Records element.
Protocol Definition JSON Each SSN record will be contained within [{}] under the Records element.
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"XML <RecordID>string</RecordID>
Social Security Number
- This is the returned string value of the Social Security Number submitted for validation.
Protocol Syntax JSON "SSN":"string"XML <SSN>string</SSN>
Issuing State
- This is a string value of the issued state calculated by using the SSN Area Number (first 3 digits of the SSN).
Protocol Syntax JSON "IssuingState":"string"XML <IssuingState>string</IssuingState>
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 SSN Web Service Result Codes.
Protocol Syntax JSON "Results":"string"XML <Results>string</Results>
Results From Data Source
- This is a string value with comma delimited status, error codes, and change codes from the Data Source.
Protocol Syntax JSON "ResultsFromDataSource":"string"XML <ResultsFromDataSource>string</ResultsFromDataSource>