Circ4Life Traceability Module - Open API Specification

message
optional

Specific error message. Required if the status is not 2xx.
Example : "Write-only-memory subsystem too slow for this machine."

string

path
required

The requested path.
Example : "/"

string

reason
optional

Standard human readable reason for the HTTP status code.
Example : "Ok"

string

status
optional

Same code as returned in the HTTP header. Repeated here for logging/debugging purposes.
Example : 200

integer (int32)

timestamp
optional

Timestamp of response generation.

string (date-time)

applicationIdentifier
optional

string

numeric
optional

boolean

value
optional

string

binBarcode
required

The same number as encoded into the printed bar code label. Contains the RecycleBinUserID as the first 11 digits.
Example : "16004000001181122000011"

string

eventTime
optional

Time when the event happens
Example : "2019-05-16T13:40:00+02:00"

string (date-time)

fillingLevel
optional

Filling level of the bin at the time of disposal in %
Example : 42.23

number (double)

binBarcode
required

Barcode from bag label. Must be at least 22 digits long
Example : "16004000001181122000011"

string

compostable
required

Usable for compost?
Example : true

boolean

weightInKgm
optional

Weight in kg
Example : 5.0

number

bizTransaction
required

Standard BusinessTransactionID
Example : "http://transaction.acme.com/shipment/34ABC8"

string

type
optional

Standard BusinessTransactionTypeID

string

action
required

See EPCIS standard for details.
Example : "ADD"

enum (ADD, OBSERVE, DELETE)

bizLocation
optional

Standard epcis:BusinessLocationType

string

bizStep
optional

Standard epcis:BusinessStepIDType

string

bizTransactionList
optional

Standard epcis:BusinessTransactionListType

< BusinessTransaction > array

destinationList
optional

Standard epcis:DestinationListType

< SourceDestType > array

disposition
optional

Standard epcis:DispositionIDType

string

epcList
optional

Standard epcglobal:EPC list (epcs are to be represented in URI format)
Example : [ "urn:epc:id:sgtin:4047111.012345.012345678901" ]

< string > array

eventTime
required

When the event happened. (Contains offset)

string (date-time)

ilmd
optional

epcis:ILMDType

< object > array

impactData
optional

Data about the ecological or other impacts associated with the event

ImpactData

quantityList
optional

Standard epcis:QuantityListType

< QuantityElement > array

readPoint
optional

Standard epcis:ReadPointType

string

sourceList
optional

Standard epcis:SourceListType

< SourceDestType > array

en
optional

string

es
optional

string

epc
required

EPC URI
Example : "http://scillyorganics.com/epcis/obj/carrots.2019.3"

string

epc
optional

string

impactData
optional

ImpactData

eventType
required

Type of the farming event
Example : "GROWING"

enum (GROWING, HARVESTING, PLANTING, RECYCLING, SOIL_PREPARATION)

impacts
optional

List of impacts
Example : "Fuel, Water"

< FarmingEventUiImpact > array

lgtin
optional

Input LGTIN for transformation events

Lgtin

location
required

location of the farming event
Example : "http://www.scillyorganics.com/epcis/loc/east_field"

string

products
optional

EPC of processed products

< string > array

timestamp
required

Timestamp of the farming
Example : "2019-05-16T13:40:00+02:00"

string (date-time)

amount
optional

number

description
optional

string

type
optional

string

uom
optional

string

impactType
required

This is a URI as specified in <c4l:impactType>.
Example : "http://dbpedia.org/resource/Premises"

string

measure
optional

Quantifying the amount

Measure

epc
optional

string

impactData
optional

ImpactData

locationId
optional

string

impactList
optional

JSON representation of <c4l:impactList>. It can be used to track social or ecological impacts that are not associated with material flows such as e.g. land usage.

< Impact > array

resourceList
optional

This list represents the inflow of material into the process. It is the JSON representation of <c4l:resourceList>.

ResourceOrWasteList

transportationList
optional

This is the JSON representation of <c4l:transportList>.If the environmental impact of transportation can not be broken down into resource consumption (fuel,…) and type (exhaust fumes,…) then a transportList can be used instead.

< Transportation > array

wasteList
optional

This represents the outflow (typically not including the actual products) of a process. JSON representation of <c4l:wasteList>.

ResourceOrWasteList

age
optional

Estimated lifetime in ISO duration format. Need to be set if state is REUSABLE, BROKEN or WORKING
Example : "P10Y"

string

binBarcode
required

Barcode from the bin label. Must be at least 22 digits long
Example : "16004000001181122000011"

string

brand
optional

Brand of the item. Need only to be filled out if GTIN is missing and product is a EEE item
Example : "Apple"

string

gtin
optional

GTIN of the item. Required if product is a EEE item. If GTIN is not available, please provide manufacturer & model
Example : "4047111000006"

string

model
optional

Model of the item. Need only to be filled out if GTIN is missing and product is a EEE item
Example : "iPhone 7"

string

serialNumber
optional

Serialnumber of the item. Required if product is a EEE item
Example : "X01X23Y4XYXY"

string

state
required

Condition of the electronic device
Example : "WORKING"

enum (WORKING, REUSABLE, BROKEN, NO_EEE_ITEM)

timestamp
required

Timestamp of the inspection
Example : "2019-05-16T13:40:00+02:00"

string (date-time)

unuKey
optional

UNUkey of the electronic device. Need to be set if state is REUSABLE, BROKEN or WORKING
Example : "303"

enum (-1, 0, 303, 306, 401, 402, 406, 701, 702, 501, 504, 506)

gtin
optional

string

lot
optional

BatchOrLotNumber

value
optional

string

locations
optional

< NamedId > array

objects
optional

< NamedId > array

ownerId
optional

string

ownerName
optional

string

quantity
required

Amount, measured in UOM.
Example : 1294.5

number

uom
optional

Unit of Measure. JSON representation of <c4l:measure>. May be omitted if there is a natural uom.
Example : "MTK"

string

description
optional

Description

epc
optional

string

epcClass
required

URI of the epc class, see standard.

string

measure
optional

Contains uom and quantity as in the epcis standard, although not named measure there.

Measure

amount
required

c4l:measure amount of waste produced/resource consumed

Measure

sourceOrSink
optional

c4l:sinkType or c4l:sourceType: Semantic web URI for how the waste was deposed/from where the resource is taken.
Example : "http://semanco02.hs-albsig.de/repository/ontology-releases/eu/semanco/ontology/SEMANCO/SEMANCO.owl#Not-Renewable_Energy_Source"

string

type
required

c4l:wasteType or c4l:resourceType: URI for the type of produced waste/consumed resource. Preferably using a semantic web URI.
Example : "http://w3id.org/saref#Electricity"

string

epcList
optional

Standard epcglobal:EPC list (epcs are to be represented in URI format)
Example : [ "urn:epc:id:sgtin:4047111.012345.012345678901" ]

< string > array

quantityList
optional

Standard epcis:QuantityElementType list.

< QuantityElement > array

resourceOrWasteList
optional

CIRC4Life specific type element format

< ResourceOrWaste > array

sourceDest
required

Standard SourceDestID. An identifier that denotes a specific source or destination.

string

type
optional

Standard SourceDestTypeID. An identifier that indicates what kind of source or destination this Source or Destination (respectively) denotes.

string

disposition
required

Last known disposition (status) of the item. The EPCIS standard core business vocabulary (cbv) is used.The meaning of typical values for Circ4Life is: 'urn:epcglobal:cbv:disp:returned': Item is returned into a smart recycling bin and awaiting collection 'urn:epcglobal:cbv:disp:sellable_not_accessible': Item is in working condition and will be reused 'urn:epcglobal:cbv:disp:damaged': Item is damaged and needs to be repaired before it can be reused 'urn:epcglobal:cbv:disp:disposed': Item is broken and will be recycled 'urn:epcglobal:cbv:disp:unknown': An item which was put into a smart bin was found to be not of a recyclable type
Example : "urn:epcglobal:cbv:disp:returned"

string

epc
required

The items identifier in EPC (URN) Format
Example : "http://circ4life.eecc.info/recycling/bin/obj/1600400000118112200001100001"

string

location
required

Last known location of the item
Example : "urn:epc:epc:sgln:4057847.0000018.0"

string

distance
optional

Distance travelled.

Measure

vehicle
required

c4l:vehicleType URI naming the vehicle type used for transportation
Example : "http://purl.org/vso/ns#Truck"

string