Class AttendeeItem.
An Attendee is a person who is visiting so AttendeeItem connects VisitInfo to PersonInfo and visa versa.
Item -> AttendeeItem
Field | Type | Inherited from | Description |
---|---|---|---|
Href | String | Item | Gets or sets the href. |
Person | PersonInfo | AttendeeItem | Gets or sets the person. |
Status | AttendeeStatus | AttendeeItem | Gets or sets the status. |
{
"Href" : "String",
"Person" : "[PersonInfo](/object-model/personinfo)",
"Status" : "[AttendeeStatus](/object-model/attendeestatus)"
}
Example in C#
// Returns: AttendeeInfo
var attendeeInfo = await client.AddAttendeeAsync(FolderInfo folder, AttendeeInfo item);
Example in CURL
curl -X POST \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/attendees \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.AttendeeInfo, Feenics.Keep.WebApi.Model",
"PersonKey":null,
"Card":null,
"Status":0,
"Key":null,
"CommonName":null,
"InFolderHref":null,
"InFolderKey":null,
"Links":[],
"ObjectLinks":null,
"Metadata":null,
"Notes":null,
"Tags":null,
"Monikers":null,
"Href":null
}'
Example in C#
// Returns: PersonInfo
var personInfo = await client.AddAttendeeToVisitAsync(VisitInfo visit, PersonInfo person, AttendeeStatus status);
Example in CURL
curl -X POST \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/visits/VISIT.KEY/attendees \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.PersonInfo, Feenics.Keep.WebApi.Model",
"GivenName":"PERSON_FIRST_NAME",
"Surname":"PERSON_LAST_NAME",
"Addresses":
[
{
"$type":"Feenics.Keep.WebApi.Model.EmailAddressInfo, Feenics.Keep.WebApi.Model",
"MailTo":"ATTENDEE_EMAIL",
"Key":"EMAIL.KEY",
"IsPrivate":false,
"Type":"Work",
"Href":"/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses/EMAIL.KEY"
}
],
"CardAssignments":
[
{
"$type":"Feenics.Keep.WebApi.Model.CardAssignmentInfo, Feenics.Keep.WebApi.Model",
"Key":"CARDASSIGNMENT.KEY",
"EncodedCardNumber":1,
"DisplayCardNumber":"1",
"ActiveOn":"0001-01-01T00:00:00Z",
"ExpiresOn":"0001-01-01T00:00:00Z",
"PinCode":null,
"AntiPassbackExempt":false,
"ExtendedAccess":false,
"PinExempt":false,
"IsDisabled":false,
"ManagerLevel":0,
"OriginalUseCount":null,
"CurrentUseCount":0,
"Note":null,
"HexValue":null,
"RecordId":11,
"LastUsed":null,
"Href":"/api/f/INSTANCE.KEY/people/PERSON.KEY/cards/CARDASSIGNMENT.KEY"
}
],
"Key":"PERSON.KEY",
"CommonName":"PERSON_COMMON_NAME",
"InFolderHref":"/api/f/INSTANCE.KEY",
"InFolderKey":"INSTANCE.KEY",
"Links":
[
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Addresses",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"addresses",
"Text":"Addresses"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"User",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"user",
"Text":"User"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"AccessLevels",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"accesslevels",
"Text":"Access Levels"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Cards",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"cards",
"Text":"Card Assignments"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Visiting",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"visiting",
"Text":"Visiting"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Visitors",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"visitors",
"Text":"Visitors"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"CompareImage",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"compareimage",
"Text":"Compare Image"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Meta",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"meta",
"Text":"Metadata"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Monikers",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"monikers",
"Text":"Monikers"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"CommonName",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"commonname",
"Text":"Common Name"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Images",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"images",
"Text":"Images"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"TakeOwnership",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"takeownership",
"Text":"Take Ownership"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Connections",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"connections",
"Text":"Connected Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"References",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"references",
"Text":"Referencing Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Notes",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"notes",
"Text":"Notes"
}
}
],
"ObjectLinks":
[
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"INSTANCE_NAME",
"Relation":"InInstance",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
},
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"INSTANCE_NAME",
"Relation":"InstanceScope",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
},
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"ACCESSLEVEL.KEY",
"CommonName":"ACCESSLEVEL_NAME",
"Relation":"AccessLevel",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
},
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"BADGETYPE.KEY",
"CommonName":"BADGETYPE_NAME",
"Relation":"BadgeType",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
}
],
"Metadata":[],
"Notes":[],
"Tags":[],
"Monikers":[],
"Href":"/api/f/INSTANCE.KEY/people/PERSON.KEY"
}'
Example in C#
// Returns: nothing
await client.DeleteAttendeeAsync(AttendeeInfo item);
Example in CURL
curl -X DELETE \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/attendees/ATTENEDEE.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<AttendeeInfo>
var attendeeInfo = await client.GetAttendeesAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/attendees \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<PersonInfo>
var personInfo = await client.GetAttendeesForVisitAsync(VisitInfo visit);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/visitis/VISIT.KEY/attendees \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.RemoveAttendeeFromVisitAsync(VisitInfo visit, String personKey);
Example in CURL
curl -X DELETE \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/visits/VISIT.KEY/attendees/ATTENDEE.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.SetAttendeeStatusAsync(VisitInfo visit, String personKey, AttendeeStatus status);
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/visits/VISIT.KEY/attendees/ATTENDEE.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '"Unconfirmed"'
Example in C#
// Returns: nothing
await client.UpdateAttendeeAsync(AttendeeInfo item);
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/api/INSTANCE.KEY/attendees \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.AttendeeInfo, Feenics.Keep.WebApi.Model",
"PersonKey":"PERSON.KEY",
"Card":null,
"Status":0,
"Key":"ATTENDEE.KEY",
"CommonName":null,
"InFolderHref":"/api/f/INSTANCE.KEY",
"InFolderKey":"INSTANCE.KEY",
"Links":
[
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Meta",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"meta",
"Text":"Metadata"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Monikers",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"monikers",
"Text":"Monikers"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"CommonName",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"commonname",
"Text":"Common Name"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Images",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"images",
"Text":"Images"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"TakeOwnership",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"takeownership",
"Text":"Take Ownership"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Connections",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"connections",
"Text":"Connected Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"References",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"references",
"Text":"Referencing Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Notes",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"notes",
"Text":"Notes"
}
}
],
"ObjectLinks":
[
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"INSTANCE_NAME",
"Relation":"InInstance",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
},
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"INSTANCE_NAME",
"Relation":"InstanceScope",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
}
],
"Metadata":[],
"Notes":[],
"Tags":[],
"Monikers":[],
"Href":"/api/f/INSTANCE.KEY/attendees/ATTENDEE.KEY"
}'