SmartMover V3:Request - Revision history

Admin at 00:58, 23 November 2021

2021-11-23T00:58:10Z

← Older revision		Revision as of 00:58, 23 November 2021
Line 27:		Line 27:
	\|Job ID\|\|jobid\|\|JobID		\|Job ID\|\|jobid\|\|JobID
	\|-		\|-
	\|PAF ID\|\|pafid\|\|~~PAFID~~		\|PAF ID\|\|pafid\|\|PAFId
	\|-		\|-
	\|Execution ID\|\| \|\|ExecutionID		\|Execution ID\|\| \|\|ExecutionID
Line 139:		Line 139:
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~PAFID~~":"'''''string'''''"</code>		\|JSON\|\|<code>"PAFId":"'''''string'''''"</code>
	\|-		\|-
	\|REST\|\|<code>&pafid = '''''string'''''</code>		\|REST\|\|<code>&pafid = '''''string'''''</code>

Admin at 23:24, 13 October 2021

2021-10-13T23:24:13Z

← Older revision		Revision as of 23:24, 13 October 2021
Line 120:		Line 120:

	<h3 style="background-color:rgb(240,240,240);">Job ID</h3>		<h3 style="background-color:rgb(240,240,240);">Job ID</h3>
			:This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that.
	:~~A unique string of characters used~~ to ~~identify a group~~ of records ~~submitted with this request~~.

	:This is ~~also used to retrieve summary reports returned by SmartMover V3~~.

	:{\| class="alternate01"		:{\| class="alternate01"
Line 135:		Line 132:

	<h3 style="background-color:rgb(240,240,240);">PAF ID</h3>		<h3 style="background-color:rgb(240,240,240);">PAF ID</h3>
			:''Only applies for Broker accounts and not to CCOA.''

	:~~Identifies~~ the ~~individual list owner when the request is submitted froma broker account.~~		:For Smartmover Brokers with their own set of end users, use the PAF ID to identify which end user this record belongs to.

	~~:This is required for any License Key issued~~ to ~~a broker account. Not applicable~~ to ~~CCOA~~.

	:{\| class="alternate01"		:{\| class="alternate01"
Line 150:		Line 146:

	<h3 style="background-color:rgb(240,240,240);">Execution ID</h3>		<h3 style="background-color:rgb(240,240,240);">Execution ID</h3>
			:In rare situations you may run into a situation where a request will be time-out by a client but finished on the server. The client then resends the same request but the server believes it is another request. So, that can result in the same record counting twice on the NCOA and CCOA report. To account for that possibility, we have the Execution ID input. We will take a hash of the input and if the hash of the current input is identical to the previous input with the same ExecutionID, we will consider it a duplicate and not count it towards the report. Specify different values for different threads.

	:~~Identifies the thread you are processing under when using multiple threads. This allows the system to track individual threads if a request times out.~~		:Default value is <code>0</code> if not set.

	:If you send the same request with the same Execution ID immediately after a request times out, the system will process the second request but will not count it against the total number of records in the NCOA and CASS reports. The default value is <code>0</code> if not set.

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 23:09, 27 March 2019

2019-03-27T23:09:33Z

← Older revision		Revision as of 23:09, 27 March 2019
Line 91:		Line 91:

	<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>		<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
	~~:''Optional.''~~

	:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.		:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Line 121:		Line 120:

	<h3 style="background-color:rgb(240,240,240);">Job ID</h3>		<h3 style="background-color:rgb(240,240,240);">Job ID</h3>
	~~:''Optional.''~~

	:A unique string of characters used to identify a group of records submitted with this request.		:A unique string of characters used to identify a group of records submitted with this request.
Line 137:		Line 135:

	<h3 style="background-color:rgb(240,240,240);">PAF ID</h3>		<h3 style="background-color:rgb(240,240,240);">PAF ID</h3>
	~~:''Optional.''~~

	:Identifies the individual list owner when the request is submitted froma broker account.		:Identifies the individual list owner when the request is submitted froma broker account.
Line 153:		Line 150:

	<h3 style="background-color:rgb(240,240,240);">Execution ID</h3>		<h3 style="background-color:rgb(240,240,240);">Execution ID</h3>
	~~:''Optional.''~~

	:Identifies the thread you are processing under when using multiple threads. This allows the system to track individual threads if a request times out.		:Identifies the thread you are processing under when using multiple threads. This allows the system to track individual threads if a request times out.
Line 167:		Line 163:

	<h3 style="background-color:rgb(240,240,240);">Actions</h3>		<h3 style="background-color:rgb(240,240,240);">Actions</h3>
	~~:''Optional.''~~

	:Selects which COA objects to be used in the request.		:Selects which COA objects to be used in the request.
Line 414:		Line 409:

	<h3 style="background-color:rgb(240,240,240);">Options</h3>		<h3 style="background-color:rgb(240,240,240);">Options</h3>
	~~:''Optional.''~~

	:This is a string value containing the options set by the user.		:This is a string value containing the options set by the user.
Line 480:		Line 474:

	<h3 style="background-color:rgb(240,240,240);">OptSmartMoverListName</h3>		<h3 style="background-color:rgb(240,240,240);">OptSmartMoverListName</h3>
	~~:''Optional.''~~

	:Identifies the current list. It will be included in reports returned by SmartMover V3 after processing.		:Identifies the current list. It will be included in reports returned by SmartMover V3 after processing.
Line 494:		Line 487:

	<h3 style="background-color:rgb(240,240,240);">Format</h3>		<h3 style="background-color:rgb(240,240,240);">Format</h3>
	~~:''Optional.''~~

	:The desired format of the response.		:The desired format of the response.
Line 532:		Line 524:

	<h3 style="background-color:rgb(240,240,240);">Company</h3>		<h3 style="background-color:rgb(240,240,240);">Company</h3>
	~~:''Optional.''~~

	:The name of the business.		:The name of the business.
Line 546:		Line 537:

	<h3 style="background-color:rgb(240,240,240);">Full Name</h3>		<h3 style="background-color:rgb(240,240,240);">Full Name</h3>
	~~:''Optional.''~~

	:The full name of an individual.		:The full name of an individual.
Line 560:		Line 550:

	<h3 style="background-color:rgb(240,240,240);">First Name</h3>		<h3 style="background-color:rgb(240,240,240);">First Name</h3>
	~~:''Optional.''~~

	:The first name of an individual.		:The first name of an individual.
Line 574:		Line 563:

	<h3 style="background-color:rgb(240,240,240);">Middle Name</h3>		<h3 style="background-color:rgb(240,240,240);">Middle Name</h3>
	~~:''Optional.''~~

	:The middle name of an individual.		:The middle name of an individual.
Line 588:		Line 576:

	<h3 style="background-color:rgb(240,240,240);">Name Prefix</h3>		<h3 style="background-color:rgb(240,240,240);">Name Prefix</h3>
	~~:''Optional.''~~

	:The title or honorific prefix of the name. E.g. "Mr, Miss, Dr".		:The title or honorific prefix of the name. E.g. "Mr, Miss, Dr".
Line 602:		Line 589:

	<h3 style="background-color:rgb(240,240,240);">Name Suffix</h3>		<h3 style="background-color:rgb(240,240,240);">Name Suffix</h3>
	~~:''Optional.''~~

	:The generational or professional suffix of the name. E.g. "Jr, IV, Ph.D.".		:The generational or professional suffix of the name. E.g. "Jr, IV, Ph.D.".
Line 616:		Line 602:

	<h3 style="background-color:rgb(240,240,240);">Last Name</h3>		<h3 style="background-color:rgb(240,240,240);">Last Name</h3>
	~~:''Optional.''~~

	:The last name of the individual.		:The last name of the individual.
Line 630:		Line 615:

	<h3 style="background-color:rgb(240,240,240);">Urbanization</h3>		<h3 style="background-color:rgb(240,240,240);">Urbanization</h3>
	~~:''Optional.''~~

	:Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code.		:Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code.
Line 644:		Line 628:

	<h3 style="background-color:rgb(240,240,240);">Address Line 1</h3>		<h3 style="background-color:rgb(240,240,240);">Address Line 1</h3>
	~~:''Optional.''~~

	:The first address line.		:The first address line.
Line 658:		Line 641:

	<h3 style="background-color:rgb(240,240,240);">Address Line 2</h3>		<h3 style="background-color:rgb(240,240,240);">Address Line 2</h3>
	~~:''Optional.''~~

	:The second address line.		:The second address line.
Line 672:		Line 654:

	<h3 style="background-color:rgb(240,240,240);">Suite</h3>		<h3 style="background-color:rgb(240,240,240);">Suite</h3>
	~~:''Optional.''~~

	:The suite number.		:The suite number.
Line 686:		Line 667:

	<h3 style="background-color:rgb(240,240,240);">Private Mailbox</h3>		<h3 style="background-color:rgb(240,240,240);">Private Mailbox</h3>
	~~:''Optional.''~~

	:The private mailbox number, if this address is a box in a private mailbox service.		:The private mailbox number, if this address is a box in a private mailbox service.
Line 700:		Line 680:

	<h3 style="background-color:rgb(240,240,240);">City</h3>		<h3 style="background-color:rgb(240,240,240);">City</h3>
	~~:''Optional.''~~

	:The city name.		:The city name.
Line 714:		Line 693:

	<h3 style="background-color:rgb(240,240,240);">State</h3>		<h3 style="background-color:rgb(240,240,240);">State</h3>
	~~:''Optional.''~~

	:The state name.		:The state name.
Line 728:		Line 706:

	<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>		<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>
	~~:''Optional.''~~

	:The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4.		:The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4.
Line 756:		Line 733:

	<h3 style="background-color:rgb(240,240,240);">Country</h3>		<h3 style="background-color:rgb(240,240,240);">Country</h3>
	~~:''Optional.''~~

	:The country code. The SmartMover V3 web service can only update addresses within the United States.		:The country code. The SmartMover V3 web service can only update addresses within the United States.

Admin at 01:04, 8 December 2018

2018-12-08T01:04:01Z

← Older revision		Revision as of 01:04, 8 December 2018
Line 9:		Line 9:

	SmartMover V3 supports the JSON and REST protocols to access the service.		SmartMover V3 supports the JSON and REST protocols to access the service.


			==URL==
			{{URL-SmartMoverV3}}

Admin at 17:31, 18 January 2018

2018-01-18T17:31:35Z

← Older revision		Revision as of 17:31, 18 January 2018
Line 233:		Line 233:
	!Field Name !! Group		!Field Name !! Group
	\|-		\|-
	\|~~AddressExtras~~\|\|rowspan="24"\|'''[DEFAULT]'''		\|TransmissionResults\|\|rowspan="31"\|'''[DEFAULT]'''
	Always return in the output structure.		Always return in the output structure.
			\|-
			\|TransmissionReference
			\|-
			\|Version
			\|-
			\|TotalRecords
			\|-
			\|CASSReportLink
			\|-
			\|NCOAReportLink
			\|-
			\|Records
			\|-
			\|AddressExtras
	\|-		\|-
	\|AddressKey		\|AddressKey
Line 382:		Line 396:
	\|StandardizedUrbanization		\|StandardizedUrbanization
	\|-		\|-
	\|DPVFootNotes\|\|rowspan="5"\|'''[COLUMN NAME ~~ONLYL~~]'''		\|DPVFootNotes\|\|rowspan="5"\|'''[COLUMN NAME ONLY]'''
	These columns can only be requested by using their name.		These columns can only be requested by using their name.
	\|-		\|-

Admin at 00:07, 18 January 2018

2018-01-18T00:07:43Z

← Older revision		Revision as of 00:07, 18 January 2018
Line 382:		Line 382:
	\|StandardizedUrbanization		\|StandardizedUrbanization
	\|-		\|-
	\|DPVFootNotes\|\|rowspan="5"\|'''[~~Column Name Only~~]'''		\|DPVFootNotes\|\|rowspan="5"\|'''[COLUMN NAME ONLYL]'''
			These columns can only be requested by using their name.
	\|-		\|-
	\|MoveReturnCode		\|MoveReturnCode

Admin at 00:06, 18 January 2018

2018-01-18T00:06:31Z

← Older revision		Revision as of 00:06, 18 January 2018
Line 382:		Line 382:
	\|StandardizedUrbanization		\|StandardizedUrbanization
	\|-		\|-
	\|DPVFootNotes\|\|rowspan="5"\|'''Column Name Only'''		\|DPVFootNotes\|\|rowspan="5"\|'''[Column Name Only]'''
	\|-		\|-
	\|MoveReturnCode		\|MoveReturnCode

Admin at 00:05, 18 January 2018

2018-01-18T00:05:54Z

← Older revision		Revision as of 00:05, 18 January 2018
Line 233:		Line 233:
	!Field Name !! Group		!Field Name !! Group
	\|-		\|-
	\|AddressExtras\|\|rowspan="24"\|'''[~~Default~~]'''		\|AddressExtras\|\|rowspan="24"\|'''[DEFAULT]'''
	~~These columns are returned by default~~.		Always return in the output structure.
	\|-		\|-
	\|AddressKey		\|AddressKey

Admin at 23:56, 17 January 2018

2018-01-17T23:56:54Z

Show changes

Admin at 19:04, 17 January 2018

2018-01-17T19:04:18Z

← Older revision		Revision as of 19:04, 17 January 2018
Line 17:		Line 17:
	!Field Name !! Level !! REST !! JSON		!Field Name !! Level !! REST !! JSON
	\|-		\|-
	\|Transmission Reference\|\|rowspan="10" valign="center"\|Request\|\|t\|\|TransmissionReference		\|Transmission Reference\|\|rowspan="11" valign="center"\|Request\|\|t\|\|TransmissionReference
	\|-		\|-
	\|License Key\|\|id\|\|CustomerID		\|License Key\|\|id\|\|CustomerID