User GuideReference ManualIntegration Scenarios
 

7.5. The Catalogue

Search and list catalogue items

URL Endpoint

http://www.babelway.net/SelfService/rest/v1/catalogue.{format}

where

  • format : either 'json' or 'xml'

HTTP Method

GET

Requires authentification

no but authenticated request can access private catalogues ( About authentication )

Parameters can be added to filter the query

btags

A comma-separated list of tags

q

a query string (not case-sensitive)

p

An integer to set the page number. By default, the value is at 1. To get the second page, the value should be set at 2.

Examples

  • Get catalogue items with the tags 'belgium' and 'as2' in JSON

    https://www.babelway.net/SelfService/rest/v1/catalogue.json?btags=belgium,as2

    [
       {
          "hubElementProxy":{
             "channelNumber":0,
             "createdOn":"2011-02-28T00:00:00+01:00",
             "description":"AS2 parameters to exchange files with Delhaize. Before being able to exchange messages with them, you need to send your AS2 parameters to edisupport@delhaize.be (see file GenericAS2Specifications.doc attached)",
             "duplicationNumber":0,
             "hubId":25775,
             "hubName":"Hub 1",
             "id":58616,
             "name":"to delhaize",
             "subType":"GATEWAY_OUT_AS2_OUT",
             "tags":{
                "tag":[
                   "gateway-out",
                   "delhaize"
                ]
             },
             "template":false,
             "type":"GATEWAY_OUT",
             "useNumber":0,
             "useUrl":"\/u\/ZTU4NjE2\/gateway-out\/as2out\/to-delhaize.html",
             "viewUrl":"\/v\/ZTU4NjE2\/gateway-out\/as2out\/to-delhaize.html"
          }
       },
       {
          "hubElementProxy":{
             "authorFirstName":"Babelway",
             "authorLastName":"Admin",
             "channelNumber":1,
             "createdOn":"2009-01-26T00:00:00+01:00",
             "description":"AS2 parameters to exchange files with Delhaize. Before being able to exchange messages with them, you need to send your AS2 parameters to edisupport@delhaize.be (see file GenericAS2Specifications.doc attached)",
             "duplicationNumber":98,
             "hubId":25037,
             "hubName":"Babelway catalogue",
             "id":28785,
             "name":"AS2 Delhaize",
             "subType":"GATEWAY_OUT_AS2_OUT",
             "tags":{
                "tag":[
                   "gateway-out",
                   "delhaize"
                ]
             },
             "template":false,
             "type":"GATEWAY_OUT",
             "useNumber":99,
             "useUrl":"\/u\/ZTI4Nzg1\/gateway-out\/as2out\/as2-delhaize.html",
             "viewUrl":"\/v\/ZTI4Nzg1\/gateway-out\/as2out\/as2-delhaize.html"
          }
       }
    ]
    			
  • Get catalogue items containing the word 'edifact' in XML

    https://www.babelway.net/SelfService/rest/v1/catalogue.xml?q=edifact

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <collection>
    	<hubElementProxy>
    		<authorFirstName>Babelway</authorFirstName>
    		<authorLastName>Admin</authorLastName>
    		<channelNumber>0</channelNumber>
    		<createdOn>2008-02-02T00:00:00+01:00</createdOn>
    		<description>Wizard to define a new message in EDIFACT format</description>
    		<duplicationNumber>308</duplicationNumber>
    		<hubId>50</hubId>
    		<hubName>Babelway templates</hubName>
    		<id>21157</id>
    		<name>EDIFACT</name>
    		<subType>EDIFACT</subType>
    		<tags>
    			<tag>message-in</tag>
    			<tag>edifact</tag>
    		</tags>
    		<template>true</template>
    		<type>MESSAGE_DEFINITION_IN</type>
    		<useNumber>308</useNumber>
    		<useUrl>/u/ZTIxMTU3/message-in/edifact/edifact.html</useUrl>
    		<viewUrl>/v/ZTIxMTU3/message-in/edifact/edifact.html</viewUrl>
    	</hubElementProxy>
    	(...)
    	<hubElementProxy>
    		<channelNumber>2</channelNumber>
    		<createdOn>2010-06-21T00:00:00+02:00</createdOn>
    		<description>Delhaize Invoice 01B</description>
    		<duplicationNumber>12</duplicationNumber>
    		<hubId>25037</hubId>
    		<hubName>Babelway catalogue</hubName>
    		<id>47921</id>
    		<name>Delhaize Invoice 01B</name>
    		<subType>EDIFACT</subType>
    		<tags>
    			<tag>invoice</tag>
    			<tag>01b</tag>
    			<tag>delhaize</tag>
    			<tag>edifact</tag>
    			<tag>message-out</tag>
    		</tags>
    		<template>false</template>
    		<type>MESSAGE_DEFINITION_OUT</type>
    		<useNumber>14</useNumber>
    		<useUrl>/u/ZTQ3OTIx/message-out/edifact/delhaize-invoice-01b.html</useUrl>
    		<viewUrl>/v/ZTQ3OTIx/message-out/edifact/delhaize-invoice-01b.html</viewUrl>
    	</hubElementProxy>
    </collection>