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. |
---|
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. |
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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerId: 00000000000000000000000000000000,
batchFileTypeId: 0,
name: String,
fileName: String,
folder: String,
dateCreated: 0001-01-01,
createdById: 00000000000000000000000000000000,
isActive: False,
hotlistLineAppenderId: 0,
scofflawImporterDefinitionId: 0,
eligibleVehicleListBuilderId: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: 0 }