Edgefinity RFID REST APIs

product : Product Information

get /product/

Find Products

Implementation Notes

Query for Product Information

Response Class

{
  "product": [
    {
      "product_id": "",
      "product_description": "",
      "product_type": "",
      "mProductInfoDto": "product_info",
      "product_descriptor": {
        "pdmsc1": "",
        "pdmsc2": "",
        "pdmsc3": "",
        "pdmsc4": "",
        "pdmsc5": "",
        "pdmsc6": "",
        "pdmsc7": "",
        "pdmsc8": "",
        "pdmsc9": "",
        "pdmsc10": "",
        "pdmsc11": "",
        "pdmsc12": "",
        "pdmsc13": "",
        "pdmsc14": "",
        "pdmsc15": "",
        "pdmsc16": "",
        "pdmsc17": "",
        "pdmsc18": "",
        "pdmsc19": "",
        "pdmsc20": "",
        "pdmsc21": "",
        "pdmsc22": "",
        "pdmsc23": "",
        "pdmsc24": "",
        "pdmsc25": ""
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
product_id	Product Id of the Product to return	query	string
product_type	Product Type for the Products to return	query	string
epc	EPC for the Product to return	query	string
include_product_descriptor	Indicates whether to include the Product Descriptor Information	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining Product Information

get /product/{product_id}/

Find Product

Implementation Notes

Query for a specific Product's Information

Response Class

{
  "product_id": "",
  "product_description": "",
  "product_type": "",
  "mProductInfoDto": "product_info",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
product_id		Product Id of the Product to return	path	string
include_product_descriptor		Boolean indicating whether to return the Product Descriptor information	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining Product Information

asset : Asset Information

get /asset

Find Assets

Implementation Notes

Query for Asset Information

Response Class

{
  "asset": [
    {
      "asset_id": "",
      "asset_description": "",
      "epc": "",
      "product_descriptor": {
        "pdmsc1": "",
        "pdmsc2": "",
        "pdmsc3": "",
        "pdmsc4": "",
        "pdmsc5": "",
        "pdmsc6": "",
        "pdmsc7": "",
        "pdmsc8": "",
        "pdmsc9": "",
        "pdmsc10": "",
        "pdmsc11": "",
        "pdmsc12": "",
        "pdmsc13": "",
        "pdmsc14": "",
        "pdmsc15": "",
        "pdmsc16": "",
        "pdmsc17": "",
        "pdmsc18": "",
        "pdmsc19": "",
        "pdmsc20": "",
        "pdmsc21": "",
        "pdmsc22": "",
        "pdmsc23": "",
        "pdmsc24": "",
        "pdmsc25": ""
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
asset_id	Asset Id of the Asset to return	query	string
asset_description	Description of the Assets to be returned	query	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining Asset Information

post /asset

Create/Add Asset

Implementation Notes

Create/Add Asset via Query Parameters

Response Class

{
  "asset_id": "",
  "asset_description": "",
  "epc": "",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
asset_id	Asset Id for the Asset to create	query	string
asset_description	Description to give the Asset to create	query	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem creating Asset

post /asset

Create/Add Asset

Implementation Notes

Create/Add Asset

Response Class

{
  "asset_id": "",
  "asset_description": "",
  "epc": "",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	Asset to be added/created	body	Model Model Schema asset { asset_id (string, optional), asset_description (string, optional), epc (string, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } `{ "asset_id": "", "asset_description": "", "epc": "", "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } }` Click to set as parameter value
include_epc		Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem creating Asset

get /asset/{asset_id}

Find Asset

Implementation Notes

Query for a specific Asset's Information

Response Class

{
  "asset_id": "",
  "asset_description": "",
  "epc": "",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
asset_id	Asset Id for the Asset to return	path	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem obtaining Asset

put /asset/{asset_id}/

Update Asset

Implementation Notes

Update Asset Information via Query Parameters

Response Class

{
  "asset_id": "",
  "asset_description": "",
  "epc": "",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
asset_id	Asset Id for the Asset to update	path	string
asset_description	Description to update the Asset with	query	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Internal Server Error

put /asset/{asset_id}/

Update Asset

Implementation Notes

Update Asset Information

Response Class

{
  "asset_id": "",
  "asset_description": "",
  "epc": "",
  "product_descriptor": {
    "pdmsc1": "",
    "pdmsc2": "",
    "pdmsc3": "",
    "pdmsc4": "",
    "pdmsc5": "",
    "pdmsc6": "",
    "pdmsc7": "",
    "pdmsc8": "",
    "pdmsc9": "",
    "pdmsc10": "",
    "pdmsc11": "",
    "pdmsc12": "",
    "pdmsc13": "",
    "pdmsc14": "",
    "pdmsc15": "",
    "pdmsc16": "",
    "pdmsc17": "",
    "pdmsc18": "",
    "pdmsc19": "",
    "pdmsc20": "",
    "pdmsc21": "",
    "pdmsc22": "",
    "pdmsc23": "",
    "pdmsc24": "",
    "pdmsc25": ""
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema asset { asset_id (string, optional), asset_description (string, optional), epc (string, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } `{ "asset_id": "", "asset_description": "", "epc": "", "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } }` Click to set as parameter value
asset_id		Asset Id for the Asset to update	path	string
include_epc		Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem obtaining Asset

giai : GIAI Information

Query for GIAI Information. If the Product Id is specified, that is use to determine the GIAI Information to return. If no Product Id is passed, but the Company Prefix and Individual Asset Reference is passed, then those are used to determine the GIAI Information to return. If no Individual Asset Reference is passed, but the Company Prefix is passed, then that is used to determine which GIAIs to return. If none of those are specified, but the Product Descriptor columns are, then those are used. Otherwise, it returns information on all the GIAIs.

Response Class

{
  "giai": [
    {
      "product_id": "",
      "product_description": "",
      "filter": 0,
      "partition": 0,
      "company_prefix": "",
      "individual_asset_reference": "",
      "epc": "",
      "product_descriptor": {
        "pdmsc1": "",
        "pdmsc2": "",
        "pdmsc3": "",
        "pdmsc4": "",
        "pdmsc5": "",
        "pdmsc6": "",
        "pdmsc7": "",
        "pdmsc8": "",
        "pdmsc9": "",
        "pdmsc10": "",
        "pdmsc11": "",
        "pdmsc12": "",
        "pdmsc13": "",
        "pdmsc14": "",
        "pdmsc15": "",
        "pdmsc16": "",
        "pdmsc17": "",
        "pdmsc18": "",
        "pdmsc19": "",
        "pdmsc20": "",
        "pdmsc21": "",
        "pdmsc22": "",
        "pdmsc23": "",
        "pdmsc24": "",
        "pdmsc25": ""
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
product_id	Product Id of the GIAI to return	query	string
company_prefix	Company Prefix for the GIAIs to return	query	string
individual_asset_reference	Individual Asset Reference of the GIAIs to return	query	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean
pdmsc1	Value for Product Descriptor Column 1 for GIAIs to return	query	string
pdmsc2	Value for Product Descriptor Column 2 for GIAIs to return	query	string
pdmsc3	Value for Product Descriptor Column 3 for GIAIs to return	query	string
pdmsc4	Value for Product Descriptor Column 4 for GIAIs to return	query	string
pdmsc5	Value for Product Descriptor Column 5 for GIAIs to return	query	string
pdmsc6	Value for Product Descriptor Column 6 for GIAIs to return	query	string
pdmsc7	Value for Product Descriptor Column 7 for GIAIs to return	query	string
pdmsc8	Value for Product Descriptor Column 8 for GIAIs to return	query	string
pdmsc9	Value for Product Descriptor Column 9 for GIAIs to return	query	string
pdmsc10	Value for Product Descriptor Column 10 for GIAIs to return	query	string
pdmsc11	Value for Product Descriptor Column 11 for GIAIs to return	query	string
pdmsc12	Value for Product Descriptor Column 12 for GIAIs to return	query	string
pdmsc13	Value for Product Descriptor Column 13 for GIAIs to return	query	string
pdmsc14	Value for Product Descriptor Column 14 for GIAIs to return	query	string
pdmsc15	Value for Product Descriptor Column 15 for GIAIs to return	query	string
pdmsc16	Value for Product Descriptor Column 16 for GIAIs to return	query	string
pdmsc17	Value for Product Descriptor Column 17 for GIAIs to return	query	string
pdmsc18	Value for Product Descriptor Column 18 for GIAIs to return	query	string
pdmsc19	Value for Product Descriptor Column 19 for GIAIs to return	query	string
pdmsc20	Value for Product Descriptor Column 20 for GIAIs to return	query	string
pdmsc21	Value for Product Descriptor Column 21 for GIAIs to return	query	string
pdmsc22	Value for Product Descriptor Column 22 for GIAIs to return	query	string
pdmsc23	Value for Product Descriptor Column 23 for GIAIs to return	query	string
pdmsc24	Value for Product Descriptor Column 24 for GIAIs to return	query	string
pdmsc24	Value for Product Descriptor Column 25 for GIAIs to return	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining GIAI Information

post /giai

Create/Add GIAI

Implementation Notes

Create/Add GIAI

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	GIAI Information to be added/created	body	Model Model Schema giai { product_id (string, optional), product_description (string, optional), filter (integer, optional), partition (integer, optional), company_prefix (string, optional), individual_asset_reference (string, optional), epc (string, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } { "product_id": "", "product_description": "", "filter": 0, "partition": 0, "company_prefix": "", "individual_asset_reference": "", "epc": "", "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } } Click to set as parameter value
include_epc		Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor		Indicates whether to include the Product Descriptor with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem creating GIAI

get /giai/{product_id}

Find GIAI

Parameter	Description	Parameter Type	Data Type
product_id	Product Id of the GIAI to return	path	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor with the response	query	boolean

put /giai/{product_id}

Update GIAI

Implementation Notes

Update GIAI

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	Information to update GIAI with	body	Model Model Schema giai { product_id (string, optional), product_description (string, optional), filter (integer, optional), partition (integer, optional), company_prefix (string, optional), individual_asset_reference (string, optional), epc (string, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } { "product_id": "", "product_description": "", "filter": 0, "partition": 0, "company_prefix": "", "individual_asset_reference": "", "epc": "", "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } } Click to set as parameter value
product_id		Product Id of the GIAI to update	path	string
include_epc		Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	GIAI not found/Invalid Parameter
500	Problem updating GIAI

delete /giai/{product_id}

Delete GIAI

Parameter	Value	Description	Parameter Type	Data Type
product_id		Product Id of the GIAI to delete	path	string

post /giai/{product_id}/encode-epc

Encode GIAI

Parameter	Description	Parameter Type	Data Type
product_id	Product Id of the GIAI to encode	path	string
include_epc	Indicates whether to include the EPC with the response	query	boolean
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean
location_id	Id of the Location at which to encode the GIAI	query	integer
location_name	Name of the Location at which to encode the GIAI	query	string
rfid_lock_type	RFID Lock Type to give the EPC Memory Bank during encoding	query	string

grai : GRAI Information

get /grai

Find GRAIs

Implementation Notes

Query for GRAI Information. Logic behind the selection...:
    1) If the GTIN Id is specified, search for an exact match using that.
    2) If the Product Id is specified, search for an exact match using that.
    3) If the Company Prefix and Asset Type are specified, then search for an exact match using those.
    4) If the Company Prefix is specified, search for all GRAIs that match that.
    5) If Product Descriptor value(s) are passed, search for all GRAIs that have matching values for what is specified.
    6) Search/Return all GRAI information.

Response Class

{
  "grai": [
    {
      "product_id": "",
      "product_description": "",
      "filter": 0,
      "partition": 0,
      "company_prefix": "",
      "asset_type": "",
      "last_serial_number_used": 0,
      "product_descriptor": {
        "pdmsc1": "",
        "pdmsc2": "",
        "pdmsc3": "",
        "pdmsc4": "",
        "pdmsc5": "",
        "pdmsc6": "",
        "pdmsc7": "",
        "pdmsc8": "",
        "pdmsc9": "",
        "pdmsc10": "",
        "pdmsc11": "",
        "pdmsc12": "",
        "pdmsc13": "",
        "pdmsc14": "",
        "pdmsc15": "",
        "pdmsc16": "",
        "pdmsc17": "",
        "pdmsc18": "",
        "pdmsc19": "",
        "pdmsc20": "",
        "pdmsc21": "",
        "pdmsc22": "",
        "pdmsc23": "",
        "pdmsc24": "",
        "pdmsc25": ""
      }
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
gtin_id	GTIN Id of the GRAI to return	query	integer
product_id	Product Id of the GRAI to return	query	string
company_prefix	Company Prefix for the GRAIs to return	query	string
asset_type	Asset Type for the GRAIs to return	query	string
include_product_descriptor	Indicates whether to include the Product Descriptor Information with the response	query	boolean
pdmsc1	Value for Product Descriptor Column 1 for GRAIs to return	query	string
pdmsc2	Value for Product Descriptor Column 2 for GRAIs to return	query	string
pdmsc3	Value for Product Descriptor Column 3 for GRAIs to return	query	string
pdmsc4	Value for Product Descriptor Column 4 for GRAIs to return	query	string
pdmsc5	Value for Product Descriptor Column 5 for GRAIs to return	query	string
pdmsc6	Value for Product Descriptor Column 6 for GRAIs to return	query	string
pdmsc7	Value for Product Descriptor Column 7 for GRAIs to return	query	string
pdmsc8	Value for Product Descriptor Column 8 for GRAIs to return	query	string
pdmsc9	Value for Product Descriptor Column 9 for GRAIs to return	query	string
pdmsc10	Value for Product Descriptor Column 10 for GRAIs to return	query	string
pdmsc11	Value for Product Descriptor Column 11 for GRAIs to return	query	string
pdmsc12	Value for Product Descriptor Column 12 for GRAIs to return	query	string
pdmsc13	Value for Product Descriptor Column 13 for GRAIs to return	query	string
pdmsc14	Value for Product Descriptor Column 14 for GRAIs to return	query	string
pdmsc15	Value for Product Descriptor Column 15 for GRAIs to return	query	string
pdmsc16	Value for Product Descriptor Column 16 for GRAIs to return	query	string
pdmsc17	Value for Product Descriptor Column 17 for GRAIs to return	query	string
pdmsc18	Value for Product Descriptor Column 18 for GRAIs to return	query	string
pdmsc19	Value for Product Descriptor Column 19 for GRAIs to return	query	string
pdmsc20	Value for Product Descriptor Column 20 for GRAIs to return	query	string
pdmsc21	Value for Product Descriptor Column 21 for GRAIs to return	query	string
pdmsc22	Value for Product Descriptor Column 22 for GRAIs to return	query	string
pdmsc23	Value for Product Descriptor Column 23 for GRAIs to return	query	string
pdmsc24	Value for Product Descriptor Column 24 for GRAIs to return	query	string
pdmsc24	Value for Product Descriptor Column 25 for GRAIs to return	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining GRAI Information

post /grai

Create/Add GRAI

Implementation Notes

Create/Add GRAI

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	GRAI Information to be added/created	body	Model Model Schema grai { product_id (string, optional), product_description (string, optional), filter (integer, optional), partition (integer, optional), company_prefix (string, optional), asset_type (string, optional), last_serial_number_used (integer, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } { "product_id": "", "product_description": "", "filter": 0, "partition": 0, "company_prefix": "", "asset_type": "", "last_serial_number_used": 0, "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } } Click to set as parameter value
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid Parameter
500	Problem creating GRAI

get /grai/{product_id}

Find GRAI

Parameter	Value	Description	Parameter Type	Data Type
product_id		Product Id of the GRAI to return	path	string
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

put /grai/{product_id}

Update GRAI

Implementation Notes

Update GRAI

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	GRAI Information to update the specified GRAI with	body	Model Model Schema grai { product_id (string, optional), product_description (string, optional), filter (integer, optional), partition (integer, optional), company_prefix (string, optional), asset_type (string, optional), last_serial_number_used (integer, optional), product_descriptor (product_descriptor, optional) } product_descriptor { pdmsc1 (string, optional), pdmsc2 (string, optional), pdmsc3 (string, optional), pdmsc4 (string, optional), pdmsc5 (string, optional), pdmsc6 (string, optional), pdmsc7 (string, optional), pdmsc8 (string, optional), pdmsc9 (string, optional), pdmsc10 (string, optional), pdmsc11 (string, optional), pdmsc12 (string, optional), pdmsc13 (string, optional), pdmsc14 (string, optional), pdmsc15 (string, optional), pdmsc16 (string, optional), pdmsc17 (string, optional), pdmsc18 (string, optional), pdmsc19 (string, optional), pdmsc20 (string, optional), pdmsc21 (string, optional), pdmsc22 (string, optional), pdmsc23 (string, optional), pdmsc24 (string, optional), pdmsc25 (string, optional) } { "product_id": "", "product_description": "", "filter": 0, "partition": 0, "company_prefix": "", "asset_type": "", "last_serial_number_used": 0, "product_descriptor": { "pdmsc1": "", "pdmsc2": "", "pdmsc3": "", "pdmsc4": "", "pdmsc5": "", "pdmsc6": "", "pdmsc7": "", "pdmsc8": "", "pdmsc9": "", "pdmsc10": "", "pdmsc11": "", "pdmsc12": "", "pdmsc13": "", "pdmsc14": "", "pdmsc15": "", "pdmsc16": "", "pdmsc17": "", "pdmsc18": "", "pdmsc19": "", "pdmsc20": "", "pdmsc21": "", "pdmsc22": "", "pdmsc23": "", "pdmsc24": "", "pdmsc25": "" } } Click to set as parameter value
product_id		Product Id of the GRAI to update	path	string
include_product_descriptor		Indicates whether to include the Product Descriptor Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	GRAI not found/Invalid Parameter
500	Problem updating GRAI

delete /grai/{product_id}

Delete GRAI

Parameter	Value	Description	Parameter Type	Data Type
product_id		Product Id of the GRAI to delete	path	string

post /grai/{product_id}/generate-tag

Generate Tag

Parameter	Value	Description	Parameter Type	Data Type
product_id		Product Id of the GRAI to generate the next Tag for.	path	string

pick-list : Pick List Information

get /pick-list

Find Pick Lists

Implementation Notes

Query for Pick List Information

Response Class

{
  "pick_list": [
    {
      "order": "",
      "status": "",
      "date_created": "",
      "date_last_updated": "",
      "last_updated_by": "",
      "pick_list_detail": [
        {
          "product_id": "",
          "quantity": 0
        }
      ]
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
order	Order for the Pick List to return	query	string
status	Status for the Pick Lists to return	query	string
include_detail_info	Indicates whether to include the Pick List Detail Information with the response	query	boolean

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
500	Problem obtaining Pick List Information

post /pick-list

Create/Add Pick List

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	Pick List information to be added to EdgeMagic	body	Model Model Schema pick_list { order (string, optional), status (string, optional), date_created (string, optional), date_last_updated (string, optional), last_updated_by (string, optional), pick_list_detail (array[pick_list_detail], optional) } pick_list_detail { product_id (string, optional), quantity (integer, optional) } `{ "order": "", "status": "", "date_created": "", "date_last_updated": "", "last_updated_by": "", "pick_list_detail": [ { "product_id": "", "quantity": 0 } ] }` Click to set as parameter value

get /pick-list/{order}/

Find Pick List

Parameter	Value	Description	Parameter Type	Data Type
order		Order of the Pick List to return	path	string
include_detail_info		Indicates whether to include the Pick List Detail Information with the response	query	boolean

put /pick-list/{order}/

Update Pick List

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:	Pick List Information to update the Pick List with	body	Model Model Schema pick_list { order (string, optional), status (string, optional), date_created (string, optional), date_last_updated (string, optional), last_updated_by (string, optional), pick_list_detail (array[pick_list_detail], optional) } pick_list_detail { product_id (string, optional), quantity (integer, optional) } `{ "order": "", "status": "", "date_created": "", "date_last_updated": "", "last_updated_by": "", "pick_list_detail": [ { "product_id": "", "quantity": 0 } ] }` Click to set as parameter value
order		Order of the Pick List to update	path	string

delete /pick-list/{order}/

Delete Pick List

Parameter	Value	Description	Parameter Type	Data Type
order		Order for the Pick List to delete	path	string

antenna : Fixed Reader Antennas

get /antenna

Antennas

Response Class

{
  "antenna": [
    {
      "antenna_id": 0,
      "antenna_name": "",
      "antenna_company": "",
      "antenna_device": "",
      "antenna_location": "",
      "antenna_power": 0,
      "antenna_status": ""
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
antenna_id	Antenna Id	query	integer
antenna_name	Antenna Name/Port	query	string
antenna_status	Antenna Status	query	string
antenna_device	Antenna Device	query	string
antenna_location	Antenna Location	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
204	Valid Query Returned No Result
400	Null parameter value
500	Problem obtaining Antenna information

location : Locations

system : System Information

inventory : Inventory Current

get /inventory/{branchId}/{branchLocationId}

Search Inventory at a Branch Location

Implementation Notes

none

Response Class

{
  "inventory": [
    {
      "branch_id": "",
      "branch_location_id": 0,
      "branch_name": "",
      "branch_location_name": "",
      "product_id": "",
      "epc": "",
      "retag": "",
      "sscc": "",
      "inventory_date": ""
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
page	first page	header	integer
page_size	per page	header	integer
branchId	Existing Branch Id	path	string
branchLocationId	Existing Branch Location Id	path	string
product_id	Product Id	query	string
epc	EPC	query	string
from	>= MM-DD-YYYY	query	string
to	<= MM-DD-YYYY	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Problem obtaining Inventory information

get /inventory

Search Inventory

Implementation Notes

none

Response Class

{
  "inventory": [
    {
      "branch_id": "",
      "branch_location_id": 0,
      "branch_name": "",
      "branch_location_name": "",
      "product_id": "",
      "epc": "",
      "retag": "",
      "sscc": "",
      "inventory_date": ""
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
page	first page	header	integer
page_size	per page	header	integer
branch_name	Branch Name	query	string
branch_location_name	Branch Location Name	query	string
product_id	Product Id	query	string
epc	EPC	query	string
from	>= MM-DD-YYYY	query	string
to	<= MM-DD-YYYY	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Problem obtaining Inventory information

inventory-history : Inventory History

get /inventory-history/{branchId}/{branchLocationId}

Search Inventory History

Response Class

{
  "inventory_history": [
    {
      "branch_id": "",
      "branch_location_id": 0,
      "branch_name": "",
      "branch_location_name": "",
      "product_id": "",
      "epc": "",
      "retag": "",
      "sscc": "",
      "inventory_date": ""
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
page	first page	header	integer
page_size	per page	header	integer
branch	Branch	query	string
branchId	Branch Id	path	string
branchLocationId	Branch Location Id	path	string
product_id	Product Id	query	string
epc	EPC	query	string
from	>= MM-DD-YYYY	query	string
to	<= MM-DD-YYYY	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Problem obtaining Inventory History information

get /inventory-history

Search Inventory History

Implementation Notes

none

Response Class

{
  "inventory_history": [
    {
      "branch_id": "",
      "branch_location_id": 0,
      "branch_name": "",
      "branch_location_name": "",
      "product_id": "",
      "epc": "",
      "retag": "",
      "sscc": "",
      "inventory_date": ""
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
page	first page	header	integer
page_size	per page	header	integer
branch	Branch	query	string
branch_location	Branch Location	query	string
product_id	Product Id	query	string
epc	EPC	query	string
from	>= MM-DD-YYYY	query	string
to	<= MM-DD-YYYY	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200	Success
400	Problem obtaining Inventory History information

HTTP Status Code	Reason	Response Model
200	Success
400	GIAI not found/Invalid Parameter
500	Problem deleting GIAI

HTTP Status Code	Reason	Response Model
200	Success
400	Location not found/GIAI not found/Invalid Parameters
500	Problem encoding GIAI

HTTP Status Code	Reason	Response Model
200	Success
400	GRAI not found/Invalid Parameter
500	Problem deleting GRAI

HTTP Status Code	Reason	Response Model
200	Success
400	Unknown GRAI.
500	Problem generating next Tag for GRAI.

HTTP Status Code	Reason	Response Model
200	Success
400	Pick List not found/Invalid Parameter
500	Problem deleting Pick List

Parameter	Value	Description	Parameter Type	Data Type
location_id		location_id	path	integer
operation		operation	query	string

HTTP Status Code	Reason	Response Model
204	Success, no content
400	Invalid Parameters
500	Problem Starting or Stopping the Listener

Parameter	Description	Parameter Type	Data Type
location_id	location id	path	integer
asset_id	asset id	query	string
description	description	query	string

HTTP Status Code	Reason	Response Model
200	Success
400	Invalid/Missing Parameters
500	Problem encoding Asset/Internal Server Error

Parameter	Description	Parameter Type	Data Type
location_id	Location Id	query	integer
location_name	Location Name	query	string
location_type	Location Type	query	integer
location_status	Location Status	query	string

HTTP Status Code	Reason	Response Model
200	Success
204	Success, but no content found
500	Internal Server Error

product : Product Information

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

asset : Asset Information

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

giai : GIAI Information

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Parameters

Response Messages

Request URL

Response Body