FxHubPartnersApi

<back to all web services

GetClientReplies

Requires Authentication
The following routes are available for this service:
GET/notification/client_reply
GetClientReplies Parameters:
NameParameterData TypeRequiredDescription
NotificationTypequerystringNo
GetClientRepliesResponse Parameters:
NameParameterData TypeRequiredDescription
TotalUnreadformintNo
ResultformList<ClientNotification>No
MessageformstringNo
ClientNotification Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ChannelformstringNo
SentByUserIdformintNo
SentByUserNameformstringNo
SentDateformDateTime?No
SentTimeformstringNo
ReplyByUserIdformintNo
ReplyByUserNameformstringNo
ReplyDateformDateTime?No
ReplyTimeformstringNo
ClientNameformstringNo
MessageformstringNo
NotificationTypeformstringNo
HasRepliedformbool?No
ClientIdformint?No
SentToIdformintNo

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

HTTP + XML

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

GET /notification/client_reply HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetClientRepliesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Message>String</Message>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:ClientNotification>
      <d2p1:Channel>String</d2p1:Channel>
      <d2p1:ClientId>0</d2p1:ClientId>
      <d2p1:ClientName>String</d2p1:ClientName>
      <d2p1:HasReplied>false</d2p1:HasReplied>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:NotificationType>String</d2p1:NotificationType>
      <d2p1:ReplyByUserId>0</d2p1:ReplyByUserId>
      <d2p1:ReplyByUserName>String</d2p1:ReplyByUserName>
      <d2p1:ReplyDate>0001-01-01T00:00:00</d2p1:ReplyDate>
      <d2p1:ReplyTime>String</d2p1:ReplyTime>
      <d2p1:SentByUserId>0</d2p1:SentByUserId>
      <d2p1:SentByUserName>String</d2p1:SentByUserName>
      <d2p1:SentDate>0001-01-01T00:00:00</d2p1:SentDate>
      <d2p1:SentTime>String</d2p1:SentTime>
      <d2p1:SentToId>0</d2p1:SentToId>
    </d2p1:ClientNotification>
  </Result>
  <TotalUnread>0</TotalUnread>
</GetClientRepliesResponse>