BootView WebApi

<back to all web services

CreateCustomerHotlistLineAppender

The following routes are available for this service:
POST/customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/hotlistlineappenderCreates mapping for hotlist line appender to file definition.
CreateCustomerHotlistLineAppender Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe Customer Id.
BatchFileDefinitionIdpathintYesThe Batch File Definition Id.
HotlistLineAppenderMapbodyCustomerHotlistLineAppenderMapYesA map between a hotlist line appender and file definition.
CustomerHotlistLineAppenderMap Parameters:
NameParameterData TypeRequiredDescription
BatchFileDefinitionIdformintNo
BatchFileDefinitionHotlistLineAppenderIdformintNo
CreatedByIdformGuidNo
DateCreatedformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/hotlistlineappender HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customerId":"00000000000000000000000000000000","batchFileDefinitionId":0,"hotlistLineAppenderMap":{"batchFileDefinitionId":0,"batchFileDefinitionHotlistLineAppenderId":0,"createdById":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/"}}