BootView WebApi

CreateCustomerHexBatchFileDefinition

The following routes are available for this service:
POST	/customers/{customerId}/hexbatchfiledefinitions	Creates a new hotlist exporter batch file definition for this customer. Fails if this user does not have access to this customer.

**CreateCustomerHexBatchFileDefinition** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	path	Guid	Yes	The Customer Id.
BatchFileTypeId	body	int	Yes	The Batch File Type Id.
Name	body	string	Yes	The name of the batch file definition.
FileName	body	string	Yes	The file name of the batch file definition.
Folder	body	string	Yes	The folder of the batch file definition.
DateCreated	body	DateTime	Yes	The date/time the definition was created.
CreatedById	body	Guid	Yes	The creator of the batch file definition.
IsActive	body	bool	Yes	Whether the batch file definition is active or not.
HotlistLineAppenderId	body	int	No	The hotlist line appender id.
ScofflawImporterDefinitionId	body	int	Yes	The associated scofflaw batch file definition id.
EligibleVehicleListBuilderId	body	int	Yes	The hotlist eligible vehicles list builder id.

**CreateCustomerBatchFileDefinitionResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

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

HTTP + XML

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

POST /customers/{customerId}/hexbatchfiledefinitions HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCustomerHexBatchFileDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <BatchFileTypeId>0</BatchFileTypeId>
  <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <EligibleVehicleListBuilderId>0</EligibleVehicleListBuilderId>
  <FileName>String</FileName>
  <Folder>String</Folder>
  <HotlistLineAppenderId>0</HotlistLineAppenderId>
  <IsActive>false</IsActive>
  <Name>String</Name>
  <ScofflawImporterDefinitionId>0</ScofflawImporterDefinitionId>
</CreateCustomerHexBatchFileDefinition>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCustomerBatchFileDefinitionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>0</Id>
</CreateCustomerBatchFileDefinitionResult>