ExperthubRobotics APIs Doc

ExperthubRobotics Software has standard modules such as Demo, Accounts and Menu. Using ExperthubRobotics APIs, you can retrieve the data of available modules through the API.

Software API

Purpose

ExperthubRobotics has standard Software such as Expert Hub Payment, Expert Hub Standard, and so on. Using ExperthubRobotics REST API, you can retrieve the list of available software through the Get List of software API.

Request

GET

api/Application

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type
SoftwareID	Software Unique ID.	integer
SoftwareType	Client Software Type.	string

Response Formats

[
    {
        "SoftwareID": 1,
        "SoftwareType": "String"
    }
]

Example

Request

GET

api/Application

Request Body

[
    {
        "SoftwareID": 1,
        "SoftwareType": "Expert Hub Payment Module"
    },
    {
        "SoftwareID": 2,
        "SoftwareType": "Expert Hub Standard Module"
    }
]

Application API

Purpose

ExperthubRobotics has standard Application such as Expert Restaurant, Expert Health, Expert Education, Expert Retail, Expert Office, Expert Home, Expert Exhibition, and so on. Using ExperthubRobotics REST API, you can retrieve the list of available application through the Get List of application API.

Request

GET

api/Application/{ID}

Additional Header Parameters

None.

URI Parameters

Name	Description	Type
ID	Software Unique ID.	integer

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type
AppSoftwareTypeID	Application Unique ID.	integer
ApplicationName	Application of Software Type.	string
AppMenuTypeID	Application Menu Type ID.	integer

Response Formats

[
    {
        "AppSoftwareTypeID": 1,
        "ApplicationName": "String",
        "AppMenuTypeID": 1
    }
]

Example

Request

GET

api/Application/2

Request Body

[    
    {
        "AppSoftwareTypeID": 5,
        "ApplicationName": "Expert Lounge",
        "AppMenuTypeID": 1
    },
    {
        "AppSoftwareTypeID": 9,
        "ApplicationName": "Expert Exhibition Booth Host",
        "AppMenuTypeID": 1
    }
]

Languages API

Purpose

ExperthubRobotics has standard Languages such as English, Arabic and so on. Using ExperthubRobotics REST API, you can retrieve the list of available application through the Get List of application API.

Request

GET

api/Language

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type
ID	Language Unique ID.	integer
Language	Language Name.	string

Response Formats

[
    {
        "ID": 1,
        "Language": "String"
    }
]

Example

Request

GET

api/Language

Request Body

[    
    {
        "ID": 1,
        "Language": "English"
    },
    {
        "ID": 2,
        "Language": "Arabic"
    }
]

Demo API

Purpose

To create Demo Account at ExperthubRobotics App.

Request

POST

api/Demo/org

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
Robot_ID	Robot ID in which application in install.	string
FullName	Full Name of Client. *Allow a-zA-Z and Space.	string
Email	Client Login Email Address. *Allow valid Email Only.	string
Mobile	Client Mobile Number. *Allow 0-9 only International Number without 00.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	integer
SoftwareVersion	Software Version on which app is running.	decimal(1.XXX)
MenuVersion	Menu Version on which app menu is running.	decimal(1.XXXX)
RobotName	Robot Name in which application in install.	string
ReleaseNotes	Release Notes of application.	string
ReleaseDate	Release Date of application.	date(yyyy-MM-dd)
RobotNickName	(Optional)Robot Nick Name in which application in install.	string

Note:

All Fields are mandatory.

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

{
    "Robot_ID": "sample string 1",
    "FullName": "sample string 2",
    "Email": "sample string 3",
    "Mobile": "sample string 4",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "sample string 5",
    "ReleaseNotes": "sample string 6",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "sample string 7"
}

Response Information

Resource Description

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
Company	Firm/ Organization Name.	string
ClientName	Client Full Name.	string
ClientPhone	Client Number.	string
AuthenticationCode	Authentication Code.	string
DaysRemaining	Authentication days.	integer
AuthenticationDate	Authentication Date.	date
BGHome	Application Home Background Image.	string
BGMain	Application Inner Pages Background Image.	string
HomeFace	Application Home Face Image.	string
AppIcon	Application Icon Image.	string
MenuIcon	Application Checkout Icon Shows.	string
ColorCode	Application Color Code for the Button and Application.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	string
AppMenuTypeID	Application of Menu Type. Menu Type from ExperthubRobotics Applications.	string
PaymentLink	Application Checkout Payment Link	string
Moto	Moto	string
PaymentPayPal	Application Checkout Payment PayPal Link	string
PaymentCash	Application Checkout with Payment Cash	string
MenuVersion	Menu Version on which app menu is running.	decimal(1.XXXX)
TipName	Tip Name to display on app	string
ShareASmileName	ShareASmile Name to display on app	string
TipTAX	TAX Percentage to be count in Tip.	decimal
ShareASmileTax	TAX Percentage to be count in ShareASmile.	decimal
OtherInfo	Other Information like Event Date, schedule or other details to display on app	string
Venue	Venue of Event or Address of Corporate	string
PrintDocSize	Print Document Size on app	string
PrintImgFirst	Print Image First on app	string
PrintImgSecond	Print Image Second on app	string
PrintImgThired	Print Image Thired on app	string
AuthorizedToAssignRoles	Authorized To Assign Roles on app	string
TAXName	Order TAX Name(VAT,GST,etc.)	string
CURRENCY	Item's CURRENCY AED/USD/INR etc.	string
TrumpetTime	Trumpet Time in seconds	int
Announcement	Announcement text speak by robot.	string
RobotNickName	Robot Nick Name.	string
LeastFeedFileName	Least Feed File Uploaded Name.	string
AutoStart	Application auto start when on.	Boolean
AdvancedContact	Application ask for advanced contact details.	Boolean
ActiveDemographic	Application ask for Customer demographics details.	Boolean
AllowName	Application ask for Name.	Boolean
AllowMobile	Application ask for Mobile.	Boolean
AllowEmail	Application ask for Email.	Boolean
AllowOrganization	Application ask for Organization.	Boolean
AllowDesignation	Application ask for Designation.	Boolean
AllowEmiratesID	Application ask for EmiratesID.	Boolean
AllowCustomRegisterField	Application ask for custom register details.	Boolean
CustomRegisterField	Application ask for advanced contact details.	string
AllowCustomRegisterSecondField	Application ask for custom register second details.	Boolean
CustomRegisterSecondField	Application ask for custom register second details.	string

Child : apimap

Name	Description	Type
ClientID	Registered Corporate ID	integer
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	string
APIUrl	API URL(End Point)	string
APIFeedbackUrl	Order API Feedback URL(End Point)	string
OAuth	API Authentication Code(End Authentication Point) end to end encrypted.	string
Customer_IDMap	Customer ID Field Mapping.	string
OrderRobotNickName	Robot Name Type Field Mapping.	string
AppSoftwareTypeIDMap	Application of Software Type Field Mapping.	string
Full_NameMap	Customer Full Name Field Mapping	string
MobileMap	Customer Mobile Field Mapping	string
TableCodeMap	Customer Table Number Field Mapping	string
Order_IDMap	Order ID Field Mapping	string
Order_DateMap	Order Date Field Mapping	string
CurrencyMap	Order Currency API Field Mapping.	string
SubTotalMap	Order Sub Total Field Mapping	string
VATMap	Order TAX Amount Field Mapping	string
DiscountMap	Order Discount Field Mapping	string
TotalMap	Order Total Amount Field Mapping	string
TIPTaxPercentageMap	Optional Order TIP Tax Percentage Field Mapping.	string
TIPNameMap	Optional Order TIP Name Field Mapping.	string
TIPMap	Order TIP Field Mapping	string
ShareASmileTaxPercentageMap	Optional Order Share A Smile Tax Percentage Field Mapping.	string
ShareASmileNameMap	Optional Order Share A Smile Name Field Mapping.	string
ShareASmileMap	Order Share My Meal Field Mapping	string
PaymentModeMap	Order Payment Mode Field Mapping	string
PaymentLinkMap	Order Payment Link selected by Customer Field Mapping.	string
CelebrationIDMap	Order Celebration ID Field Mapping	string
isActiveMap	Order Status Field Mapping	string
ItemCollectionMap	Order Items Collection Field Mapping	string
Item_IDMap	Order Item ID Field Mapping	string
Item_NameMap	Order Item Name Mapping	string
QuantityMap	Order Quantity Field Mapping	string
ItemDiscountMap	Order Item Discount Field Mapping	string
ItemTAXMap	Order Item TAX Field Mapping	string
TaxPercentageMap	Optional Order Tax Percentage Field Mapping.	string
DiscountPercentageMap	Optional Order Item Discount Percentage Field Mapping.	string
ItemCostMap	Optional Order Item Cost Field Mapping.	string
priceMap	Order Price Field Mapping	string
isActive_ItemMap	Order Item Status Field Mapping	string
OrderItemLanguage	Order Item Language ID Field Mapping	string
OrderItemEItemID	Order Item English Item ID Field Mapping	string
SurveyClientMap	Order Client Survey Field Mapping.	string
SurveyAppMap	Order Survey App Field Mapping.	string
DOBMap	Order Item AGE Field Mapping.	string
AGEMap	Order Item AGE Field Mapping.	string
GenderMap	Order Item Gender Field Mapping.	string
ReligionMap	Order Item Religion Field Mapping.	string
LoyatyCardMap	Order Item LoyatyCard Field Mapping.	string
OrderTypeMap	Order Item OrderType Field Mapping.	string
CustomerDemographicMap	Order Item CustomerDemographic Field Mapping.	string
MeetingLinkMap	Order Item MeetingLink Field Mapping.	string
SMSAPIUrlMap	SMS Provider API URL/End Point Field Mapping	string
SMSAPIUserNameMap	SMS Provider Username, Will be End to End Encrypted Field Mapping	string
SMSAPIPasswordMap	SMS Provider Password, Will be End to End Encrypted Field Mapping	string
SMSAPICallbackQueryStringMap	Optional SMS Provider CallbackQueryString if any Field Mapping.	string
SMSAPIPriorityMap	Optional SMS Sending Priority Field Mapping.	string
SMSAPIJsonBodyMap	Optional SMS Json if sms api support json format Field Mapping.	string
SMSAPICopyToMap	Optional SMS Mobile number for sanding copy Field Mapping.	string
SMSAPIUrl	SMS Provider API URL/End Point	string
SMSAPIUserName	SMS Provider Username, Will be End to End Encrypted	string
SMSAPIPassword	SMS Provider Password, Will be End to End Encrypted	string
SMSAPICallbackQueryString	Optional SMS Provider CallbackQueryString if any.	string
SMSAPIPriority	Optional SMS Sending Priority.	string
SMSAPIJsonBody	Optional SMS Json if sms api support json format.	string
SMSAPICopyTo	Optional SMS Mobile number for sanding copy.	string
EmailFrom	Email from Address	string
EmailCC	Email CC Address if any.	string
EmailBCC	Email BCC Address if any.	string
EmailSMTP	Email sending smtp for sending email.	string
EmailPORT	Email Port for sending email.	string
EmailUser	Email Address for sending email Network Credentials. End to End Encrypted.	string
EmailPassword	Email Password for sending email Network Credentials. End to End Encrypted.	string
OrderCustomerEMAIL	Optional Order Customer EMAIL Field Mapping	string
OrderCorporateName	Optional Order Corporate Name Field Mapping	string
OrderEmailFrom	Optional Order Email from Address Field Mapping	string
OrderEmailCC	Optional Order Email CC Address if any Field Mapping.	string
OrderEmailBCC	Optional Order Email BCC Address if any Field Mapping.	string
OrderEmailSMTP	Optional Order Email sending smtp for sending email Field Mapping.	string
OrderEmailPORT	Optional Order Email Port for sending email Field Mapping.	string
OrderEmailUser	Optional Order Email Address for sending email Network Credentials Field Mapping.	string
OrderEmailPassword	Optional Order Email Password for sending email Network Credentials Field Mapping.	string
OrderLanguage	Order Language Field Mapping.	string
MeetingAPIUrl	Meeting API URL.	string
MeetingCustomer_ID	Meeting Customer ID Field Mapping.	string
MeetingAppSoftwareTypeID	Meeting Application of Software Type Field Mapping.	string
MeetingRobotNickName	Meeting schedule from Robot Nick Name Field Mapping.	string
MeetingFullName	Meeting Full Name Field Mapping	string
MeetingMobile	Meeting Mobile Field Mapping	string
MeetingOrganization	Meeting Organization Field Mapping	string
MeetingEMAIL	Meeting EMAIL Field Mapping	string
MeetingDesignation	Meeting Designation Field Mapping	string
MeetingID	Meeting ID Field Mapping	string
MeetingAppointmentDate	Meeting Appointment Date Field Mapping	string
MeetingType	Meeting Type Field Mapping	string
MeetingItemID	Meeting Item ID Field Mapping	string
MeetingVisitorLogs	Meeting Visitor Logs Field Mapping	string
MeetingCustomerDemographic	Meeting Customer Demographic Field Mapping.	string
MeetingMeetingLink	Meeting MeetingLink Field Mapping.	string
MeetingWebsiteLink	Meeting WebsiteLink Field Mapping.	string
MeetingSurveyClient	Meeting Survey Client Field Mapping.	string
MeetingSurveyApp	Meeting Survey App Field Mapping.	string
MeetingSMSAPIUrl	Meeting SMS API URL/End Point Field Mapping	string
MeetingSMSAPIUserName	Meeting SMS Provider Username, Will be End to End Encrypted Field Mapping	string
MeetingSMSAPIPassword	Meeting SMS Provider Password, Will be End to End Encrypted Field Mapping	string
MeetingSMSAPICallbackQueryString	Optional Meeting SMS Provider CallbackQueryString if any Field Mapping.	string
MeetingSMSAPIPriority	Optional Meeting SMS Sending Priority Field Mapping.	string
MeetingSMSAPIJsonBody	Optional Meeting SMS Json if sms api support json format Field Mapping.	string
MeetingSMSAPICopyTo	Optional Meeting SMS Mobile number for sanding copy Field Mapping.	string
MeetingisActive	Optional Meeting Status Field Mapping.	string
Temperature	Optional Temperature Field Mapping.	string
MeetingEmiratesID	Optional Meeting Emirates ID Field Mapping.	string
MeetingCustomRegisterField	Optional Meeting Custom Register Field Mapping.	string
MeetingCustomRegisterFieldValue	Optional Meeting Custom Register Field Value Field Mapping.	string
MeetingCustomRegisterSecondField	Optional Meeting Custom Register Second Field Field Mapping.	string
MeetingCustomRegisterSecondFieldValue	Optional Meeting Custom Register Second Field Value Field Mapping.	string
MeetingCorporateName	Optional Meeting Corporate Name Field Mapping	string
MeetingEmailFrom	Optional Meeting Email from Address Field Mapping	string
MeetingEmailCC	Optional Meeting Email CC Address if any Field Mapping.	string
MeetingEmailBCC	Optional Meeting Email BCC Address if any Field Mapping.	string
MeetingEmailSMTP	Optional Meeting Email sending smtp for sending email Field Mapping.	string
MeetingEmailPORT	Optional Meeting Email Port for sending email Field Mapping.	string
MeetingEmailUser	Optional Meeting Email Address for sending email Network Credentials Field Mapping.	string
MeetingEmailPassword	Optional Meeting Email Password for sending email Network Credentials Field Mapping.	string
MeetingLanguage	Meeting Language ID Field Mapping.	string
MeetingItemEItemID	Meeting Item English Item ID Field Mapping.	string

Response Formats

[
    {
    "CORPORATEID": 1,
    "Company": "sample string 2",
    "ClientName": "sample string 3",
    "ClientPhone": "sample string 4",
    "AuthenticationCode": "sample string 5",
    "DaysRemaining": 6,
    "AuthenticationDate": "2020-12-07T16:45:34.7917875+05:30",
    "BGHome": "sample string 8",
    "HomeFace":"sample string",
    "BGMain": "sample string 9",
    "AppIcon": "sample string 10",
    "MenuIcon": "sample string 11",
    "ColorCode": "sample string 12",
    "AppSoftwareType": "sample string 13",
    "AppMenuTypeID" : 1,
    "PaymentLink": "sample string 14",
    "Moto": "sample string 15",
    "PaymentPayPal": "sample string 16",
    "PaymentCash": false,
    "MenuVersion": "1.0001",
    "TipName": "TIP",
    "ShareASmileName": "ShareASmile",
    "TipTAX": 0.00,
    "ShareASmileTax": 0.00,
    "OtherInfo": "sample string",
    "Venue": "sample string",
    "PrintDocSize": "sample string",
    "PrintImgFirst": "sample string",
    "PrintImgSecond": "sample string",
    "PrintImgThired": "sample string",
    "AuthorizedToAssignRoles": "sample string",        
    "TAXName": "sample string 11",
    "CURRENCY": "sample string",         
    "TrumpetTime": 0,
    "Announcement": "sample string",
    "RobotNickName": "sample string",
    "LeastFeedFileName": "sample string",
    "AutoStart": true,
    "AdvancedContact": true,
    "ActiveDemographic": true,
    "AllowName": true,
    "AllowMobile": true,
    "AllowEmail": true,
    "AllowOrganization": true,
    "AllowDesignation": true,
    "AllowEmiratesID": true,
    "AllowCustomRegisterField": true,
    "CustomRegisterField": "sample string",
    "AllowCustomRegisterSecondField": true,
    "CustomRegisterSecondField": "sample string",
    "apimap": {
        "ClientID": 1,
        "AppSoftwareType": "sample string 2",
        "APIUrl": "sample string 3",
        "APIFeedbackUrl": "sample string",
        "OAuth": "sample string 4",
        "Customer_IDMap": "sample string",
        "OrderRobotNickName": "sample string",
        "AppSoftwareTypeIDMap": "sample string",
        "Full_NameMap": "sample string 5",
        "MobileMap": "sample string 6",
        "TableCodeMap": "sample string 7",
        "Order_IDMap": "sample string 8",
        "Order_DateMap": "sample string 9",
        "CurrencyMap": "sample string",
        "SubTotalMap": "sample string 10",
        "VATMap": "sample string",
        "DiscountMap": "sample string",
        "TotalMap": "sample string",            
        "TIPNameMap": "sample string",            
        "TIPTaxPercentageMap": "sample string",            
        "TIPMap": "sample string",
        "ShareASmileNameMap": "sample string",
        "ShareASmileTaxPercentageMap": "sample string",
        "ShareASmileMap": "sample string",
        "PaymentModeMap": "sample string 14",
        "PaymentLinkMap": "sample string",
        "CelebrationIDMap": "sample string",
        "SurveyClientMap": "sample string",
        "SurveyAppMap": "sample string",
        "DOBMap": "sample string",
        "AGEMap": "sample string",
        "GenderMap": "sample string",
        "ReligionMap": "sample string",
        "LoyatyCardMap": "sample string",
        "OrderTypeMap": "sample string",
        "CustomerDemographicMap": "sample string",
        "MeetingLinkMap": "sample string",
        "isActiveMap": "sample string 15",
        "ItemCollectionMap": "sample string 16",
        "Item_IDMap": "sample string 17",
        "Item_NameMap": "sample string 18",
        "QuantityMap": "sample string 19",
        "ItemDiscountMap": "sample string",
        "ItemTAXMap": "sample string",
        "TaxPercentageMap": "sample string",
        "DiscountPercentageMap": "sample string",
        "ItemCostMap": "sample string",
        "priceMap": "sample string 20",
        "isActive_ItemMap": "sample string 21",
        "OrderItemLanguage": "sample string",
        "OrderItemEItemID": "sample string",
        "SMSAPIUrlMap": "sample string",
        "SMSAPIUserNameMap": "sample string",
        "SMSAPIPasswordMap": "sample string",
        "SMSAPICallbackQueryStringMap": "sample string",
        "SMSAPIPriorityMap": "sample string",
        "SMSAPIJsonBodyMap": "sample string",
        "SMSAPICopyToMap": "sample string",
        "SMSAPIUrl": "sample string 22",
        "SMSAPIUserName": "sample string 23",
        "SMSAPIPassword": "sample string 24",
        "SMSAPICallbackQueryString": "sample string 25",
        "SMSAPIPriority": "sample string 26",
        "SMSAPIJsonBody": "sample string",
        "SMSAPICopyTo": "sample string",
        "EmailFrom": "sample string 27",
        "EmailCC": "sample string 28",
        "EmailBCC": "sample string 29",
        "EmailSMTP": "sample string 30",
        "EmailPORT": "sample string 31",
        "EmailUser": "sample string 32",
        "EmailPassword": "sample string 33",
        "OrderCustomerEMAIL": "sample string",
        "OrderCorporateName": "sample string",
        "OrderEmailFrom": "sample string",
        "OrderEmailCC": "sample string",
        "OrderEmailBCC": "sample string",
        "OrderEmailSMTP": "sample string",
        "OrderEmailPORT": "sample string",
        "OrderEmailUser": "sample string",
        "OrderEmailPassword": "sample string",
        "OrderLanguage": "sample string",
        "MeetingAPIUrl": "sample string",
        "MeetingCustomer_ID": "sample string",
        "MeetingAppSoftwareTypeID": "sample string",
        "MeetingRobotNickName": "sample string",
        "MeetingFullName": "sample string",
        "MeetingMobile": "sample string",
        "MeetingOrganization": "sample string",
        "MeetingEMAIL": "sample string",
        "MeetingDesignation": "sample string",
        "MeetingID": "sample string",
        "MeetingAppointmentDate": "sample string",
        "MeetingType": "sample string",
        "MeetingItemID": "sample string",
        
        "MeetingVisitorLogs": "sample string",
        "MeetingCustomerDemographic": "sample string",
        "MeetingMeetingLink": "sample string",
        "MeetingWebsiteLink": "sample string",
        "MeetingSurveyClient": "sample string",
        "MeetingSurveyApp": "sample string",
        "MeetingSMSAPIUrl": "sample string",
        "MeetingSMSAPIUserName": "sample string",
        "MeetingSMSAPIPassword": "sample string",
        "MeetingSMSAPICallbackQueryString": "sample string",
        "MeetingSMSAPIPriority": "sample string",
        "MeetingSMSAPIJsonBody": "sample string",
        "MeetingSMSAPICopyTo": "sample string",
        "MeetingisActive": "sample string",
        "Temperature": "sample string",
        "MeetingEmiratesID": "sample string",
        "MeetingCustomRegisterField": "sample string",
        "MeetingCustomRegisterFieldValue": "sample string",
        "MeetingCustomRegisterSecondField": "sample string",
        "MeetingCustomRegisterSecondFieldValue": "sample string", 
        "MeetingCorporateName": "sample string",
        "MeetingEmailFrom": "sample string",
        "MeetingEmailCC": "sample string",
        "MeetingEmailBCC": "sample string",
        "MeetingEmailSMTP": "sample string",
        "MeetingEmailPORT": "sample string",
        "MeetingEmailUser": "sample string",
        "MeetingEmailPassword": "sample string",
        "MeetingLanguage": "sample string",
        "MeetingItemEItemID": "sample string"
        }
    }
]

Example(Requst First Time)

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test.user@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

200

[
    {
        "Robot_ID": "23",
        "CORPORATEID": 25,
        "Message": "Demo Account Created Successfully.",
        "SoftwareVersion": "1.000",
        "ReleaseNotes": "",
        "ReleaseDate": "2021-01-01T00:00:00"
    }
]

Example(After OTP Verification)

Next request after the OTP Verification.

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test.user@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

200

[
    {
        "CORPORATEID": 1,
        "Company": "YOUR COMPANY",
        "ClientName": "YOUR NAME",
        "ClientPhone": "1234567890",
        "AuthenticationCode": "c335bd96-3d99-36cd-b34d-d9b0b027920f",
        "DaysRemaining": 30,
        "AuthenticationDate": "2020-12-07T18:18:15.1342341+05:30",
        "BGHome": "http://example.com/splash_bottom.jpg",
        "BGMain": "http://example.com/splash_bottom_sub.jpg",
        "HomeFace":"http://example.com/splash_face.jpg",
        "AppIcon": "http://example.com/logo.png",
        "MenuIcon": "http://example.com/icon_fork.png",
        "ColorCode": "#F95009",
        "AppSoftwareType": "1",
        "AppMenuTypeID" : 1,
        "PaymentLink": "",
        "Moto": "your company moto goes here",
        "PaymentPayPal": "",
        "PaymentCash": false,
        "MenuVersion": "1.0001",
        "TipName": "TIP",
        "ShareASmileName": "ShareASmile",
        "TipTAX": 0.00,
        "ShareASmileTax": 0.00,
        "OtherInfo": "6-10 Dec 2022",
        "Venue": "Dubai",
        "PrintDocSize": "A4",
        "PrintImgFirst": "splash_PrintImgFirst.jpg",
        "PrintImgSecond": "splash_PrintImgSecond.jpg",
        "PrintImgThired": "splash_PrintImgThired.jpg",
        "AuthorizedToAssignRoles": "visitor,exhibitor",
        "TAXName": "VAT",
        "CURRENCY": "AED",         
        "TrumpetTime": 0,
        "Announcement": "5% Off on all Items as store.",
        "RobotNickName": "Sanbot elf",
        "LeastFeedFileName": "Sanbot-Elf_1",
        "AutoStart": true,
        "AdvancedContact": true,
        "ActiveDemographic": true,
        "AllowName": true,
        "AllowMobile": true,
        "AllowEmail": true,
        "AllowOrganization": true,
        "AllowDesignation": true,
        "AllowEmiratesID": true,
        "AllowCustomRegisterField": true,
        "CustomRegisterField": "Loyalty Card",
        "AllowCustomRegisterSecondField": true,
        "CustomRegisterSecondField": "Sample ID",
        "apimap": {
            "ClientID": 1,
            "AppSoftwareType": "1",
            "APIUrl": "http://abc.com/Order?ClientID=123&AppSoftwareType=3",
            "APIFeedbackUrl": "http://abc.com/Feedback",
            "OAuth": "XHVk7gBXuKEbGLQKGTW29aOItHbX7i7e/pwL8IW8ZvuCBtVOvDy+AntTBym8iPaE",
            "Customer_IDMap": "Customer_ID",
            "OrderRobotNickName": "RobotNickName",
            "AppSoftwareTypeIDMap": "AppSoftwareTypeID",
            "Full_NameMap": "FullName",
            "MobileMap": "Mobile",
            "TableCodeMap": "TableCode",
            "Order_IDMap": "OrderID",
            "Order_DateMap": "OrderDate",
            "CurrencyMap": "CURRENCY",
            "SubTotalMap": "SubTotal",
            "VATMap": "VAT",
            "DiscountMap": "Discount",
            "TotalMap": "Total",            
            "TIPNameMap": "TIPName",            
            "TIPTaxPercentageMap": "TIPTaxPercentage",            
            "TIPMap": "TIP",
            "ShareASmileNameMap": "ShareASmileName",
            "ShareASmileTaxPercentageMap": "ShareASmileTaxPercentage",
            "ShareASmileMap": "ShareASmile",
            "PaymentModeMap": "PaymentMode",
            "PaymentLinkMap": "PaymentLink",
            "CelebrationIDMap": "CelebrationID",
            "SurveyClientMap": "SurveyClient",
            "SurveyAppMap": "SurveyApp",
            "DOBMap": "DOB",
            "AGEMap": "AGE",
            "GenderMap": "Gender",
            "ReligionMap": "Religion",
            "LoyatyCardMap": "LoyatyCard",
            "OrderTypeMap": "OrderType",
            "CustomerDemographicMap": "CustomerDemographic",
            "MeetingLinkMap": "MeetingLink",
            "isActiveMap": "isActive",
            "ItemCollection": "orderItem",
            "Item_IDMap": "ItemID",
            "Item_NameMap": "ItemName",
            "QuantityMap": "Quantity",
            "ItemDiscountMap": "ItemDiscount",
            "ItemTAXMap": "ItemTAX",
            "TaxPercentageMap": "TaxPercentage",
            "DiscountPercentageMap": "DiscountPercentage",
            "ItemCostMap": "ItemCost",
            "priceMap": "price",
            "isActive_ItemMap": "isActive",
            "OrderItemLanguage": "ItemLanguage",
            "OrderItemEItemID": "EItemID",
            "SMSAPIUrlMap": "SMSAPIUrl",
            "SMSAPIUserNameMap": "SMSAPIUserName",
            "SMSAPIPasswordMap": "SMSAPIPassword",
            "SMSAPICallbackQueryStringMap": "SMSAPICallbackQueryString",
            "SMSAPIPriorityMap": "SMSAPIPriority",
            "SMSAPIJsonBodyMap": "SMSAPIJsonBody",
            "SMSAPICopyToMap": "SMSAPICopyTo",
            "SMSAPIUrl": "http://abc.com/webservices/HttpReceiver.asmx/SubmitSms?",
            "SMSAPIUserName": "wMdWbMHjhTSGbBk6k8EgcA==",
            "SMSAPIPassword": "qXb4EKXYV0tCdbzWZr2k0Q==",
            "SMSAPICallbackQueryString": "URLEncodedCallBackURL",
            "SMSAPIPriority": "Priority",
            "SMSAPIJsonBody": "{TO:'###MESSAGETO###';MESSAGE:'###MESSAGE###';}",
            "SMSAPICopyTo": "1236547893",
            "EmailFrom": "",
            "EmailCC": "",
            "EmailBCC": "",
            "EmailSMTP": "",
            "EmailPORT": "",
            "EmailUser": "",
            "EmailPassword": "",
            "OrderCustomerEMAIL": "CustomerEMAIL",
            "OrderCorporateName": "CorporateName",
            "OrderEmailFrom": "EmailFrom",
            "OrderEmailCC": "EmailCC",
            "OrderEmailBCC": "EmailBCC",
            "OrderEmailSMTP": "EmailSMTP",
            "OrderEmailPORT": "EmailPORT",
            "OrderEmailUser": "EmailUser",
            "OrderEmailPassword": "EmailPassword",
            "OrderLanguage": "Language",
            "MeetingAPIUrl": "http://abc.com/Order?ClientID=123&AppSoftwareType=3",
            "MeetingCustomer_ID": "Customer_ID",
            "MeetingAppSoftwareTypeID": "AppSoftwareTypeID",
            "MeetingRobotNickName": "RobotNickName",
            "MeetingFullName": "FullName",
            "MeetingMobile": "Mobile",
            "MeetingOrganization": "Organization",
            "MeetingEMAIL": "EMAIL",
            "MeetingDesignation": "Designation",
            "MeetingID": "ID",
            "MeetingAppointmentDate": "AppointmentDate",
            "MeetingType": "Type",
            "MeetingItemID": "ItemID",
            
            "MeetingVisitorLogs": "VisitorLogs",
            "MeetingCustomerDemographic": "CustomerDemographic",
            "MeetingMeetingLink": "MeetingLink",
            "MeetingWebsiteLink": "WebsiteLink",
            "MeetingSurveyClient": "SurveyClient",
            "MeetingSurveyApp": "SurveyApp",
            "MeetingSMSAPIUrl": "SMSAPIUrl",
            "MeetingSMSAPIUserName": "SMSAPIUserName",
            "MeetingSMSAPIPassword": "SMSAPIPassword",
            "MeetingSMSAPICallbackQueryString": "SMSAPICallbackQueryString",
            "MeetingSMSAPIPriority": "SMSAPIPriority",
            "MeetingSMSAPIJsonBody": "SMSAPIJsonBody",
            "MeetingSMSAPICopyTo": "SMSAPICopyTo",
            "MeetingisActive": "isActive",
            "Temperature": "Temperature",
            "MeetingEmiratesID": "EmiratesID",
            "MeetingCustomRegisterField": "CustomRegisterField",
            "MeetingCustomRegisterFieldValue": "CustomRegisterFieldValue",
            "MeetingCustomRegisterSecondField": "CustomRegisterSecondField",
            "MeetingCustomRegisterSecondFieldValue": "CustomRegisterSecondFieldValue", 
            "MeetingCorporateName": "CorporateName",
            "MeetingEmailFrom": "EmailFrom",
            "MeetingEmailCC": "EmailCC",
            "MeetingEmailBCC": "EmailBCC",
            "MeetingEmailSMTP": "EmailSMTP",
            "MeetingEmailPORT": "EmailPORT",
            "MeetingEmailUser": "EmailUser",
            "MeetingEmailPassword": "EmailPassword",
            "MeetingLanguage": "Language",
            "MeetingItemEItemID": "EItemID"
        }
    }
]

Example(Requst After Expired)

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test.user@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

[
    {
        "Code": "410",
        "Message": "Demo Account Expired."
    }
]

Example(Already have Register Account)

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

[
    {
        "Code": "403",
        "Message": "Email already have Register Account. Please Sign In!"
    }
]

Example(Robot ID Already Register)

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

[
    {
        "Code": "400",
        "Message": "Robot ID already connected with other client."
    }
]

Example(Invalid Data)

Request

POST

api/Demo/org

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.001",
    "MenuVersion": "1.0001",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

[
    {
        "Code": "400",
        "Message": "Invalid Data Supply to request."
    }
]

Demo Menu

Purpose

To get list of demo mainmenu, submenu, InnerSubMenu, product(items) and AddOns at ExperthubRobotics App.

Request

POST

api/Demo/Menu

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
AppSoftwareType	Client Software Type. Unique ID from master of Software Type.	integer

Note:

Software Type is optional only for Expert Restaurant.

Software Type Must be Unique id from master.
1 for Expert Restaurant
2 for Expert Health
3 for Expert Education
4 for Expert Retail
5 for Expert Office
6 for Expert Home
9 for Expert Exhibition

Request Formats

{
    "AppSoftwareType": 1
}

Response Information

Resource Description

Name	Description	Type
ItemID	Unique Items ID	integer
MainMenu	Main Menu of Items	string
SubMenu	Sub Menu of Items	string
InnerSubMenu	Inner Sub Menu of Items(optional if any, Items will be in Sub Menu)	string
ItemName	Item Name	string
ItemPrice	Item's Price	decimal number
DiscountAMT	Item's Discount Amount	decimal number
ItemDiscount	Item's Discount Percentage	decimal number
ItemCost	Item's Cost	decimal number
ItemTAX	Item's TAX Percentage	decimal number
TaxAMT	Item's TAX Amount	decimal number
GrandTotal	Item's Grand Total Amount	decimal number
ItemDetails	Item's description	string
ImageTitle	Image Name	string
ItemType	Item Type MainMenu/ SubMenu/ InnerSubMenu/ Item	string
AgeRestricted	Item is Restricted For the Age Limit, return true if Restricted false for not.	bool
GenderRestricted	Item is Restricted For the Male / Female / No.	string
MuslimRestricted	Item is Restricted For Muslim, return true if Restricted false for not.	bool
OrderBy	Order Item while display on Application.	integer
EmailItem	Contact Email of the Item.	string
MeetingItem	Meeting Link of the Item.	string
MobileItem	Contact Mobile of the Item.	string
WebsiteLink	Video Link of the Item.	string
YouTubeLink	YouTube Link of the Item.	string
AddOns	List of Add Ons in Item	Collection of AddOn

Child : AddOns

Name	Description	Type
AddONID	Unique AddOn ID	integer
AddON	AddOn Item Name	string
PriceAddON	AddOn Price	decimal number
DiscountAMT	AddOn Item's Discount Amount	decimal number
ItemDiscount	AddOn Item's Discount Percentage	decimal number
ItemCost	AddOn Item's Cost	decimal number
ItemTAX	AddOn Item's TAX Percentage	decimal number
TaxAMT	AddOn Item's TAX Amount	decimal number
GrandTotal	AddOn Item's Grand Total Amount	decimal number
AddONImage	AddOn Image	string
AddONDetails	AddOn description	string

Messages

Name	Description	Type
ID	Unique ID.	integer
Trigger	Trigger Details	string
MessageCode	Message Code (Success 200/ Error 400)	integer
MessageStatus	Message Status	string
RobotSpeech	Robot Speech bass on input message.	string
Message	Error/ Successful Message return from APIs.	string
Validation	Validation apply on inputs.	string

Demographic

Name	Description	Type
ID	Unique ID.	integer
Title	Title of Demographic	string
Name	Name of Demographic	string
Image	Image path of Customer Demographic	string
OrderBy	Order Item while display on Application.	int

Response Formats

[
    {
        "Menus": [
              {
                "ItemID": 2,
                "MainMenu": "sample string 3",
                "SubMenu": "sample string 4",
                "InnerSubMenu" : "sample string",
                "ItemName": "sample string 5",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "sample string 7",
                "ImageTitle": "sample string 8",
                "ItemType": "sample string 9",
                "AgeRestricted": false,
                "GenderRestricted": 'No',
                "MuslimRestricted": false,
                "OrderBy": 10,
                "EmailItem": "sample string",
                "MeetingItem": "sample string ",
                "MobileItem": "sample string ",
                "WebsiteLink": "",
                "YouTubeLink": "sample string ",
                "AddOns": [
                  {
                    "AddONID": 1,
                    "AddON": "sample string 2",
                    "PriceAddON": 3.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 3.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 3.00,
                    "AddONImage": "sample string 4",
                    "AddONDetails": "sample string 5"
                  },
                  {
                    "AddONID": 1,
                    "AddON": "sample string 2",
                    "PriceAddON": 3.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 3.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 3.00,
                    "AddONImage": "sample string 4",
                    "AddONDetails": "sample string 5"
                  }
                ]
              },
              {
                "ItemID": 2,
                "MainMenu": "sample string 3",
                "SubMenu": "sample string 4",
                "InnerSubMenu" : "sample string",
                "ItemName": "sample string 5",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "sample string 7",
                "ImageTitle": "sample string 8",
                "ItemType": "sample string 9",
                "AgeRestricted": false,
                "GenderRestricted": 'No',
                "MuslimRestricted": false,
                "OrderBy": 10,
                "EmailItem": "sample string",
                "MeetingItem": "sample string ",
                "MobileItem": "sample string ",
                "WebsiteLink": "",
                "YouTubeLink": "sample string ",
                "AddOns": []
              }
            ],
    "Messages": [
            {
                "ID": 1,
                "Trigger": "sample string 6",
                "MessageCode": 7,
                "MessageStatus": "sample string 8",
                "RobotSpeech": "sample string 9",
                "Message": "sample string 10",
                "Validation": "sample string 11"
              },
              {
                "ID": 1,                
                "Trigger": "sample string 6",
                "MessageCode": 7,
                "MessageStatus": "sample string 8",
                "RobotSpeech": "sample string 9",
                "Message": "sample string 10",
                "Validation": "sample string 11"
              }
        ],
    "Demographic": [
            {
                "ID": 1,
                "Title": "sample string",
                "Name": "sample string",
                "Image": "sample string",
                "OrderBy": 1
            },
            {
                "ID": 2,
                "Title": "sample string",
                "Name": "sample string",
                "Image": "sample string",
                "OrderBy": 2
            }
        ]
    }
]

Example

Request

POST

api/Demo/Menu

Request Body

{
    "AppSoftwareType": 1
}

Response Body

200

[
    {
        "Menus": [
            {
                "ItemID": 1,
                "MainMenu": "Beverage",
                "SubMenu": "",
                "InnerSubMenu" : "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "",
                "ImageTitle": "MainMenu.png",
                "ItemType": "MainMenu",
                "AgeRestricted": false,
                "GenderRestricted": 'No',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "AddOns": []
            },
            {
                "ItemID": 2,
                "MainMenu": "Soft Drinks",
                "SubMenu": "",
                "InnerSubMenu" : "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "",
                "ImageTitle": "SoftDrinks.png",
                "ItemType": "SubMenu",
                "AgeRestricted": false,
                "GenderRestricted": 'Male',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "AddOns": []
            },
            {
                "ItemID": 3,
                "MainMenu": "XYZ Drink",
                "SubMenu": "",
                "InnerSubMenu" : "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "XYZ Drink is good for the health.",
                "ImageTitle": "XYZDrink.png",
                "ItemType": "Item",
                "AgeRestricted": false,
                "GenderRestricted": 'female',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "AddOns": [
                    {
                        "AddONID": 1,
                        "AddON": "Diet",
                        "PriceAddON": 5.00,
                        "ItemDiscount": 0.0,
                        "DiscountAMT": 0.0,
                        "ItemCost": 5.00,
                        "ItemTAX": 0.0,
                        "TaxAMT": 0.0,
                        "GrandTotal": 5.00,
                        "AddONImage": "",
                        "AddONDetails": "XYZ Drink is best for the health."
                    },
                    {
                        "AddONID": 2,
                        "AddON": "Cold",
                        "PriceAddON": 2.00,
                        "ItemDiscount": 0.0,
                        "DiscountAMT": 0.0,
                        "ItemCost": 2.00,
                        "ItemTAX": 0.0,
                        "TaxAMT": 0.0,
                        "GrandTotal": 2.00,
                        "AddONImage": "",
                        "AddONDetails": "XYZ Drink is best for the health."
                    }
                ]
            }
        ],
    "Messages": [
            {
                "ID": 1,
                "Trigger": "Corporate Email",
                "MessageCode": 400,
                "MessageStatus": "Fail",
                "RobotSpeech": "Enter your Corporate Email",
                "Message": "Please enter a valid Corporate Email",
                "Validation": "0.000"
            }
        ],
    "Demographic": [
            {
                "ID": 1,
                "Title": "Customer Demographics",
                "Name": "I am Individual",
                "Image": "user.png",
                "OrderBy": 1
            },
            {
                "ID": 2,
                "Title": "Customer Demographics",
                "Name": "I am Corporate",
                "Image": "corporate.png",
                "OrderBy": 2
            }
        ]
    }
]

Example(Expert Retail)

Request

POST

api/Demo/Menu

Request Body

{
    "AppSoftwareType": 4
}

Response Body

200

[
    {
        "Menus": [
            {
                "ItemID": 926,
                "MainMenu": "Women Wear",
                "SubMenu": "Formals",
                "InnerSubMenu": "Jackets",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "",
                "ImageTitle": "Women-Wear-Formals-Jackets.png",
                "ItemType": "InnerSubMenu",
                "AgeRestricted": false,
                "GenderRestricted": "No",
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "AddOns": []
            },
            {
                "ItemID": 935,
                "MainMenu": "Women Wear",
                "SubMenu": "Formals",
                "InnerSubMenu": "Jackets",
                "ItemName": "Women Black Solid Tailored Jacket",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "Women Black Solid Tailored Jac",
                "ImageTitle": "Women-Black-Solid-Tailored-Jacket.png",
                "ItemType": "Item",
                "AgeRestricted": false,
                "GenderRestricted": "No",
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "AddOns": [
                {
                    "AddONID": 42,
                    "AddON": "S",
                    "PriceAddON": 5.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 5.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 5.00,
                    "AddONImage": "",
                    "AddONDetails": "Women Black Solid Tailored Jac"
                },
                {
                    "AddONID": 43,
                    "AddON": "M",
                    "PriceAddON": 20.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 20.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 20.00,
                    "AddONImage": "",
                    "AddONDetails": "Women Black Solid Tailored Jac"
                },
                {
                    "AddONID": 44,
                    "AddON": "L",
                    "PriceAddON": 20.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 20.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 20.00,
                    "AddONImage": "",
                    "AddONDetails": "Women Black Solid Tailored Jac"
                },
                {
                    "AddONID": 45,
                    "AddON": "XL",
                    "PriceAddON": 50.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 50.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 50.00,
                    "AddONImage": "",
                    "AddONDetails": "Women Black Solid Tailored Jac"
                },
                {
                    "AddONID": 46,
                    "AddON": "XXL",
                    "PriceAddON": 50.00,
                    "ItemDiscount": 0.0,
                    "DiscountAMT": 0.0,
                    "ItemCost": 50.00,
                    "ItemTAX": 0.0,
                    "TaxAMT": 0.0,
                    "GrandTotal": 50.00,
                    "AddONImage": "",
                    "AddONDetails": "Women Black Solid Tailored Jac"
                }
                ]
            }
        ],
    "Messages": [
            {
                "ID": 1,
                "Trigger": "Corporate Email",
                "MessageCode": 400,
                "MessageStatus": "Fail",
                "RobotSpeech": "Enter your Corporate Email",
                "Message": "Please enter a valid Corporate Email",
                "Validation": "0.000"
            }
        ],
    "Demographic": [
            {
                "ID": 1,
                "Title": "Customer Demographics",
                "Name": "I am Individual",
                "Image": "user.png",
                "OrderBy": 1
            },
            {
                "ID": 2,
                "Title": "Customer Demographics",
                "Name": "I am Corporate",
                "Image": "corporate.png",
                "OrderBy": 2
            }
        ]
    }
]

Sign Up API

Purpose

To create account at ExperthubRobotics app.

Request

POST

api/SignUp

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
Robot_ID	Robot ID.	string
FullName	Full Name of Client. *Allow a-zA-Z and Space.	string
Email	Client Login Email Address. *Allow valid Email Only.	string
Mobile	Client Mobile Number. *Allow 0-9 only International Number without 00.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	integer
CorporateID	(optional) If Client Provide Existing Corporate ID.	integer
SoftwareVersion	Software Version on which app is running.	decimal(1.XXX)
MenuVersion	Menu Version on which app menu is running.	decimal(1.XXXX)
RobotName	Robot Name in which application in install.	string
ReleaseNotes	Release Notes of application.	string
ReleaseDate	Release Date of application.	date(yyyy-MM-dd)
RobotNickName	(Optional)Robot Nick Name in which application in install.	string

Note:

All Fields are mandatory.which are not mark (optional).

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

{
    "Robot_ID": "sample string 1",
    "CorporateID": 2,
    "FullName": "sample string 3",
    "Email": "sample string 4",
    "Mobile": "sample string 5",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.000",
    "MenuVersion": "1.0001",
    "RobotName": "sample string 6",
    "ReleaseNotes": "sample string 7",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "sample string 8"
}

Response Information

Resource Description

Name	Description	Type
Robot_ID	Robot ID.	string
CORPORATEID	Registered Corporate ID.	integer
Message	Message for registration completed Status.	string
Daily	Software Daily Charges/ Amount.	string
Monthly	Software Monthly Charges/ Amount.	string
Yearly	Software Yearly Charges/ Amount.	string
Currency	Software Charges/ Amount in Currency.	string

Response Formats

{
  "Robot_ID": "sample string 1",
  "CORPORATEID": 2,
  "Message": "sample string 3",
  "Daily": "sample string 4",
  "Monthly": "sample string 5",
  "Yearly": "sample string 6",
  "Currency": "sample string 7"
}

Example

Request

POST

api/SignUp

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test.user@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "CorporateID" : 2,
    "SoftwareVersion": "1.000",
    "MenuVersion": "1.0000",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

200

{
    "Robot_ID": "23",
    "CORPORATEID": 25,
    "Message": "SignUp Successfully, Otp Sent to Register Mobile.",
    "Daily": "900",
    "Monthly": "300",
    "Yearly": "1200",
    "Currency": "USD"
}

Example(Invalid Data)

Request

POST

api/SignUp

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "",  
    "Mobile": "1234567890",    
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.000",
    "MenuVersion": "1.0000",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

{
    "Code": "400",
    "Message": "Invalid Data Supply to request."
}

Example(Already have Register Account)

Request

POST

api/SignUp

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.000",
    "MenuVersion": "1.0000",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

{
    "Code": "400",
    "Message": "Email already have Register Account. Please Sign In!"
}

Example(Robot ID Already Register)

Request

POST

api/SignUp

Request Body

{
    "Robot_ID": "23",
    "FullName": "test",
    "Email": "test@experthubrobotics.com",  
    "Mobile": "1234567890",
    "AppSoftwareType": 1,
    "SoftwareVersion": "1.000",
    "MenuVersion": "1.0000",
    "RobotName": "Sanbot ELF",
    "ReleaseNotes": "Sanbot ELF Release Notes.",
    "ReleaseDate": "2021-01-31",
    "RobotNickName": "Sanbot ELF"
}

Response Body

400

{
    "Code": "400",
    "Message": "Robot ID already connected with other client."
}

Verify Corporate Details API

Purpose

To Verify corporate account details while signup in ExperthubRobotics app.

Request

POST

api/SignUp/Verify

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
CorporateID	Registered Corporate ID.	integer
CorporateEmail	Registered Corporate Email. *Allow valid Email Only.	string

Note:

All Body Parameters are mandatory.

Request Formats

{
  "CorporateID": 1,
  "CorporateEmail": "sample string 2"
}

Response Information

Resource Description

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
Message	Status of Corporate Verification.	string

Response Formats

{
  "CORPORATEID": 1,
  "Message": "sample string 2"
}

Example

Request

POST

api/SignUp/Verify

Request Body

{
    "CorporateID": "2",
    "CorporateEmail" : "test@experthubrobotics.com"
}

Response Body

200

{
    "CorporateID": 2,
    "Message": "Corporate details verify successfully."
}

Example(Empty / Null)

Request

POST

api/SignUp/Verify

Request Body

{
    "CorporateID": "2"
}

Response Body

400

{
    "Code": "400",
    "Message": "Invalid data supply to request."
}

Example(Invalid Email)

Request

POST

api/SignUp/Verify

Request Body

{
    "CorporateID": "2",
    "CorporateEmail" : "testexperthubrobotics.com"
}

Response Body

400

{
    "Code": "400",
    "Message": "Please enter a valid Email."
}

Verify OTP API

Purpose

To Verify account details via One Time Password on SignUp and Demo Account in ExperthubRobotics app.

Request

POST

api/VerifyOTP

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
RobotID	Robot ID.	string
Email	Registered Corporate Email. *Allow valid Email Only.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	integer
VerifyFor	OTP Verify For Demo/ SignUp.	string(Demo/ SignUp)
OTP	OTP get via Message.	integer
Payment	(Optional) Payment Type which is selected by user(Pay Now/ Send Link).	string
SignUpDays	(Optional) Number of Day Application Valid till.	integer

Note:

All Body Parameters are mandatory.which are not mark (optional)

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

{
  "CORPORATEID": 1,
  "RobotID": "sample string 2",
  "Email": "sample string 3",
  "AppSoftwareType": 4,
  "VerifyFor": "sample string 5",
  "OTP": 623654,
  "Payment": "sample string 7",
  "SignUpDays": 180
}

Response Information

Resource Description

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
Message	Status of OTP Verification.	string

Response Formats

{
  "CORPORATEID": 1,
  "Message": "sample string 2"
}

Example

Request

POST

api/VerifyOTP

Request Body

{
    "CORPORATEID": 1,
    "RobotID": "963258741",
    "Email": "example@experthutrobotic.com",
    "AppSoftwareType": 4,
    "VerifyFor": "SignUp",
    "Payment": "Pay Now",
    "OTP": 1234567890,
    "SignUpDays": 180
}

Response Body

200

{
    "CORPORATEID": 1,
    "Message": "OTP Verify Successfully."
}

Example(Empty / Null)

Request

POST

api/VerifyOTP

Request Body

{
    "Email": "example@experthutrobotic.com",
    "AppSoftwareType": 4,
    "VerifyFor": "SignUp",
    "Payment": "Pay Now",
    "OTP": 1234567890,
    "SignUpDays": 180
}

Response Body

400

{
    "CORPORATEID": 0,
    "Message": "Mandatory parameters cannot empty or null."
}

Example(Already Verify)

Request

POST

api/VerifyOTP

Request Body

{
    "CORPORATEID": 1,
    "Email": "example@experthutrobotic.com",
    "AppSoftwareType": 4,
    "VerifyFor": "SignUp",
    "Payment": "Pay Now",
    "OTP": 1234567890,
    "SignUpDays": 180
}

Response Body

400

{
    "CORPORATEID": 0,
    "Message": "OTP Already Verify."
}

Example(Invalid OTP)

Request

POST

api/VerifyOTP

Request Body

{
    "CORPORATEID": 1,
    "Email": "example@experthutrobotic.com",
    "AppSoftwareType": 4,
    "VerifyFor": "SignUp",
    "Payment": "Pay Now",
    "OTP": 1234567890
}

Response Body

400

{
    "CORPORATEID": 16,
    "Message": "Invalid OTP."
}

Resend OTP API

Purpose

To Resend OTP details while signup or demo in ExperthubRobotics app.

Request

POST

api/ResendOTP

Additional Header Parameters

None.

URI Parameters

None.

Body Parameters

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
RobotID	Robot ID.	string
Email	Registered Corporate Email. *Allow valid Email Only.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	integer
OTPFor	OTP For Demo/ SignUp.	string(Demo/ SignUp)

Note:

All Body Parameters are mandatory.which are not mark (optional)

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

{
  "CORPORATEID": 1,
  "RobotID": "sample string 2",
  "Email": "sample string 3",
  "AppSoftwareType": 5,
  "OTPFor": "SignUp"
}

Response Information

Resource Description

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
Message	Status of OTP Sent.	string

Response Formats

{
  "CORPORATEID": 1,
  "Message": "sample string 2"
}

Example

Request

POST

api/ResendOTP

Request Body

{
      "CORPORATEID": 1,
      "RobotID": "123",
      "Email": "example@experthubrobotics.com",
      "AppSoftwareType": 4,
      "OTPFor": "SignUp"
}

Response Body

200

{
    "CORPORATEID": 55,
    "Message": "OTP Re-Sent to Register Mobile."
}

Example(Empty / Null)

Request

POST

api/ResendOTP

Request Body

{
      "CORPORATEID": 1,
      "RobotID": "123",      
      "AppSoftwareType": 4,
      "OTPFor": "SignUp"
}

Response Body

400

{
    "Code": "400",
    "Message": "Recent register email cannot empty or null."
}

Sign In API

Purpose

To SignIn in ExperthubRobotics app and get auth code for further requst to api.

Api responce is also contains details for the AUTH Code, Payment API Link, SMS API Details and Send Email Details to use in ExperthubRotobics app.

Request

POST

api/SignIn?Robot_ID={Robot_ID}&EMAIL_ID={EMAIL_ID}&PASSWORD={PASSWORD}&RobotName={RobotName}&SoftwareType={SoftwareType}&SoftwareVersion={SoftwareVersion}&MenuVersion={MenuVersion}

Additional Header Parameters

None.

URI Parameters

Name	Description	Type
Robot_ID	Robot ID in which app install Installed.	string
EMAIL_ID	Client Login Email Address. *Allow valid Email Only.	string
PASSWORD	Application Sign in Password.	string
RobotName	Robot Name in which application in install.	string
SoftwareType	(Optional) Client Software Type. Unique ID from master of Software Type.	integer
SoftwareVersion	(Optional) Software Version on which app is running.	decimal(1.XXX)
MenuVersion	(Optional) Menu Version on which app menu is running.	decimal(1.XXXX)

Body Parameters

None.

Note:

All URL Parameters are mandatory.

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

api/SignIn?Robot_ID=1&EMAIL_ID=test@experthubrobotics.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Information

Resource Description

Name	Description	Type
CORPORATEID	Registered Corporate ID.	integer
Company	Firm/ Organization Name.	string
ClientName	Client Full Name.	string
ClientPhone	Client Number.	string
AuthenticationCode	Authentication Code.	string
AppMenuTypeID	Application of Menu Type. Menu Type from ExperthubRobotics Applications.	string
DaysRemaining	Authentication days.	integer
AuthenticationDate	Authentication Date.	date
BGHome	Application Home Background Image.	string
BGMain	Application Inner Pages Background Image.	string
HomeFace	Application Home Face Image.	string
AppIcon	Application Icon Image.	string
MenuIcon	Application Checkout Icon Shows.	string
ColorCode	Application Color Code for the Button and Application.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	string
PaymentLink	Application Checkout Payment Link	string
Moto	Moto	string
PaymentPayPal	Application Checkout Payment PayPal Link	string
PaymentCash	Application Checkout with Payment Cash	string
MenuVersion	Menu Version on which app menu is running.	decimal(1.XXXX)
TipName	Tip Name to display on app	string
ShareASmileName	ShareASmile Name to display on app	string
TipTAX	TAX Percentage to be count in Tip.	decimal
ShareASmileTax	TAX Percentage to be count in ShareASmile.	decimal
OtherInfo	Other Information like Event Date, schedule or other details to display on app	string
Venue	Venue of Event or Address of Corporate	string
PrintDocSize	Print Document Size on app	string
PrintImgFirst	Print Image First on app	string
PrintImgSecond	Print Image Second on app	string
PrintImgThired	Print Image Thired on app	string
AuthorizedToAssignRoles	Authorized To Assign Roles on app	string
TAXName	Order TAX Name(VAT,GST,etc.) Field Mapping	string
CURRENCY	Item's CURRENCY AED/USD/INR etc.	string
TrumpetTime	Trumpet Time in seconds	int
Announcement	Announcement text speak by robot.	string
RobotNickName	Robot Nick Name.	string
LeastFeedFileName	Least Feed File Uploaded Name.	string
AutoStart	Application auto start when on.	Boolean
AdvancedContact	Application ask for advanced contact details.	Boolean
ActiveDemographic	Application ask for Customer demographics details.	Boolean
AllowName	Application ask for Name.	Boolean
AllowMobile	Application ask for Mobile.	Boolean
AllowEmail	Application ask for Email.	Boolean
AllowOrganization	Application ask for Organization.	Boolean
AllowDesignation	Application ask for Designation.	Boolean
AllowEmiratesID	Application ask for EmiratesID.	Boolean
AllowCustomRegisterField	Application ask for custom register details.	Boolean
CustomRegisterField	Application ask for advanced contact details.	string
AllowCustomRegisterSecondField	Application ask for custom register second details.	Boolean
CustomRegisterSecondField	Application ask for custom register second details.	string

Child : apimap

Name	Description	Type
ClientID	Registered Corporate ID	integer
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	string
APIUrl	API URL(End Point)	string
APIFeedbackUrl	Order API Feedback URL(End Point)	string
OAuth	API Authentication Code(End Authentication Point) end to end encrypted.	string
Customer_IDMap	Customer ID Field Mapping.	string
OrderRobotNickName	Robot Name Type Field Mapping.	string
AppSoftwareTypeIDMap	Application of Software Type Field Mapping.	string
Full_NameMap	Customer Full Name Field Mapping	string
MobileMap	Customer Mobile Field Mapping	string
TableCodeMap	Customer Table Number Field Mapping	string
Order_IDMap	Order ID Field Mapping	string
Order_DateMap	Order Date Field Mapping	string
CurrencyMap	Order Currency API Field Mapping.	string
SubTotalMap	Order Sub Total Field Mapping	string
VATMap	Order TAX Amount Field Mapping	string
DiscountMap	Order Discount Field Mapping	string
TotalMap	Order Total Amount Field Mapping	string
TIPTaxPercentageMap	Optional Order TIP Tax Percentage Field Mapping.	string
TIPNameMap	Optional Order TIP Name Field Mapping.	string
TIPMap	Order TIP Field Mapping	string
ShareASmileTaxPercentageMap	Optional Order Share A Smile Tax Percentage Field Mapping.	string
ShareASmileNameMap	Optional Order Share A Smile Name Field Mapping.	string
ShareASmileMap	Order Share My Meal Field Mapping	string
PaymentModeMap	Order Payment Mode Field Mapping	string
PaymentLinkMap	Order Payment Link selected by Customer Field Mapping.	string
CelebrationIDMap	Order Celebration ID Field Mapping	string
isActiveMap	Order Status Field Mapping	string
ItemCollectionMap	Order Items Collection Field Mapping	string
Item_IDMap	Order Item ID Field Mapping	string
Item_NameMap	Order Item Name Mapping	string
QuantityMap	Order Quantity Field Mapping	string
ItemDiscountMap	Order Item Discount Field Mapping	string
ItemTAXMap	Order Item TAX Field Mapping	string
TaxPercentageMap	Optional Order Tax Percentage Field Mapping.	string
DiscountPercentageMap	Optional Order Item Discount Percentage Field Mapping.	string
ItemCostMap	Optional Order Item Cost Field Mapping.	string
priceMap	Order Price Field Mapping	string
isActive_ItemMap	Order Item Status Field Mapping	string
OrderItemLanguage	Order Item Language ID Field Mapping	string
OrderItemEItemID	Order Item English Item ID Field Mapping	string
SurveyClientMap	Order Item Survey App Field Mapping.	string
SurveyAppMap	Order Item DOB Field Mapping.	string
DOBMap	Order Item AGE Field Mapping.	string
AGEMap	Order Item AGE Field Mapping.	string
GenderMap	Order Item Gender Field Mapping.	string
ReligionMap	Order Item Religion Field Mapping.	string
LoyatyCardMap	Order Item LoyatyCard Field Mapping.	string
OrderTypeMap	Order Item OrderType Field Mapping.	string
CustomerDemographicMap	Order Item CustomerDemographic Field Mapping.	string
MeetingLinkMap	Order Item MeetingLink Field Mapping.	string
SMSAPIUrlMap	SMS Provider API URL/End Point Field Mapping	string
SMSAPIUserNameMap	SMS Provider Username, Will be End to End Encrypted Field Mapping	string
SMSAPIPasswordMap	SMS Provider Password, Will be End to End Encrypted Field Mapping	string
SMSAPICallbackQueryStringMap	Optional SMS Provider CallbackQueryString if any Field Mapping.	string
SMSAPIPriorityMap	Optional SMS Sending Priority Field Mapping.	string
SMSAPIJsonBodyMap	Optional SMS Json if sms api support json format Field Mapping.	string
SMSAPICopyToMap	Optional SMS Mobile number for sanding copy Field Mapping.	string
SMSAPIUrl	SMS Provider API URL/End Point	string
SMSAPIUserName	SMS Provider Username, Will be End to End Encrypted	string
SMSAPIPassword	SMS Provider Password, Will be End to End Encrypted	string
SMSAPICallbackQueryString	Optional SMS Provider CallbackQueryString if any.	string
SMSAPIPriority	Optional SMS Sending Priority.	string
SMSAPIJsonBody	Optional SMS Json if sms api support json format.	string
SMSAPICopyTo	Optional SMS Mobile number for sanding copy.	string
EmailFrom	Email from Address	string
EmailCC	Email CC Address if any.	string
EmailBCC	Email BCC Address if any.	string
EmailSMTP	Email sending smtp for sending email.	string
EmailPORT	Email Port for sending email.	string
EmailUser	Email Address for sending email Network Credentials. End to End Encrypted.	string
EmailPassword	Email Password for sending email Network Credentials. End to End Encrypted.	string
OrderCustomerEMAIL	Optional Order Customer EMAIL Field Mapping	string
OrderCorporateName	Optional Order Corporate Name Field Mapping	string
OrderEmailFrom	Optional Order Email from Address Field Mapping	string
OrderEmailCC	Optional Order Email CC Address if any Field Mapping.	string
OrderEmailBCC	Optional Order Email BCC Address if any Field Mapping.	string
OrderEmailSMTP	Optional Order Email sending smtp for sending email Field Mapping.	string
OrderEmailPORT	Optional Order Email Port for sending email Field Mapping.	string
OrderEmailUser	Optional Order Email Address for sending email Network Credentials Field Mapping.	string
OrderEmailPassword	Optional Order Email Password for sending email Network Credentials Field Mapping.	string
OrderLanguage	Order Language Field Mapping.	string
MeetingAPIUrl	Meeting API URL.	string
MeetingCustomer_ID	Meeting Customer ID Field Mapping.	string
MeetingAppSoftwareTypeID	Meeting Application of Software Type Field Mapping.	string
MeetingRobotNickName	Meeting schedule from Robot Nick Name Field Mapping.	string
MeetingFullName	Meeting Full Name Field Mapping	string
MeetingMobile	Meeting Mobile Field Mapping	string
MeetingOrganization	Meeting Organization Field Mapping	string
MeetingEMAIL	Meeting EMAIL Field Mapping	string
MeetingDesignation	Meeting Designation Field Mapping	string
MeetingID	Meeting ID Field Mapping	string
MeetingAppointmentDate	Meeting Appointment Date Field Mapping	string
MeetingType	Meeting Type Field Mapping	string
MeetingItemID	Meeting Item ID Field Mapping	string
MeetingVisitorLogs	Meeting Visitor Logs Field Mapping	string
MeetingCustomerDemographic	Meeting Customer Demographic Field Mapping.	string
MeetingMeetingLink	Meeting MeetingLink Field Mapping.	string
MeetingWebsiteLink	Meeting WebsiteLink Field Mapping.	string
MeetingSurveyClient	Meeting Survey Client Field Mapping.	string
MeetingSurveyApp	Meeting Survey App Field Mapping.	string
MeetingSMSAPIUrl	Meeting SMS API URL/End Point Field Mapping	string
MeetingSMSAPIUserName	Meeting SMS Provider Username, Will be End to End Encrypted Field Mapping	string
MeetingSMSAPIPassword	Meeting SMS Provider Password, Will be End to End Encrypted Field Mapping	string
MeetingSMSAPICallbackQueryString	Optional Meeting SMS Provider CallbackQueryString if any Field Mapping.	string
MeetingSMSAPIPriority	Optional Meeting SMS Sending Priority Field Mapping.	string
MeetingSMSAPIJsonBody	Optional Meeting SMS Json if sms api support json format Field Mapping.	string
MeetingSMSAPICopyTo	Optional Meeting SMS Mobile number for sanding copy Field Mapping.	string
MeetingisActive	Optional Meeting Status Field Mapping.	string
Temperature	Optional Temperature Field Mapping.	string
MeetingEmiratesID	Optional Meeting Emirates ID Field Mapping.	string
MeetingCustomRegisterField	Optional Meeting Custom Register Field Mapping.	string
MeetingCustomRegisterFieldValue	Optional Meeting Custom Register Field Value Field Mapping.	string
MeetingCustomRegisterSecondField	Optional Meeting Custom Register Second Field Field Mapping.	string
MeetingCustomRegisterSecondFieldValue	Optional Meeting Custom Register Second Field Value Field Mapping.	string
MeetingCorporateName	Optional Meeting Corporate Name Field Mapping	string
MeetingEmailFrom	Optional Meeting Email from Address Field Mapping	string
MeetingEmailCC	Optional Meeting Email CC Address if any Field Mapping.	string
MeetingEmailBCC	Optional Meeting Email BCC Address if any Field Mapping.	string
MeetingEmailSMTP	Optional Meeting Email sending smtp for sending email Field Mapping.	string
MeetingEmailPORT	Optional Meeting Email Port for sending email Field Mapping.	string
MeetingEmailUser	Optional Meeting Email Address for sending email Network Credentials Field Mapping.	string
MeetingEmailPassword	Optional Meeting Email Password for sending email Network Credentials Field Mapping.	string
MeetingLanguage	Meeting Language ID Field Mapping.	string
MeetingItemEItemID	Meeting Item English Item ID Field Mapping.	string

Response Formats

[
    {
    "CORPORATEID": 1,
    "Company": "sample string 2",
    "ClientName": "sample string 3",
    "ClientPhone": "sample string 4",
    "AuthenticationCode": "sample string 5",
    "DaysRemaining": 6,
    "AuthenticationDate": "2020-12-07T16:45:34.7917875+05:30",
    "BGHome": "sample string 8",
    "BGMain": "sample string 9",
    "HomeFace":"sample string",
    "AppIcon": "sample string 10",
    "MenuIcon": "sample string 11",
    "ColorCode": "sample string 12",
    "AppSoftwareType": "sample string 13",
    "AppMenuTypeID" : 1,
    "PaymentLink": "sample string 14",
    "Moto": "sample string 15",
    "PaymentPayPal": "sample string 16",
    "PaymentCash": false,
    "MenuVersion": "1.0001",
    "TipName": "TIP",
    "ShareASmileName": "ShareASmile",
    "TipTAX": 0.00,
    "ShareASmileTax": 0.00,
    "OtherInfo": "sample string",
    "Venue": "sample string",
    "PrintDocSize": "sample string",
    "PrintImgFirst": "sample string",
    "PrintImgSecond": "sample string",
    "PrintImgThired": "sample string",
    "AuthorizedToAssignRoles": "sample string",        
    "TAXName": "sample string 11",
    "CURRENCY": "sample string",         
    "TrumpetTime": 0,
    "Announcement": "sample string",
    "RobotNickName": "sample string",
    "LeastFeedFileName": "sample string",
    "AutoStart": true,
    "AdvancedContact": true,
    "ActiveDemographic": true,
    "AllowName": true,
    "AllowMobile": true,
    "AllowEmail": true,
    "AllowOrganization": true,
    "AllowDesignation": true,
    "AllowEmiratesID": true,
    "AllowCustomRegisterField": true,
    "CustomRegisterField": "sample string",
    "AllowCustomRegisterSecondField": true,
    "CustomRegisterSecondField": "sample string",
    "apimap": {
        "ClientID": 1,
        "AppSoftwareType": "sample string 2",
        "APIUrl": "sample string 3",
        "APIFeedbackUrl": "sample string",
        "OAuth": "sample string 4",
        "Customer_IDMap": "sample string",
        "OrderRobotNickName": "sample string",
        "AppSoftwareTypeIDMap": "sample string",
        "Full_NameMap": "sample string 5",
        "MobileMap": "sample string 6",
        "TableCodeMap": "sample string 7",
        "Order_IDMap": "sample string 8",
        "Order_DateMap": "sample string 9",
        "CurrencyMap": "sample string",
        "SubTotalMap": "sample string 10",
        "VATMap": "sample string",
        "DiscountMap": "sample string",
        "TotalMap": "sample string",            
        "TIPNameMap": "sample string",            
        "TIPTaxPercentageMap": "sample string",            
        "TIPMap": "sample string",
        "ShareASmileNameMap": "sample string",
        "ShareASmileTaxPercentageMap": "sample string",
        "ShareASmileMap": "sample string", 
        "PaymentModeMap": "sample string 14",
        "PaymentLinkMap": "sample string",
        "CelebrationIDMap": "sample string",
        "SurveyClientMap": "sample string",
        "SurveyAppMap": "sample string",
        "DOBMap": "sample string",
        "AGEMap": "sample string",
        "GenderMap": "sample string",
        "ReligionMap": "sample string",
        "LoyatyCardMap": "sample string",
        "OrderTypeMap": "sample string",
        "CustomerDemographicMap": "sample string",
        "MeetingLinkMap": "sample string",
        "isActiveMap": "sample string 15",
        "ItemCollectionMap": "sample string 16",
        "Item_IDMap": "sample string 17",
        "Item_NameMap": "sample string 18",
        "QuantityMap": "sample string 19",
        "ItemDiscountMap": "sample string",
        "ItemTAXMap": "sample string",
        "TaxPercentageMap": "sample string",
        "DiscountPercentageMap": "sample string",
        "ItemCostMap": "sample string",
        "priceMap": "sample string 20",
        "isActive_ItemMap": "sample string 21",
        "OrderItemLanguage": "sample string",
        "OrderItemEItemID": "sample string",
        "SMSAPIUrlMap": "sample string",
        "SMSAPIUserNameMap": "sample string",
        "SMSAPIPasswordMap": "sample string",
        "SMSAPICallbackQueryStringMap": "sample string",
        "SMSAPIPriorityMap": "sample string",
        "SMSAPIJsonBodyMap": "sample string",
        "SMSAPICopyToMap": "sample string",        
        "SMSAPIUrl": "sample string 22",
        "SMSAPIUserName": "sample string 23",
        "SMSAPIPassword": "sample string 24",
        "SMSAPICallbackQueryString": "sample string 25",
        "SMSAPIPriority": "sample string 26",
        "SMSAPIJsonBody": "sample string",
        "SMSAPICopyTo": "sample string",
        "EmailFrom": "sample string 27",
        "EmailCC": "sample string 28",
        "EmailBCC": "sample string 29",
        "EmailSMTP": "sample string 30",
        "EmailPORT": "sample string 31",
        "EmailUser": "sample string 32",
        "EmailPassword": "sample string 33",
        "OrderCustomerEMAIL": "sample string",
        "OrderCorporateName": "sample string",
        "OrderEmailFrom": "sample string",
        "OrderEmailCC": "sample string",
        "OrderEmailBCC": "sample string",
        "OrderEmailSMTP": "sample string",
        "OrderEmailPORT": "sample string",
        "OrderEmailUser": "sample string",
        "OrderEmailPassword": "sample string",
        "OrderLanguage": "sample string",
        "MeetingAPIUrl": "sample string",
        "MeetingCustomer_ID": "sample string",
        "MeetingAppSoftwareTypeID": "sample string",
        "MeetingRobotNickName": "sample string",
        "MeetingFullName": "sample string",
        "MeetingMobile": "sample string",
        "MeetingOrganization": "sample string",
        "MeetingEMAIL": "sample string",
        "MeetingDesignation": "sample string",
        "MeetingID": "sample string",
        "MeetingAppointmentDate": "sample string",
        "MeetingType": "sample string",
        "MeetingItemID": "sample string",
        
        "MeetingVisitorLogs": "sample string",
        "MeetingCustomerDemographic": "sample string",
        "MeetingMeetingLink": "sample string",
        "MeetingWebsiteLink": "sample string",
        "MeetingSurveyClient": "sample string",
        "MeetingSurveyApp": "sample string",
        "MeetingSMSAPIUrl": "sample string",
        "MeetingSMSAPIUserName": "sample string",
        "MeetingSMSAPIPassword": "sample string",
        "MeetingSMSAPICallbackQueryString": "sample string",
        "MeetingSMSAPIPriority": "sample string",
        "MeetingSMSAPIJsonBody": "sample string",
        "MeetingSMSAPICopyTo": "sample string",
        "MeetingisActive": "sample string",
        "Temperature": "sample string",
        "MeetingEmiratesID": "sample string",
        "MeetingCustomRegisterField": "sample string",
        "MeetingCustomRegisterFieldValue": "sample string",
        "MeetingCustomRegisterSecondField": "sample string",
        "MeetingCustomRegisterSecondFieldValue": "sample string", 
        "MeetingCorporateName": "sample string",
        "MeetingEmailFrom": "sample string",
        "MeetingEmailCC": "sample string",
        "MeetingEmailBCC": "sample string",
        "MeetingEmailSMTP": "sample string",
        "MeetingEmailPORT": "sample string",
        "MeetingEmailUser": "sample string",
        "MeetingEmailPassword": "sample string",
        "MeetingLanguage": "sample string",
        "MeetingItemEItemID": "sample string"
        }
    }
]

Example

Request

POST

api/SignIn?Robot_ID=1&EMAIL_ID=test@experthubrobotics.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

200

[
    {
        "CORPORATEID": 1,
        "Company": "YOUR COMPANY",
        "ClientName": "YOUR NAME",
        "ClientPhone": "1234567890",
        "AuthenticationCode": "c335bd96-3d99-36cd-b34d-d9b0b027920f",
        "DaysRemaining": 30,
        "AuthenticationDate": "2020-12-07T18:18:15.1342341+05:30",
        "BGHome": "http://example.com/splash_bottom.jpg",
        "BGMain": "http://example.com/splash_bottom_sub.jpg",
        "HomeFace":"http://example.com/splash_face.jpg",
        "AppIcon": "http://example.com/logo.png",
        "MenuIcon": "http://example.com/icon_fork.png",
        "ColorCode": "#F95009",
        "AppSoftwareType": "1",
        "AppMenuTypeID" : 1,
        "PaymentLink": "",
        "Moto": "your company moto goes here",
        "PaymentPayPal": "",
        "PaymentCash": false,
        "MenuVersion": "1.0001",
        "TipName": "TIP",
        "ShareASmileName": "ShareASmile",
        "TipTAX": 0.00,
        "ShareASmileTax": 0.00,
        "OtherInfo": "6-10 Dec 2022",
        "Venue": "Dubai",
        "PrintDocSize": "A4",
        "PrintImgFirst": "splash_PrintImgFirst.jpg",
        "PrintImgSecond": "splash_PrintImgSecond.jpg",
        "PrintImgThired": "splash_PrintImgThired.jpg",
        "AuthorizedToAssignRoles": "visitor,exhibitor",
        "TAXName": "VAT",
        "CURRENCY": "AED",         
        "TrumpetTime": 0,
        "Announcement": "5% Off on all Items as store.",
        "RobotNickName": "Sanbot Elf",
        "LeastFeedFileName": "Sanbot-Elf_1",
        "AutoStart": true,
        "AdvancedContact": true,
        "ActiveDemographic": true,
        "AllowName": true,
        "AllowMobile": true,
        "AllowEmail": true,
        "AllowOrganization": true,
        "AllowDesignation": true,
        "AllowEmiratesID": true,
        "AllowCustomRegisterField": true,
        "CustomRegisterField": "Loyalty Card",
        "AllowCustomRegisterSecondField": true,
        "CustomRegisterSecondField": "Sample ID",
        "apimap": {
            "ClientID": 1,
            "AppSoftwareType": "1",
            "APIUrl": "http://abc.com/Order?ClientID=123&AppSoftwareType=3",
            "APIFeedbackUrl": "http://abc.com/Feedback"
            "OAuth": "XHVk7gBXuKEbGLQKGTW29aOItHbX7i7e/pwL8IW8ZvuCBtVOvDy+AntTBym8iPaE",
            "Customer_IDMap": "Customer_ID",
            "OrderRobotNickName": "RobotNickName",
            "AppSoftwareTypeIDMap": "AppSoftwareTypeID",
            "Full_NameMap": "FullName",
            "MobileMap": "Mobile",
            "TableCodeMap": "TableCode",
            "Order_IDMap": "OrderID",
            "Order_DateMap": "OrderDate",
            "CurrencyMap": "CURRENCY",
            "SubTotalMap": "SubTotal",
            "VATMap": "VAT",
            "DiscountMap": "Discount",
            "TotalMap": "Total",            
            "TIPNameMap": "TIPName",            
            "TIPTaxPercentageMap": "TIPTaxPercentage",            
            "TIPMap": "TIP",
            "ShareASmileNameMap": "ShareASmileName",
            "ShareASmileTaxPercentageMap": "ShareASmileTaxPercentage",
            "ShareASmileMap": "ShareASmile",
            "PaymentModeMap": "PaymentMode",
            "PaymentLinkMap": "PaymentLink",
            "CelebrationIDMap": "CelebrationID",
            "SurveyClientMap": "SurveyClient",
            "SurveyAppMap": "SurveyApp",
            "DOBMap": "DOB",
            "AGEMap": "AGE",
            "GenderMap": "Gender",
            "ReligionMap": "Religion",
            "LoyatyCardMap": "LoyatyCard",
            "OrderTypeMap": "OrderType",
            "CustomerDemographicMap": "CustomerDemographic",
            "MeetingLinkMap": "MeetingLink",
            "isActiveMap": "isActive",
            "ItemCollectionMap": "orderItem",
            "Item_IDMap": "ItemID",
            "Item_NameMap": "ItemName",
            "QuantityMap": "Quantity",
            "ItemDiscountMap": "ItemDiscount",
            "ItemTAXMap": "ItemTAX",
            "TaxPercentageMap": "TaxPercentage",
            "DiscountPercentageMap": "DiscountPercentage",
            "ItemCostMap": "ItemCost",
            "priceMap": "price",
            "isActive_ItemMap": "isActive",
            "OrderItemLanguage": "ItemLanguage",
            "OrderItemEItemID": "EItemID",
            "SMSAPIUrlMap": "SMSAPIUrl",
            "SMSAPIUserNameMap": "SMSAPIUserName",
            "SMSAPIPasswordMap": "SMSAPIPassword",
            "SMSAPICallbackQueryStringMap": "SMSAPICallbackQueryString",
            "SMSAPIPriorityMap": "SMSAPIPriority",
            "SMSAPIJsonBodyMap": "SMSAPIJsonBody",
            "SMSAPICopyToMap": "SMSAPICopyTo",
            "SMSAPIUrl": "http://abc.com/webservices/HttpReceiver.asmx/SubmitSms?",
            "SMSAPIUserName": "wMdWbMHjhTSGbBk6k8EgcA==",
            "SMSAPIPassword": "qXb4EKXYV0tCdbzWZr2k0Q==",
            "SMSAPICallbackQueryString": "URLEncodedCallBackURL",
            "SMSAPIPriority": "Priority",
            "SMSAPIJsonBody": "{TO:'###MESSAGETO###';MESSAGE:'###MESSAGE###';}",
            "SMSAPICopyTo": "1236547893",
            "EmailFrom": "",
            "EmailCC": "",
            "EmailBCC": "",
            "EmailSMTP": "",
            "EmailPORT": "",
            "EmailUser": "",
            "EmailPassword": "",
            "OrderCustomerEMAIL": "CustomerEMAIL",
            "OrderCorporateName": "CorporateName",
            "OrderEmailFrom": "EmailFrom",
            "OrderEmailCC": "EmailCC",
            "OrderEmailBCC": "EmailBCC",
            "OrderEmailSMTP": "EmailSMTP",
            "OrderEmailPORT": "EmailPORT",
            "OrderEmailUser": "EmailUser",
            "OrderEmailPassword": "EmailPassword",
            "OrderLanguage": "Language",
            "MeetingAPIUrl": "http://abc.com/Order?ClientID=123&AppSoftwareType=3",
            "MeetingCustomer_ID": "Customer_ID",
            "MeetingAppSoftwareTypeID": "AppSoftwareTypeID",
            "MeetingRobotNickName": "RobotNickName",
            "MeetingFullName": "FullName",
            "MeetingMobile": "Mobile",
            "MeetingOrganization": "Organization",
            "MeetingEMAIL": "EMAIL",
            "MeetingDesignation": "Designation",
            "MeetingID": "ID",
            "MeetingAppointmentDate": "AppointmentDate",
            "MeetingType": "Type",
            "MeetingItemID": "ItemID",
            
            "MeetingVisitorLogs": "VisitorLogs",
            "MeetingCustomerDemographic": "CustomerDemographic",
            "MeetingMeetingLink": "MeetingLink",
            "MeetingWebsiteLink": "WebsiteLink",
            "MeetingSurveyClient": "SurveyClient",
            "MeetingSurveyApp": "SurveyApp",
            "MeetingSMSAPIUrl": "SMSAPIUrl",
            "MeetingSMSAPIUserName": "SMSAPIUserName",
            "MeetingSMSAPIPassword": "SMSAPIPassword",
            "MeetingSMSAPICallbackQueryString": "SMSAPICallbackQueryString",
            "MeetingSMSAPIPriority": "SMSAPIPriority",
            "MeetingSMSAPIJsonBody": "SMSAPIJsonBody",
            "MeetingSMSAPICopyTo": "SMSAPICopyTo",
            "MeetingisActive": "isActive",
            "Temperature": "Temperature",
            "MeetingEmiratesID": "EmiratesID",
            "MeetingCustomRegisterField": "CustomRegisterField",
            "MeetingCustomRegisterFieldValue": "CustomRegisterFieldValue",
            "MeetingCustomRegisterSecondField": "CustomRegisterSecondField",
            "MeetingCustomRegisterSecondFieldValue": "CustomRegisterSecondFieldValue", 
            "MeetingCorporateName": "CorporateName",
            "MeetingEmailFrom": "EmailFrom",
            "MeetingEmailCC": "EmailCC",
            "MeetingEmailBCC": "EmailBCC",
            "MeetingEmailSMTP": "EmailSMTP",
            "MeetingEmailPORT": "EmailPORT",
            "MeetingEmailUser": "EmailUser",
            "MeetingEmailPassword": "EmailPassword",
            "MeetingLanguage": "Language",
            "MeetingItemEItemID": "EItemID"    
        }
    }
]

Example(Expired Login)

Request

POST

api/SignIn?Robot_ID=1&EMAIL_ID=test@experthubrobotics.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

200

[
    {
        "Code": "200",
        "Message": "Expired Login, Expired login access since 15 days."
    }
]

Example(Not Found)

Request

POST

api/SignIn?EMAIL_ID=test@experthubrobotics.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

404

{
    "Message": "No HTTP resource was found that matches the request 
URI 'api/SignIn?EMAIL_ID=BOL-GAPPA@gmail.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX'."
}

Example(Invalid)

Request

POST

api/SignIn?Robot_ID=1&EMAIL_ID=test@experthubrobotics.com&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

400

[
    {
        "Code": "400",
        "Message": "Invalid Robot ID, Email, Password and SoftwareType."
    }
]

Example(Plain Password)

Request

POST

api/SignIn?Robot_ID=1&EMAIL_ID=test@experthubrobotics.com&PASSWORD=12345&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

400

[
    {
        "Code": "400",
        "Message": "An error has occurred while password is decrypt. Password has not end to end encrypted."
    }
]

Example(NULL / Empty)

Request

POST

api/SignIn?Robot_ID=1&EMAIL_ID=&PASSWORD=kyVC0k0h71HccYcXkn6H2w==&SoftwareType=1&SoftwareVersion=1.001&MenuVersion=1.0001&RobotName=Sanbot MAX

Response Body

400

[
    {
        "Code": "400",
        "Message": "Mandatory parameters cannot empty or null."
    }
]

Menu API

Purpose

To get MainMenu, SubMenu, InnerSubMenu, Product(Item) and AddOns in ExperthubRobotics app.

Request

POST

api/V2/Menu/Items?RobotID={RobotID}&ClientID={ClientID}&AppSoftwareType={AppSoftwareType}&Language={Language}&Email={Email}

Additional Header Parameters

Name	Description	Type
auth	"Authentication code" get while sign in.	string

URI Parameters

Name	Description	Type
RobotID	Robot ID in which app install Installed.	string
ClientID	Client ID register with robot.	string
AppSoftwareType	Application of Software Type. Application Unique ID from ExperthubRobotics Applications.	string
Language	Language ID from ExperthubRobotics Language. Only Pass if needed other details.	string
Email	SignIn Email.	string

Body Parameters

None.

Note:

All URL Parameters are mandatory.

Header "authentication code" is also mandatory.

App Software Type Must be Unique id(AppSoftwareTypeID) from Application Request.

Request Formats

api/V2/Menu/Items?RobotID=1&ClientID=1&AppSoftwareType=6
auth : " < authentication code hear as header > "

Response Information

Resource Description

Name	Description	Type
ItemID	Unique Items ID	integer
MainMenu	Main Menu of Items	string
SubMenu	Sub Menu of Items	string
InnerSubMenu	Inner Sub Menu of Items(optional if any, Items will be in Sub Menu)	string
ItemName	Item Name	string
ItemPrice	Item's Price	decimal number
DiscountAMT	Item's Discount Amount	decimal number
ItemDiscount	Item's Discount Percentage	decimal number
ItemCost	Item's Cost	decimal number
ItemTAX	Item's TAX Percentage	decimal number
TaxAMT	Item's TAX Amount	decimal number
GrandTotal	Item's Grand Total Amount	decimal number
ItemDetails	Item's description	string
ImageTitle	Image Name	string
ItemType	Item Type MainMenu/ SubMenu/ InnerSubMenu/ Item	string
AgeRestricted	Item is Restricted For the Age Limit return true/ false.	bool
GenderRestricted	Item is Restricted For the Male / Female / No.	string
MuslimRestricted	Item is Restricted For Muslim.	bool
OrderBy	Order Item while display on Application.	integer
EmailItem	Contact Email of the Item.	string
MeetingItem	Meeting Link of the Item.	string
MobileItem	Contact Mobile of the Item.	string
WebsiteLink	Video Link of the Item.	string
YouTubeLink	YouTube Link of the Item.	string
EItemID	EItem ID.	int
AppointmentTimeRegion	Appointment Time Region.	string
AppointmentFromDate	Appointment From Date.	string
AppointmentToDate	Appointment To Date.	string
AppoinmentPeriod	Appoinment Period.	string
AppointmentFromTime	Appointment From Time.	string
AppointmentToTime	Appointment To Time.	string
AppointmentOnSun	Appointment On Sun.	string
AppointmentOnMon	Appointment On Mon.	string
AppointmentOnTue	Appointment On Tue.	string
AppointmentOnWed	Appointment On Wed.	string
AppointmentOnThu	Appointment On Thu.	string
AppointmentOnFri	Appointment On Fri.	string
AppointmentOnSat	Appointment On Sat.	string
VideoTimeRegion	Video Time Region.	string
VideoFromDate	Video From Date.	string
VideoToDate	Video To Date.	string
VideoPeriod	Video Period.	string
VideoFromTime	Video From Time.	string
VideoToTime	Video To Time.	string
VideoOnSun	Video On Sun.	string
VideoOnMon	Video On Mon.	string
VideoOnTue	Video On Tue.	string
VideoOnWed	Video On Wed.	string
VideoOnThu	Video On Thu.	string
VideoOnFri	Video On Fri.	string
VideoOnSat	Video On Sat.	string
RobotSpeechItemDetails	Robot Speech Item Details.	string
EnableEmail	Enable Email.	string
ShowEmail	Show Email.	string
EnableSMS	Enable SMS.	string
ShowMobile	Show Mobile.	string
EnableYouTubeVideo	Enable YouTube Video.	string
EnableAppointment	Enable Appointment.	string
EnableVideoMeeting	Enable Video Meeting.	string
EnableWebsite	Enable Website.	string
EnableRecordedMessages	Enable Recorded Messages.	string
EnableReport	Enable Report.	string
YouTubeRepeatOne	YouTube Repeat One.	string
EnableBrowserLock	Enable Browser Lock.	string
EnableVideoLock	Enable Video Lock.	string
AddOns	List of Add Ons in Item	Collection of AddOn

Child : AddOns

Name	Description	Type
AddONID	Unique AddOn ID	integer
AddON	AddOn Item Name	string
PriceAddON	AddOn Price	decimal number
DiscountAMT	AddOn Item's Discount Amount	decimal number
ItemDiscount	AddOn Item's Discount Percentage	decimal number
ItemCost	AddOn Item's Cost	decimal number
ItemTAX	AddOn Item's TAX Percentage	decimal number
TaxAMT	AddOn Item's TAX Amount	decimal number
GrandTotal	AddOn Item's Grand Total Amount	decimal number
AddONImage	AddOn Image	string
AddONDetails	AddOn description	string

Messages

Name	Description	Type
ID	Unique ID.	integer
Trigger	Trigger Details	string
MessageCode	Message Code (Success 200/ Error 400)	integer
MessageStatus	Message Status	string
RobotSpeech	Robot Speech bass on input message.	string
Message	Error/ Successful Message return from APIs.	string
Validation	Validation apply on inputs.	string

Demographic

Name	Description	Type
ID	Unique ID.	integer
Title	Title of Demographic	string
Name	Name of Demographic	string
Image	Image path of Customer Demographic	string
OrderBy	Order Item while display on Application.	int

Response Formats

[
    {
        "Menus": [
          {
            "ItemID": 2,
            "MainMenu": "sample string 3",
            "SubMenu": "sample string 4",
            "InnerSubMenu": "sample string",
            "ItemName": "sample string 5",
            "ItemPrice": 100.00,
            "ItemDiscount": 10.00,
            "DiscountAMT": 10.00,
            "ItemCost": 90.00,
            "ItemTAX": 5.00,
            "TaxAMT": 4.50,
            "GrandTotal": 94.50,
            "ItemDetails": "sample string 7",
            "ImageTitle": "sample string 8",
            "ItemType": "sample string 9",
            "AgeRestricted": false,
            "GenderRestricted": 'No',
            "MuslimRestricted": false,
            "OrderBy": 10,
            "EmailItem": "sample string",
            "MeetingItem": "sample string ",
            "MobileItem": "sample string ",
            "WebsiteLink": "sample string",
            "YouTubeLink": "sample string ",
            "EItemID": 111,
            "AppointmentTimeRegion": "sample string",
            "AppointmentFromDate": "sample string",
            "AppointmentToDate": "sample string",
            "AppoinmentPeriod": "sample string",
            "AppointmentFromTime": "sample string",
            "AppointmentToTime": "sample string",
            "AppointmentOnSun": "sample string",
            "AppointmentOnMon": "sample string",
            "AppointmentOnTue": "sample string",
            "AppointmentOnWed": "sample string",
            "AppointmentOnThu": "sample string",
            "AppointmentOnFri": "sample string",
            "AppointmentOnSat": "sample string",
            "VideoTimeRegion": "sample string",
            "VideoFromDate": "sample string",
            "VideoToDate": "sample string",
            "VideoPeriod": "sample string",
            "VideoFromTime": "sample string",
            "VideoToTime": "sample string",
            "VideoOnSun": "sample string",
            "VideoOnMon": "sample string",
            "VideoOnTue": "sample string",
            "VideoOnWed": "sample string",
            "VideoOnThu": "sample string",
            "VideoOnFri": "sample string",
            "VideoOnSat": "sample string",
            "RobotSpeechItemDetails": "sample string",
            "EnableEmail": "sample string",
            "ShowEmail": "sample string",
            "EnableSMS": "sample string",
            "ShowMobile": "sample string",
            "EnableYouTubeVideo": "sample string",
            "EnableAppointment": "sample string",
            "EnableVideoMeeting": "sample string",
            "EnableWebsite": "sample string",
            "EnableRecordedMessages": "sample string",
            "EnableReport": "sample string",
            "YouTubeRepeatOne": "sample string",
            "EnableBrowserLock": "sample string",
            "EnableVideoLock": "sample string",
            "AddOns": [
              {
                "AddONID": 1,
                "AddON": "sample string 2",
                "PriceAddON": 3.00,
                "ItemDiscount": 0.0,
                "DiscountAMT": 0.0,
                "ItemCost": 3.00,
                "ItemTAX": 0.0,
                "TaxAMT": 0.0,
                "GrandTotal": 3.00,
                "AddONImage": "sample string 4",
                "AddONDetails": "sample string 5"
              },
              {
                "AddONID": 1,
                "AddON": "sample string 2",
                "PriceAddON": 3.00,
                "ItemDiscount": 0.0,
                "DiscountAMT": 0.0,
                "ItemCost": 3.00,
                "ItemTAX": 0.0,
                "TaxAMT": 0.0,
                "GrandTotal": 3.00,
                "AddONImage": "sample string 4",
                "AddONDetails": "sample string 5"
              }
            ]
          },
          {
            "ItemID": 2,
            "MainMenu": "sample string 3",
            "SubMenu": "sample string 4",
            "InnerSubMenu": "sample string",
            "ItemName": "sample string 5",
            "ItemPrice": 100.00,
            "ItemDiscount": 10.00,
            "DiscountAMT": 10.00,
            "ItemCost": 90.00,
            "ItemTAX": 5.00,
            "TaxAMT": 4.50,
            "GrandTotal": 94.50,
            "ItemDetails": "sample string 7",
            "ImageTitle": "sample string 8",
            "ItemType": "sample string 9",
            "AgeRestricted": false,
            "GenderRestricted": 'No',
            "MuslimRestricted": false,
            "OrderBy": 10,
            "EmailItem": "sample string",
            "MeetingItem": "sample string ",
            "MobileItem": "sample string ",
            "WebsiteLink": "",
            "YouTubeLink": "sample string ",
            "EItemID": 30991,
            "AppointmentTimeRegion": "GMT+4",
            "AppointmentFromDate": "15-09-2021",
            "AppointmentToDate": "31-12-2022",
            "AppoinmentPeriod": "15",
            "AppointmentFromTime": "08:00:00",
            "AppointmentToTime": "20:00:00",
            "AppointmentOnSun": "True",
            "AppointmentOnMon": "True",
            "AppointmentOnTue": "True",
            "AppointmentOnWed": "True",
            "AppointmentOnThu": "True",
            "AppointmentOnFri": "True",
            "AppointmentOnSat": "True",
            "VideoTimeRegion": "GMT+4",
            "VideoFromDate": "15-09-2021",
            "VideoToDate": "31-12-2030",
            "VideoPeriod": "15",
            "VideoFromTime": "08:00:00",
            "VideoToTime": "20:00:00",
            "VideoOnSun": "True",
            "VideoOnMon": "True",
            "VideoOnTue": "True",
            "VideoOnWed": "True",
            "VideoOnThu": "True",
            "VideoOnFri": "True",
            "VideoOnSat": "True",
            "RobotSpeechItemDetails": "Here you can have your company Introduction, show your company mobile number, email, website or video, send sms and email to visitors, with your product catalogue.",
            "EnableEmail": "True",
            "ShowEmail": "True",
            "EnableSMS": "True",
            "ShowMobile": "True",
            "EnableYouTubeVideo": "True",
            "EnableAppointment": "True",
            "EnableVideoMeeting": "True",
            "EnableWebsite": "True",
            "EnableRecordedMessages": "True",
            "EnableReport": "False",
            "YouTubeRepeatOne": "TimeOut",
            "EnableBrowserLock": "False",
            "EnableVideoLock": "False",
            "AddOns": []
          }
        ],
    "Messages": [
            {
                "ID": 1,
                
                "Trigger": "sample string 6",
                "MessageCode": 7,
                "MessageStatus": "sample string 8",
                "RobotSpeech": "sample string 9",
                "Message": "sample string 10",
                "Validation": "sample string 11"
                
              },
              {
                "ID": 1,
                
                "Trigger": "sample string 6",
                "MessageCode": 7,
                "MessageStatus": "sample string 8",
                "RobotSpeech": "sample string 9",
                "Message": "sample string 10",
                "Validation": "sample string 11"
                
              }
        ],
    "Demographic": [
            {
                "ID": 1,
                "Title": "sample string",
                "Name": "sample string",
                "Image": "sample string",
                "OrderBy": 1
            },
            {
                "ID": 2,
                "Title": "sample string",
                "Name": "sample string",
                "Image": "sample string",
                "OrderBy": 2
            }
        ]
    }
]

Example

Request

POST

api/V2/Menu/Items?RobotID=1&ClientID=1&AppSoftwareType=6&Language=1&Email=test@test.com

Additional Header Parameters

auth : "c335bd96-3d99-36cd-b34d-d9b0b027920f"

Response Body

200

[
    {
        "Menus": [
            {
                "ItemID": 1,
                "MainMenu": "Beverage",
                "SubMenu": "",
                "InnerSubMenu": "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "",
                "ImageTitle": "MainMenu.png",
                "ItemType": "MainMenu",
                "AgeRestricted": false,
                "GenderRestricted": 'No',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "EItemID": 30991,
                "AppointmentTimeRegion": "GMT+4",
                "AppointmentFromDate": "15-09-2021",
                "AppointmentToDate": "31-12-2022",
                "AppoinmentPeriod": "15",
                "AppointmentFromTime": "08:00:00",
                "AppointmentToTime": "20:00:00",
                "AppointmentOnSun": "True",
                "AppointmentOnMon": "True",
                "AppointmentOnTue": "True",
                "AppointmentOnWed": "True",
                "AppointmentOnThu": "True",
                "AppointmentOnFri": "True",
                "AppointmentOnSat": "True",
                "VideoTimeRegion": "GMT+4",
                "VideoFromDate": "15-09-2021",
                "VideoToDate": "31-12-2030",
                "VideoPeriod": "15",
                "VideoFromTime": "08:00:00",
                "VideoToTime": "20:00:00",
                "VideoOnSun": "True",
                "VideoOnMon": "True",
                "VideoOnTue": "True",
                "VideoOnWed": "True",
                "VideoOnThu": "True",
                "VideoOnFri": "True",
                "VideoOnSat": "True",
                "RobotSpeechItemDetails": "Here you can have your company Introduction, show your company mobile number, email, website or video, send sms and email to visitors, with your product catalogue.",
                "EnableEmail": "True",
                "ShowEmail": "True",
                "EnableSMS": "True",
                "ShowMobile": "True",
                "EnableYouTubeVideo": "True",
                "EnableAppointment": "True",
                "EnableVideoMeeting": "True",
                "EnableWebsite": "True",
                "EnableRecordedMessages": "True",
                "EnableReport": "False",
                "YouTubeRepeatOne": "TimeOut",
                "EnableBrowserLock": "False",
                "EnableVideoLock": "False",
                "AddOns": []
            },
            {
                "ItemID": 2,
                "MainMenu": "Soft Drinks",
                "SubMenu": "",
                "InnerSubMenu": "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "",
                "ImageTitle": "SoftDrinks.png",
                "ItemType": "SubMenu",
                "AgeRestricted": false,
                "GenderRestricted": 'Male',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "EItemID": 30991,
                "AppointmentTimeRegion": "GMT+4",
                "AppointmentFromDate": "15-09-2021",
                "AppointmentToDate": "31-12-2022",
                "AppoinmentPeriod": "15",
                "AppointmentFromTime": "08:00:00",
                "AppointmentToTime": "20:00:00",
                "AppointmentOnSun": "True",
                "AppointmentOnMon": "True",
                "AppointmentOnTue": "True",
                "AppointmentOnWed": "True",
                "AppointmentOnThu": "True",
                "AppointmentOnFri": "True",
                "AppointmentOnSat": "True",
                "VideoTimeRegion": "GMT+4",
                "VideoFromDate": "15-09-2021",
                "VideoToDate": "31-12-2030",
                "VideoPeriod": "15",
                "VideoFromTime": "08:00:00",
                "VideoToTime": "20:00:00",
                "VideoOnSun": "True",
                "VideoOnMon": "True",
                "VideoOnTue": "True",
                "VideoOnWed": "True",
                "VideoOnThu": "True",
                "VideoOnFri": "True",
                "VideoOnSat": "True",
                "RobotSpeechItemDetails": "Here you can have your company Introduction, show your company mobile number, email, website or video, send sms and email to visitors, with your product catalogue.",
                "EnableEmail": "True",
                "ShowEmail": "True",
                "EnableSMS": "True",
                "ShowMobile": "True",
                "EnableYouTubeVideo": "True",
                "EnableAppointment": "True",
                "EnableVideoMeeting": "True",
                "EnableWebsite": "True",
                "EnableRecordedMessages": "True",
                "EnableReport": "False",
                "YouTubeRepeatOne": "TimeOut",
                "EnableBrowserLock": "False",
                "EnableVideoLock": "False",
                "AddOns": []
            },
            {
                "ItemID": 3,
                "MainMenu": "XYZ Drink",
                "SubMenu": "",
                "InnerSubMenu": "",
                "ItemName": "",
                "ItemPrice": 100.00,
                "ItemDiscount": 10.00,
                "DiscountAMT": 10.00,
                "ItemCost": 90.00,
                "ItemTAX": 5.00,
                "TaxAMT": 4.50,
                "GrandTotal": 94.50,
                "ItemDetails": "XYZ Drink is good for the health.",
                "ImageTitle": "XYZDrink.png",
                "ItemType": "Item",
                "AgeRestricted": false,
                "GenderRestricted": 'Female',
                "MuslimRestricted": false,
                "OrderBy": 1000,
                "EmailItem": "example@experthubrobotics.com",
                "MeetingItem": "http://example.com",
                "MobileItem": "9173914832",
                "WebsiteLink": "http://example.com?abc=abc",
                "YouTubeLink": "http://youtube.com?abc=abc",
                "EItemID": 30991,
                "AppointmentTimeRegion": "GMT+4",
                "AppointmentFromDate": "15-09-2021",
                "AppointmentToDate": "31-12-2022",
                "AppoinmentPeriod": "15",
                "AppointmentFromTime": "08:00:00",
                "AppointmentToTime": "20:00:00",
                "AppointmentOnSun": "True",
                "AppointmentOnMon": "True",
                "AppointmentOnTue": "True",
                "AppointmentOnWed": "True",
                "AppointmentOnThu": "True",
                "AppointmentOnFri": "True",
                "AppointmentOnSat": "True",
                "VideoTimeRegion": "GMT+4",
                "VideoFromDate": "15-09-2021",
                "VideoToDate": "31-12-2030",
                "VideoPeriod": "15",
                "VideoFromTime": "08:00:00",
                "VideoToTime": "20:00:00",
                "VideoOnSun": "True",
                "VideoOnMon": "True",
                "VideoOnTue": "True",
                "VideoOnWed": "True",
                "VideoOnThu": "True",
                "VideoOnFri": "True",
                "VideoOnSat": "True",
                "RobotSpeechItemDetails": "Here you can have your company Introduction, show your company mobile number, email, website or video, send sms and email to visitors, with your product catalogue.",
                "EnableEmail": "True",
                "ShowEmail": "True",
                "EnableSMS": "True",
                "ShowMobile": "True",
                "EnableYouTubeVideo": "True",
                "EnableAppointment": "True",
                "EnableVideoMeeting": "True",
                "EnableWebsite": "True",
                "EnableRecordedMessages": "True",
                "EnableReport": "False",
                "YouTubeRepeatOne": "TimeOut",
                "EnableBrowserLock": "False",
                "EnableVideoLock": "False",
                "AddOns": [
                    {
                        "AddONID": 1,
                        "AddON": "Diet",
                        "PriceAddON": 5.00,
                        "ItemDiscount": 0.0,
                        "DiscountAMT": 0.0,
                        "ItemCost": 5.00,
                        "ItemTAX": 0.0,
                        "TaxAMT": 0.0,
                        "GrandTotal": 5.00,
                        "AddONImage": "",
                        "AddONDetails": "XYZ Drink is best for the health."
                    },
                    {
                        "AddONID": 2,
                        "AddON": "Cold",
                        "PriceAddON": 2.00,
                        "ItemDiscount": 0.0,
                        "DiscountAMT": 0.0,
                        "ItemCost": 2.00,
                        "ItemTAX": 0.0,
                        "TaxAMT": 0.0,
                        "GrandTotal": 2.00,
                        "AddONImage": "",
                        "AddONDetails": "XYZ Drink is best for the health."
                    }
                ]
            }
        ],
    "Messages": [
            {
                "ID": 1,
                
                "Trigger": "Corporate Email",
                "MessageCode": 400,
                "MessageStatus": "Fail",
                "RobotSpeech": "Enter your Corporate Email",
                "Message": "Please enter a valid Corporate Email",
                "Validation": "0.000"
                
            }
        ],
    "Demographic": [
            {
                "ID": 1,
                "Title": "Customer Demographics",
                "Name": "I am Individual",
                "Image": "user.png",
                "OrderBy": 1
            },
            {
                "ID": 2,
                "Title": "Customer Demographics",
                "Name": "I am Corporate",
                "Image": "corporate.png",
                "OrderBy": 2
            }
        ]
    }
]

Example(Unauthorized/ Expired Login)

Request

POST

api/V2/Menu/Items?RobotID=1&ClientID=1&AppSoftwareType=6&Language=1&Email=test@test.com

Additional Header Parameters

auth : "c335bd96-3d99-36cd-b34d-d9b0b027920f"

Response Body

401

[
    {
        "Code": "403",
        "Message": "Unauthorized Request, invalid authentication token."
    }
]

Example(Not Found)

Request

POST

api/V2/Menu/Items?RobotID=1&ClientID=1&AppSoftwareType=6&Language=1&Email=test@test.com

Additional Header Parameters

auth : ""

if auth not supply / empty.

Response Body

404

[
    {
        "Code": "400",
        "Message": "authentication token Not Found."
    }
]

Example(No Item)

Request

POST

api/V2/Menu/Items?RobotID=1&ClientID=1&AppSoftwareType=6&Language=1&Email=test@test.com

Additional Header Parameters

auth : "c335bd96-3d99-36cd-b34d-d9b0b027920f"

Response Body

404

[
    {
        "Code": "404",
        "Message": "Not Found, No product / item Found in account."
    }
]

Example(Null / Empty Peram)

Request

POST

api/V2/Menu/Items?RobotID=1&ClientID=&AppSoftwareType=6

Additional Header Parameters

auth : "c335bd96-3d99-36cd-b34d-d9b0b027920f"

Response Body

400

[
    {
        "Code": "400",
        "Message": "Mandatory parameters cannot empty or null."
    }
]