| GET | /partners/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | Partners | 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 |
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.
GET /partners/{Id} HTTP/1.1
Host: api.fxhub.co.za
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
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
}
}