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 .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 /xml/reply/GetCustomerHexBatchFileDefinitions HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCustomerHexBatchFileDefinitions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
</GetCustomerHexBatchFileDefinitions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomerHexBatchFileDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerHexBatchFileDefinition>
    <BatchFileTypeId>0</BatchFileTypeId>
    <BatchTypeId>0</BatchTypeId>
    <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>
    <Id>0</Id>
    <IsActive>false</IsActive>
    <Name>String</Name>
    <ScofflawImporterDefinitionId>0</ScofflawImporterDefinitionId>
  </CustomerHexBatchFileDefinition>
</ArrayOfCustomerHexBatchFileDefinition>