FxHubPartnersApi

<back to all web services

CreateClientNotificationToHomeChannel

Requires Authentication
The following routes are available for this service:
All Verbs/client_notification/create/home
CreateClientNotificationToHomeChannel Parameters:
NameParameterData TypeRequiredDescription
ChannelquerystringNo
SentByUserIdqueryintNo
SentByUserNamequerystringNo
SentDatequeryDateTime?No
SentTimequerystringNo
ReplyByUserIdqueryintNo
ReplyByUserNamequerystringNo
ReplyDatequeryDateTime?No
ReplyTimequerystringNo
ClientNamequerystringNo
MessagequerystringNo
NotificationTypequerystringNo
HasRepliedquerybool?No
ClientIdqueryint?No
SentToIdqueryintNo
ClientNotificationqueryClientNotificationNo
ClientNotification Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ChannelformstringNo
SentByUserIdformintNo
SentByUserNameformstringNo
SentDateformDateTime?No
SentTimeformstringNo
ReplyByUserIdformintNo
ReplyByUserNameformstringNo
ReplyDateformDateTime?No
ReplyTimeformstringNo
ClientNameformstringNo
MessageformstringNo
NotificationTypeformstringNo
HasRepliedformbool?No
ClientIdformint?No
SentToIdformintNo
CreateClientNotificationToHomeChannelResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformClientNotificationNo
NotificationMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /client_notification/create/home HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"channel":"String","sentByUserId":0,"sentByUserName":"String","sentDate":"0001-01-01","sentTime":"String","replyByUserId":0,"replyByUserName":"String","replyDate":"0001-01-01","replyTime":"String","clientName":"String","message":"String","notificationType":"String","hasReplied":false,"clientId":0,"sentToId":0,"clientNotification":{"id":0,"channel":"String","sentByUserId":0,"sentByUserName":"String","sentDate":"0001-01-01","sentTime":"String","replyByUserId":0,"replyByUserName":"String","replyDate":"0001-01-01","replyTime":"String","clientName":"String","message":"String","notificationType":"String","hasReplied":false,"clientId":0,"sentToId":0}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"id":0,"channel":"String","sentByUserId":0,"sentByUserName":"String","sentDate":"0001-01-01","sentTime":"String","replyByUserId":0,"replyByUserName":"String","replyDate":"0001-01-01","replyTime":"String","clientName":"String","message":"String","notificationType":"String","hasReplied":false,"clientId":0,"sentToId":0},"notificationMessage":"String"}