The base class for all types of addresses for a person
AddressInfo is used to keep track (links to) of many different types of addresses. Mainly used on PersonInfo Objects.
Item -> AddressInfo
AddressInfo -> EmailAddressInfo -> MailingAddressInfo -> PhoneInfo
Field | Type | Inherited from | Description |
---|---|---|---|
Href | String | Item | Gets or sets the href. |
IsPrivate | Boolean | AddressInfo | Gets or sets a value indicating whether this instance is private.Possible Values (true, false) |
Key | String | AddressInfo | Gets or sets the key. |
Type | String | AddressInfo | Gets or sets the type. |
{
"Href" : "String",
"IsPrivate" : "Boolean",
"Key" : "String",
"Type" : "String"
}
Example in C#
// Returns: AddressInfo
var addressInfo = await client.AddAddressAsync(PersonInfo person, AddressInfo address);
Example in CURL
curl -X POST \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.PhoneInfo, Feenics.Keep.WebApi.Model",
"Number":"847-691-0602",
"Key":null,
"IsPrivate":false,
"Type":"Work",
"Href":null
}'
Example in C#
// Returns: nothing
await client.DeleteAddressAsync(AddressInfo address);
Example in CURL
curl -X DELETE \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses/ADDRESS.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: AddressInfo
var addressInfo = await client.GetAddressesForPersonAsync(PersonInfo person);
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateAddressAsync(AddressInfo address);
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses/ADDRESS.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '{
"$type":"Feenics.Keep.WebApi.Model.PhoneInfo, Feenics.Keep.WebApi.Model",
"Number":"847-691-0602",
"Key":"ADDRESS.KEY",
"IsPrivate":false,
"Type":"Work",
"Href":"/api/f/INSTANCE.KEY/people/PERSON.KEY/addresses/ADDRESS.KEY"
}'