Skip to content
English
Log to my account
  • There are no suggestions because the search field is empty.

Get parcel list with filter

This API allows you to find a list of parcels by using search filters. Please refer to the last row of the table for instructions on how to use search filters.

URL /parcel/v2/get_parcel_list
Method POST 
Parameters

dcreatedfrom, date

dcreatedto, date

nlimitfrom, integer

nlimitto, integer

ssort, string

sreference, string

sowneruser, string

ntotalstonesfrom, intege

ntotalstonesto, intege 

rweightfrom: float

rweightto, float

scountry, string

sparcelcountry, string

scity, string

sminefactory, string

nisexported, integer

nislinkedtoparent, integer

sparcelsearch, string

nparceltype, integer

nmetadatadefinitionid, string

smetadatavalue, string
Sample Request JSON

{

"dcreatedfrom":20230405,

"dcreatedto":20230406,

"nlimitfrom":0,

"nlimitto":65,

"ssort":"numberofstones ASC ,datecreated ASC",

"reference":"",

"sowneruser":"",

"ntotalstonesfrom": null,

"ntotalstonesto": null,

"rweightfrom": 45.52,

"rweightto": 45.52,

"country":"",

"sparcelcountry": "",

"scity":"",

"sminefactory":"",

"nisexported":0,

"nislinkedtoparent": 0,

"sparcelsearch": "",

"nparceltype": 0,

"nmetadatadefinitionid": "",

"smetadatavalue": ""

} 
Sample Response JSON

{

   "status": "ok",

   "isvalid": true,

   "domid": "d7e19951-6990-402e-a1f3-357bd375ee61",

   "parcel": [

        {

          "parcelid": "11393241-59ef-4c79-8b44-1d2f38b4a8d3",

          "parcelreference": "",

          "parcelweight": 0,

          "numberofstones": 0,

          "averageweight": 0,

          "parceltype": 2,

          "parcelbatchid": "895b706b-c578-4e61-82eb-a54650b726cb",

          "owneruserid": "ef086e7c-48f4-4116-b12b-84c2cf16a004",

          "owneruser": "Shashika ",

          "datecreated": "2023-04-06T10:10:14.816",

          "datemodified": "2023-04-06T10:10:14.816",

          "parcelcountry": "BELGIUM",

          "domaincountry": "BELGIUM",

          "minefactory": "Alrosa",

          "city": "BRAINE-LE-COMTE",

         "isexported": false,

         "islinkedtoparent": false,

         "metadatavaluememo": "",

         "metadatavaluestring": ""

      }

    ],

"number_parcels_sent": 1,

"number_parcels": 1

}
Response Codes  200: ok
Note
  • dcreatedfrom (format YYYYMMDD). Leave it NULL if you are not going to filter by this parameter.
  • dcreatedto (format YYYYMMDD). Leave it NULL if you are not going to filter by this parameter.
  • to only show for one date, set dcreatedfrom = dcreatedto
  • nlimitfrom -> shows only results from nlimitfrom (default : 0)
  • nlimitto -> shows only results to nlimitto (default : end of records)
  • ssort -> specify the sorting (default : IDParcel desc)
  • Sorting can be a mix of the following, separated by a comma ',' with parameter ASC or DESC (Eg: weight DESC, numberofstones DESC, idparcel  DESC)
    • idparcel,  parcelid, weight, numberofstones, reference, datecreated, datemodified
  • sreference -> force display for a specific reference or part of a reference (it's doing a LIKE %{sreference}%). Leave it empty if you are not going to filter by this parameter.
  • sowneruser -> force display for a user or part of it (do a LIKE%..% into UserLastName UserFirstName and UserEmail). Leave it empty if you are not going to filter by this parameter.
  • scountry -> force display for a country or part of it. Leave it empty if you are not going to filter by this parameter.
  • sparcelcountry -> same for a parcel country or part of it. Leave it empty if you are not going to filter by this parameter.
  • scity -> force display for a city or part of it. Leave it empty if you are not going to filter by this parameter.
  • sminefactory -> force display for a mining factory or part of it. Leave it empty if you are not going to filter by this parameter.
  • nisexported -> is exported or not (0 for all (default), 1 for exported, 2 for non exported)
  • nislinkedtoparent -> has parent or not (0 for all, 1 for has parent, 2 has no parent)
  • sparcelsearch : a text that will look into (OR)
    • Can search by parcelweight OR numberofstones OR reference OR mining company OR parcel_country OR city
  • nparceltype : 0 for all, 2 for parcel, 3 for merged
  • nmetadatadefinitionid : look into the extra field name,  Leave it empty if you are not going to filter by this parameter.
  • smetadatavalue : for this extra field value,  Leave it empty if you are not going to filter by this parameter.

 

  • Response
    • number_parcels_sent → limit your set to nlimitto parameter
    • number_parcels → Total number of parcels