BootView WebApi

GetCustomerBatchFileDefinitionBatchRecordProperties

The following routes are available for this service:
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.

**GetCustomerBatchFileDefinitionBatchRecordProperties** Parameters:
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 .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.

GET /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchrecordproperties HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomerBatchRecordProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerBatchRecordProperty>
    <BatchFileDefinitionFields>
      <CustomerBatchFileDefinitionField>
        <BatchFileActualColumnTypeId>0</BatchFileActualColumnTypeId>
        <BatchFileDefinitionFieldConverters>
          <BatchFileDefinitionFieldConverter>
            <ClassName>String</ClassName>
            <Description>String</Description>
            <Id>0</Id>
            <Name>String</Name>
          </BatchFileDefinitionFieldConverter>
        </BatchFileDefinitionFieldConverters>
        <BatchFileDefinitionId>0</BatchFileDefinitionId>
        <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <Description>String</Description>
        <FieldIndex>0</FieldIndex>
        <FieldValueLiteral>String</FieldValueLiteral>
        <Id>0</Id>
        <Length>0</Length>
        <Name>String</Name>
        <Quoted>false</Quoted>
      </CustomerBatchFileDefinitionField>
    </BatchFileDefinitionFields>
    <Description>String</Description>
    <DisplayName>String</DisplayName>
    <Id>0</Id>
    <IsRequired>false</IsRequired>
    <PropertyName>String</PropertyName>
    <RecordTypeId>0</RecordTypeId>
    <Reducer>
      <ClassName>String</ClassName>
      <Description>String</Description>
      <Id>0</Id>
      <IsConstant>false</IsConstant>
      <Name>String</Name>
    </Reducer>
  </CustomerBatchRecordProperty>
</ArrayOfCustomerBatchRecordProperty>