JSON Form Submission
Use POST api/v1.0/rfq
To submit using the JSON form submission you need to do the following steps:
- Build a QuoteSubmit object
- Build a list of QuoteSubmitItems, one for EACH question in the form
| Field | Source | Description |
|---|---|---|
| ID | QuoteField.IdentityTag | This value is obtained from the QuoteField used to build the form |
| Value | The User | The information the user filled in / selected |
| Tag | QuoteField.QuestionTag | This value is obtained from the QuoteField used to build the form |
| Type | QuoteSection.Name | This value is obtained from the QuoteSection used to build the form |
| Item | QuoteSection.RiskSectionIndex | This value is obtained from the QuoteSection used to build the form |
| Identity | Hard Code | For a new Request this should always by '0' |
| Changed | Hard Code | For a new Request this should always be 'true' |
QE XML Format v3.5
The basic XML format is as follows
-<Request>-<Header><version>3.5</version><system>QE3.</system><source>QE3-DG</source><Instance>QE3</Instance><FormID>1</FormID><RequestType>1</RequestType><HostURL>Your Host URL</HostURL><ITCConsent>false</ITCConsent><clientID>11754</clientID><requestID>new</requestID></Header><People/><Values/></Request>
The "tags" mentioned below (The_questionTag) are obtained from QuoteField.QuestionTag
Each person element as follows
-<Person id="0"index="1"sequence="1"><The_questionTag id="0"question="The_questionID"changed="true">The_value</The_questionTag>-<Addresses>-<Address id="0"type="1"changed="true"><area>1</area><number>1</number><street>Shurch street</street><suburbID>0001:Suburb_Name</suburbID></Address></Addresses>-<Licenses>-<License id="0"changed="true"><code id="4">EB</code><Issued>1 Jan 2020</Issued><Expires>1 Jan 2025</Expires></License></Licenses>-<NoClaims>-<NoClaim id="0"item="1"name="The_RiskItemName"changed="true"><Value>In Years</Value><Years>In Years</Years></NoClaim></NoClaims></Person>
Each value element as follows (with "The_RiskItemName" coming from QuoteSection.Name
-<The_RiskItemName id="1"><The_questionTag id="0"question="The_questionID"changed="true">The_value</The_questionTag></The_RiskItemName>
Response Information
Resource Description
Getting the new Request ID
ResultModel-of-String| Name | Description | Type | Additional information |
|---|---|---|---|
| status | string | None. | |
| message | string | None. | |
| identity | integer | None. | |
| result | string | None. |
Response Formats
application/json, text/json
Sample:
{
"status": "ok",
"message": "",
"identity": 3,
"result": ""
}
application/xml, text/xml
Sample:
<ResultModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Logic.Core.InterfaceModels"> <identity>3</identity> <message>sample string 2</message> <result>sample string 4</result> <status>sample string 1</status> </ResultModelOfstring>