namerefs

Documentation

Index

• type NameRefs

Types

type NameRefs

type NameRefs struct {
	// Input of a name and/or reference
	Input input.Input `json:"input"`

	// Canonical is a full canonical form of the input name-string.
	Canonical string `json:"canonical,omitempty"`

	// CurrentCanonical is a full canonical form of a currently accepted
	// name for the taxon of the input name-string.
	CurrentCanonical string `json:"currentCanonical,omitempty"`

	// Synonyms is a list of synonyms for the name-string.
	Synonyms []string `json:"synonyms,omitempty"`

	// ImagesURL provides URL that contains images of the taxon.
	ImagesURL string `json:"imagesURL,omitempty"`

	// ReferenceNumber is the number of references found for the name-string.
	ReferenceNumber int `json:"refsNum"`

	// References is a list of all unique BHL references to the name occurence.
	References []*refbhl.ReferenceNameBHL `json:"references,omitempty"`

	// Error in the kk
	Error error

	// WithSynonyms sets an option of returning references for synonyms of a name
	// as well.
	WithSynonyms bool
}

NameRefs provides apparent occurrences of a name-string in BHL.