Person commands
CreateUpdatePersonByID
Creates or updates a person in Microbizz.
If a person with the given person id already exists, then the person will be overwritten.
If the person provided have a person id of 0, a new person will be created and a new person id will be provided.
Input
person | The person to create/update |
Output
person | The person object as it is in Microbizz after the update |
GetPersonByID
Get a person by their Microbizz person id
If no such person exist an empty collection will be returned.
Input
personid | number | The microbizz person id of the person to fetch |
Output
persons | collection[person] | A collection either empty if no person was found, or with exactly one element being the person. |
GetPersonByEmail
Get a person by their email
If no such person exist an empty collection will be returned.
If several persons with the same email exists they will all be returned.
Input
string | The email to search for |
Output
persons | collection[ person ] | A collection either empty if no person was found, or with all persons with the relevant email. |
GetPersonsByField
Get persons where a given field matches a value.
If no matching persons exist an empty collection will be returned.
Input
field | string | The field to match, these are not the field names used in the person object; contact MB if you need a particular field |
value | string | The value to match |
Output
persons | collection[person] | A collection either empty if no person was found, or with the matching persons. |
GetPersonByUsername
Get a person by their xnet user name
If no such person exist an empty collection will be returned.
Input
username | string | The user name to search for |
Output
persons | collection[person] | A collection either empty if no person was found, or with the matching person. |
GetPersonsByLastChange
Get a collection of persons changed since a given date and time.
Input
changedate | date | Return all persons changed on or after the provided date. |
changetime | time | If this is provided only return persons changed after the provided date and time. |
skip_deleted | bool | If 1 then don't send deleted persons |
Output
persons | collection[ person ] | A collection of the relevant persons, or an empty collection if no persons was found. |
GetPersonTypes
Get information about the person types.
Input
None | - | - |
Output
types | collection[ persontype ] | A collection of the person types |