Represents a unique name with in a namespace for a specific resourceMonikers are typically used by 3rd party apps to embed the 3rd party ID value into the Keep resource. Since one Keep resource may be of interest to many 3rd party apps, each app must use a unique namespace.
A Moniker is a personal name or nickname; an informal label, often drawing attention to a particular attribute. It is used in Keep to be able to identify objects you create quickly.
MonikerItem
Field | Type | Inherited from | Description |
---|---|---|---|
Namespace | String | MonikerItem | Gets or sets the namespace. |
Nickname | String | MonikerItem | Gets or sets the nickname. |
{
"Namespace" : "String",
"Nickname" : "String"
}
Example in C#
// Returns: nothing
await client.DeleteMonikerAsync(BaseInfo baseInfo, String namespace, String nickname);
Example in CURL
curl -X DELETE \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/monikers?namespace=cUrlExmaple&nickname=SetMonikerOnPersonForcUrlExample \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: T
var item = await client.GetByMonikerAsync<T>(String namespace, String nickname);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/monikers?namespace=cUrlExmaple&nickname=SetMonikerOnPersonForcUrlExample \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<T>
var item = await client.GetByMonikersAsync<T>(String namespace, String nicknames);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/baseinfo?namespace=cUrlExmaple \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '["SetMonikerOnPersonForcUrlExample"]'
Example in C#
// Returns: IEnumerable<MonikerItem>
var monikerItem = await client.GetMonikersAsync(BaseInfo baseInfo);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/monikers \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.SetMonikerAsync(BaseInfo baseInfo, MonikerItem monikerItem);
Example in CURL
curl -X POST \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/monikers \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.MonikerItem, Feenics.Keep.WebApi.Model",
"Namespace":"cUrlExmaple",
"Nickname":"SetMonikerOnPersonForcUrlExample"
}'