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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"customerId":"00000000-0000-0000-0000-000000000000","id":0,"batchFileTypeId":0,"name":"String","fileName":"String","folder":"String","dateCreated":"\/Date(-62135596800000-0000)\/","createdById":"00000000-0000-0000-0000-000000000000","isActive":false,"hotlistLineAppenderId":0,"scofflawImporterDefinitionId":0,"eligibleVehicleListBuilderId":0}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length 0