| GET | /customers/{customerId}/batchfiledefinitions | 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. |
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.
GET /customers/{customerId}/batchfiledefinitions HTTP/1.1
Host: api.paylock.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"id":0,"customerId":"00000000000000000000000000000000","batchTypeId":0,"batchFileTypeId":0,"batchFileLayoutTypeId":0,"name":"String","fileName":"String","folder":"String","delimiter":0,"createdById":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","isActive":false,"batchFileDefinitionFields":[{"id":0,"batchFileDefinitionId":0,"name":"String","description":"String","length":0,"quoted":false,"fieldIndex":0,"createdById":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","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}}]