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

HTTP + XML

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

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

<GetBatchRecorProperties xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>0</Id>
</GetBatchRecorProperties>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BatchRecordProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <BatchRecordTypeId>0</BatchRecordTypeId>
  <Description>String</Description>
  <DisplayName>String</DisplayName>
  <Id>0</Id>
  <IsRequired>false</IsRequired>
  <PropertyName>String</PropertyName>
</BatchRecordProperty>