API¶
Accessing the database table Content through an URL¶
ReactClient application allows you to access certain data from the database, through an entered URL.
It has to have the syntax: protocol://server/application/api/content/ApiPath
ApiPath |
Data type |
GUID |
Authorization |
Description |
|---|---|---|---|---|
picture/{GUID} |
AgentPicture |
AgentId |
Yes |
Agent’s profile avatar. If it doens’t exist - |
avatar/{GUID} |
AgentChatAvatar |
AgentId |
Yes |
Agent’s avatar for WebChat. If it doens’t exist - |
image/{GUID} |
LogoPicture |
ContentId |
Yes |
Any picture according to GUID. If it doesn’t exist, 404 error returned. |
sound/{GUID} |
SoundFile |
ContentId |
Yes |
Any sound file according to GUID. If it doesn’t exist, 404 error returned. |
logo/{FileName} |
LogoPicture |
FileName |
No |
Logo pictures. {FileName} can be substituted only for listed values: logo-frontstage.svg, logo-frontstage-2.svg, logo-frontstage-tc.svg, login-logo-frontstage.svg, logo-frontstage-inverse.svg, logo-eight-inverse.svg, frontstage.png, logo-frontstage.png, logo-frontstage-inverse.png, fs-square.png. If the file doesn’t exist and provided name is a valid one, a default file from Images folder will be displayed. Otherwise 404 error will be returned. Max. {FileName} length is 256 characters. |
To access the data, you have to be an authorized user (not applied to LogoPicture). Data are temporarily stored localy for one hour.
