serialnumber-load.schema

Serial number data from an external system is validated against serialnumber-load.schema.

Download Schema (How?) Click the Download Schema link and choose to either download the TEXT file or open the JSON schema will open in your chosen application for editing such files. To convert the file to a JSON schema, save it with a .json extension.

 

serialnumber-load.schema
type	object
properties	interfaceCategory	type	string
		required	True
		description	CMP categorization of the job that produces this extract file. This must match the corresponding output file.
		maxLength	50
	interfaceType	type	string
		required	True
		description	CMP cub-categorization of the job that produces this extract file. This must match the corresponding outbound file.
		maxLength	50
	version	type	number
		required	True
		description	The current version of the generic extract file. This must match the corresponding outbound file.
		maximum	99.99
		minimum	0.0
	transformDateTime	type	type
		description	Timestamp indicating when the third-party response was transformed into the CMP generic format.
		format	date-time
	transmitDateTime	type	string
		description	Timestamp indicating when the response file was received from the third-party system
		format	date-time
	networkCode	type	string
		required	True
		description	Code of the network from the external system
		maxLength	6
	networkType	type	string
		required	True
		description	Type of the network from the external system
		maxLength	6
	idNumber	type	integer
	details	type	array
		description	A response consists of one or more details
		items	type	object
			properties	detailSequence	type	integer
					required	True
					description	Unique identifier of the detail record within the current extract. Starts at 1 and incremented for each detail record
					maximum	999999999.0
					minimum	1.0
				fromSerialNumber	type	string
					required	True
					description	Serial number for the current Serial Number Load Batch Detail record
					maxLength	25
				count	type	integer
					description	Count for the current Serial Number Load Batch Detail record
				account	type	integer
					description	Account for the current Serial Number Load Batch Detail record
				price	type	number
					description	Price for the current Serial Number Load Batch Detail record
				useByDate	type	string
					description	Date and time this was used
					format	date-time
				reUseByDate	type	string
					description	Date and time this was reused
					format	date-time
				expiryDate	type	string
					description	Date and time this was expired
					date-time	date-time
	externalFileName	type	string
		required	True
		description	The name of the file that was received from the external system
		maxLength	100
	Id	type	integer
		required	True
		maximum	5.0
		minimum	1.0
	networkOperator	type	string
		required	True
		description	Operator of the network from the external system
		maxLength	6