Smartscreen (3.0.3)

Download OpenAPI specification:Download

License: Commercial

Connector

Get all Services

path Parameters

tenantId

required

string

query Parameters

page	integer <int32> [ 1 .. 21474837 ] Default: 1 Number of the requested page, starting at 1
page_size	integer [ 1 .. 100 ] How many items to return at one time (max 100)
hideType	Array of strings Example: hideType=URL&hideType=MiniApp Comma separated list of service types that are NOT included in the response.
onlySearchable	boolean Only list smartscreen services that are marked as searchable. If omitted all services are returned.

header Parameters

MinResourceVersion

string

Example: 12345

Minimal version of resource to wait for

Responses

Response samples

200
400
406
412
500

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": {"default": "Default Localization message",
"locales": [{"language": "en",
"value": "Localized Text"
},
{"language": "de",
"value": "Lokalisierter Text"
}
]
},
"description": {"default": "Default Localization message",
"locales": [{"language": "en",
"value": "Localized Text"
},
{"language": "de",
"value": "Lokalisierter Text"
}
]
},
"launchInstructions": {"chatRecipient": "ecoId/userId"
},
"type": "MiniApp",
"behaviour": "Banner",
"tags": {"categories": ["Deals",
"Hotels",
"Phone",
"Meals"
],
"keywords": ["Pizza",
"Ice Cream",
"Sport Shoes"
]
},
"requirements": {"min-age": "18",
"max-age": "40",
"gender": "male",
"subcriptionType": "payed"
},
"searchable": true,
"callbackUrl": "http://localhost:8090",
"date1": "2021-11-22",
"logo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"banner": {"default": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"locales": [{"language": "string",
"value": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
}
}
]
},
"spotlight": {"default": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"locales": [{"language": "string",
"value": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
}
}
]
},
"status": "Active"
}
]

Get one service

path Parameters

tenantId required	string
serviceId required	string <uuid> Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

header Parameters

MinResourceVersion

string

Example: 12345

Minimal version of resource to wait for

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": {"default": "Default Localization message",
"locales": [{"language": "en",
"value": "Localized Text"
},
{"language": "de",
"value": "Lokalisierter Text"
}
]
},
"description": {"default": "Default Localization message",
"locales": [{"language": "en",
"value": "Localized Text"
},
{"language": "de",
"value": "Lokalisierter Text"
}
]
},
"launchInstructions": {"chatRecipient": "ecoId/userId"
},
"type": "MiniApp",
"behaviour": "Banner",
"tags": {"categories": ["Deals",
"Hotels",
"Phone",
"Meals"
],
"keywords": ["Pizza",
"Ice Cream",
"Sport Shoes"
]
},
"requirements": {"min-age": "18",
"max-age": "40",
"gender": "male",
"subcriptionType": "payed"
},
"searchable": true,
"callbackUrl": "http://localhost:8090",
"date1": "2021-11-22",
"logo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"banner": {"default": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"locales": [{"language": "string",
"value": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
}
}
]
},
"spotlight": {"default": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
},
"locales": [{"language": "string",
"value": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"etag": "etag"
}
}
]
},
"status": "Active"
}