BootView WebApi

<back to all web services

CreateCustomerBatchFileDefinition

The following routes are available for this service:
POST/customers/{customerId}/batchfiledefinitionsCreates a new batch file definition for this customer. Fails if this user does not have access to this customer.
CreateCustomerBatchFileDefinition Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
BatchTypeIdbodyintYesThe Batch Type Id.
BatchFileTypeIdbodyintYesThe Batch File Type Id.
BatchFileLayoutTypeIdbodyintYesThe Batch File Layout Type Id.
NamebodystringYesThe name of the batch file definition.
FileNamebodystringYesThe file name of the batch file definition.
FolderbodystringYesThe folder of the batch file definition.
DelimiterbodyintNoThe delimiter used in the batch file definition.
DateCreatedbodyDateTimeYesThe date/time the definition was created.
CreatedByIdbodyGuidYesThe creator of the batch file definition.
IsActivebodyboolYesWhether the batch file definition is active or not.
HotlistLineAppenderIdbodyintNoThe hotlist line appender id.
BatchFileDefinitionFieldsbodyList<CustomerBatchFileDefinitionField>NoAn array of objects representing the fields of the batch file definition.
ScofflawImportProcessIdbodyintYesThe Scofflaw Batch Process Type Id.
CustomerBatchFileDefinitionField Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BatchFileDefinitionIdformintNo
NameformstringNo
DescriptionformstringNo
LengthformintNo
QuotedformboolNo
FieldIndexformintNo
CreatedByIdformGuidNo
DateCreatedformDateTimeNo
BatchFileDefinitionFieldConvertersformList<BatchFileDefinitionFieldConverter>No
BatchFileDefinitionFieldConverter Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ClassNameformstringNo
DescriptionformstringNo
CreateCustomerBatchFileDefinitionResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNo

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 /jsv/reply/CreateCustomerBatchFileDefinition HTTP/1.1 
Host: api.paylock.com 
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
				}
			]
		}
	],
	scofflawImportProcessId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}