| GET | /customers/{customerId}/batchfiledefinitions/{batchTypeId} | Gets a list of the given customer's batch file definitions. Only returns the list if this user has access to this customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | Guid | Yes | The Customer Id. |
| BatchTypeId | path | int | Yes | The batch type Id. |
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.
GET /customers/{customerId}/batchfiledefinitions/{batchTypeId} HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
id: 0,
customerId: 00000000000000000000000000000000,
batchTypeId: 0,
batchFileTypeId: 0,
batchFileLayoutTypeId: 0,
name: String,
fileName: String,
folder: String,
delimiter: 0,
createdById: 00000000000000000000000000000000,
dateCreated: 0001-01-01,
isActive: False,
batchFileDefinitionFields:
[
{
id: 0,
batchFileDefinitionId: 0,
name: String,
description: String,
length: 0,
quoted: False,
fieldIndex: 0,
createdById: 00000000000000000000000000000000,
dateCreated: 0001-01-01,
batchFileDefinitionFieldConverters:
[
{
id: 0,
name: String,
className: String,
description: String
}
],
fieldValueLiteral: String,
batchFileActualColumnTypeId: 0
}
],
hotlistLineAppenderId: 0,
scofflawImportProcessId: 0,
batchFileQueryFilter:
{
id: 0,
batchFileId: 0,
hasPayCreditCC: False,
hasPayCashCP: False,
hasPayDebitDC: False,
hasPayCheckingEC: False,
hasPayECash: False,
hasFineParking3: False,
hasFinePropertyTax12: False,
hasFineRedLight13: False,
hasFineSpeeding23: False
}
}
]