Fetch the location details by location code
get
/service/v1/locationmaster/{locationCode}
This API fetches the location details by location code.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
locationCode(required): string
location code of the location that needs to be fetched
Header Parameters
-
appId(required): string
App ID
-
branchCode(required): string
branchCode
-
userId(required): string
userId
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the location based on given id.
Root Schema : CmTmLocationMasterCollection
Type:
object
Collection of Location Master.
Show Source
-
data:
array data
-
paging:
object PagingDto
Contains the paging data like Total Results and Next/Prev Links
Nested Schema : PagingDto
Type:
object
Contains the paging data like Total Results and Next/Prev Links
Show Source
Nested Schema : CmTmLocationMasterDTO
Type:
Show Source
object
-
countryCode:
string
Country Code
-
id:
string
ID
-
locationCode:
string
Location Code
-
locationDescription:
string
Location Description
-
locationType:
string
Location Type
-
stateCode:
string
State Code
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error