POST api/Udf/UDFValueList
Request Information
URI Parameters
None.
Body Parameters
UDFRequestName | Description | Type | Additional information |
---|---|---|---|
KeyNum | integer |
None. |
|
KeyType | string |
None. |
|
UDFCode | string |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "KeyNum": 1, "KeyType": "sample string 1", "UDFCode": "sample string 2", "SessionNum": 3, "SessionPassword": "QEA=", "ApplicationCode": "sample string 4", "StagesURL": "sample string 5" }
application/xml, text/xml
Sample:
<UDFRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 5</StagesURL> <ApplicationCode>sample string 4</ApplicationCode> <SessionNum>3</SessionNum> <SessionPassword>QEA=</SessionPassword> <KeyNum>1</KeyNum> <KeyType>sample string 1</KeyType> <UDFCode>sample string 2</UDFCode> </UDFRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UDFValueListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of UDFValueListResult |
None. |
|
Success | boolean |
None. |
|
UserErrorMessage | string |
None. |
|
ErrorTypeNum | integer |
None. |
|
SqlConnectionLost | boolean |
None. |
|
ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ExcludeColumnList": [ "sample string 1", "sample string 2" ], "ResultSet": [ { "HighlightFlag": true, "HighlightString": "sample string 1", "KeyNum": 1, "KeyType": "sample string 2", "Label": "sample string 3", "Option": "sample string 4", "UDFCode": "sample string 5", "UDFValue": "sample string 6" }, { "HighlightFlag": true, "HighlightString": "sample string 1", "KeyNum": 1, "KeyType": "sample string 2", "Label": "sample string 3", "Option": "sample string 4", "UDFCode": "sample string 5", "UDFValue": "sample string 6" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<UDFValueListQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages"> <ClientVersion>sample string 5</ClientVersion> <ErrorTypeNum>3</ErrorTypeNum> <SqlConnectionLost>true</SqlConnectionLost> <Success>true</Success> <UserErrorMessage>sample string 2</UserErrorMessage> <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ExcludeColumnList> <ResultSet> <UDFValueListResult> <HighlightFlag>true</HighlightFlag> <HighlightString>sample string 1</HighlightString> <KeyNum>1</KeyNum> <KeyType>sample string 2</KeyType> <Label>sample string 3</Label> <Option>sample string 4</Option> <UDFCode>sample string 5</UDFCode> <UDFValue>sample string 6</UDFValue> </UDFValueListResult> <UDFValueListResult> <HighlightFlag>true</HighlightFlag> <HighlightString>sample string 1</HighlightString> <KeyNum>1</KeyNum> <KeyType>sample string 2</KeyType> <Label>sample string 3</Label> <Option>sample string 4</Option> <UDFCode>sample string 5</UDFCode> <UDFValue>sample string 6</UDFValue> </UDFValueListResult> </ResultSet> </UDFValueListQueryResult>