| POST | /query/create |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Query | body | Query | No | |
| Partners | body | Partners | No | |
| QueryMessages | body | QueryMessage | No | |
| CurrentDateTime | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserId | form | int | No | |
| UserName | form | string | No | |
| AdminId | form | int | No | |
| AdminName | form | string | No | |
| PartnerName | form | string | No | |
| PartnerId | form | int | No | |
| QueryCategory | form | string | No | |
| QuerySentTime | form | DateTime? | No | |
| InitialSendTime | form | string | No | |
| MostRecentUpdatedTime | form | string | No | |
| HasBeenAnswered | form | bool? | No | |
| QueryStatus | form | string | No | |
| QueryMessages | form | List<QueryMessage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No | |
| SentBy | form | string | No | |
| UpdatedAt | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| PartnerName | form | string | No | |
| RegNo | form | string | No | |
| FspNo | form | string | No | |
| LandobyteName | form | string | No | |
| ShortName | form | string | No | |
| IsSubAdvisor | form | string | No | |
| ParentPartner | form | string | No | |
| Address | form | string | No | |
| Suburb | form | string | No | |
| City | form | string | No | |
| Province | form | string | No | |
| PostalCode | form | string | No | |
| PartnerContactNumber | form | string | No | |
| WebsiteUrl | form | string | No | |
| MainContact | form | string | No | |
| ContactEmail | form | string | No | |
| ContactMobile | form | string | No | |
| PartnerLogoUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | bool | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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.fxlink.co.za
Accept: text/jsv
Content-Type: text/jsv
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
}
]
},
partners:
{
id: 0,
partnerName: String,
regNo: String,
fspNo: String,
landobyteName: String,
shortName: String,
isSubAdvisor: String,
parentPartner: String,
address: String,
suburb: String,
city: String,
province: String,
postalCode: String,
partnerContactNumber: String,
websiteUrl: String,
mainContact: String,
contactEmail: String,
contactMobile: String,
partnerLogoUrl: String
},
queryMessages:
{
message: String,
sentBy: String,
updatedAt: String
},
currentDateTime: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result: False,
message: String
}