BootView WebApi

<back to all web services

GetCustomerHexBatchFileDefinitions

The following routes are available for this service:
GET/customers/{customerId}/hexbatchfiledefinitions/Gets a list of the given customer's hotlist exporter batch file definitions. Only returns the list if this user has access to this customer.
GetCustomerHexBatchFileDefinitions Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer 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}/hexbatchfiledefinitions/ HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"id":0,"scofflawImporterDefinitionId":0,"customerId":"00000000000000000000000000000000","batchTypeId":0,"batchFileTypeId":0,"name":"String","fileName":"String","folder":"String","createdById":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","isActive":false,"hotlistLineAppenderId":0,"eligibleVehicleListBuilderId":0}]