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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The Customer Id. |
Id | path | int | Yes | The Batch File Definition 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /customers/{customerId}/hexbatchfiledefinitions/{id} HTTP/1.1
Host: api.paylock.com
Accept: application/xml
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>