| GET | /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchrecordproperties | Gets a list of the given customer's batch record properties for a batch file definition. 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. |
| BatchFileDefinitionId | path | int | Yes | The Batch File Definition Id. |
| BatchRecordTypeId | query | int | Yes | The Batch Record Type Id. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchrecordproperties HTTP/1.1
Host: api.paylock.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"id":0,"recordTypeId":0,"displayName":"String","propertyName":"String","description":"String","isRequired":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}],"reducer":{"id":0,"name":"String","className":"String","description":"String","isConstant":false}}]