POST Client/RequestPreCheck
Before Request Check
Request Information
URI Parameters
None.
Body Parameters
The service request object
ParaRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| NeedHelpLanguageId | integer |
None. |
|
| RequestSituationCodeId | integer |
None. |
|
| AdditionalInfo | string |
None. |
|
| FromLanguage | integer |
None. |
|
| RelatedVersionCode | string |
None. |
|
| ApplicationCompanyCode | string |
None. |
|
| DeviceTypeCodeId | integer |
None. |
|
| ApplicationTypeCodeId | integer |
None. |
|
| BJCVRIEntityNumber | string |
None. |
|
| BJCVRIDepartmentPinNumber | string |
None. |
|
| RequestLocation | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"NeedHelpLanguageId": 1,
"RequestSituationCodeId": 2,
"AdditionalInfo": "sample string 3",
"FromLanguage": 1,
"RelatedVersionCode": "sample string 4",
"ApplicationCompanyCode": "sample string 5",
"DeviceTypeCodeId": 1,
"ApplicationTypeCodeId": 1,
"BJCVRIEntityNumber": "sample string 6",
"BJCVRIDepartmentPinNumber": "sample string 7",
"RequestLocation": "sample string 8"
}
application/xml, text/xml
Sample:
<ParaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <AdditionalInfo>sample string 3</AdditionalInfo> <ApplicationCompanyCode>sample string 5</ApplicationCompanyCode> <ApplicationTypeCodeId>1</ApplicationTypeCodeId> <BJCVRIDepartmentPinNumber>sample string 7</BJCVRIDepartmentPinNumber> <BJCVRIEntityNumber>sample string 6</BJCVRIEntityNumber> <DeviceTypeCodeId>1</DeviceTypeCodeId> <FromLanguage>1</FromLanguage> <NeedHelpLanguageId>1</NeedHelpLanguageId> <RelatedVersionCode>sample string 4</RelatedVersionCode> <RequestLocation>sample string 8</RequestLocation> <RequestSituationCodeId>2</RequestSituationCodeId> </ParaRequest>
Response Information
Resource Description
Returns the transaction server API URL. If null, the transaction server API URL will remain the same
ResultRequestPrecheck| Name | Description | Type | Additional information |
|---|---|---|---|
| CheckResult | string |
None. |
|
| CheckResultId | integer |
None. |
|
| DefaultProductName | string |
None. |
|
| DefaultProductDescription | string |
None. |
|
| ProductMoreOptionsUrl | string |
None. |
|
| AgreementUrl | string |
None. |
|
| ProductHtmlData | string |
None. |
|
| RequiredInputUrl | string |
None. |
|
| SkipProductPage | boolean |
None. |
|
| SkipSummaryPage | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"CheckResult": "sample string 1",
"CheckResultId": 2,
"DefaultProductName": "sample string 3",
"DefaultProductDescription": "sample string 4",
"ProductMoreOptionsUrl": "sample string 5",
"AgreementUrl": "sample string 6",
"ProductHtmlData": "sample string 7",
"RequiredInputUrl": "sample string 8",
"SkipProductPage": true,
"SkipSummaryPage": true
}
application/xml, text/xml
Sample:
<ResultRequestPrecheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <AgreementUrl>sample string 6</AgreementUrl> <CheckResult>sample string 1</CheckResult> <CheckResultId>2</CheckResultId> <DefaultProductDescription>sample string 4</DefaultProductDescription> <DefaultProductName>sample string 3</DefaultProductName> <ProductHtmlData>sample string 7</ProductHtmlData> <ProductMoreOptionsUrl>sample string 5</ProductMoreOptionsUrl> <RequiredInputUrl>sample string 8</RequiredInputUrl> <SkipProductPage>true</SkipProductPage> <SkipSummaryPage>true</SkipSummaryPage> </ResultRequestPrecheck>