GET | /customers/{customerId}/batchfiledefinitions | Gets a list of the given customer's batch file definitions. Only returns the list if this user has access to this customer. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The Customer Id. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{customerId}/batchfiledefinitions HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfCustomerBatchFileDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <CustomerBatchFileDefinition> <BatchFileDefinitionFields> <CustomerBatchFileDefinitionField> <BatchFileActualColumnTypeId>0</BatchFileActualColumnTypeId> <BatchFileDefinitionFieldConverters> <BatchFileDefinitionFieldConverter> <ClassName>String</ClassName> <Description>String</Description> <Id>0</Id> <Name>String</Name> </BatchFileDefinitionFieldConverter> </BatchFileDefinitionFieldConverters> <BatchFileDefinitionId>0</BatchFileDefinitionId> <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById> <DateCreated>0001-01-01T00:00:00</DateCreated> <Description>String</Description> <FieldIndex>0</FieldIndex> <FieldValueLiteral>String</FieldValueLiteral> <Id>0</Id> <Length>0</Length> <Name>String</Name> <Quoted>false</Quoted> </CustomerBatchFileDefinitionField> </BatchFileDefinitionFields> <BatchFileLayoutTypeId>0</BatchFileLayoutTypeId> <BatchFileQueryFilter> <BatchFileId>0</BatchFileId> <HasFineParking3>false</HasFineParking3> <HasFinePropertyTax12>false</HasFinePropertyTax12> <HasFineRedLight13>false</HasFineRedLight13> <HasFineSpeeding23>false</HasFineSpeeding23> <HasPayCashCP>false</HasPayCashCP> <HasPayCheckingEC>false</HasPayCheckingEC> <HasPayCreditCC>false</HasPayCreditCC> <HasPayDebitDC>false</HasPayDebitDC> <HasPayECash>false</HasPayECash> <Id>0</Id> </BatchFileQueryFilter> <BatchFileTypeId>0</BatchFileTypeId> <BatchTypeId>0</BatchTypeId> <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <DateCreated>0001-01-01T00:00:00</DateCreated> <Delimiter>0</Delimiter> <FileName>String</FileName> <Folder>String</Folder> <HotlistLineAppenderId>0</HotlistLineAppenderId> <Id>0</Id> <IsActive>false</IsActive> <Name>String</Name> <ScofflawImportProcessId>0</ScofflawImportProcessId> </CustomerBatchFileDefinition> </ArrayOfCustomerBatchFileDefinition>