ExtraValues¶

For the AddExtraValue* functions below, if the ExtraValue already exists on a person’s record, it will update it with this new value, otherwise it will add a new extra value to the person’s record

model.AddExtraValueBool(query, name, truefalse)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• truefalse (bool) – The boolean value (True or False)

model.AddExtraValueCode(query, name, code)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• code (str) – The code value (text)

model.AddExtraValueDate(query, name, date)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• date,str (date) – The date value

model.AddExtraValueInt(query, name, number)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• number (str) – The integer value (not in quotes)

model.AddExtraValueText(query, name, text)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• text (str) – The text value

model.AddExtraValueAttributes(query, name, text)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field

• text (str) – The JSON text value

Extra Value Attributes are intended for json text.

model.ExtraValue(peopleid, name)¶

Returns:

The extra value for the indicated person

Return type:

str

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

This function returns the extra value as a string, without having to specify the type.

model.ExtraValueBit(peopleid, name)¶

Returns:

The bool value for the indicated person

Return type:

bool

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

model.ExtraValueCode(peopleid, name)¶

Returns:

The code extra value for the indicated person

Return type:

str

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

model.ExtraValueDate(peopleid, name)¶

Returns:

The date extra value for the indicated person

Return type:

date

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

model.ExtraValueInt(peopleid, name)¶

Returns:

The int extra value for the indicated person

Return type:

int

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

model.ExtraValueText(peopleid, name)¶

Returns:

The text value for the indicated person

Return type:

str

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

model.ExtraValueAttributes(peopleid, name)¶

Returns:

The text value for the indicated person

Return type:

str

Parameters:

• peopleid (int) –

• name (str) – The name of the Extra Value Field

This will only return a value if the IsAttribute flag is set on the extra value. The only way this value is set is using the AddExtraValueAttributes.

model.DeleteExtraValue(query, name)¶

Parameters:

• query (str) – see The Query Parameter

• name (str) – The name of the Extra Value Field to delete

model.DeleteAllExtraValueLike(search)¶

Parameters:

• query (str) – see The Query Parameter

• search (str) – The text to be searched

This is useful if you have an extra value that has a pattern and it works on the entire database.

For example, if you have a value that begins with something like ‘BP:’, then you would use model.DeleteAllExtraValueLike('BP:%').