Description Request

URL for the description of a request:

https://real-time.data-quality-service.com/rest/describe/name-analysis/<analyse_name|verifyname>

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.

Sample Requests

GET /rest/describe/name-analysis/analyse_name
GET /rest/describe/name-analysis/verifyname

Sample Response

Response for the description of a request verifyname:

{
   "links": [
      {
         "rel": "self",
         "href": "https://real-time.data-quality-service.com/rest/describe/nameanalysis/verifyname"
      },
      {
         "rel": "exec",
         "href": "https://real-time.data-quality-service.com/rest/name-analysis/verifyname?language=en"
      }
   ],
   "content": [
      {
         "parameters": [
            {
               "name": "language",
               "type": "Enum",
               "values": {
               "deutsch": "de",
               "english": "en",
               "français": "fr"
               },
               "defaultValue": "en"
            },
            {
               "name": "country",
               "type": "String",
               "length": 2,
               "defaultValue": "DE"
           }
         ],
         "requestName": "verifyname",
         "inputArguments": [
            {
               "name": "in_language",
               "type": "String",
               "length": "20"
            },
            {
               "name": "in_form_of_address",
               "type": "String",
               "length": "20"
            },
            {
               "name": "in_preceding_academic_titles",
               "type": "String",
               "length": "30"
            },
            {
               "name": "in_given_names",
               "type": "String",
               "length": "30"
            },
            {
               "name": "in_legal_form",
               "type": "String",
               "length": "30"
            }
         ],
         "outputArguments": [
            {
               "name": "out_given_names",
               "type": "String",
               "length": "30"
            },
            {
               "name": "out_initials",
               "type": "String",
               "length": "20"
            },
            {
               "name": "out_rate_info",
               "type": "String",
               "length": "256"
            }
         ]
      }
   ]
}