<back to all web services
CreateCustomerBatchFileDefinitionProperties
The following routes are available for this service:POST | /customers/{customerId}/batchfiledefinitions/{batchFileDefinitionId}/batchrecordproperties | Creates mappings for batch record properties to batch record property reducers and to batch file definition fields. | |
---|
CreateCustomerBatchFileDefinitionProperties Parameters:Name | Parameter | Data Type | Required | Description |
---|
CustomerId | path | Guid | Yes | The Customer Id. |
BatchFileDefinitionId | path | int | Yes | The Batch File Definition Id. |
BatchRecordPropertyReducerMaps | body | List<BatchRecordPropertyReducerMap> | Yes | A list of mappings between batch record property and batch record property reducer. |
BatchRecordPropertyFieldMaps | body | List<BatchRecordPropertyFieldMap> | Yes | A list of mappings between batch record property and batch file definition field. |
BatchRecordPropertyReducerMap Parameters:Name | Parameter | Data Type | Required | Description |
---|
BatchRecordPropertyId | form | int | No | |
BatchRecordPropertyReducerId | form | int | No | |
CreatedById | form | Guid | No | |
DateCreated | form | DateTime | No | |
BatchRecordPropertyFieldMap Parameters:Name | Parameter | Data Type | Required | Description |
---|
BatchRecordPropertyId | form | int | No | |
BatchFileDefinitionFieldId | 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}/batchrecordproperties HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomerBatchFileDefinitionProperties xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<BatchFileDefinitionId>0</BatchFileDefinitionId>
<BatchRecordPropertyFieldMaps>
<BatchRecordPropertyFieldMap>
<BatchFileDefinitionFieldId>0</BatchFileDefinitionFieldId>
<BatchRecordPropertyId>0</BatchRecordPropertyId>
<CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
<DateCreated>0001-01-01T00:00:00</DateCreated>
</BatchRecordPropertyFieldMap>
</BatchRecordPropertyFieldMaps>
<BatchRecordPropertyReducerMaps>
<BatchRecordPropertyReducerMap>
<BatchRecordPropertyId>0</BatchRecordPropertyId>
<BatchRecordPropertyReducerId>0</BatchRecordPropertyReducerId>
<CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
<DateCreated>0001-01-01T00:00:00</DateCreated>
</BatchRecordPropertyReducerMap>
</BatchRecordPropertyReducerMaps>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
</CreateCustomerBatchFileDefinitionProperties>