Skip to content

Latest commit

 

History

History
341 lines (326 loc) · 35 KB

API.md

File metadata and controls

341 lines (326 loc) · 35 KB
### Table of Contents* [OsmRequest][1] 
*   [Parameters][2]
*   [apiUrl][3]
*   [fetchNotes][4]
    *   [Parameters][5]
*   [fetchNotesSearch][6]
    *   [Parameters][7]
*   [fetchNote][8]
    *   [Parameters][9]
*   [createNote][10]
    *   [Parameters][11]
*   [commentNote][12]
    *   [Parameters][13]
*   [closeNote][14]
    *   [Parameters][15]
*   [reopenNote][16]
    *   [Parameters][17]
*   [createChangeset][18]
    *   [Parameters][19]
*   [isChangesetStillOpen][20]
    *   [Parameters][21]
*   [fetchChangeset][22]
    *   [Parameters][23]
*   [updateChangesetTags][24]
    *   [Parameters][25]
*   [closeChangeset][26]
    *   [Parameters][27]
*   [uploadChangesetOsc][28]
    *   [Parameters][29]
*   [fetchChangesets][30]
    *   [Parameters][31]
*   [createNodeElement][32]
    *   [Parameters][33]
*   [createWayElement][34]
    *   [Parameters][35]
*   [createRelationElement][36]
    *   [Parameters][37]
*   [fetchElement][38]
    *   [Parameters][39]
*   [fetchMultipleElements][40]
    *   [Parameters][41]
*   [fetchRelationsForElement][42]
    *   [Parameters][43]
*   [fetchWaysForNode][44]
    *   [Parameters][45]
*   [findElementWithinOSMCollection][46]
    *   [Parameters][47]
*   [getTags][48]
    *   [Parameters][49]
*   [setProperty][50]
    *   [Parameters][51]
*   [setTag][52]
    *   [Parameters][53]
*   [setProperties][54]
    *   [Parameters][55]
*   [setTags][56]
    *   [Parameters][57]
*   [replaceTags][58]
    *   [Parameters][59]
*   [removeProperty][60]
    *   [Parameters][61]
*   [removeTag][62]
    *   [Parameters][63]
*   [setCoordinates][64]
    *   [Parameters][65]
*   [getNodeIdsForWay][66]
    *   [Parameters][67]
*   [setNodeIdsForWay][68]
    *   [Parameters][69]
*   [getRelationMembers][70]
    *   [Parameters][71]
*   [setRelationMembers][72]
    *   [Parameters][73]
*   [setTimestampToNow][74]
    *   [Parameters][75]
*   [setVersion][76]
    *   [Parameters][77]
*   [sendElement][78]
    *   [Parameters][79]
*   [fetchMapByBbox][80]
    *   [Parameters][81]
*   [deleteElement][82]
    *   [Parameters][83]
*   [fetchUser][84]
    *   [Parameters][85]
*   [getUserPreferences][86]
*   [setUserPreferences][87]
    *   [Parameters][88]
*   [getUserPreferenceByKey][89]
    *   [Parameters][90]
*   [setUserPreferenceByKey][91]
    *   [Parameters][92]
*   [deleteUserPreference][93]
    *   [Parameters][94]

  • [fetchElementRequest][95]

    • [Parameters][96]

  • [fetchElementRequestFull][97]

    • [Parameters][98]

  • [multiFetchElementsByTypeRequest][99]

    • [Parameters][100]

  • [fetchWaysForNodeRequest][101]

    • [Parameters][102]

  • [sendElementRequest][103]

    • [Parameters][104]

  • [fetchNotesRequest][105]

    • [Parameters][106]

  • [fetchNotesSearchRequest][107]

    • [Parameters][108]

  • [fetchNoteByIdRequest][109]

    • [Parameters][110]

  • [genericPostNoteRequest][111]

    • [Parameters][112]

  • [createNoteRequest][113]

    • [Parameters][114]

  • [createChangesetRequest][115]

    • [Parameters][116]

  • [changesetCheckRequest][117]

    • [Parameters][118]

  • [changesetGetRequest][119]

    • [Parameters][120]

  • [updateChangesetTagsRequest][121]

    • [Parameters][122]

  • [closeChangesetRequest][123]

    • [Parameters][124]

  • [uploadChangesetOscRequest][125]

    • [Parameters][126]

  • [fetchChangesetsRequest][127]

    • [Parameters][128]

  • [fetchMapByBboxRequest][129]

    • [Parameters][130]

  • [deleteElementRequest][131]

    • [Parameters][132]

  • [fetchRelationsForElementRequest][133]

    • [Parameters][134]

  • [fetchUserRequest][135]

    • [Parameters][136]

  • [getUserPreferencesRequest][137]

    • [Parameters][138]

  • [setUserPreferencesRequest][139]

    • [Parameters][140]

  • [getUserPreferenceByKeyRequest][141]

    • [Parameters][142]

  • [setUserPreferenceByKeyRequest][143]

    • [Parameters][144]

  • [deleteUserPreferenceRequest][145]

    • [Parameters][146]## OsmRequestOSM API request handlerType: [Object][147]### Parameters* options [Object][147]? Custom options to apply (optional, default {})### apiUrlReturn the API URL to use for the requestsReturns [string][148] URL of the API### fetchNotesRetrieve the OSM notes in given bounding box#### Parameters* left [number][149] The minimal longitude (X)

  • bottom [number][149] The minimal latitude (Y)

  • right [number][149] The maximal longitude (X)

  • top [number][149] The maximal latitude (Y)

  • limit [number][149]? The maximal amount of notes to retrieve (between 1 and 10000, defaults to 100) (optional, default null)

  • closedDays [number][149]? The amount of days a note needs to be closed to no longer be returned (defaults to 7, 0 means only opened notes are returned, and -1 means all notes are returned) (optional, default null)Returns [Promise][150] Resolves on notes list### fetchNotesSearchFetch OSM notes with textual search#### Parameters* q [string][148] Specifies the search query

  • format [string][148]? It can be 'xml' (default) to get OSM and convert to JSON, 'raw' to return raw OSM XML, 'json' to return GeoJSON, 'gpx' to return GPX and 'rss' to return GeoRSS (optional, default 'xml')

  • limit [number][149]? The maximal amount of notes to retrieve (between 1 and 10000, defaults to 100) (optional, default null)

  • closed [number][149]? The amount of days a note needs to be closed to no longer be returned (defaults to 7, 0 means only opened notes are returned, and -1 means all notes are returned) (optional, default null)

  • display_name [string][148]? Specifies the creator of the returned notes by using a valid display name. Does not work together with the user parameter (optional, default null)

  • user [number][149]? Specifies the creator of the returned notes by using a valid id of the user. Does not work together with the display_name parameter (optional, default null)

  • from [number][149]? Specifies the beginning of a date range to search in for a note (optional, default null)

  • to [number][149]? Specifies the end of a date range to search in for a note. Today date is the default (optional, default null)Returns [Promise][150] ### fetchNoteGet OSM note by id param {number} noteId Identifier for the note#### Parameters* noteId

  • format [string][148] It can be 'xml' (default) to get OSM and convert to JSON, 'raw' to return raw OSM XML, 'json' to return GeoJSON, 'gpx' to return GPX and 'rss' to return GeoRSS (optional, default 'xml')Returns [Promise][150] ### createNoteCreate an OSM note#### Parameters* lat [number][149] Specifies the latitude of the note

  • lon [number][149] Specifies the longitude of the note

  • text [string][148] A mandatory text field with arbitrary text containing the noteReturns [Promise][150] ### commentNoteComment an OSM note#### Parameters* noteId

  • text [string][148] A mandatory text field with arbitrary text containing the noteReturns [Promise][150] ### closeNoteClose an OSM note#### Parameters* noteId

  • text [string][148] A mandatory text field with arbitrary text containing the noteReturns [Promise][150] ### reopenNoteReopen an OSM note#### Parameters* noteId

  • text [string][148] A mandatory text field with arbitrary text containing the noteReturns [Promise][150] ### createChangesetSend a request to OSM to create a new changeset#### Parameters* createdBy [string][148]? (optional, default '')

  • comment [string][148]? (optional, default '')

  • tags [string][148]? (optional, default {})Returns [Promise][150] ### isChangesetStillOpenCheck if a changeset is still open#### Parameters* changesetId [number][149] Returns [Promise][150] ### fetchChangesetGet a changeset for a given id#### Parameters* changesetId [number][149] Returns [Promise][150] ### updateChangesetTagsUpdate changeset tags if still open#### Parameters* changesetId [number][149]

  • createdBy [string][148]? (optional, default '')

  • comment [string][148]? (optional, default '')

  • object [Object][147]? use to set multiples tags (optional, default {})* Throws any Will throw an error for any request with http code 40xReturns [Promise][150] ### closeChangesetClose changeset for a given id if still opened#### Parameters* changesetId [number][149] * Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] Empty string if it works### uploadChangesetOscUpload an OSC file content conforming to the OsmChange specification OSM changeset#### Parameters* changesetId [string][148]

  • osmChangeContent [string][148] OSC file content text* Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] ### fetchChangesetsFetch changesets from OSM API#### Parameters* options [Object][147] Optional parameters

    • options.left [number][149]? The minimal longitude (X)
    • options.bottom [number][149]? The minimal latitude (Y)
    • options.right [number][149]? The maximal longitude (X)
    • options.top [number][149]? The maximal latitude (Y)
    • options.display_name [string][148]? Specifies the creator of the returned notes by using a valid display name. Does not work together with the user parameter
    • options.user [number][149]? Specifies the creator of the returned notes by using a valid id of the user. Does not work together with the display_name parameter
    • options.time [string][148]? Can be a unique value T1 or two values T1, T2 comma separated. Find changesets closed after value T1 or find changesets that were closed after T1 and created before T2. In other words, any changesets that were open at some time during the given time range T1 to T2. Time format is anything that [http://ruby-doc.org/stdlib-2.6.3/libdoc/date/rdoc/DateTime.html#method-c-parse][151] can parse.
    • options.open [number][149]? Only finds changesets that are still open but excludes changesets that are closed or have reached the element limit for a changeset (50.000 at the moment). Can be set to true
    • options.closed [number][149]? Only finds changesets that are closed or have reached the element limit. Can be set to true
    • options.changesets [number][149]? Finds changesets with the specified idsReturns [Promise][150] ### createNodeElementCreate a shiny new OSM node element, in a JSON format#### Parameters* lat [number][149]

  • lon [number][149]

  • tags [Object][147]? Optional, initial tags (optional, default {})

  • id [string][148]? Optional, identifier for OSM elementReturns [Object][147] ### createWayElementCreate a shiny new OSM way element, in a JSON format#### Parameters* nodeOsmIds [Array][152]<[string][148]>

  • tags [Object][147]? Optional, initial tags (optional, default {})

  • id [string][148]? Optional, identifier for OSM elementReturns [Object][147] ### createRelationElementCreate a shiny new OSM relation element, in a JSON format#### Parameters* osmElements [Array][152]<[Object][147]> Array of object with keys id and optional role key. Key id contains an osmId value like 'node/1234'

  • tags [Object][147]? Optional, initial tags (optional, default {})

  • id [string][148]? Optional, identifier for OSM elementReturns [Object][147] ### fetchElementFetch an OSM element by its ID and optionnally all other elements referenced by it#### Parameters* osmId [string][148] Eg: node/12345

  • options [Object][147] Optional parameters

    • options.full [boolean][153]? True for getting all elements referenced by this elementReturns [Promise][150] ### fetchMultipleElementsFetch multiple OSM elements by it full OSM IDs. Work only with a type of elements, no mixed elements type are allowed#### Parameters* osmIds [Array][152] Eg: ['node/12345', 'node/6789']. We do not support optional version e.g 'node/12345v2'Returns [Promise][150] ### fetchRelationsForElementFetch relation(s) from an OSM element#### Parameters* osmId [string][148] Eg: node/12345Returns [Promise][150] ### fetchWaysForNodeFetch ways using the given OSM node#### Parameters* osmId [string][148] Eg: node/12345Returns [Promise][150] Resolve on ways array (each one can be used as an Element for all other functions)### findElementWithinOSMCollectionFind an element with it OsmId within an OSM collection#### Parameters* json [Object][147] An object with key that can be 'node', 'way', 'relation'

  • osmId [string][148] Eg: node/12345Returns Obejct OSM element### getTagsGet all tags of this element as an object#### Parameters* element [Object][147] Returns [Object][147] Tags of this element### setPropertyUse setTag instead. Will be removed in the future.#### Parameters* element

  • propertyName

  • propertyValue Meta* deprecated: This is deprecated.### setTagAdd or replace a tag in a given element#### Parameters* element [Object][147]

  • tagName [string][148]

  • tagValue [string][148] Returns [Object][147] A new version of the element### setPropertiesUse setTags instead. Will be removed in the future.#### Parameters* element

  • properties Meta* deprecated: This is deprecated.### setTagsAdd or replace several tags in a given element#### Parameters* element [Object][147]

  • tags [Object][147] Returns [Object][147] A new version of the element### replaceTagsCompletely replace tags of a given element#### Parameters* element [Object][147]

  • tags [Object][147] The tags that will replace completely current element tagsReturns [Object][147] A new version of the element### removePropertyUse removeTag instead. Will be removed in the future.#### Parameters* element

  • propertyName Meta* deprecated: This is deprecated.### removeTagRemove a tag from a given element#### Parameters* element [Object][147]

  • tagName [string][148] Returns [Object][147] A new version of the element### setCoordinatesReplace the coordinates of the OSM node and return a copy of the element#### Parameters* element [Object][147]

  • lat [number][149]

  • lon [number][149] Returns [Object][147] A new version of the element### getNodeIdsForWayGet the nodes ids of the OSM way#### Parameters* way [Object][147] Returns [Array][152]<[string][148]> nodeOsmIds### setNodeIdsForWayReplace the nodes of the OSM way and return a copy of the way#### Parameters* way [Object][147]

  • nodeOsmIds [Array][152]<[string][148]> Returns [Object][147] A new version of the way### getRelationMembersGet the members objects from an OSM relation#### Parameters* relation [Object][147] Returns [Array][152]<[Object][147]> Array of object with keys id with osmId value e.g 'node/1234' and optional role key### setRelationMembersReplace the members objects of the OSM relation and return a copy of the relation#### Parameters* relation [Object][147]

  • osmElements [Array][152]<[Object][147]> Array of object with keys id and optional role key. Key id contains an osmId value like 'node/1234'Returns [Object][147] A new version of the relation### setTimestampToNowSet the current UTC date to a given element#### Parameters* element [Object][147] Returns [Object][147] A new version of the element### setVersionChange the version number (given by API) of an element#### Parameters* element [Object][147]

  • version int Returns [Object][147] A new version of the element### sendElementSend an element to OSM#### Parameters* element [Object][147]

  • changesetId [number][149] Returns [Promise][150] ### fetchMapByBboxRequest to fetch all OSM elements within a bbox extent#### Parameters* left [number][149] The minimal longitude (X)

  • bottom [number][149] The minimal latitude (Y)

  • right [number][149] The maximal longitude (X)

  • top [number][149] The maximal latitude (Y)

  • mode [string][148] The mode is json so output in the promise will be an object, otherwise, it will be an object and a XML string (optional, default 'json')Returns [Promise][150] ### deleteElementDelete an element from OSM#### Parameters* element [Object][147]

  • changesetId [number][149] Returns [Promise][150] Promise with the new version number due to deletion### fetchUserGet an user details#### Parameters* userId [string][148] The user IDReturns [Promise][150] Resolves on user details as JSON### getUserPreferencesGet all preferences from connected userReturns [Promise][150] Promise with Well formatted JSON of user preferences### setUserPreferencesSet all preferences for a connected user#### Parameters* object [Object][147] An object to provide keys values to create XML preferencesReturns [Promise][150] Promise### getUserPreferenceByKeyGet a preference from a key for the connected user#### Parameters* key [string][148] The key to retrieveReturns [Promise][150] Promise with the value for the key### setUserPreferenceByKeySet a preference from a key for the connected user#### Parameters* key [string][148] The key to set.

  • value [string][148] The value to set. Overwrite existing value if key existsReturns [Promise][150] Promise### deleteUserPreferenceDelete a preference from a key for the connected user#### Parameters* key [string][148] The key to use.Returns [Promise][150] Promise## fetchElementRequestRequest to fetch an OSM element### Parameters* apiUrl [string][148] The API URL

  • osmId [string][148]

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Object][147] ## fetchElementRequestFullRequest to fetch way or relation and all other elements referenced by it### Parameters* apiUrl [string][148] The API URL

  • osmId [string][148] Can only contain either a way or a relation

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] Promise with well formatted JSON content## multiFetchElementsByTypeRequestRequest to fetch an OSM element### Parameters* apiUrl [string][148] The API URL

  • osmIds [Array][152] Eg: ['node/12345', 'node/6789']. We do not support optional version e.g 'node/12345v2'

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## fetchWaysForNodeRequestRequest to fetch ways using the given OSM node### Parameters* apiUrl [string][148] The API URL

  • osmId [string][148]

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Object][147] ## sendElementRequestSend an element to OSM### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • element [Object][147]

  • changesetId [number][149] Returns [Promise][150] ## fetchNotesRequestRequest to fetch OSM notes### Parameters* apiUrl [string][148] The API URL

  • left [number][149] The minimal longitude (X)

  • bottom [number][149] The minimal latitude (Y)

  • right [number][149] The maximal longitude (X)

  • top [number][149] The maximal latitude (Y)

  • limit [number][149]? The maximal amount of notes to retrieve (between 1 and 10000, defaults to 100) (optional, default null)

  • closedDays [number][149]? The amount of days a note needs to be closed to no longer be returned (defaults to 7, 0 means only opened notes are returned, and -1 means all notes are returned) (optional, default null)

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Object][147] ## fetchNotesSearchRequestRequest to get OSM notes with textual search### Parameters* apiUrl [string][148] The API URL

  • q [string][148] Specifies the search query

  • format [string][148]? It can be 'xml' (default) to get OSM and convert to JSON, 'raw' to return raw OSM XML, 'json' to return GeoJSON, 'gpx' to return GPX and 'rss' to return GeoRSS (optional, default 'xml')

  • limit [number][149]? The maximal amount of notes to retrieve (between 1 and 10000, defaults to 100) (optional, default null)

  • closed [number][149]? The amount of days a note needs to be closed to no longer be returned (defaults to 7, 0 means only opened notes are returned, and -1 means all notes are returned) (optional, default null)

  • display_name [string][148]? Specifies the creator of the returned notes by using a valid display name. Does not work together with the user parameter (optional, default null)

  • user [number][149]? Specifies the creator of the returned notes by using a valid id of the user. Does not work together with the display_name parameter (optional, default null)

  • from [number][149]? Specifies the beginning of a date range to search in for a note (optional, default null)

  • to [number][149]? Specifies the end of a date range to search in for a note. Today date is the default (optional, default null)

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## fetchNoteByIdRequestRequest to fetch OSM note by id### Parameters* apiUrl [string][148] The API URL param {number} noteId Identifier for the note

  • noteId

  • format [string][148] It can be 'xml' (default) to get OSM and convert to JSON, 'raw' to return raw OSM XML, 'json' to return GeoJSON, 'gpx' to return GPX and 'rss' to return GeoRSS (optional, default 'xml')

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## genericPostNoteRequestRequest generic enough to manage all POST request for a particular note### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL param {number} noteId Identifier for the note

  • noteId

  • text [string][148] A mandatory text field with arbitrary text containing the note

  • type [string][148] Mandatory type. It can be 'comment', 'close' or 'reopen'Returns [Promise][150] ## createNoteRequestRequest to create a note### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • lat [number][149] Specifies the latitude of the note

  • lon [number][149] Specifies the longitude of the note

  • text [string][148] A mandatory text field with arbitrary text containing the noteReturns [Promise][150] ## createChangesetRequestRequest to create OSM changeset### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • createdBy [string][148]? (optional, default '')

  • comment [string][148]? (optional, default '')

  • tags [string][148]? An object with keys values to set to tags (optional, default {})Returns [Promise][150] ## changesetCheckRequestChecks if a given changeset is still opened at OSM.### Parameters* apiUrl [string][148] The API URL

  • changesetId [number][149]

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## changesetGetRequestGet a changeset for a given id at OSM.### Parameters* apiUrl [string][148] The API URL

  • changesetId [number][149]

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## updateChangesetTagsRequestUpdate tags if a given changeset is still opened at OSM.### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • changesetId [number][149]

  • createdBy [string][148]? (optional, default '')

  • comment [string][148]? (optional, default '')

  • tags [Object][147]? Use to set multiples tags (optional, default {})* Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] ## closeChangesetRequestRequest to close changeset for a given id if still opened### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • changesetId [number][149] * Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] Empty string if it works## uploadChangesetOscRequestRequest to upload an OSC file content conforming to the OsmChange specification OSM changeset### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • changesetId [string][148]

  • osmChangeContent [string][148] OSC file content textReturns [Promise][150] ## fetchChangesetsRequestRequest to get changesets from OSM API### Parameters* apiUrl [string][148] The API URL

  • options [Object][147] Optional parameters (optional, default {})

    • options.left [number][149]? The minimal longitude (X)
    • options.bottom [number][149]? The minimal latitude (Y)
    • options.right [number][149]? The maximal longitude (X)
    • options.top [number][149]? The maximal latitude (Y)
    • options.display_name [string][148]? Specifies the creator of the returned notes by using a valid display name. Does not work together with the user parameter
    • options.user [number][149]? Specifies the creator of the returned notes by using a valid id of the user. Does not work together with the display_name parameter
    • options.time [string][148]? Can be a unique value T1 or two values T1, T2 comma separated. Find changesets closed after value T1 or find changesets that were closed after T1 and created before T2. In other words, any changesets that were open at some time during the given time range T1 to T2. Time format is anything that [http://ruby-doc.org/stdlib-2.6.3/libdoc/date/rdoc/DateTime.html#method-c-parse][151] can parse.
    • options.open [number][149]? Only finds changesets that are still open but excludes changesets that are closed or have reached the element limit for a changeset (50.000 at the moment). Can be set to true
    • options.closed [number][149]? Only finds changesets that are closed or have reached the element limit. Can be set to true
    • options.changesets [number][149]? Finds changesets with the specified ids
    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## fetchMapByBboxRequestRequest to fetch all OSM elements within a bbox extent### Parameters* apiUrl [string][148] The API URL

  • left [number][149] The minimal longitude (X)

  • bottom [number][149] The minimal latitude (Y)

  • right [number][149] The maximal longitude (X)

  • top [number][149] The maximal latitude (Y)

  • mode [string][148] The mode is json so output in the promise will be an object, otherwise, it will be an object and a XML string (optional, default 'json')

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## deleteElementRequestDelete an OSM element### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • element [Object][147]

  • changesetId [number][149] Returns [Promise][150] Promise with the new version number due to deletion## fetchRelationsForElementRequestRequest to fetch relation(s) from an OSM element### Parameters* apiUrl [string][148] The API URL

  • osmId [string][148]

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Promise][150] ## fetchUserRequestRequest to fetch an OSM user details### Parameters* apiUrl [string][148] The API URL

  • userId [string][148] The user ID

  • options [Object][147]? Options (optional, default {})

    • options.auth [Object][147]? Auth XHR object to use instead of unauthenticated callReturns [Object][147] ## getUserPreferencesRequestRequest to fetch preferences for the connected user### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL* Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] Promise with the value for the key## setUserPreferencesRequestRequest to set all preferences for a connected user### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • object [Object][147] An object to provide keys values to create XML preferencesReturns [Promise][150] Promise## getUserPreferenceByKeyRequestRequest to fetch a preference from a key for the connected user### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • key [string][148] The key to retrieve* Throws any Will throw an error for any request with http code 40x.Returns [Promise][150] Promise with the value for the key## setUserPreferenceByKeyRequestRequest to set a preference from a key for the connected user### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • key [string][148] The key to set

  • value [string][148] The value to set. Overwrite existing value if key existsReturns [Promise][150] Promise## deleteUserPreferenceRequestRequest to delete a preference from a key for the connected user### Parameters* auth osmAuth An instance of osm-auth

  • apiUrl [string][148] The API URL

  • key [string][148] The key to useReturns [Promise][150] Promise[1]: #osmrequest[2]: #parameters[3]: #apiurl[4]: #fetchnotes[5]: #parameters-1[6]: #fetchnotessearch[7]: #parameters-2[8]: #fetchnote[9]: #parameters-3[10]: #createnote[11]: #parameters-4[12]: #commentnote[13]: #parameters-5[14]: #closenote[15]: #parameters-6[16]: #reopennote[17]: #parameters-7[18]: #createchangeset[19]: #parameters-8[20]: #ischangesetstillopen[21]: #parameters-9[22]: #fetchchangeset[23]: #parameters-10[24]: #updatechangesettags[25]: #parameters-11[26]: #closechangeset[27]: #parameters-12[28]: #uploadchangesetosc[29]: #parameters-13[30]: #fetchchangesets[31]: #parameters-14[32]: #createnodeelement[33]: #parameters-15[34]: #createwayelement[35]: #parameters-16[36]: #createrelationelement[37]: #parameters-17[38]: #fetchelement[39]: #parameters-18[40]: #fetchmultipleelements[41]: #parameters-19[42]: #fetchrelationsforelement[43]: #parameters-20[44]: #fetchwaysfornode[45]: #parameters-21[46]: #findelementwithinosmcollection[47]: #parameters-22[48]: #gettags[49]: #parameters-23[50]: #setproperty[51]: #parameters-24[52]: #settag[53]: #parameters-25[54]: #setproperties[55]: #parameters-26[56]: #settags[57]: #parameters-27[58]: #replacetags[59]: #parameters-28[60]: #removeproperty[61]: #parameters-29[62]: #removetag[63]: #parameters-30[64]: #setcoordinates[65]: #parameters-31[66]: #getnodeidsforway[67]: #parameters-32[68]: #setnodeidsforway[69]: #parameters-33[70]: #getrelationmembers[71]: #parameters-34[72]: #setrelationmembers[73]: #parameters-35[74]: #settimestamptonow[75]: #parameters-36[76]: #setversion[77]: #parameters-37[78]: #sendelement[79]: #parameters-38[80]: #fetchmapbybbox[81]: #parameters-39[82]: #deleteelement[83]: #parameters-40[84]: #fetchuser[85]: #parameters-41[86]: #getuserpreferences[87]: #setuserpreferences[88]: #parameters-42[89]: #getuserpreferencebykey[90]: #parameters-43[91]: #setuserpreferencebykey[92]: #parameters-44[93]: #deleteuserpreference[94]: #parameters-45[95]: #fetchelementrequest[96]: #parameters-46[97]: #fetchelementrequestfull[98]: #parameters-47[99]: #multifetchelementsbytyperequest[100]: #parameters-48[101]: #fetchwaysfornoderequest[102]: #parameters-49[103]: #sendelementrequest[104]: #parameters-50[105]: #fetchnotesrequest[106]: #parameters-51[107]: #fetchnotessearchrequest[108]: #parameters-52[109]: #fetchnotebyidrequest[110]: #parameters-53[111]: #genericpostnoterequest[112]: #parameters-54[113]: #createnoterequest[114]: #parameters-55[115]: #createchangesetrequest[116]: #parameters-56[117]: #changesetcheckrequest[118]: #parameters-57[119]: #changesetgetrequest[120]: #parameters-58[121]: #updatechangesettagsrequest[122]: #parameters-59[123]: #closechangesetrequest[124]: #parameters-60[125]: #uploadchangesetoscrequest[126]: #parameters-61[127]: #fetchchangesetsrequest[128]: #parameters-62[129]: #fetchmapbybboxrequest[130]: #parameters-63[131]: #deleteelementrequest[132]: #parameters-64[133]: #fetchrelationsforelementrequest[134]: #parameters-65[135]: #fetchuserrequest[136]: #parameters-66[137]: #getuserpreferencesrequest[138]: #parameters-67[139]: #setuserpreferencesrequest[140]: #parameters-68[141]: #getuserpreferencebykeyrequest[142]: #parameters-69[143]: #setuserpreferencebykeyrequest[144]: #parameters-70[145]: #deleteuserpreferencerequest[146]: #parameters-71[147]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object[148]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String[149]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number[150]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise[151]: http://ruby-doc.org/stdlib-2.6.3/libdoc/date/rdoc/DateTime.html#method-c-parse[152]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array[153]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean