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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GetBatchRecorProperties HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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