FxHubPartnersApi

<back to all web services

CreateQuery

Requires Authentication
The following routes are available for this service:
POST/query/create
CreateQuery Parameters:
NameParameterData TypeRequiredDescription
QuerybodyQueryNo
PartnersbodyPartnersNo
QueryMessagesbodyQueryMessageNo
CurrentDateTimebodystringNo
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
Partners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerNameformstringNo
RegNoformstringNo
FspNoformstringNo
LandobyteNameformstringNo
ShortNameformstringNo
IsSubAdvisorformstringNo
ParentPartnerformstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
PartnerContactNumberformstringNo
WebsiteUrlformstringNo
MainContactformstringNo
ContactEmailformstringNo
ContactMobileformstringNo
PartnerLogoUrlformstringNo
CreateQueryResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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.

POST /query/create HTTP/1.1 
Host: api.fxhub.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <CurrentDateTime>String</CurrentDateTime>
  <Partners xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:City>String</d2p1:City>
    <d2p1:ContactEmail>String</d2p1:ContactEmail>
    <d2p1:ContactMobile>String</d2p1:ContactMobile>
    <d2p1:FspNo>String</d2p1:FspNo>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsSubAdvisor>String</d2p1:IsSubAdvisor>
    <d2p1:LandobyteName>String</d2p1:LandobyteName>
    <d2p1:MainContact>String</d2p1:MainContact>
    <d2p1:ParentPartner>String</d2p1:ParentPartner>
    <d2p1:PartnerContactNumber>String</d2p1:PartnerContactNumber>
    <d2p1:PartnerLogoUrl>String</d2p1:PartnerLogoUrl>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:Province>String</d2p1:Province>
    <d2p1:RegNo>String</d2p1:RegNo>
    <d2p1:ShortName>String</d2p1:ShortName>
    <d2p1:Suburb>String</d2p1:Suburb>
    <d2p1:WebsiteUrl>String</d2p1:WebsiteUrl>
  </Partners>
  <Query xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:AdminId>0</d2p1:AdminId>
    <d2p1:AdminName>String</d2p1:AdminName>
    <d2p1:HasBeenAnswered>false</d2p1:HasBeenAnswered>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:InitialSendTime>String</d2p1:InitialSendTime>
    <d2p1:MostRecentUpdatedTime>String</d2p1:MostRecentUpdatedTime>
    <d2p1:PartnerId>0</d2p1:PartnerId>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:QueryCategory>String</d2p1:QueryCategory>
    <d2p1:QueryMessages>
      <d2p1:QueryMessage>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:SentBy>String</d2p1:SentBy>
        <d2p1:UpdatedAt>String</d2p1:UpdatedAt>
      </d2p1:QueryMessage>
    </d2p1:QueryMessages>
    <d2p1:QuerySentTime>0001-01-01T00:00:00</d2p1:QuerySentTime>
    <d2p1:QueryStatus>String</d2p1:QueryStatus>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:UserName>String</d2p1:UserName>
  </Query>
  <QueryMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:Message>String</d2p1:Message>
    <d2p1:SentBy>String</d2p1:SentBy>
    <d2p1:UpdatedAt>String</d2p1:UpdatedAt>
  </QueryMessages>
</CreateQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Message>String</Message>
  <Result>false</Result>
</CreateQueryResponse>