Skip to content

ValidatedComposition_Handle

Request

This API allows to retrieve some information written in the Composition per GTIN when a Recipe section has been validated by retailer.

Security
Bearer
Query
Periodstring(Period)

By default week is selected. Example: if week is selected in period field, it allows to retrieve the info on the previous 7 days ending on EndDate.

Enum:"Day""Week"
EndDatestring, (date-time)

By default EndDate is current date. Format to be used :yyyy-mm-dd.

SpecTypesArray of strings(List`1)

By default all specifications are taken into account.

Items Enum:"Food""NonFood""Cosmetic""GeneralMerchandise"
SpecStatusesArray of strings(List`1)

By default all statuses are taken into account.

Items Enum:"PartiallyValidated""ValidatedByWriter""Validated""SignedByWriter""Signed"
curl -i -X GET \
  'https://apis.traceone.com/spec-bridge/v1.0/specificationmodule/composition/validated?Period=Day&EndDate=2019-08-24T14%3A15%3A22Z&SpecTypes=Food&SpecStatuses=PartiallyValidated' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
collabInfoIdinteger, (int64)
namestring or null
specificationTypestring or null
languagestring or null
retailerstring or null
commonIdinteger, (int64)
lastStatusDatestring or null, (date-time)
specStatusobject(Status)
specVersionstring or null
reasonForRevisionobject(TabReasonForRevision)
recipeSectionsArray of objects or null(ICollection`1)
preparationSectionsArray of objects or null(ICollection`1)
]
Response
[
  {
    "collabInfoId": 0,
    "name": "string",
    "specificationType": "string",
    "language": "string",
    "retailer": "string",
    "commonId": 0,
    "lastStatusDate": "2019-08-24T14:15:22Z",
    "specStatus": { … },
    "specVersion": "string",
    "reasonForRevision": { … },
    "recipeSections": [ … ],
    "preparationSections": [ … ]
  }
]