TaxComm Platform Service

<back to all web services

BatchesRequest

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/BatchView/{fipsCode}
GET,POST,PUT,DELETE,OPTIONS/v1/BatchView/
GET,POST,PUT,DELETE,OPTIONS/v1/BatchView/{fipsCode}/{status}

To override the Content-type in your clients 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/BatchesRequest HTTP/1.1 
Host: taxcommapi.trendsic.net 
Content-Type: application/xml
Content-Length: length

<BatchesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BatchView>
    <BatchView>
      <ID>0</ID>
      <TotalCount>0</TotalCount>
      <batch_created>0001-01-01T00:00:00</batch_created>
      <batch_no>0</batch_no>
      <batch_submitted>0001-01-01T00:00:00</batch_submitted>
      <fips_code>0</fips_code>
      <status>String</status>
      <tax_year>0</tax_year>
    </BatchView>
  </BatchView>
  <fipsCode>0</fipsCode>
  <status>String</status>
</BatchesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BatchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BatchView>
    <BatchView>
      <ID>0</ID>
      <TotalCount>0</TotalCount>
      <batch_created>0001-01-01T00:00:00</batch_created>
      <batch_no>0</batch_no>
      <batch_submitted>0001-01-01T00:00:00</batch_submitted>
      <fips_code>0</fips_code>
      <status>String</status>
      <tax_year>0</tax_year>
    </BatchView>
  </BatchView>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</BatchesResponse>