FxHubPartnersApi

<back to all web services

Download

Requires Authentication
The following routes are available for this service:
All Verbs/form/download
Download Parameters:
NameParameterData TypeRequiredDescription
FormTypequeryFormTypeNo
IdqueryintNo
FormType Enum:
Form265I
Form265A
Form266
DownloadResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
FileDataformbyte[]No

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

HTTP + JSV

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

POST /form/download HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	formType: Form265I,
	id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	fileData: AA==
}