forked from LiveCarta/PayPal-PHP-Server-SDK
82 lines
2.0 KiB
Markdown
82 lines
2.0 KiB
Markdown
|
|
# Error Exception
|
|
|
|
The error details.
|
|
|
|
## Structure
|
|
|
|
`ErrorException`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `name` | `string` | Required | The human-readable, unique name of the error. | getName(): string | setName(string name): void |
|
|
| `message` | `string` | Required | The message that describes the error. | getMessage(): string | setMessage(string message): void |
|
|
| `debugId` | `string` | Required | The PayPal internal ID. Used for correlation purposes. | getDebugId(): string | setDebugId(string debugId): void |
|
|
| `details` | [`?(ErrorDetails[])`](../../doc/models/error-details.md) | Optional | An array of additional details about the error. | getDetails(): ?array | setDetails(?array details): void |
|
|
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"name": "name4",
|
|
"message": "message4",
|
|
"debug_id": "debug_id0",
|
|
"details": [
|
|
{
|
|
"field": "field4",
|
|
"value": "value2",
|
|
"location": "location4",
|
|
"issue": "issue6",
|
|
"links": [
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
},
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
}
|
|
],
|
|
"description": "description0"
|
|
},
|
|
{
|
|
"field": "field4",
|
|
"value": "value2",
|
|
"location": "location4",
|
|
"issue": "issue6",
|
|
"links": [
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
},
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
}
|
|
],
|
|
"description": "description0"
|
|
}
|
|
],
|
|
"links": [
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
},
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|