Description Request

URL for the description of a request:

https://real-time.data-quality-service.com/rest/describe/phone_number_analysis/analyse_phone

When calling the request description, the following two objects will be returned:

links self-reference (self) and link for running the request (exec).
content contains descriptions of all optional parameters and the input and output arguments. The request description describes the interface of the request in JSON format.

Sample request

GET /rest/describe/phone_number_analysis/analyse_phone

Sample Response

{
   "links": [
      {
         "rel": "self",
         "href": "https://real-time.data-quality-service.com/rest/describe/phone_number_analysis"
      },
      {
         "rel": "analyse_phone",
         "href": "https://real-time.data-quality-service.com/rest/describe/phone_number_analysis/analyse_phone"
      }
   ],
   "content": [
      {
         "parameters": [
            {
               "name": "language",
               "type": "Enum",
               "values": {
                  "deutsch": "de",
                  "english": "en",
                  "français": "fr"
               },
               "defaultValue": "en"
            },
            {
               "name": "country",
               "type": "String",
               "length": 2
            },
            {
               "name": "par_format",
               "type": "String",
               "length": 32,
               "defaultValue": "INTERNATIONAL"
            },
            {
               "name": "par_verbosity",
               "type": "Numeric",
               "defaultValue": 2,
               "minimumValue": 0,
               "maximumValue": 3
            }
         ]
      }
   ]
}