observation-js Documentation - v1.16.0
    Preparing search index...

    Type Alias CreateObservationPayload

    Writable fields for creating an observation via the single-observation endpoint (/observations/create-single/).

    type CreateObservationPayload = {
        species: number;
        date: string;
        point: Point | string;
        time?: string;
        number?: number;
        sex?: string;
        notes?: string;
        is_certain?: boolean;
        accuracy?: number;
        external_reference?: string;
        embargo_date?: string;
        uuid?: string;
        obscurity?: number;
        is_escape?: boolean;
        activity?: number | string;
        life_stage?: number | string;
        method?: number;
        substrate?: number;
        related_species?: number;
        counting_method?: number;
        observer_location?: Point | string;
        transect_uuid?: string;
        recognition_probability?: number;
        details?: ObservationDetail[];
        photos?: string[];
        sounds?: string[];
        upload_media?: string[];
    }
    Index

    Properties

    species date point time? number? sex? notes? is_certain? accuracy? external_reference? embargo_date? uuid? obscurity? is_escape? activity? life_stage? method? substrate? related_species? counting_method? observer_location? transect_uuid? recognition_probability? details? photos? sounds? upload_media?

    Properties

    species: number

    Species id. Required.

    date: string

    Date of observing, ISO yyyy-mm-dd. Required.

    point: Point | string

    Coordinates of the observation, as a GeoJSON Point or WKT string. The location is derived server-side from this point.

    time?: string

    Time of observing, hh:mm.

    number?: number

    Number of individuals (defaults to 1).

    sex?: string

    Sex of observed individual(s): M, F or U (defaults to U).

    notes?: string

    Observation notes.

    is_certain?: boolean

    Whether the observer is certain the species is correct (defaults to true).

    accuracy?: number

    Position accuracy in meters.

    external_reference?: string

    External reference string to identify the observation externally.

    embargo_date?: string

    Hide the observation until this date, ISO yyyy-mm-dd.

    uuid?: string

    UUID4 string (defaults to a random uuid4).

    obscurity?: number

    Obscure the exact location: write 0 (public) or 1 (obscured 1km).

    is_escape?: boolean

    Whether the observation concerns an escaped/planted individual.

    activity?: number | string

    Observed activity id, or its english name.

    life_stage?: number | string

    Observed life stage id, or its english name.

    method?: number

    Observation method id.

    substrate?: number

    Substrate id (Mosses, Lichens and Fungi only).

    related_species?: number

    Related species id (host plant, prey, etc.).

    counting_method?: number

    Counting method id.

    observer_location?: Point | string

    Location of the observer, as a GeoJSON Point or WKT string.

    transect_uuid?: string

    Transect UUID to link this observation to.

    recognition_probability?: number

    Certainty of recognition by NIA, float between 0 and 1.

    details?: ObservationDetail[]

    Group composition entries.

    photos?: string[]

    Photo URLs or async-upload names.

    sounds?: string[]

    Sound URLs or async-upload names.

    upload_media?: string[]

    Names of asynchronously uploaded media to attach.

    Settings

    Member Visibility

    On This Page

    Properties