error resource

Methods

  • get - filingHistoryItem resource
  • get - Get a company officer appointment
  • get - filingHistoryList resource

Resource

{
    "errors": [
        {
            "error": "string",
            "error_values": [
                {
                    "<argument>": "string"
                }
            ],
            "location": "string",
            "location_type": "string",
            "type": "string"
        }
    ]
}

Properties

Name Type Description Additional
errors[] array

A list of errors found
errors[].error string

The error being returned. See github for valid enumeration types
errors[].error_values[] array

A collection of argument name and value pairs which, when substituted into the error string, provide the full description of the error. As many name/value pairs as necessary to complete the error description are returned. See example above.

 Optional
errors[].error_values[].<argument> string

The element name and value pair required to complete the error description, will repeat as necessary.

 Optional
errors[].location string

The location in the submitted request in which the error relates. This parameter is only provided when errors[].type is set to "ch:validation".

 Optional
errors[].location_type string

Describes the type of location returned so that it may be parsed appropriately

Possible values are:

  • json-path
  • query-parameter
 Optional
errors[].type string

Type of error

Possible values are:

  • ch:service
  • ch:validation