Location Contents

Attributes

id uuid
ID of this item.
isCounted boolean
Whether all materials in this location breakdown have an accurate count.
quantity float
Amount of items at this location breakdown.
locationId uuid
ID of the location this belongs to.
materialId uuid
ID of the material in this location area.
nextCountDate datetime
When this location area will be counted next.
countDate datetime
When this location area was last counted.
countingCycle integer
Number of days between counting.
creationDate datetime
When this location area was created.
type integer
Type of location.

Possible values:

1 = Permanent
2 = Temporary
warehouseName string
Name of the warehouse of this location.

Endpoints

List Location Contents

get /api/location_contents

Get the location contents from the PPG database and return a JSON response.

Arguments

binId uuid
ID of the bin where the material is stored.
countDate dateTime
Date and time the material was counted.
creationDate dateTime
Date and time the material was created.
currentQuantity decimal
Current quantity of one type of material in the location.
locationId uuid
ID of the location where the material is stored.
materialId uuid
ID of the material stored in this location.
type integer
Type of location.

Possible values:

1 = Permanent
2 = Temporary
warehouseName string
Name of the warehouse of this location.
limit integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000.

Default value: 250
page integer
Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.

Default value: false
orderBy string
Order the response by the selected field. Multiple values can be passed, separated by a comma.
countOnly boolean
When "true", will only return a count of the amount of items in the query.

Default value: false

Request with curl

curl "http://[Your IP] /api/location_contents" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{
    "contents": [
        {
            "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
            "countDate": null,
            "countingCycle": null,
            "creationDate": "2021-11-22T19:22:39.303000",
            "currentQuantity": 1,
            "id": "77EF2454-17C5-4F69-B6C2-00A4FE9F0519",
            "isCounted": 0,
            "locationId": "FD8EEE72-5F90-4B9A-B0F0-C41BCE2F39E1",
            "locationName": "VLM-01-001/01-11/01",
            "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
            "nextCountDate": null,
            "type": 2,
            "typeDescription": "Temporary",
            "warehouseName": "Warehouse"
        },
        {
            "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
            "countDate": "2022-01-24T10:35:28",
            "countingCycle": null,
            "creationDate": "2020-07-04T16:18:49.887000",
            "currentQuantity": 99,
            "id": "6F2ADABF-9EC7-4EA2-8BB3-04308F1C6A90",
            "isCounted": 0,
            "locationId": "5ABE61D6-F0DF-48F6-8CE8-093C726C2404",
            "locationName": "VLM-02-001/01-02/03",
            "materialId": "D7952417-E513-45EB-95F6-D979790E4E5E",
            "nextCountDate": null,
            "type": 2,
            "typeDescription": "Temporary",
            "warehouseName": "Warehouse"
        }
    ]
}

Show Location Content

get /api/location_contents/[id]

Arguments

Request with curl

curl "http://[Your IP] /api/location_contents/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{
    "content": {
        "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
        "countDate": null,
        "countingCycle": null,
        "creationDate": "2022-01-10T19:44:16.800000",
        "currentQuantity": 1,
        "id": "E8C2F396-4C91-4EF3-AE5B-050087E481EA",
        "isCounted": 0,
        "locationId": "ED2AECC5-0EFE-42D7-B838-B1F251A7EC1F",
        "locationName": "VLM-01-002/01-08/04",
        "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
        "nextCountDate": null,
        "type": 2,
        "typeDescription": "Temporary",
        "warehouseName": "Warehouse"
    }
}