Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Jira Legacy
serverSystem JIRA
serverId43fc03b0-b37f-33f0-b945-0936bf447179
keyPMP-79546

...

Background and strategic fit

The purpose of this Integration is to pull the Location information. This data can be further used while hitting other APIs)

(as request parameter). This document provides information on how the the end Users can consume the API


Assumptions

  • ProcessMAP system User permissions would not be considered while exposing the data
  • Data will be shown in Readable JSON format
  • User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
  • The "Level" property in the output JSON will have the levels and sublevels separated by a "/" till the last level where the location belongs to.
  • If the user does not pass any Level Name as the parameter then all locations of the system will be displayed .
  • If the user passes any level name as the parameter, then all locations under that level will be displayed.
  • If any level available in multiple categories and mapped to a single location, display anyone mapping enterprise heiarchy of the location.

...

Location Field List and Mapping


Product Field NameDescriptionField Type and Size
Location Name
Represents location nameNVARCHAR(50)


Location Code
Represents location code
NVARCHAR(50)


LocationId
Represents Database LocationIdCityRepresents Location


Company Code

Address
Represents Location Address


Country

State/Province

City
StateRepresents Location StateCountryRepresents Location CountryZipRepresents Location ZipLevelRepresents the Level Hierarchy in flat format[when rootname is passed in parameter]


County

Postal/Zip Code

Location Status

Business Type

Operation Type

Industry Description

Comments


Errors/Validation Messages

...