Notes
This Message Implementation Guideline (MIG) for the Electronic Visa System must be used to request a Visa Activity Report (VAR).

A Visa Activity Report (VAR) may be requested based on the following:

1. A single date or date range with no Visa number(s) specified. This will generate a VAR with all "Entry" activities recorded against "matched" Visas for the specified date/date range.
2. A single Visa number or a range of Visa numbers with no dates specified. This will generate a VAR with all "Entry" activities recorded for the Visa or Visas specified from the date the first activity was recorded to the date of the report request.

	Pos. No.	Seg. ID	Name	Req. Des.	Max. Use	Group Repeat	Notes and Comments
M	0010	UNH	Message Header	M	1
M	0020	BGM	Beginning of Message	M	1
M	0030	DOC	Document/Message Details	M	1
M	0040	DTM	Date/Time/Period	M	3
	0050		Segment Group 1: RFF	C		99
M	0060	RFF	Reference	M	1
M	0070	UNT	Message Trailer	M	1

 

Segment:	UNH Message Header
Postion:	0010
Group:
Level:	0
Usage:	Mandatory
Max Use:	1
Purpose:	A service segment starting and uniquely identifying a message. The message type code for the Customs response message is REQDOC. Note: Request for document messages conforming to this document must contain the following data in segment UNH, composite S009: Data element 0065 REQDOC 0052 D 0054 99A 0051 UN
Dependency Notes:
Semantic Notes:
Comments:

Data Element Summary

	Data Element	Component Element	Name	Attributes
M	0062		Message Reference Number	M 1 an..14
			Unique message reference assigned by the sender. This is a control number generated by the participant.
M	S009		Message Identifier	M 1
			Identification of the type, version etc. of the message being interchanged.
M		0065	Message Type Identifier	M an..6
			Code identifying a type of message and assigned by its controlling agency. Always "REQDOC". REQDOC Request for document message
M		0052	Message Type Version Number	M an..3
			Version number of a message type. Always "D". D Draft version/UN/EDIFACT Directory
M		0054	Message Type Release Number	M an..3
			Release number within the current message type version number (0052). Always "99A". 99A Release 1999 - A
M		0051	Controlling Agency	M an..2
			Code identifying the agency controlling the specification, maintenance and publication of the message type. Always "UN". UN UN/ECE/TRADE/WP.4

Segment:	BGM Beginning of Message
Postion:	0020
Group:
Level:	0
Usage:	Mandatory
Max Use:	1
Purpose:	A segment by which the sender must uniquely identify the request for document by means of its type and number.
Dependency Notes:
Semantic Notes:
Comments:

Data Element Summary

	Data Element	Component Element	Name	Attributes
	C002		Document/Message Name	C 1
			Identification of a type of document/message by code or name. Code preferred.
M		1001	Document/Message Name, Coded	M an..3
			Document/message identifier expressed in code. Always "21". 21 Query

Segment:	DOC Document/Message Details
Postion:	0030
Group:
Level:	0
Usage:	Mandatory
Max Use:	1
Purpose:	A segment indicating the type of document that is required, how many copies, and in what form it is required, e.g. EDI, mail, etc.
Dependency Notes:
Semantic Notes:
Comments:
Notes:	This segment is mandatory in the standard REQDOC message, therefore in order to maintain standards compliance, U.S. Customs and Border Protection requires it's use. Code 21 must be transmitted in data element 1001.

Data Element Summary

	Data Element	Component Element	Name	Attributes
	MC002		Document/Message Name	M 1
			Identification of a type of document/message by code or name. Code preferred.
		1001	Document/Message Name, Coded	C an..3
			Document/message identifier expressed in code. Always "21". 21 Query

Segment:	DTM Date/Time/Period
Postion:	0040
Group:
Level:	1
Usage:	Mandatory
Max Use:	3
Purpose:	A segment specifying general dates and, when relevant, times related to the whole message. The request preparation date must be specified using this segment.
Dependency Notes:
Semantic Notes:
Comments:
Notes:	At least one (1) DTM segment is required in the Electronic Visa System. Data element 2005 of Composite C507 must equal 137 - Document/message date/time. This will reflect the date of the request. To request a report on a single date of Visa activity, use a single DTM segment with data element 2005 of Composite C507 equal 90 - report start date. To request a report for a date range of Visa activity, two (2) DTM segments are required. In the first DTM segment, data element 2005 of Composite C507 must equal 90 -report start date. In the second DTM segment, data element 2005 must equal 91 - report end date. To request a report where a single Visa number or a range of Visa numbers are specified, use a single DTM segment with data element 2005 of Composite C507 equal 137 - Document/message date/time. Only Visas within the requested Visa range or date range that are "matched", will be reported in the VAR. A Visa is considered "matched" if "Entry" activity is recorded against the Visa.

Data Element Summary

	Data Element	Component Element	Name	Attributes
M	C507		Date/Time/Period	M 1
			Date and/or time, or period relevant to the specified date/time/period type.
M		2005	Date/Time/Period Qualifier	M an..3
			Code giving specific meaning to a date, time or period. Use"90" to indicate start date range. Use"91" to indicate start date range. 90 Report start date 91 Report end date 137 Document/message date/time
Must Use		2380	Date/Time/Period	C an..35
			The value of a date, a date and time, a time or of a period in a specified representation. Identify Start date range (for 90 qualifier). Identify End date range (for 91 qualifier).
Must Use		2379	Date/Time/Period Format Qualifier	C an..3
			Specification of the representation of a date, a date and time or of a period. Always use "102". 102 CCYYMMDD

Segment:	RFF Reference
Postion:	0060 (Trigger Segment)
Group:	Segment Group 1 (Reference) Conditional (Optional)
Level:	1
Usage:	Mandatory
Max Use:	1
Purpose:	A segment identifying the reference by its number and where appropriate a line number within the document.
Dependency Notes:
Semantic Notes:
Comments:
Notes:	This segment identifies the Visa number or numbers for which the Visa Activity Report is requested. The first occurrence of the RFF loop segment identifies the starting range of Visa numbers. The second occurrence identifies the end range of Visa numbers. A REQDOC request message with only one RFF loop segment will generate a report with Entries for the identified Visa.

Data Element Summary

	Data Element	Component Element	Name	Attributes
M	C506		Reference	M 1
			Identification of a reference.
M		1153	Reference Qualifier	M an..3
			Code giving specific meaning to a reference segment or a reference number. Always "ZZZ". ZZZ Mutually defined reference number
Must Use		1154	Reference Number	C an..35
			Identification number the nature and function of which can be qualified by an entry in data element 1153 Reference qualifier. 1st Occurrence: Starting Visa Number. 2nd Occurrence: Ending Visa Number.

Segment:	UNT Message Trailer
Postion:	0070
Group:
Level:	0
Usage:	Mandatory
Max Use:	1
Purpose:	A service segment ending a message, giving the total number of segments in the message and the control reference number of the message.
Dependency Notes:
Semantic Notes:
Comments:

Data Element Summary

	Data Element	Component Element	Name	Attributes
M	0074		Number of Segments in a Message	M 1 n..6
			Control count of number of segments in a message.
M	0062		Message Reference Number	M1 an..14
			Unique message reference assigned by the sender.

REQDOC3 (D.99A)

NOVEMBER 28, 2001