extract API documentation version 1.0
$ROOT/extract where ROOT is e.g. https://www.whitespaceplatform.com or https://sandbox.whitespace.co.uk
The /extract endpoints run data extraction routines on a JMRC passed in.
At 18 January 2020 we are supporting this being run without credentials at the endpoint https://dev.whitespace.co.uk/extract so that we can iterate improvements. Your data is passed securely, and is not recorded on the server.
/all
extract specific data values by running text-extraction rules on the JMRC
post
post /all/
Body
Media type: application/json
Type:
{
"comment" : "a JMRC document, from e.g. /api/risks/$IC or /api/risks/$IC/getExtendedMRC"
}HTTP status code 200
Body
Media type: value
Type:
{
"brokerageDeductionsFromPremium": {
"totalPercentage": "25.5",
"desc": "25.5%",
"basis": "gross_premium"
},
"insured": {
"value": "Slingback Aviation Limited"
},
"reinsuredsRetention": {
"deductibleArray": [
{
"description": " The Insured shall bear the following amount in respect of each claim or series of claims arising out of any one Event:",
"type": "retention",
"basis": ""
},
{
"type": "retention",
"description": "The Insured shall bear the following amount in respect of each claim or series of claims arising out of any one Event:USD 250,000 each and every claim or series of claims arising out of any one Event. A series of events arising from one cause during any period of 72 consecutive hours shall be treated as one Event.",
"excessAmountCurrency": "USD",
"basis": "",
"excessAmount": "250000.00"
}
]
},
"inceptionDate": {
"periodStartDate": "2019-07-01T00:01:00",
"description": "From: 1 July 2019 To: 1 July 2020 Both days at 12.01 a.m. Local Standard Time at the location of the property insured. And any other period for which the Insurer and the Insured agree to renew the Policy.",
"periodStartTimezone": "local_standard_time"
},
"regulatoryClientClassification": {},
"bureauxArrangements": {
"value": "Broker Limited will submit de-linked accounts to Xchanging Ins-Sure Services Ltd (XIS) where possible.\n\nIn respect of any PPW, PPC, PPD or SDD the following apply:\n\nPremium payment requirements are deemed met by presentation of premium/accounts to XIS on or before the SDD and will not be recorded as a late signing or payment;\n\nThe SDD is deemed in all instances to be the same as the PPW, PPC or PPD due date;\n\nWhere the PPW, PPC or PPD has been updated then the SDD shall be deemed to be updated in parallel, unless otherwise stated to the contrary;\n\nThe PPW, PPC, PPD or SDD shall not be deemed to be breached if the original presentation of the electronic submission to XIS is in time, but subsequently amendments to the electronic submission are notified as being required to enable the premium signing to be completed. In such event Broker Limited shall have an additional period of seven days from such notification to complete the amendments and resubmit the electronic submission to XIS;\n\nWhere a PPW, PPC, PPD or SDD falls on a weekend or public holiday, presentation to XIS on the next working day will be deemed in compliance with the PPW, PPC, PPD or SDD.\n\n(Re)insurer(s) hereby agree that any premium payable in instalments under this contract will be processed as\n\ndelinked Additional Premium entries other than when submitted under the Deferred Account Scheme. However, any annual instalments to be allocated to respective year of account.\n\n(Re)insurer(s) authorise XIS to issue separate signing numbers and dates for their participations only and issue a single claims FDO signing where applicable.\n\nWhere payments are received by Broker Limited in convertible currencies, (re)insurer(s) agree to accept/settle accounts at rate(s) of exchange obtained by Broker Limited.\n\nIn respect of convertible currencies, (re)insurer(s) instruct XIS to accept settlement in any valid settlement currency as determined by Broker Limited.\n\nIn the event of this contract stating multiple insurance and/or reinsurance premiums (each to be paid from a different source); and/or separate entries/sections for taxation/regulation reporting purposes, XIS are instructed to leave the premium advice notes ungrouped so that each can be released separately once paid by the respective client.\n\nIn the event of partial premium received by Broker Limited, (re)insurer(s) agree to accept premium as paid to and endorsed by Broker Limited.\n\nXIS are authorised to sign premium from individual Insureds / territories / sections separately as and when received by Broker Limited.\n\n(Re)insurers agree that Broker Limited may settle premiums for this contract/release de-linked premium for this contract into settlement at different times."
},
"premium": {
"settlementDueDate": "2018-09-01",
"premiumArray": [
{
"percentage": "",
"currency": "USD",
"instalmentAmount": "",
"numberOfInstalments": "1",
"adjustable": false,
"type": "premium",
"amount": "5500000.00",
"description": "Section 1 : USD 5,500,000 (100%) Annual.\n\nSection 2: USD 4,500,000\n\nSection 3: USD 3,000,000",
"splitAmount": ""
}
]
},
"choiceOfLawAndJurisdiction": {
"countries": [],
"description": "Overseas Jurisdiction Clause:\n\nIt is hereby agreed that: -\n\nthis insurance shall be governed by the law of the Country named below whose Courts shall have jurisdiction in any dispute arising hereunder; and\n\nany summons, notice or process to be served upon the Underwriters for the purpose of instituting any legal proceedings against them in connection with this insurance may be served\n\nupon the person(s) nominated below who have authority to accept service on their behalf.\n\n23/7/64\n\nNMA1483",
"subentities": []
},
"addressOfInsured": {
"insuranceType": "insurance",
"addressCountrySubEntity": "",
"addressNumberAndStreet": "11 Amelia Earhart Way, Rongotai, Wellington 6003, New Zealand",
"addressCountry": "NZL",
"value": "11 Amelia Earhart Way, Rongotai, Wellington 6003, New Zealand"
},
"UMR": {
"value": "B1740AHL0511X1636"
},
"coverType": {
"value": "facultative_non_proportional"
},
"expertsFeesCollection": {
"value": "Broker Limited will not undertake the collection of any fee invoices rendered by third parties unless in Broker Limited’s view the fees form part of the (Re)Insured’s claim or the work is for the exclusive benefit of the (Re)Insured. As an example of this, Broker Limited will not collect loss adjusters’ fees or the fees of coverage counsel.\n\nBroker Limited will hold all monies which client monies are not (e.g.: Loss Adjuster’s fees, Salvage recoveries and engineering fees) on behalf of the (re)insurers."
},
"conditions": {
"value": "Wording as agreed by Slip Leader.\n\nDeductibles:\n\nHull All Risks:\n\nApplicable to each and every claim other than total loss/ constructive total loss/ arranged total loss: -\n\nAircraft type: Boeing 777X\n\nAmount: USD 200,000\n\nNevertheless, in the event of an incident arising hereon involving the application of more than one deductible, then only one deductible shall apply (being the highest applicable) as an aggregate deductible for all losses arising out of that incident.\n\nLiabilities:\n\nPassenger Baggage: USD 5,000 any one claim.\n\nCargo Liability: USD 10,000 any one claim.\n\nIs not applicable to claims when arising out of fire, wind, tornado, cyclone, typhoon, flood, hail, theft, lightning, explosion, earthquake or tidal wave, or to claims arising out of an accident to the carrying aircraft or conveyance.\n\nIs not applicable to claims arising under the Extended Coverage Endorsement (Aviation Liabilities) AVN52E, or to claims arising out of an accident to the carrying aircraft or conveyance.\n\nUnearned Premium Insurance.\n\nNon-Aviation Liability Clause AVN59\n\nSeverability of Interest Clause as per form.\n\n5 Day(s) missing Aircraft Clause.\n\n50/50 Provisional Claims Settlement Clause AVS 103.\n\nNuclear Risks Exclusion Clause AVN38B.\n\nNoise and Pollution and other Perils Exclusion Clause AVN46B, not applicable to hull or spares claims and to liability claims to passengers, baggage, cargo or mail and with paragraph 1(b) not applicable to pollution or contamination of products sold or supplied by the Insured.\n\nWar, Hijacking and Other Perils Exclusion Clause (Aviation) AVN48B but in respect of liability coverage, agree to delete all paragraphs other than (b) subject to the Extended Coverage Endorsement (Aviation Liabilities) AVN52E paragraph 3 sub limit, as specified in the Liabilities Sum Insured.\n\nContracts (Rights of Third Parties) Act 1999 Exclusion Clause AVN72.\n\nDate Recognition Exclusion Clause AVN2000A. Date Recognition Limited Coverage Clause AVN2001A.\n\nAsbestos Exclusion Clause 2488AGM00003 (applicable to Liabilities coverage only)."
},
"insuredPerson": {
"value": "Slingback Aviation Limited"
},
"situationTerritorialScope": {
"excludedSupraentities": [],
"includedCountries": [],
"excludedCountries": [],
"excludedSubentities": [],
"includedSupraentities": [],
"description": "Worldwide"
},
"claimsAdministration": {
"value": "Broker Limited and (re)insurer(s) agree that any claims hereunder (including any claims related costs/fees) will be notified and administered via ECF with any payment(s) processed via CLASS, unless both parties agree to do otherwise and/or IUA Claims Agreement Practices as required."
},
"basisOfSignedLines": {
"value": "percentage_of_whole"
},
"declaredValues": {
"limitArray": [
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Liabilities: Combined Single Limit: (Bodily Injury/ Property Damage/ Personal Injury) USD 100,000,000 any one occurrence / aircraft subject to",
"coverageAmount": "100000000.00",
"coverageType": "sum_insuredtotal"
},
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Hull All Risks: Agreed Values as per Schedule subject to a maximum of USD 20,000,000 any one Aircraft.",
"coverageAmount": "20000000.00",
"coverageType": "sum_insuredtotal"
}
]
},
"basisOfClaimsAgreement": {
"value": "Claims to be managed in accordance with:\n\n-\n\nThe Lloyd’s Claims Scheme (Combined), or as amended or any successor thereto. The applicable Scheme/part will be determined by the rules and scope of the Scheme(s);\n\n-\n\nIUA claims agreement practices;\n\n-\n\nThe practices of any (re)insurer(s) electing to agree claims in respect of their own participation.\n\n-\n\nUnless otherwise detailed in the Risk Details, the Slip Leader may instruct any third-party expert to investigate and adjust any claim or circumstance\n\nnotified to the contract."
},
"totalValue": {
"limitArray": [
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Liabilities: Combined Single Limit: (Bodily Injury/ Property Damage/ Personal Injury) USD 100,000,000 any one occurrence / aircraft subject to",
"coverageAmount": "100000000.00",
"coverageType": "sum_insuredtotal"
},
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Hull All Risks: Agreed Values as per Schedule subject to a maximum of USD 20,000,000 any one Aircraft.",
"coverageAmount": "20000000.00",
"coverageType": "sum_insuredtotal"
}
]
},
"basisOfWrittenLines": {
"basis": "percentage_of_whole"
},
"recordingTransmittingStoringInformation": {
"value": "Broker Limited may retain risk and claim data / information / documents electronically, and where this is done these documents shall be regarded with the same Legal effect as the original documents."
},
"contractType": {
"value": "direct_insurance_contract"
},
"indemnityPeriod": {
"limitArray": [
{
"coverageBasis": "month",
"coverageNumberOfUnits": "24",
"coverageDescription": "The period during which the results of the Business are affected in consequence of the Damage, beginning with the occurrence of the Damage and ending not more than 24 Months later.",
"coverageType": "sum_insuredtotal"
}
]
},
"noticeOfClaims": {
"value": "Overseas Jurisdiction Clause:\n\nIt is hereby agreed that: -\n\nthis insurance shall be governed by the law of the Country named below whose Courts shall have jurisdiction in any dispute arising hereunder; and\n\nany summons, notice or process to be served upon the Underwriters for the purpose of instituting any legal proceedings against them in connection with this insurance may be served\n\nupon the person(s) nominated below who have authority to accept service on their behalf.\n\n23/7/64\n\nNMA1483"
},
"rulesAndExtentOfAnyOtherDelegatedClaimsAuthority": {
"value": "None, unless otherwise specified here by any of the claim agreement parties shown above."
},
"serviceOfSuit": {
"value": "Overseas Jurisdiction Clause:\n\nIt is hereby agreed that: -\n\nthis insurance shall be governed by the law of the Country named below whose Courts shall have jurisdiction in any dispute arising hereunder; and\n\nany summons, notice or process to be served upon the Underwriters for the purpose of instituting any legal proceedings against them in connection with this insurance may be served\n\nupon the person(s) nominated below who have authority to accept service on their behalf.\n\n23/7/64\n\nNMA1483"
},
"supplementalClauses": {
"clauses": [
{
"reference": "",
"description": "Non-Aviation Liability Clause AVN59"
},
{
"description": "Severability of Interest Clause as per form.",
"reference": ""
},
{
"description": "5 Day(s) missing Aircraft Clause.",
"reference": ""
},
{
"reference": "",
"description": "50/50 Provisional Claims Settlement Clause AVS 103."
},
{
"reference": "",
"description": "Nuclear Risks Exclusion Clause AVN38B."
},
{
"reference": "",
"description": "Noise and Pollution and other Perils Exclusion Clause AVN46B, not applicable to hull or spares claims and to liability claims to passengers, baggage, cargo or mail and with paragraph 1(b) not applicable to pollution or contamination of products sold or supplied by the Insured."
},
{
"description": "War, Hijacking and Other Perils Exclusion Clause (Aviation) AVN48B but in respect of liability coverage, agree to delete all paragraphs other than (b) subject to the Extended Coverage Endorsement (Aviation Liabilities) AVN52E paragraph 3 sub limit, as specified in the Liabilities Sum Insured.",
"reference": ""
},
{
"description": "Contracts (Rights of Third Parties) Act 1999 Exclusion Clause AVN72.",
"reference": ""
},
{
"description": "Date Recognition Exclusion Clause AVN2000A. Date Recognition Limited Coverage Clause AVN2001A.",
"reference": ""
},
{
"reference": "",
"description": "Asbestos Exclusion Clause 2488AGM00003 (applicable to Liabilities coverage only)."
}
]
},
"reinsurersLiability": {
"value": "(Re)insurer’s liability several not joint:\n\nThe liability of a (re)insurer under this contract is several and not joint with other (re)insurers party to this contract. A (re)insurer is liable only for the proportion of liability it has underwritten. A (re)insurer is not jointly liable for the proportion of liability underwritten by any other (re)insurer. Nor is a (re)insurer otherwise responsible for any liability of any other (re)insurer that may underwrite this contract.\n\nThe proportion of liability under this contract underwritten by a (re)insurer (or, in the case of a Lloyd’s syndicate, the total of the proportions underwritten by all the members of the syndicate taken together) is shown next to its stamp. This is subject always to the provision concerning “signing” below.\n\nIn the case of a Lloyd’s syndicate, each member of the syndicate (rather than the syndicate itself) is a (re)insurer. Each member has underwritten a proportion of the total shown for the syndicate (that total itself being the total of the proportions underwritten by all the members of the syndicate taken together). The liability of each member of the syndicate is several and not joint with other members. A member is liable only for that member’s proportion. A member is not jointly liable for any other member’s proportion. Nor is any member otherwise responsible for any liability of any other (re)insurer that may underwrite this contract. The business address of each member is Lloyd’s, One Lime Street, London EC3M 7HA. The identity of each member of a Lloyd’s syndicate and their respective proportion may be obtained by writing to Market Services, Lloyd’s, at the above address.\n\nProportion of liability:\n\nUnless there is “signing” (see below), the proportion of liability under this contract underwritten by each (re)insurer (or, in the case of a Lloyd’s syndicate, the total of the proportions underwritten by all the members of the syndicate taken together) is shown next to its stamp and is referred to as its “written line”.\n\nWhere this contract permits, written lines, or certain written lines, may be adjusted (“signed”). In that case a schedule is to be appended to this contract to show the definitive proportion of liability under this contract underwritten by each (re)insurer (or, in the case of a Lloyd’s syndicate, the total of the proportions underwritten by all the members of the syndicate taken together). A definitive proportion (or, in the case of a Lloyd’s syndicate, the total of the proportions underwritten by all the members of a Lloyd’s syndicate taken together) is referred to as a “signed line”. The signed lines shown in the schedule will prevail over the written lines. Although reference is made at various points in this clause to “this contract” in the singular, where the circumstances so require this should be read as a reference to contracts in the plural.\n\nLMA3333 (amended)",
"liabilityClause": "several_liability_clause"
},
"taxes": {
"taxesPayableByInsuredAndAdministeredByInsurers": [
{
"taxType": "",
"typeDescription": "None",
"taxClass": ""
}
],
"taxPayableByInsurers": [
{
"taxType": "",
"typeDescription": "Nil",
"taxClass": ""
}
]
},
"signingProvisions": {
"value": "In the event that the written lines hereon exceed 100% of the order, any lines written “to stand” will be allocated in full and all other lines will be signed down in equal proportions so that the aggregate signed lines are equal to 100% of the order without further agreement of any of the (re)insurers.\n\nHowever:\n\nin the event that the placement of the order is not completed by the commencement date of the period of insurance then all lines written by that date will be signed in full;\n\nthe (re)insured may elect for the disproportionate signing of (re)insurers’ lines, without further specific agreement of (re)insurers, providing that any such variation is made prior to the commencement date of the period of insurance, and that lines written “to stand” may not be varied without the documented agreement of those (re)insurers.\n\nThe signed lines resulting from the application of the above provisions can be varied, before or after the commencement date of the period of insurance, by the documented agreement of the (re)insured and all (re)insurers whose lines are to be varied. The variation to the contracts will take effect only when all such (re)insurers have agreed, with the resulting variation in signed lines commencing from the date set out in that agreement."
},
"nonBureauxArrangements": {
"value": "Where a PPW, PPC, PPD or SDD falls on a weekend or public holiday, presentation to (re)insurer(s) hereon as applicable on the next working day will be deemed in compliance with the PPW, PPC, PPD or SDD.\n\nWhere payments are received by Broker Limited in convertible currencies, (re)insurer(s) agree to accept/settle accounts at rate(s) of exchange obtained by Broker Limited.\n\nIn respect of convertible currencies, (re)insurer(s) agree to accept settlement in any valid settlement currency as determined by Broker Limited.\n\nIn the event of partial premium received by Broker Limited, (re)insurer(s) agree to accept premium as paid to and\n\nendorsed by Broker Limited."
},
"overseasBroker": {
"value": "Western Broking Union Pacific, 104 Made Up St,\n\nSeattle,\n\nWA\n\nUSA"
},
"expiryDate": {
"description": "From: 1 July 2019 To: 1 July 2020 Both days at 12.01 a.m. Local Standard Time at the location of the property insured. And any other period for which the Insurer and the Insured agree to renew the Policy.",
"period_end_timezone": "local_standard_time",
"period_end_date": "2020-07-01T00:01:00"
},
"interest": {
"value": "Hull All Risks: Aircraft as per schedule against all risks of loss or damage\n\nReg Aircraft Type Config Delivered No. Age\n\nC-FYJI Airbus A319-100 C14Y106 May-97 258 21.0 Years\n\nC-FYKC Airbus A319-100 C14Y106 Jun-97 222 20.9 Years\n\nC-FYKR Airbus A319-100 C14Y106 Jul-97 261 20.9 Years\n\nC-FZUH Airbus A319-100 C14Y106 Aug-97 264 20.8 Years\n\nC-FZUJ Airbus A319-100 C14Y106 Sep-97 265 20.7 Years\n\nC-FZUL Airbus A319-100 C14Y106 Sep-97 266 20.7 Years\n\nC-GAPY Airbus A319-100 C14Y106 Oct-97 267 20.6 Years\n\nC-GAQL Airbus A319-100 C14Y106 Oct-97 268 20.6 Years\n\nC-GAQX Airbus A319-100 C14Y106 Oct-97 269 20.6 Years\n\nC-GAQZ Airbus A319-100 C14Y106 Jun-15 270 20.6 Years\n\nC-GARG Airbus A319-100 C14Y106 Nov-97 271 20.5 Years\n\nC-GBHM Airbus A319-100 C14Y106 Jan-98 274 20.4 Years\n\nC-GBIP Airbus A319-100 C14Y106 Apr-98 285 22.7 Years\n\nC-GITP Airbus A319-100 C14Y106 Aug-01 286 16.8 Years\n\nC-GITR Airbus A319-100 C14Y106 Sep-01 287 16.7 Years\n\nC-FDCA Airbus A320-200 C14Y132 Jun-12 405 26.8 Years\n\nC-FDQQ Airbus A320-200 C14Y132 Jan-90 201 28.5 Years\n\nC-FDQV Airbus A320-200 C14Y132 Feb-90 202 28.5 Years\n\nC-FDRH Airbus A320-200 C14Y132 Feb-90 203 28.5 Years\n\nC-FDRK Airbus A320-200 C14Y132 Mar-90 204 28.4 Years\n\nC-FDRP Airbus A320-200 C14Y132 Oct-90 205 27.7 Years\n\nC-FDSN Airbus A320-200 C14Y132 Nov-90 206 27.6 Years\n\nC-FDST Airbus A320-200 C14Y132 Nov-90 207 27.6 Years\n\nC-FDSU Airbus A320-200 C14Y132 Jan-91 208 27.5 Years\n\nC-FFWI Airbus A320-200 C14Y132 Feb-91 209 27.4 Years\n\nC-FFWJ Airbus A320-200 C14Y132 Feb-91 210 27.4 Years\n\nC-FFWM Airbus A320-200 C14Y132 Mar-91 211 27.3 Years\n\nC-FFWN Airbus A320-200 C14Y132 Mar-91 212 27.3 Years\n\nC-FGJI Airbus A320-200 C14Y132 Jan-15 241 16.1 Year\n\nC-FGKH Airbus A320-200 C14Y132 Feb-15 242 15.2 Years\n\nC-FGYL Airbus A320-200 C14Y132 Dec-91 218 26.6 Years\n\nC-FGYS Airbus A320-200 C14Y132 Dec-91 219 26.6 Years\n\nC-FKCK Airbus A320-200 C14Y132 Jan-92 220 26.5 Years\n\nC-FKCO Airbus A320-200 C14Y132 Feb-92 221 26.4 Years"
},
"otherDeductionsFromPremium": {
"totalPercentage": "2.5",
"desc": "Up to 2.50% of the gross premium in respect of survey or engineering fee as incurred, to be agreed slip leader only.",
"basis": "gross_premium"
},
"orderHereon": {},
"limitOfLiability": {
"limitArray": [
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Liabilities: Combined Single Limit: (Bodily Injury/ Property Damage/ Personal Injury) USD 100,000,000 any one occurrence / aircraft subject to",
"coverageAmount": "100000000.00",
"coverageType": "loss_limit"
},
{
"coverageAmountCurrency": "USD",
"coverageBasis": "",
"coverageBasisDescription": "",
"coverageDescription": "Hull All Risks: Agreed Values as per Schedule subject to a maximum of USD 20,000,000 any one Aircraft.",
"coverageAmount": "20000000.00",
"coverageType": "loss_limit"
}
]
},
"classOfBusiness": {
"description": "aviation",
"code": "aviation"
}
}
/gpm
create a Global Placing Message from a JMRC document
get
returns a version message
postgpmType : wsp or ppl brokerName : the person's name, known to PPL if gpmType = ppl brokerEmail : the person's email, known to PPL if gpmType = ppl receiverType : insurer or broker receiverName : the intended recipient company name lloydsID : the Lloyd's Syndicate Number or Broker Number DUNS : the DUNS company number, if lloydsID cannot be used
The input is a JMRC document, from e.g. /api/risks/$IC or /api/risks/$IC/getExtendedMRC
The queryString paramters are:
post /gpm/
The input is a JMRC document, from e.g. /api/risks/$IC or /api/risks/$IC/getExtendedMRC
The queryString paramters are:
Body
Media type: application/json
Type:
{
JMRC data
}
HTTP status code 200
Body
Media type: value
Type:
{
"messages": [
"the Acord standard Global Placing Message (GPM) in XML format"
]
}
/webconn
connect to WebConnectivity's gateway to send GPMs and PDFs
get
TODO
post
post
post /webconn/login
post
post
post
post /webconn/putfile
Body
Media type: application/json
Type:
{
"messages": [
"send the PDF file",
"with Content-Type application/pdf"
],
"queryStringParameters" : {
"SessionToken" : "token retrieved from login endpoint",
"DocumentId" : "from the sendgpm endpoint",
"DocumentReference" : "e.g. WSREF0001",
"DocumentVersion" : "e.g. 1.0"
}
}
HTTP status code 200
Body
Media type: value
Type:
{
"detail":"DocumentId:459488 MessageId:145900 Finished 1 ok, 0 errors ",
"message":"OK"
}
post
post /webconn/queuemessage
Body
Media type: application/json
Type:
{
"messages": [
"the payload is not used and can be merely {}"
],
"queryStringParameters" : {
"SessionToken" : "token retrieved from login endpoint",
"DocumentId" : "from the sendgpm endpoint"
}
}
HTTP status code 200
Body
Media type: value
Type:
{
"message": "OK",
"response": {
"ReturnId": "0",
"InError": "false"
}
}