Interface Import

Where can I find the import interface specification?

21. October 2020

Interface Import| XML | Json

The import interface offers you the option of transferring the desired content from your system as data records to guidle:

Format/structure
You provide the data as XML in the guidle standard import interface structure. Under "Download" you will find the interface description, the schema file and an example file

Mode
The import interface works in FULL mode. You always provide us with a complete data set. The guidle import process takes care of the correct creation and updating of advertisements.
In exceptional cases, the import interface supports a DELTA mode. However, this should only be used in consultation with guidle. Please contact guidle support for this.

Field guidle:sourceOfferId
This field is used to uniquely identify an ad during the import process and must be unique across the entire data feed. After the event has been sent to guidle, this ID for an advertisement must not change. Ideally, a database-internal event ID is used for this purpose.

Field guidle:sourceBpId and guidle:bpId
These fields are individual for each import interface. Please ask guidle Support for the ID to be used.

Transmission of advertisements from different institutions
In the event that your import interface transmits advertisements from different institutions to guidle, the container "guidle:customBusinessPartner" must be used. In it, you tell us for each advertisement which institution it belongs to. Ideally, the following four fields should be sent to us:

> guidle:ownerReferenceId
> guidle:ownerReferenceName
> guidle:ownerReferenceZip
> guidle:ownerReferenceCity

However, the field guidle:ownerReferenceId is also sufficient. It should be noted that the combination of fields allows an institution to be uniquely identified.
If the container "guidle:customBusinessPartner" is used, the field "guidle:bpId" (see section above) must be removed from the data feed.

Categorization
Using guidle:customClassification, you can send us the corresponding categorization from your source system for each content. guidle transfers this categorization to the appropriate guidle category during the import process using category mapping.

Data provision
Provide us with the XML via URL. In consultation with you, guidle defines when and how often the data is retrieved from this link.


Downloads

• Interface specification Standard Import Interface
• Schema file
• Example file

Note: This text was translated by machine translation software and not by a human translator. It may contain translation errors.