<back to all web services
CreateCustomerHotlistLineAppender
The following routes are available for this service:POST | /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/hotlistlineappender | Creates mapping for hotlist line appender to file definition. | |
---|
CreateCustomerHotlistLineAppender Parameters:Name | Parameter | Data Type | Required | Description |
---|
CustomerId | path | Guid | Yes | The Customer Id. |
BatchFileDefinitionId | path | int | Yes | The Batch File Definition Id. |
HotlistLineAppenderMap | body | CustomerHotlistLineAppenderMap | Yes | A map between a hotlist line appender and file definition. |
CustomerHotlistLineAppenderMap Parameters:Name | Parameter | Data Type | Required | Description |
---|
BatchFileDefinitionId | form | int | No | |
BatchFileDefinitionHotlistLineAppenderId | form | int | No | |
CreatedById | form | Guid | No | |
DateCreated | form | DateTime | No | |
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 /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/hotlistlineappender HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomerHotlistLineAppender xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<BatchFileDefinitionId>0</BatchFileDefinitionId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<HotlistLineAppenderMap>
<BatchFileDefinitionHotlistLineAppenderId>0</BatchFileDefinitionHotlistLineAppenderId>
<BatchFileDefinitionId>0</BatchFileDefinitionId>
<CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
<DateCreated>0001-01-01T00:00:00</DateCreated>
</HotlistLineAppenderMap>
</CreateCustomerHotlistLineAppender>