InvReceipts - 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

InvReceipts - All inventory receipts of a project are returned

URL Format

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

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:

InvReceipts is a collection of type WebApi.SPMaterials.Service.Models.EDM.MVW_INV_RECEIPTS.

MVW_INV_RECEIPTS Metadata:

<EntityType Name="InvReceipt">

<Key>

<PropertyRef Name="InvReceiptId"/>

</Key>

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

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

<Property Name="MrrId" Type="Edm.Int64"/>

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

<Property Name="WhId" Type="Edm.Int64"/>

<Property Name="SmstId" Type="Edm.Int64"/>

<Property Name="Ident" Type="Edm.Int64"/>

<Property Name="UnitId" Type="Edm.Int64"/>

<Property Name="DpId" Type="Edm.Int64"/>

<Property Name="RecvQty" Type="Edm.Decimal"/>

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

<Property Name="HeatId" Type="Edm.Int64"/>

<Property Name="ItemShipId" Type="Edm.Int64"/>

<Property Name="BnlId" Type="Edm.Int64"/>

</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}')/InvReceipts",

"value": [

{

InvReceiptId: 54048,

ProjId: "CD",

MrrId: 20008,

LocId: 5920,

WhId: 6661,

SmstId: 5581,

Ident: 14640871,

UnitId: 500127,

DpId: 5020,

RecvQty: 50,

TagNumber: "---",

HeatId: null,

ItemShipId: null,

BnlId: null

},

{

InvReceiptId: 54049,

ProjId: "CD",

MrrId: 20008,

LocId: 5920,

WhId: 6661,

SmstId: 5581,

Ident: 14640673,

UnitId: 500127,

DpId: 5020,

RecvQty: 50,

TagNumber: "---",

HeatId: null,

ItemShipId: null,

BnlId: null

} ]

}

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