Request contact list information using a specific property
You can request the user's contact information for contacts that return specific properties (for example, only the first name of the contacts). In the following sample code,
BEMS
requests the first name of all the contacts in the user's contact folder. The response includes up to 50 contacts. If the client provides a FolderId, BEMS
requests the contacts from the specific folder.
POST https://localhost:8443/api/contact HTTP/1.1 Content-Type: application/json X-Good-GD-AuthToken: <GDAuthToken> { "Account": "jamie01@ex365.example.com", "MaxNumber": 50, "Offset": 0, "UserShape": ["FirstName"], "FolderId": "AQMkADk0YzU4MjdkLWU1YjktNGE0OC1iZDczKI0Kuc7BmRwA..."" (optional) }
If the request is successful,
BEMS
returns the following response, and the third-party BlackBerry
Dynamics
apps display the first name of the contacts.
"LookupInfo": { "MoreAvailable": false, "TotalCount": 3, "NextPageOffset": null, "Size": 3, "Offset": 0 }, "Contacts": [ { "GivenName": "Jane", "UniqueId" : "g2Y2IxMzAwLWJmZmYtNGJjMi1iNAAMkAD..." }, { "GivenName": "Lori", "UniqueId" : "AAMkADMzAwLWJmZmYtNGJjMi1iNg2Y2Ix..." }, { "GivenName": "Tammy", "UniqueId" : "jMi1iNAAMkADg2Y2IxMzAwLWJmZmYtNGJ..." }, ] }