BootView WebApi

<back to all web services

GetCustomerBatchConfigurations

The following routes are available for this service:
GET/customers/{customerId}/customerbatchesGets a list of the given customer's batch configurations. Only returns the list if this user has access to this customer.
GetCustomerBatchConfigurations Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer 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.

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

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

<ArrayOfCustomerBatchConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerBatchConfiguration>
    <BatchTypeId>0</BatchTypeId>
    <ConfigurationKey>String</ConfigurationKey>
    <ConfigurationValue>String</ConfigurationValue>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Id>0</Id>
    <IsDeleted>false</IsDeleted>
  </CustomerBatchConfiguration>
</ArrayOfCustomerBatchConfiguration>