Options
All
  • Public
  • Public/Protected
  • All
Menu

Response when reading a single character.

Hierarchy

Index

Properties

callerId

callerId: number

Whatever value was included inthe request is parroted back in the response.

Optional error

error: string

If an error occurred, this will be a plain text explanation of what went wrong that will hopefully be helpful incorrecting the problem; Omitted if the request was successful

Optional export

export: null | ExportFormat

Export data for the character(or null/omittedif none is returned).

result

result: number

Result code identifying what happened with the request.

severity

severity: number

Severity level of the result, which will be one of a fewset values.

status

status: number

Indicates the status of the requested character and the nature of the retrieved export data (if any). See CharacterChangeStatus constants.

wait

wait: number

Minimum interval that the caller must wait until making another retrieval request to the API (in milliseconds).

Generated using TypeDoc