Datafeed legacy API

List all endpoints and response status codes for the datafeed legacy API

input/init

request

curl -X POST 'http://localhost:8081/input/init' \
-H 'Content-Type: application/json' \
-d '{
  "key":"dcad",
  "brand":"Michelin",
  "lang":"fr",
  "country":"fr",
  "productLineActivity":"4W",
  "kind":"tyre",
  "total":20
}'

response

200, success

{
  "data": {
    "init": {
      "feedId": "1578059506631-ce5b8402-a5b1-46bd-b54b-5722f63d886b",
      "brand": "Michelin",
      "lang": "fr",
      "country": "fr",
      "productLineActivity": "4W",
      "kind": "tyre",
      "total": 20
    }
  }
}

200, unauthorized error

{
  "errors": [
    {
      "message": "Unauthorized request",
      "name": "UnauthorizedError",
      "time_thrown": "2020-01-03T13:42:49.172Z",
      "data": {
        "httpCode": 401,
        "reason": null
      }
    }
  ],
  "data": {
    "init": null
  }
}

200, validation error

{
    "success": false,
    "name": "ValidationError",
    "message": "FeedIdRequest validation failed: kind: `aatyre` is not a valid enum value for path `kind`.",
    "errors": [
      "`aatyre` is not a valid enum value for path `kind`."
    ]
}

input/init.feedId

request

curl -X POST 'http://localhost:8081/input/init.feedId' \
-H 'Content-Type: application/json' \
-d '{
  "key":"dcad",
  "brand":"Michelin",
  "lang":"fr",
  "country":"fr",
  "productLineActivity":"4W",
  "kind":"tyre",
  "total":20
}'

response

200, success

1578059966545-07540424-a133-4153-ab4e-1c3a0bba91e1

200, unauthorized error

{
  "success": false,
  "errors": [
    {
      "name": "FeedIdRequestError",
      "message": "Invalid feed id request"
    }
  ]
}

200, validation error

{
  "success": false,
  "name": "ValidationError",
  "message": "FeedIdRequest validation failed: kind: `aatyre` is not a valid enum value for path `kind`.",
  "errors": [
    "`aatyre` is not a valid enum value for path `kind`."
  ]
}

input/validate

request

curl -X POST 'http://localhost:8081/input/validate/{{productLineActivity}}/{{kind}}' \
-H 'Content-Type: application/json' \
-d '{"brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9617009,"createDate":"2019-01-29T15:33:41","updateDate":"2019-06-03T09:52:01","active":true,"globalId":368,"name":"PILOT SPORT CUP 2 R","slug":"pilot-sport-cup-2-r","displayName":null,"season":{"name":"summer","slug":"summer"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"pilot","slug":"pilot"},"families":[{"name":"pilot","slug":"pilot"}],"softLaunchDate":null,"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null}],"usages":[{"name":"track","slug":"track"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"311223","ean":"3528703112235","mspn":null,"stud":null,"tyreDimension":{"displaySize":"325/30 ZR21 (108Y)","geoBox":"325/30 ZR21","dimSpec":"(108Y)","id":12117001,"type":"Emetric","width":{"value":"325","unit":"mm"},"ratio":30,"structure":"ZR","diameter":21,"loadIndex":108,"loadIndexDual":null,"loadIndexDisplay":"108","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"073"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"715536","ean":"3528707155368","mspn":null,"stud":null,"tyreDimension":{"displaySize":"265/35 ZR20 (99Y)","geoBox":"265/35 ZR20","dimSpec":"(99Y)","id":12106001,"type":"Emetric","width":{"value":"265","unit":"mm"},"ratio":35,"structure":"ZR","diameter":20,"loadIndex":99,"loadIndexDual":null,"loadIndexDisplay":"99","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"071"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null}'

response

200, success

{
  "success": true
}

200, validation error

{
  "success": false,
  "error": {
    "name": "ValidationError",
    "message": "4W-tyre validation failed: hasmpluss: Path `hasmpluss` is required., has3pmsf: Path `has3pmsf` is required., name: Path `name` is required., slug: Path `slug` is required., createDate: Path `createDate` is required., lang: Path `lang` is required., country: Path `country` is required., active: Path `active` is required., id: Path `id` is required., articles: Path `articles` is required.",
    "errors": [
      "Path `hasmpluss` is required.",
      "Path `has3pmsf` is required.",
      "Path `name` is required.",
      "Path `slug` is required.",
      "Path `createDate` is required.",
      "Path `lang` is required.",
      "Path `country` is required.",
      "Path `active` is required.",
      "Path `id` is required.",
      "Path `articles` is required."
    ]
  }
}

input/validate-feed

request

curl -X POST 'http://localhost:8081/input/validate-feed/{{productLineActivity}}/{{kind}}' \
-H 'Content-Type: application/octet-stream' \
-d '{"brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9617009,"createDate":"2019-01-29T15:33:41","updateDate":"2019-06-03T09:52:01","active":true,"globalId":368,"name":"PILOT SPORT CUP 2 R","slug":"pilot-sport-cup-2-r","displayName":null,"season":{"name":"summer","slug":"summer"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"pilot","slug":"pilot"},"families":[{"name":"pilot","slug":"pilot"}],"softLaunchDate":null,"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null}],"usages":[{"name":"track","slug":"track"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"311223","ean":"3528703112235","mspn":null,"stud":null,"tyreDimension":{"displaySize":"325/30 ZR21 (108Y)","geoBox":"325/30 ZR21","dimSpec":"(108Y)","id":12117001,"type":"Emetric","width":{"value":"325","unit":"mm"},"ratio":30,"structure":"ZR","diameter":21,"loadIndex":108,"loadIndexDual":null,"loadIndexDisplay":"108","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"073"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"715536","ean":"3528707155368","mspn":null,"stud":null,"tyreDimension":{"displaySize":"265/35 ZR20 (99Y)","geoBox":"265/35 ZR20","dimSpec":"(99Y)","id":12106001,"type":"Emetric","width":{"value":"265","unit":"mm"},"ratio":35,"structure":"ZR","diameter":20,"loadIndex":99,"loadIndexDual":null,"loadIndexDisplay":"99","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"071"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null}
{"brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9137009,"createDate":"2018-12-13T08:25:11","updateDate":"2019-06-03T09:52:01","active":true,"globalId":108,"name":"PRIMACY MXM4","slug":"primacy-mxm4","displayName":null,"season":{"name":"allseason","slug":"allseason"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"primacy","slug":"primacy"},"families":[{"name":"primacy","slug":"primacy"}],"softLaunchDate":null,"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null},{"name":"suv - 4x4","slug":"suv-4x4","sortOrder":null}],"usages":[{"name":"daily","slug":"daily"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"452761","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V ZP","geoBox":"225/40 R18","dimSpec":"92V ZP","id":3027001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"070"},{"key":"wetGrip","value":"E"}],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165515","ean":"3528709196772","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/45 R17 90V ZP","geoBox":"225/45 R17","dimSpec":"90V ZP","id":3699001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":45,"structure":"R","diameter":17,"loadIndex":90,"loadIndexDual":null,"loadIndexDisplay":"90","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2018-10-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165517","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V XL ZP","geoBox":"225/40 R18","dimSpec":"92V XL ZP","id":25218001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null}
'

response

200, success

{"id":9617009,"success":true}
{"id":9137009,"success":true}

200, validation error

{"id":9617009,"success":true}
{"id":9137009,"success":false,"error":{"name":"ValidationError","message":"4W-tyre validation failed: productLineActivity: Path `productLineActivity` (`aa4W`) is longer than the maximum allowed length (2).","errors":["Path `productLineActivity` (`aa4W`) is longer than the maximum allowed length (2)."]}}

input/feed

request

curl -X POST 'http://localhost:8081/input/feed/{{feedId}}' \
-H 'Content-Type: application/octet-stream' \
-d '{"brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9617009,"createDate":"2019-01-29T15:33:41","updateDate":"2019-06-03T09:52:01","active":true,"globalId":368,"name":"PILOT SPORT CUP 2 R","slug":"pilot-sport-cup-2-r","displayName":null,"season":{"name":"summer","slug":"summer"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"pilot","slug":"pilot"},"families":[{"name":"pilot","slug":"pilot"}],"softLaunchDate":null,"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null}],"usages":[{"name":"track","slug":"track"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"311223","ean":"3528703112235","mspn":null,"stud":null,"tyreDimension":{"displaySize":"325/30 ZR21 (108Y)","geoBox":"325/30 ZR21","dimSpec":"(108Y)","id":12117001,"type":"Emetric","width":{"value":"325","unit":"mm"},"ratio":30,"structure":"ZR","diameter":21,"loadIndex":108,"loadIndexDual":null,"loadIndexDisplay":"108","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"073"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"715536","ean":"3528707155368","mspn":null,"stud":null,"tyreDimension":{"displaySize":"265/35 ZR20 (99Y)","geoBox":"265/35 ZR20","dimSpec":"(99Y)","id":12106001,"type":"Emetric","width":{"value":"265","unit":"mm"},"ratio":35,"structure":"ZR","diameter":20,"loadIndex":99,"loadIndexDual":null,"loadIndexDisplay":"99","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"071"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null}
{"brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9137009,"createDate":"2018-12-13T08:25:11","updateDate":"2019-06-03T09:52:01","active":true,"globalId":108,"name":"PRIMACY MXM4","slug":"primacy-mxm4","displayName":null,"season":{"name":"allseason","slug":"allseason"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"primacy","slug":"primacy"},"families":[{"name":"primacy","slug":"primacy"}],"softLaunchDate":null,"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null},{"name":"suv - 4x4","slug":"suv-4x4","sortOrder":null}],"usages":[{"name":"daily","slug":"daily"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"452761","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V ZP","geoBox":"225/40 R18","dimSpec":"92V ZP","id":3027001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"070"},{"key":"wetGrip","value":"E"}],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165515","ean":"3528709196772","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/45 R17 90V ZP","geoBox":"225/45 R17","dimSpec":"90V ZP","id":3699001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":45,"structure":"R","diameter":17,"loadIndex":90,"loadIndexDual":null,"loadIndexDisplay":"90","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2018-10-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165517","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V XL ZP","geoBox":"225/40 R18","dimSpec":"92V XL ZP","id":25218001,"type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null}
'

response

200, success partial-summary

{"id":9617009,"oid":"5e0f6fdee8ff0e0063d6fa91","success":true,"createdAt":"2020-01-03T16:46:22.449Z","updatedAt":"2020-01-03T16:46:22.449Z","type":"insert","kind":"tyre","feedId":"1578069977608-b2f05ddc-9c19-4519-a142-f3bbacf510d9","page":1,"index":0}
{"updatedAt":"2020-01-03T17:47:32.213Z","createdAt":"2020-01-03T17:47:21.339Z","brand":"Michelin","kind":"tyre","productLineActivity":"4W","country":"gb","lang":"en","countSuccess":1,"countErrors":0,"count":1,"page":1,"total":2,"status":"FEEDING","feedId":"1578073641338-e420b5f6-7799-4599-828f-a8998dc5a290","type":"partial-summary"}

200, success overall-summary

{"id":9617009,"oid":"5e0f6fdee8ff0e0063d6fa91","success":true,"createdAt":"2020-01-03T16:46:22.449Z","updatedAt":"2020-01-03T16:46:22.449Z","type":"insert","kind":"tyre","feedId":"1578069977608-b2f05ddc-9c19-4519-a142-f3bbacf510d9","page":1,"index":0}
{"id":9137009,"oid":"5e0f6fdee8ff0e0063d6fa93","success":true,"createdAt":"2020-01-03T16:46:22.513Z","updatedAt":"2020-01-03T16:46:22.513Z","type":"insert","kind":"tyre","feedId":"1578069977608-b2f05ddc-9c19-4519-a142-f3bbacf510d9","page":1,"index":1}
{"updatedAt":"2020-01-03T17:46:07.499Z","createdAt":"2020-01-03T17:45:51.598Z","brand":"Michelin","kind":"tyre","productLineActivity":"4W","country":"gb","lang":"en","countSuccess":2,"countErrors":0,"count":2,"page":1,"total":2,"status":"VALID","feedId":"1578073551597-5a2d0805-298e-498f-b070-6809620162fa","type":"overall-summary","success":true}

200, error

{
  "success": false,
  "errors": [
    {
      "name": "Error",
      "message": "Too many documents: feed has received more than promised"
    }
  ]
}

output/subscribe

request

curl 'http://localhost:8081/output/subscribe' \
-H 'Content-Type: application/json' \
-d '{
  "key":"dcad",
  "name":"test",
  "kind":"tyre",
  "country":"gb",
  "lang":"en",
  "productLineActivity":"4W",
  "brand":"Michelin",
  "url":"http://localhost:3000",
  "email":"[e-mail]",
  "bufferLimit":10000
}'

response

200, success

{
  "success": true,
  "subscribe": {
    "key": "dcad",
    "name": "test",
    "kind": "tyre",
    "country": "gb",
    "lang": "en",
    "productLineActivity": "4W",
    "brand": "Michelin",
    "url": "http://localhost:3000",
    "email": "[e-mail]",
    "_id": "5e0f77abe8ff0e0063d6facf",
    "bufferLimit": 10000
  }
}

400, duplicate

{
  "success": false,
  "errors": [
    {
      "message": "Channel already subscribed by this consumer"
    }
  ]
}

400, unauthorized

{
  "success": false,
  "errors": [
    {
      "message": "Unauthorized request"
    }
  ]
}

output/list

request

curl 'http://localhost:8081/output/list' \
-H 'key: dcad'

response

200, success

{
  "success": true,
  "list": {
    "tyre": [
      {
        "_id": "5e0f75dae8ff0e0063d6facc",
        "key": "dcad",
        "name": "test",
        "kind": "tyre",
        "country": "gb",
        "lang": "en",
        "productLineActivity": "4W",
        "brand": "Michelin",
        "url": "http://localhost:3000",
        "email": "[e-mail]",
        "bufferLimit": 10000
      }
    ]
  }
}

400, unauthorized

{
  "success": false,
  "errors": [
    {
     "message": "Unauthorized request"
    }
  ]
}

output/init

request

curl 'http://localhost:8081/output/init' \
-H 'kind: tyre' \
-H 'country: gb' \
-H 'lang: en' \
-H 'brand: Michelin' \
-H 'productLineActivity: 4W' \
-H 'key: dcad'

additional headers

-H 'limit: 1' \
-H 'skip: 1'

response

200, success

{"updatedAt":"2020-01-03T17:46:01.969Z","createdAt":"2020-01-03T17:46:01.969Z","brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9617009,"createDate":"2019-01-29T15:33:41","updateDate":"2019-06-03T09:52:01","active":true,"globalId":368,"name":"PILOT SPORT CUP 2 R","slug":"pilot-sport-cup-2-r","displayName":null,"season":{"name":"summer","slug":"summer"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"pilot","slug":"pilot"},"families":[{"name":"pilot","slug":"pilot"}],"softLaunchDate":null,"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null}],"usages":[{"name":"track","slug":"track"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"311223","ean":"3528703112235","mspn":null,"stud":null,"tyreDimension":{"displaySize":"325/30 ZR21 (108Y)","geoBox":"325/30 ZR21","dimSpec":"(108Y)","id":"12117001","type":"Emetric","width":{"value":"325","unit":"mm"},"ratio":30,"structure":"ZR","diameter":21,"loadIndex":108,"loadIndexDual":null,"loadIndexDisplay":"108","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"073"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"715536","ean":"3528707155368","mspn":null,"stud":null,"tyreDimension":{"displaySize":"265/35 ZR20 (99Y)","geoBox":"265/35 ZR20","dimSpec":"(99Y)","id":"12106001","type":"Emetric","width":{"value":"265","unit":"mm"},"ratio":35,"structure":"ZR","diameter":20,"loadIndex":99,"loadIndexDual":null,"loadIndexDisplay":"99","speedIndex":"(Y)","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2018-09-01T00:00:00","endDate":"2036-04-30T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":false,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"071"},{"key":"wetGrip","value":"E"}],"oeMarkings":[{"name":"N0","slug":"n0"}],"manufMarkings":[],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null,"hash":"21112ab5275fee3dbb88ff2cf8dfa79b3cb528dae884e7e2e676fbcb16e15e62","feedId":"1578073551597-5a2d0805-298e-498f-b070-6809620162fa","kind":"tyre","__v":0}
{"updatedAt":"2020-01-03T17:46:02.035Z","createdAt":"2020-01-03T17:46:02.035Z","brand":"Michelin","productLineActivity":"4W","country":"gb","lang":"en","id":9137009,"createDate":"2018-12-13T08:25:11","updateDate":"2019-06-03T09:52:01","active":true,"globalId":108,"name":"PRIMACY MXM4","slug":"primacy-mxm4","displayName":null,"season":{"name":"allseason","slug":"allseason"},"has3pmsf":false,"hasmpluss":false,"family":{"name":"primacy","slug":"primacy"},"families":[{"name":"primacy","slug":"primacy"}],"softLaunchDate":null,"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","sortOrder":null,"isLatestGeneration":false,"isLowVisibility":false,"position":null,"identification":null,"categories":[{"name":"Passenger CAR","slug":"passenger-car","sortOrder":null},{"name":"suv - 4x4","slug":"suv-4x4","sortOrder":null}],"usages":[{"name":"daily","slug":"daily"}],"articles":[{"active":true,"updateDate":"2019-06-03T09:52:00","cai":"452761","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V ZP","geoBox":"225/40 R18","dimSpec":"92V ZP","id":"3027001","type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[{"key":"cLevel","value":"C1"},{"key":"echoClass","value":"2"},{"key":"energyEfficiency","value":"E"},{"key":"euDirectiveNumber","value":"1222/2009"},{"key":"externalRollingNoise","value":"070"},{"key":"wetGrip","value":"E"}],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165515","ean":"3528709196772","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/45 R17 90V ZP","geoBox":"225/45 R17","dimSpec":"90V ZP","id":"3699001","type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":45,"structure":"R","diameter":17,"loadIndex":90,"loadIndexDual":null,"loadIndexDisplay":"90","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2018-10-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]},{"active":false,"updateDate":"2019-01-29T15:33:45","cai":"165517","ean":"3528704527618","mspn":null,"stud":null,"tyreDimension":{"displaySize":"225/40 R18 92V XL ZP","geoBox":"225/40 R18","dimSpec":"92V XL ZP","id":"25218001","type":"Emetric","width":{"value":"225","unit":"mm"},"ratio":40,"structure":"R","diameter":18,"loadIndex":92,"loadIndexDual":null,"loadIndexDisplay":"92","speedIndex":"V","loadIndexSinglePoint":null,"loadIndexDualSinglePoint":null,"speedIndexSinglePoint":null,"loadRange":null,"plyRating":null},"startDate":"2017-03-01T00:00:00","endDate":"2020-12-31T00:00:00","typeTube":null,"typeSeat":null,"usage":null,"isRunflat":true,"overallDiameterInch":null,"overallDiameter":null,"roadTypeCircuit":false,"treadPattern":null,"regroovingDepth":null,"treadDepth":null,"weight":null,"categMarketing":null,"segmentMarketing":null,"traction":false,"mesuringRimWidth":null,"sectionWidth":null,"comments":null,"warranties":null,"minRimWidth":null,"maxRimWidth":null,"rimWidthRange":null,"revsMi":null,"maxLoad":null,"singlePsi":null,"cjp":null,"letteringColor":null,"position":"both","isGreen":false,"labelling":[],"oeMarkings":[],"manufMarkings":[{"type":"SM","name":"ZP","slug":"zp"}],"isTrackConnect":false,"msrp":[],"pressure":{"single":null,"twinned":null,"nominal":null},"vocation":[]}],"isStudded":false,"treadPattern":null,"hash":"a07d2bbd848f5df0fcb9a51524d01525dd8cefa69e0ff638d0e6651760943f20","feedId":"1578073551597-5a2d0805-298e-498f-b070-6809620162fa","kind":"tyre","__v":0}

400, no data

{
  "success": false,
  "errors": [
    {
      "message": "No data for this channel in datafeed"
    }
  ]
}

400, unauthorized

{
  "success": false,
  "errors": [
    {
      "message": "Unauthorized request"
    }
  ]
}

400, invalid kind

{
  "success": false,
  "errors": [
    {
      "message": "Configuration property \"input.aatyre\" is not defined"
    }
  ]
}

output/unsubscribe

request

curl -X DELETE 'http://localhost:8081/output/unsubscribe' \
-H 'key: dcad' \
-H '_id: 5e0f77abe8ff0e0063d6facf'

response

200, success

{
  "success": true,
  "unsubscribe": {
    "_id": "5e0f77abe8ff0e0063d6facf",
    "key": "dcad",
    "name": "test",
    "kind": "tyre",
    "country": "gb",
    "lang": "en",
    "productLineActivity": "4W",
    "brand": "Michelin",
    "url": "http://localhost:3000",
    "email": "[e-mail]",
    "bufferLimit": 10000
  }
}

400, not found

{
  "success": false,
  "errors": [
    {
      "message": "Cast to ObjectId failed for value \"1115e0f77abe8ff0e0063d6facf\" at path \"_id\" for model \"Subscribe\""
    }
  ]
}

400, unauthorized

{
  "success": false,
  "errors": [
    {
      "message": "Unauthorized request"
    }
  ]
}

output/trigger-webhook

request

without subscriptionId headers

curl 'http://localhost:8081/output/trigger-webhook' \
-H 'kind: tyre' \
-H 'country: gb' \
-H 'lang: en' \
-H 'brand: Michelin' \
-H 'productLineActivity: 4W' \
-H 'key: dcad' \
-H 'email: [e-mail]' \
-H 'name: test' \
-H 'url: http://localhost:3000'

with subscriptionId header

curl 'http://localhost:8081/output/trigger-webhook' \
-H 'key: dcad' \
-H '_id: 5e0f75dae8ff0e0063d6facc'

response

200, success

{
  "success": true,
  "subscribe": {
    "name": "test",
    "email": "[e-mail]",
    "url": "http://localhost:3000",
    "country": "gb",
    "lang": "en",
    "brand": "Michelin",
    "productLineActivity": "4W",
    "kind": "tyre",
    "bufferLimit": 102400,
    "key": "dcad"
  }
}

200, success with subscriptionId

{
  "success": true,
  "subscribe": {
    "name": "test",
    "email": "[e-mail]",
    "url": "http://localhost:3000",
    "country": "gb",
    "lang": "en",
    "brand": "Michelin",
    "productLineActivity": "4W",
    "kind": "tyre",
    "bufferLimit": 10000,
    "_id": "5e0f75dae8ff0e0063d6facc"
  }
}

400, not found

{
  "success": false,
  "errors": [
    {
      "message": "No data for this channel in datafeed"
    }
  ]
}

400, unauthorized

{
  "success": false,
  "errors": [
    {
      "message": "Unauthorized request"
    }
  ]
}

400, invalid parameter

{
  "success": false,
  "errors": [
    {
      "message": "Invalid trigger-webhook parameter: email"
    }
  ]
}

400, configuration error

{
  "success": false,
  "errors": [
    {
      "message": "Configuration property \"subscription.aatyre\" is not defined"
    }
  ]
}