BootView WebApi

CreateCustomerBatchFileDefinition

The following routes are available for this service:
POST	/customers/{customerId}/batchfiledefinitions	Creates a new batch file definition for this customer. Fails if this user does not have access to this customer.

**CreateCustomerBatchFileDefinition** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	path	Guid	Yes	The Customer Id.
BatchTypeId	body	int	Yes	The Batch Type Id.
BatchFileTypeId	body	int	Yes	The Batch File Type Id.
BatchFileLayoutTypeId	body	int	Yes	The Batch File Layout Type Id.
Name	body	string	Yes	The name of the batch file definition.
FileName	body	string	Yes	The file name of the batch file definition.
Folder	body	string	Yes	The folder of the batch file definition.
Delimiter	body	int	No	The delimiter used in the batch file definition.
DateCreated	body	DateTime	Yes	The date/time the definition was created.
CreatedById	body	Guid	Yes	The creator of the batch file definition.
IsActive	body	bool	Yes	Whether the batch file definition is active or not.
HotlistLineAppenderId	body	int	No	The hotlist line appender id.
BatchFileDefinitionFields	body	List<CustomerBatchFileDefinitionField>	No	An array of objects representing the fields of the batch file definition.
ScofflawImportProcessId	body	int	Yes	The Scofflaw Batch Process Type Id.
BatchFileQueryFilter	body	CustomerBatchFileQueryFilter	No	An object containing batch file query filters.

**CustomerBatchFileDefinitionField** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
BatchFileDefinitionId	form	int	No
Name	form	string	No
Description	form	string	No
Length	form	int	No
Quoted	form	bool	No
FieldIndex	form	int	No
CreatedById	form	Guid	No
DateCreated	form	DateTime	No
BatchFileDefinitionFieldConverters	form	List<BatchFileDefinitionFieldConverter>	No
FieldValueLiteral	form	string	No
BatchFileActualColumnTypeId	form	int?	No

**BatchFileDefinitionFieldConverter** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
ClassName	form	string	No
Description	form	string	No

**CustomerBatchFileQueryFilter** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
BatchFileId	form	int	No
HasPayCreditCC	form	bool	No
HasPayCashCP	form	bool	No
HasPayDebitDC	form	bool	No
HasPayCheckingEC	form	bool	No
HasPayECash	form	bool	No
HasFineParking3	form	bool	No
HasFinePropertyTax12	form	bool	No
HasFineRedLight13	form	bool	No
HasFineSpeeding23	form	bool	No

**CreateCustomerBatchFileDefinitionResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /customers/{customerId}/batchfiledefinitions HTTP/1.1 
Host: api.paylock.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	batchTypeId: 0,
	batchFileTypeId: 0,
	batchFileLayoutTypeId: 0,
	name: String,
	fileName: String,
	folder: String,
	delimiter: 0,
	dateCreated: 0001-01-01,
	createdById: 00000000000000000000000000000000,
	isActive: False,
	hotlistLineAppenderId: 0,
	batchFileDefinitionFields: 
	[
		{
			id: 0,
			batchFileDefinitionId: 0,
			name: String,
			description: String,
			length: 0,
			quoted: False,
			fieldIndex: 0,
			createdById: 00000000000000000000000000000000,
			dateCreated: 0001-01-01,
			batchFileDefinitionFieldConverters: 
			[
				{
					id: 0,
					name: String,
					className: String,
					description: String
				}
			],
			fieldValueLiteral: String,
			batchFileActualColumnTypeId: 0
		}
	],
	scofflawImportProcessId: 0,
	batchFileQueryFilter: 
	{
		id: 0,
		batchFileId: 0,
		hasPayCreditCC: False,
		hasPayCashCP: False,
		hasPayDebitDC: False,
		hasPayCheckingEC: False,
		hasPayECash: False,
		hasFineParking3: False,
		hasFinePropertyTax12: False,
		hasFineRedLight13: False,
		hasFineSpeeding23: False
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}