BootView WebApi

<back to all web services

GetCustomerBatchFileDefinitionBatchRecordProperties

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

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

HTTP + CSV

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

GET /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchrecordproperties HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"id":0,"recordTypeId":0,"displayName":"String","propertyName":"String","description":"String","isRequired":false,"batchFileDefinitionFields":[{"id":0,"batchFileDefinitionId":0,"name":"String","description":"String","length":0,"quoted":false,"fieldIndex":0,"createdById":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","batchFileDefinitionFieldConverters":[{"id":0,"name":"String","className":"String","description":"String"}],"fieldValueLiteral":"String","batchFileActualColumnTypeId":0}],"reducer":{"id":0,"name":"String","className":"String","description":"String","isConstant":false}}]