FxHubPartnersApi

<back to all web services

AdminQueryChat

Requires Authentication
The following routes are available for this service:
PUT/query/chat_admin
AdminQueryChat Parameters:
NameParameterData TypeRequiredDescription
QuerybodyQueryNo
Query Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserIdformintNo
UserNameformstringNo
AdminIdformintNo
AdminNameformstringNo
PartnerNameformstringNo
PartnerIdformintNo
QueryCategoryformstringNo
QuerySentTimeformDateTime?No
InitialSendTimeformstringNo
MostRecentUpdatedTimeformstringNo
HasBeenAnsweredformbool?No
QueryStatusformstringNo
QueryMessagesformList<QueryMessage>No
QueryMessage Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SentByformstringNo
UpdatedAtformstringNo
AdminQueryChatResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /query/chat_admin HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"query":{"id":0,"userId":0,"userName":"String","adminId":0,"adminName":"String","partnerName":"String","partnerId":0,"queryCategory":"String","querySentTime":"0001-01-01","initialSendTime":"String","mostRecentUpdatedTime":"String","hasBeenAnswered":false,"queryStatus":"String","queryMessages":[{"message":"String","sentBy":"String","updatedAt":"String"}]}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":false,"message":"String"}