BootView WebApi

<back to all web services

UpdateCustomerHexBatchFileDefinition

The following routes are available for this service:
PUT/customers/{customerId}/hexbatchfiledefinitions/{id}Updates a hotlist exporter batch file definition for this customer. Fails if this user does not have access to this customer.
UpdateCustomerHexBatchFileDefinition Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
IdpathintYesThe Batch File Definition 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.

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

<UpdateCustomerHexBatchFileDefinition 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>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <Name>String</Name>
  <ScofflawImporterDefinitionId>0</ScofflawImporterDefinitionId>
</UpdateCustomerHexBatchFileDefinition>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>