EPCIS Code Parsing Service

Method Name Description
Parse GS1Code
  • This service allows you to get EPCs included in GS1 Barcode/QR-code ( Refer to GS1 General Specification )
  • Method: get
  • REST URL:
    http://{base-url}:{base-port}/epcis/Service/CodeParser/{code}
    Supported EPC:
    SGTIN, SSCC, SGLN, GRAI, GIAI, GSRN, GSRNP, GDTI, CPI, SGCN, LGTIN, GTIN
    Supported AI:
    (11), (13), (30), (310n), (390n)
    Additional Parameter:
    gcpLength = {integer}
    Result Format:
    application/json

    Example Query:
    http://localhost:8080/epcis/Service/CodeParser/(01)80614141123458(21)6789(10)4222(414)0614141123452(254)333?gcpLength=7
    Result of the example:
    { "sgtin": "urn:epc:id:sgtin:0614141.812345.6789", "gtin": "urn:epc:idpat:sgtin:0614141.812345.*", "sgln": "urn:epc:id:sgln:0614141.12345.333", "lgtin": "urn:epc:class:lgtin:0614141.812345.4222" }

EPCIS Capture Service

Method Name Description
Event Capture
Json Event Capture
Vocabulary Capture
  • This service allows you to store your EPCIS Master Data Document into your backend storage
  • Method: post
  • Contents: raw-xml-text, complying with EPCIS v1.1 XML Schema
  • Example URL:
    Synchronous http://{base-url}:{base-port}/epcis/Service/VocabularyCapture
    Asynchronous http://{base-url}:{base-port}/epcis/VocabularyCapture
  • Example EPCIS Master Data Document:
    gs1example5(Master) NEW
    otherExample4(Master) NEW
JSON Vocabulary Capture
  • This service allows you to store your EPCIS Master Data Document into your backend storage using JSON format
  • Method: post
  • Contents: JSON Object
  • Example URL:
    Synchronous http://{base-url}:{base-port}/epcis/Service/JsonVocabularyCapture
    Asynchronous http://{base-url}:{base-port}/epcis/VocabularyCapture
  • Example EPCIS Master Data Document:
    gs1example5(Master) NEW
    otherExample4(Master) NEW
ALE Event Capture
  • This service allows you to store your ECReport into your backend storage after converting it to EPCIS Document
  • Method: post
  • Contents: raw-xml-text, complying with ALE v1.1 XML Schema
  • Example URL: http://{base-url}:{base-port}/epcis/Service/ALECapture
  • Example ALE ECReport: Example of ALE ECReport

EPCIS Query Service

Method Name Description
GetStandardVersion
  • Return the standard version of EPCIS
  • URL: http://{base-url}:{base-port}/epcis/Service/GetStandardVersion
  • Additional Parameters: Null
GetVendorVersion
  • Return the vendor specific version of EPCIS
  • URL: http://{base-url}:{base-port}/epcis/Service/GetVendorVersion
  • Additional Parameters: Null
GetQueryNames
  • Return a list of all query names available
  • URL: http://{base-url}:{base-port}/epcis/Service/GetQueryNames
  • Additional Parameters: Null
  • Return: [ {queryNames} ]
Poll
  • Return events stored in repository in interest immediately
  • URL: http://{base-url}:{base-port}/epcis/Service/Poll/{queryName}
  • Additional Parameters:
    eventType : Comma separated event type (e.g. ObjectEvent)
    (GE|LT)_eventTime : yyyy-MM-dd'T'HH:mm:ss.SSSXXX
    (GE|LT)_recordTime : yyyy-MM-dd'T'HH:mm:ss.SSSXXX
    EQ_action : Comma separated action (e.g. ADD)
    EQ_bizStep : Comma separated bizStep
    EQ_disposition : Comma separated disposition
    (EQ|WD)_readPoint : Comma separated readPoint
    (EQ|WD)_bizLocation : Comma separated bizLocation
    EQ_transformationID : Comma separated transformationID
    MATCH_(epc|parentID|inputEPC|outputEPC|anyEPC) : Comma separated EPC
    MATCH_(epcClass|inputEPCClass|outputEPCClass|anyEPCClass) : Comma separated EPC Class
    orderBy : Field used by sorting (e.g. eventTime)
    orderDirection : ASC, DESC (default)
    eventCountLimit : return specified number of events
    maxEventCount : yield error if # of events exceeds specified number
    vocabularyName : Comma separated vocabularyName
    includeAttributes : whether including attributes or not
    includeChildren : whether including children or not
    attributeNames : Comma separated attribute names, result only will include specified list of names
    (EQ|WD)_name : Comma separated attribute names
    HASATTR : Comma separated attribute names
    maxElementCount : yield error if # of events exceeds specified number
    format : (XML|JSON) formatted Output NEW
    userID : your Facebook ID NEW
    accessToken : your Facebook AccessToken NEW
  • SimpleEventQuery Example
    SimpleMasterDataQuery Example
GetSubscriptionIDs
  • Returns a list of all subscriptionIDs currently subscribed to the specified named query.
  • URL: http://{base-url}:{base-port}/epcis/Service/GetSubscriptionIDs/{queryName}
  • Return: [ {SubscriptionIDs} ]
Subscribe
  • Registers a subscriber for a previously defined query having the specified name.
  • URL: http://{base-url}:{base-port}/epcis/Service/Subscribe/{queryName}/{subscriptionID}
  • Additional Parameters:
    dest : Callback URL
    cronExpression : Quartz CronTrigger Tutorial NEW
    reportIfEmpty : do not receive events if empty (true|false)
    ignoreReceivedEvent : do not receive received events (true|false) NEW
  • [Example]
    MATCH_epc=urn:epc:id:sgtin:1.1.1
    cronExpression=0/10 * * * * ?
    dest=http://localhost:8080/epcis/SubscriptionTestServlet
    reportIfEmpty=true
    ignoreReceivedEvent=true
Unsubscribe
  • Removes a previously registered subscription having the specified subscriptionID.
  • URL: http://{base-url}:{base-port}/epcis/Service/Unsubscribe/{subscriptionID}
  • Additional Parameters: Null