version_1.0_accountlinks
Table of Contents
Account Links (Version 1.0)
Account links are hyperlinks to other election topics of interest specified by the election administrator (account) for a specific subdomain which is specified on the call (ie: nyc for the City of New York for nyc.electionapi.com provides links to other election information provided by the Board of Elections in the City of New York). These links can be integrated into your own site or app for additional resources that are hosted by the election administrator.
| NOTE: Be sure to include the key parameter with your call see api_keys |
|---|
Call:
| accountlinks | GET | Service at https://nyc.electionapi.com/psl/version/1.0/accountlinks?lang={CODE} |
|---|
Where:
{CODE}=3 character abbreviation of a language code returned from: accountlanguages call
Returns:
Return items array as follows:
- accountId is the internal identifier used by ElectionHub that is associated to the subdomain ('nyc' in example above)
- accountLinkId is the internal identifier used to map accounts to links in ElectionHub
- createdById is the internal identifier used to distinguish the user who created the record
- createdDTTM is the create date and time of the record. This is a complex item consisting of the following properties:
|day|isDateOnly|isDirty|isEmpty|localDateTime|month|tzinfo|universalDateTime|year|
- createdDTTMtz is the time zone of the user that created the record
- description is more detailed information about the link if available
- isActive is an indicator specifying whether the link is active
- languageId is the unique ElectionHub for the language in which the link is displayed
- lastUpdatedDTTM is the last date and time the record was updated. This is a complex item consisting of the following properties:
|day|isDateOnly|isDirty|isEmpty|localDateTime|month|tzinfo|universalDateTime|year|
- lastUpdatedDTTMtz is the time zone of the user that created the record
- name is the text value of the link to be displayed in the language specified
- showonNav is an indicator which specifies whether the link should appear on the navigation bar
- sortkey is the relative order in the links menu this link should be displayed
- updateById is the unique ElectionHub identifier for the user that last updated the link.
Example: https://nyc.electionapi.com/psl/version/1.0/accountlinks?lang=spa – Retrieve links for Spanish
Returns: (first link item only shown)
| Name | Value |
|---|---|
| accountId | 1 |
| accountLinkId | 14 |
| createdById | 0 |
| createdDTTM | … |
| createdDTTMtz | null |
| description | null |
| isActive | true |
| languageId | 2 |
| lastUpdatedDTTM | … |
| lastUpdatedDTTMtz | null |
| name | “Página Principal” |
| showOnNav | true |
| sortKey | 1 |
| updatedById | 0 |
| URI | “http://vote.nyc.ny.us/“ |
version_1.0_accountlinks.txt · Last modified: 2019/09/10 10:41 by timsmith
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
