POST api/CQ

Request Information

URI Parameters

None.

Body Parameters

CQRequest
NameDescriptionTypeAdditional information
Query

string

None.

VerificationCode

string

None.

Fields

Collection of Pair of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Query": "sample string 1",
  "VerificationCode": "sample string 2",
  "Fields": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<CQRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Query>sample string 1</Query>
  <VerificationCode>sample string 2</VerificationCode>
  <Fields>
    <KeyValuePairOfStringString />
    <KeyValuePairOfStringString />
  </Fields>
</CQRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CQResponse
NameDescriptionTypeAdditional information
VerificationCode

string

None.

IsValid

boolean

None.

Errors

Collection of string

None.

Results

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
{
  "VerificationCode": "sample string 1",
  "IsValid": false,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Results": [
    {},
    {}
  ]
}

application/xml, text/xml

Sample:
<CQResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VerificationCode>sample string 1</VerificationCode>
  <Errors>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Errors>
  <Results>
    <anyType />
    <anyType />
  </Results>
</CQResponse>