BootView WebApi

<back to all web services

CreateCustomerHexBatchFileDefinition

The following routes are available for this service:
POST/customers/{customerId}/hexbatchfiledefinitionsCreates a new hotlist exporter batch file definition for this customer. Fails if this user does not have access to this customer.
CreateCustomerHexBatchFileDefinition Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
BatchFileTypeIdbodyintYesThe Batch File Type Id.
NamebodystringYesThe name of the batch file definition.
FileNamebodystringYesThe file name of the batch file definition.
FolderbodystringYesThe folder of 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.
ScofflawImporterDefinitionIdbodyintYesThe associated scofflaw batch file definition id.
EligibleVehicleListBuilderIdbodyintYesThe hotlist eligible vehicles list builder id.
CreateCustomerBatchFileDefinitionResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNo

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.

POST /csv/reply/CreateCustomerHexBatchFileDefinition HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"customerId":"00000000000000000000000000000000","batchFileTypeId":0,"name":"String","fileName":"String","folder":"String","dateCreated":"\/Date(-62135596800000-0000)\/","createdById":"00000000000000000000000000000000","isActive":false,"hotlistLineAppenderId":0,"scofflawImporterDefinitionId":0,"eligibleVehicleListBuilderId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0}