POST api/Udf/UDFValueDetail

Request Information

URI Parameters

None.

Body Parameters

Name	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

UDFValueWithTypeDetailQueryResult

Name	Type	Additional information
ResultSet	Collection of UDFValueWithTypeDetailResult	None.
ExcludeColumnList	Collection of string	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5",
  "ResultSet": [
    {
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "Label": "sample string 3",
      "UDFCode": "sample string 4",
      "UDFDate": "2024-05-01T16:17:38.2864967-04:00",
      "UDFDescription": "sample string 5",
      "UDFDrop": "sample string 6",
      "UDFFlag": true,
      "UDFLookup": "sample string 7",
      "UDFNum": 1,
      "UDFValue": "sample string 8",
      "UDFType": "sample string 1"
    },
    {
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "Label": "sample string 3",
      "UDFCode": "sample string 4",
      "UDFDate": "2024-05-01T16:17:38.2864967-04:00",
      "UDFDescription": "sample string 5",
      "UDFDrop": "sample string 6",
      "UDFFlag": true,
      "UDFLookup": "sample string 7",
      "UDFNum": 1,
      "UDFValue": "sample string 8",
      "UDFType": "sample string 1"
    }
  ],
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<UDFValueWithTypeDetailQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <ClientVersion xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</ClientVersion>
  <ErrorTypeNum xmlns="http://schemas.datacontract.org/2004/07/Stages">3</ErrorTypeNum>
  <SqlConnectionLost xmlns="http://schemas.datacontract.org/2004/07/Stages">true</SqlConnectionLost>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Stages">true</Success>
  <UserErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Stages">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>
    <UDFValueWithTypeDetailResult>
      <KeyNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</KeyNum>
      <KeyType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</KeyType>
      <Label xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</Label>
      <UDFCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</UDFCode>
      <UDFDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2024-05-01T16:17:38.2864967-04:00</UDFDate>
      <UDFDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</UDFDescription>
      <UDFDrop xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</UDFDrop>
      <UDFFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</UDFFlag>
      <UDFLookup xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</UDFLookup>
      <UDFNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</UDFNum>
      <UDFValue xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</UDFValue>
      <UDFType>sample string 1</UDFType>
    </UDFValueWithTypeDetailResult>
    <UDFValueWithTypeDetailResult>
      <KeyNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</KeyNum>
      <KeyType xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 2</KeyType>
      <Label xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 3</Label>
      <UDFCode xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 4</UDFCode>
      <UDFDate xmlns="http://schemas.datacontract.org/2004/07/Stages">2024-05-01T16:17:38.2864967-04:00</UDFDate>
      <UDFDescription xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 5</UDFDescription>
      <UDFDrop xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 6</UDFDrop>
      <UDFFlag xmlns="http://schemas.datacontract.org/2004/07/Stages">true</UDFFlag>
      <UDFLookup xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 7</UDFLookup>
      <UDFNum xmlns="http://schemas.datacontract.org/2004/07/Stages">1</UDFNum>
      <UDFValue xmlns="http://schemas.datacontract.org/2004/07/Stages">sample string 8</UDFValue>
      <UDFType>sample string 1</UDFType>
    </UDFValueWithTypeDetailResult>
  </ResultSet>
</UDFValueWithTypeDetailQueryResult>