BootView WebApi

<back to all web services

GetCustomerBatchFileDefinitionFields

The following routes are available for this service:
GET/customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchfiledefinitionfieldsGets a list of the given customer's batch file definition fields. Only returns the list if this user has access to this customer.
GetCustomerBatchFileDefinitionFields Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
BatchFileDefinitionIdpathintYesThe Batch File Definition Id.

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/GetCustomerBatchFileDefinitionFields HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	batchFileDefinitionId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		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
	}
]