POST api/ApnBulk/AdvancedSql

Request Information

URI Parameters

None.

Body Parameters

BulkAdvancedRequest
NameDescriptionTypeAdditional information
CriteriaGroupID

integer

None.

Name

string

None.

Tabs

Collection of BulkAdvancedTab

None.

AsNew

boolean

None.

IncludeInactive

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CriteriaGroupID": 1,
  "Name": "sample string 1",
  "Tabs": [
    {
      "CriteriaGroupID": 1,
      "Conditions": [
        {
          "CriterionID": 1,
          "DataDictionaryFieldID": 1,
          "CriterionTypeID": 2,
          "Value": {},
          "Field": "sample string 4",
          "Table": "sample string 5",
          "Kind": "sample string 6"
        },
        {
          "CriterionID": 1,
          "DataDictionaryFieldID": 1,
          "CriterionTypeID": 2,
          "Value": {},
          "Field": "sample string 4",
          "Table": "sample string 5",
          "Kind": "sample string 6"
        }
      ],
      "OutputFieldIDs": [
        1,
        2
      ]
    },
    {
      "CriteriaGroupID": 1,
      "Conditions": [
        {
          "CriterionID": 1,
          "DataDictionaryFieldID": 1,
          "CriterionTypeID": 2,
          "Value": {},
          "Field": "sample string 4",
          "Table": "sample string 5",
          "Kind": "sample string 6"
        },
        {
          "CriterionID": 1,
          "DataDictionaryFieldID": 1,
          "CriterionTypeID": 2,
          "Value": {},
          "Field": "sample string 4",
          "Table": "sample string 5",
          "Kind": "sample string 6"
        }
      ],
      "OutputFieldIDs": [
        1,
        2
      ]
    }
  ],
  "AsNew": true,
  "IncludeInactive": true
}

application/xml, text/xml

Sample:
<BulkAdvancedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
  <AsNew>true</AsNew>
  <CriteriaGroupID>1</CriteriaGroupID>
  <IncludeInactive>true</IncludeInactive>
  <Name>sample string 1</Name>
  <Tabs>
    <BulkAdvancedTab>
      <Conditions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Admin">
        <d4p1:CriteriaCondition>
          <d4p1:CriterionID>1</d4p1:CriterionID>
          <d4p1:CriterionTypeID>2</d4p1:CriterionTypeID>
          <d4p1:DataDictionaryFieldID>1</d4p1:DataDictionaryFieldID>
          <d4p1:Field>sample string 4</d4p1:Field>
          <d4p1:Kind>sample string 6</d4p1:Kind>
          <d4p1:Table>sample string 5</d4p1:Table>
          <d4p1:Value />
        </d4p1:CriteriaCondition>
        <d4p1:CriteriaCondition>
          <d4p1:CriterionID>1</d4p1:CriterionID>
          <d4p1:CriterionTypeID>2</d4p1:CriterionTypeID>
          <d4p1:DataDictionaryFieldID>1</d4p1:DataDictionaryFieldID>
          <d4p1:Field>sample string 4</d4p1:Field>
          <d4p1:Kind>sample string 6</d4p1:Kind>
          <d4p1:Table>sample string 5</d4p1:Table>
          <d4p1:Value />
        </d4p1:CriteriaCondition>
      </Conditions>
      <CriteriaGroupID>1</CriteriaGroupID>
      <OutputFieldIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </OutputFieldIDs>
    </BulkAdvancedTab>
    <BulkAdvancedTab>
      <Conditions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Admin">
        <d4p1:CriteriaCondition>
          <d4p1:CriterionID>1</d4p1:CriterionID>
          <d4p1:CriterionTypeID>2</d4p1:CriterionTypeID>
          <d4p1:DataDictionaryFieldID>1</d4p1:DataDictionaryFieldID>
          <d4p1:Field>sample string 4</d4p1:Field>
          <d4p1:Kind>sample string 6</d4p1:Kind>
          <d4p1:Table>sample string 5</d4p1:Table>
          <d4p1:Value />
        </d4p1:CriteriaCondition>
        <d4p1:CriteriaCondition>
          <d4p1:CriterionID>1</d4p1:CriterionID>
          <d4p1:CriterionTypeID>2</d4p1:CriterionTypeID>
          <d4p1:DataDictionaryFieldID>1</d4p1:DataDictionaryFieldID>
          <d4p1:Field>sample string 4</d4p1:Field>
          <d4p1:Kind>sample string 6</d4p1:Kind>
          <d4p1:Table>sample string 5</d4p1:Table>
          <d4p1:Value />
        </d4p1:CriteriaCondition>
      </Conditions>
      <CriteriaGroupID>1</CriteriaGroupID>
      <OutputFieldIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </OutputFieldIDs>
    </BulkAdvancedTab>
  </Tabs>
</BulkAdvancedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfBulkAdvancedSql
NameDescriptionTypeAdditional information
Response

ApiResponse

None.

Data

BulkAdvancedSql

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": {
    "Success": true,
    "ErrorMessage": "sample string 2"
  },
  "Data": {
    "Sql": "sample string 1",
    "Problem": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ApiResultOfBulkAdvancedSqlpqgyCYEG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
    <d2p1:Problem>sample string 2</d2p1:Problem>
    <d2p1:Sql>sample string 1</d2p1:Sql>
  </Data>
  <Response>
    <ErrorMessage>sample string 2</ErrorMessage>
    <Success>true</Success>
  </Response>
</ApiResultOfBulkAdvancedSqlpqgyCYEG>