User Defined Fields (UDF) query/create

Query and create UDF labels

Endpoints

/rpc/v1/udf.html: The browsable documentation for this API endpoint.
/rpc/v1/udf.json: Endpoint that will return a JSON response.
/rpc/v1/udf.xml: Endpoint that will return an XML response.

Usage

Usage for HTTP GET

Key Name: label: UDF label to lookup

Must provide on Key/Value pair, batch is NOT supported

Usage for HTTP POST

Key Name: label: UDF label to create
Key Name: type: UDF type (NUMBER|ALPHA-NUMERIC|DATE|AMOUNT) to assign
Key Name: desc: Description of the UDF being created

All three parameters must be provided in POST. Batch is NOT supported

Error Codes

200 Success: Successfully queried or created UDF
400 Invalid Request: Invalid input was supplied
401 Authentication: The key provided could not be authenticated
404 Not Found: Requested UDF not found

Response Samples

GET [XML]

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <status>ok</status>
 <count>
  <success>1</success>
  <failure>0</failure>
 </count>
 <errors/>
 <result></result>
</response>

GET [JSON]

{"status":"ok","count":{"success":1,"failure":0},"errors":[]}

Code Examples

GET

curl -G \
  -d"label=VALUE" \
  -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
  https://api.kount.net/rpc/v1/udf.json

POST

curl \
  -d"label=VALUE" \
  -d"type=VALUE" \
  -d"desc=VALUE" \
  -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
  https://api.kount.net/rpc/v1/udf.xml