BootView WebApi

<back to all web services

GetBatchRecorProperties

The following routes are available for this service:
GET/batchrecordtypes/{id}/propertiesGets the batch record properties by batch record type.
GetBatchRecorProperties Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe Batch Record Type Id.
BatchRecordProperty Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BatchRecordTypeIdformintNo
DisplayNameformstringNo
PropertyNameformstringNo
DescriptionformstringNo
IsRequiredformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /batchrecordtypes/{id}/properties HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"batchRecordTypeId":0,"displayName":"String","propertyName":"String","description":"String","isRequired":false}