Table of Contents

Search

  1. Preface
  2. Part 1: On-Prem Operations
  3. Part 2: Parameter and Element Reference
  4. Appendix A: Geocode Countries
  5. Appendix B: Certified Mode Values

On-Premises Developer Guide

On-Premises Developer Guide

Entering the Input Address Data

Entering the Input Address Data

To enter address data for verification, use the IDVE_PutJSON() or IDVE_PutJSONW() function. The IDVE_PutJSON() function passes the data in a UTF-8-encoded string. The IDVE_PutJSONW() function passes the data in a UTF-16-encoded string. The functions otherwise operate identically.
The JSON functions operate on JSON values. The values written and read must be a valid JSON document that matches the sub-schema of the given URI.

Entering the UTF-8 Address Data

The following sample code shows the structure of the IDVE_PutJSON() function:
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2
IDVE_PutJSON
( const char* const kpksCustomerID, const char* const kpksURI, const char* const kpksValue, const IDVE_U64 ku64ValueLength, const char* const kpksValueFilePath, char* const kpsExtStatusMsg );
The following table shows the parameter definitions for the IDVE_PutJSON() function:
Parameter
Operation
Comment
const char* const kpksCustomerID
[in]
Pointer to the zero-terminated 7-bit ASCII-encoded customer ID. The value might not be NULL.
const char* const kpksURI
[in]
Pointer to the zero-terminated 7-bit ASCII URI, for example "
AV/v1/Jobs/0/IO/Inputs/0
". The value might not be NULL.
const char* const kpksValue
[in]
Pointer to the UTF-8-encoded JSON value.
For the process command, the string can contain an input address in JSON format or can be NULL. The value must be NULL if the kpksValueFilePath is not NULL.
const IDVE_U64 ku64ValueLength
[in]
Length of the JSON value in number of code units, excluding any terminating zero. The value can be string length or IDVE_AUTOLEN. Ignored if kpksValue is NULL.
const char* const kpksValueFilePath
[in]
Pointer to the file path which refers to a JSON-formatted file to use as the value, encoded as UTF-8 or UTF-16. For the process command, the path identifies a file that contains the set of addresses that the job will process.
The value must be NULL if kpksValue is not NULL.
char* const kpsExtStatusMsg
[out]
Pointer to a buffer of size IDVE_EXT_STATUS_MSG_BUFFER_SIZE for an optional extended status message. The value can be NULL.

Entering the UTF-16 Address Data

The following sample code shows the structure of the IDVE_PutJSONW() function:
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2
IDVE_PutJSONW
( const char* const kpksCustomerID, const char* const kpksURI, const IDVE_WChar* const kpksValue, const IDVE_U64 ku64ValueLength, const char* const kpksValueFilePath, char* const kpsExtStatusMsg );
The following table shows the parameter definitions for the IDVE_PutJSONW() function:
Parameter
Operation
Comment
const char* const kpksCustomerID
[in]
Pointer to the zero-terminated 7-bit ASCII-encoded customer ID. The value might not be NULL.
const char* const kpksURI
[in]
Pointer to the zero-terminated 7-bit ASCII URI, for example "
AV/v1/Jobs/0/IO/Inputs/0
". The value might not be NULL.
const IDVE_WChar* const kpksValue
[in]
Pointer to the UTF-16-encoded JSON value.
For the process command, the string can contain an input address in JSON format or can be NULL. The value must be NULL if the kpksValueFilePath is not NULL.
const IDVE_U64 ku64ValueLength
[in]
Length of the JSON value in number of code units, excluding any terminating zero. The value can be string length or IDVE_AUTOLEN. Ignored if kpksValue is NULL.
const char* const kpksValueFilePath
[in]
Pointer to the file path which refers to a JSON-formatted file to use as the value, encoded as UTF-8 or UTF-16. For the process command, the path identifies a file that contains the set of addresses that the job will process.
The value must be NULL if kpksValue is not NULL.
char* const kpsExtStatusMsg
[out]
Pointer to a buffer of size IDVE_EXT_STATUS_MSG_BUFFER_SIZE for an optional extended status message. The value can be NULL.


Updated November 02, 2020