getSigCustomInfo

A MoogDb v2 method that returns all custom info related to a Situation.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSigCustomInfo takes the following request arguments:

Name

Type

Required

Description

sigId

Number

Yes

Situation ID.

key

String

Node path for specific value to return.

Response

Method getSigCustomInfo returns the following response:

Type

Description

Number, Object, Array or String

Response depends on the key but can be a number, object, array or string containing a list of maps of custom info.

Examples

The following examples demonstrate typical use of method getSigCustomInfo:

Request example

Example request to get the value of a custom info field called SnowStatus:

moogdb.getSigCustomInfo(SigID,"SnowStatus")