Locations - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

Locations - All locations specified in the project are returned

URL Format

https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Locations

Specify values for ProjId, DisciplineCode and NlsDescription parameters in the URL.

Use the following read-only APIs to get the available values for each parameter.

/Projects,

/projects(':project')/Disciplines,

/projects(':project')/Disciplines(':discipline')/Nls

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

Locations is a collection of type WebApi.SPMaterials.Service.Models.EDM.MVW_LOCATIONS.

MVW_LOCATIONS Metadata:

<EntityType Name="Location">

<Key>

<PropertyRef Name="LocId"/>

</Key>

<Property Name="LocId" Type="Edm.Int64" Nullable="false"/>

<Property Name="LocCode" Type="Edm.String"/>

<Property Name="QuarantLocInd" Type="Edm.String"/>

</EntityType>

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https ://{ host} /Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls ('{nls}')/Locations",

"value": [

{

LocId: 5920,

LocCode: "RACK10",

QuarantLocInd: "N"

},

{

LocId: 6201,

LocCode: "UK QUA01",

QuarantLocInd: "Y"

}]

}

Error Response

This API may fail with the following error messages: 
Error Code: 401 Unauthorized 
Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request." }

}

Notes