POST api/Udf/UDFList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HighlightString	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:

{
  "HighlightString": "sample string 1",
  "UDFCode": "sample string 2",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:

<UDFListRequest 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>
  <HighlightString>sample string 1</HighlightString>
  <UDFCode>sample string 2</UDFCode>
</UDFListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UDFListQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of UDFListResult	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": [
    {
      "BillingFlag": true,
      "DisplayOnDispatchFlag": true,
      "DisplayOnSiteGroupSummaryFlag": true,
      "DisplayOnStagesMobileFlag": true,
      "ExcludeExternalFlag": true,
      "FunctionOption": "sample string 1",
      "HighlightFlag": true,
      "HighlightString": "sample string 2",
      "Label": "sample string 3",
      "SeqNum": 1,
      "UDFCode": "sample string 4",
      "UDFType": "sample string 5",
      "UDFTypeDescription": "sample string 6",
      "UDFUsage": "sample string 7"
    },
    {
      "BillingFlag": true,
      "DisplayOnDispatchFlag": true,
      "DisplayOnSiteGroupSummaryFlag": true,
      "DisplayOnStagesMobileFlag": true,
      "ExcludeExternalFlag": true,
      "FunctionOption": "sample string 1",
      "HighlightFlag": true,
      "HighlightString": "sample string 2",
      "Label": "sample string 3",
      "SeqNum": 1,
      "UDFCode": "sample string 4",
      "UDFType": "sample string 5",
      "UDFTypeDescription": "sample string 6",
      "UDFUsage": "sample string 7"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<UDFListQueryResult 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>
    <UDFListResult>
      <BillingFlag>true</BillingFlag>
      <DisplayOnDispatchFlag>true</DisplayOnDispatchFlag>
      <DisplayOnSiteGroupSummaryFlag>true</DisplayOnSiteGroupSummaryFlag>
      <DisplayOnStagesMobileFlag>true</DisplayOnStagesMobileFlag>
      <ExcludeExternalFlag>true</ExcludeExternalFlag>
      <FunctionOption>sample string 1</FunctionOption>
      <HighlightFlag>true</HighlightFlag>
      <HighlightString>sample string 2</HighlightString>
      <Label>sample string 3</Label>
      <SeqNum>1</SeqNum>
      <UDFCode>sample string 4</UDFCode>
      <UDFType>sample string 5</UDFType>
      <UDFTypeDescription>sample string 6</UDFTypeDescription>
      <UDFUsage>sample string 7</UDFUsage>
    </UDFListResult>
    <UDFListResult>
      <BillingFlag>true</BillingFlag>
      <DisplayOnDispatchFlag>true</DisplayOnDispatchFlag>
      <DisplayOnSiteGroupSummaryFlag>true</DisplayOnSiteGroupSummaryFlag>
      <DisplayOnStagesMobileFlag>true</DisplayOnStagesMobileFlag>
      <ExcludeExternalFlag>true</ExcludeExternalFlag>
      <FunctionOption>sample string 1</FunctionOption>
      <HighlightFlag>true</HighlightFlag>
      <HighlightString>sample string 2</HighlightString>
      <Label>sample string 3</Label>
      <SeqNum>1</SeqNum>
      <UDFCode>sample string 4</UDFCode>
      <UDFType>sample string 5</UDFType>
      <UDFTypeDescription>sample string 6</UDFTypeDescription>
      <UDFUsage>sample string 7</UDFUsage>
    </UDFListResult>
  </ResultSet>
</UDFListQueryResult>