BootView WebApi

<back to all web services

UpdateCustomerBatchConfiguration

The following routes are available for this service:
PUT/customers/{customerId}/customerbatches/{id}Updates an existing batch configuration for the given customer. Fails if this user does not have access to this customer or if the batch configuration doesn't exist.
UpdateCustomerBatchConfiguration Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe batch configuration id
CustomerIdpathGuidYesThe customer id
BatchTypeIdbodyintYesThe batch type
ConfigurationKeybodystringYesThe configuration key or name.
ConfigurationValuebodystringYesThe configuration value.
IsDeletedbodyboolNoWhether the batch configuration is deleted (visible) or not.

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/UpdateCustomerBatchConfiguration HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<UpdateCustomerBatchConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <BatchTypeId>0</BatchTypeId>
  <ConfigurationKey>String</ConfigurationKey>
  <ConfigurationValue>String</ConfigurationValue>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <Id>0</Id>
  <IsDeleted>false</IsDeleted>
</UpdateCustomerBatchConfiguration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>