Knowledge Marketing
Home Reference

GET GetConsensusCustomFieldValues?accessKey={accessKey}&customFieldName={customFieldName}

This method returns a list of all of the descriptions and codes that are setup for a consensus level dimension.

SOAP Examples

C#

             class Test
             {
                 static void Main()
                 {
                     UADServiceClient client = new UADServiceClient();
            
                     // Use the 'client' variable to call operations on the service.
                     Guid guid = new Guid("00000000-0000-0000-0000-000000000000");
                     String customFieldName = "Business";
                     Response response = client.GetConsensusCustomFieldValues( guid, customFieldName);
             
                     // Always close the client.
                     client.Close();
                 }
             }
             
             
Visual Basic

             Class Test
                 Shared Sub Main()
                     Dim client As UADServiceClient = New UADServiceClient()
                     ' Use the 'client' variable to call operations on the service.
                     Dim guid as Guid = new Guid("00000000-0000-0000-0000-000000000000")
                     Dim customFieldName as String = "Business"
                     Dim response As Response = client.GetConsensusCustomFieldValues( guid, customFieldName)
             
                     ' Always close the client.
                     client.Close()
                 End Sub
             End Class
             

JSON Examples

Request

             GET Service at https://uadservices.kmpsgroup.com/UAD/UADService.svc/GetConsensusCustomFieldValues?accessKey=00000000-0000-0000-0000-000000000000&customFieldName=Department HTTP/1.1
             Accept: application/json
             Content-Type: application/json; charset=utf-8
             Content-Length: 422
             Host: uadservices.kmpsgroup.com
             
Responce

             HTTP/1.1 200 (OK)
             Content-Length: 662
             Cache-Control: private
             Content-Type: application/json; charset=utf-8
             Date: Tue, 26 Jul 2016 16:16:26 GMT
             Server: Microsoft-IIS/7.5
             X-AspNet-Version: 4.0.30319
             X-Powered-By: ASP.NET
             
             {
                 "Message": "Success",
                 "ProcessCode": "6lbzreJzk47a_07262016_11:16:26",
                 "Result": [
                     {
                         "Description": "EMAIL",
                         "DisplayOrder": 0,
                         "IsConsensus": false,
                         "IsOther": false,
                         "Name": "Department",
                         "ProductCode": "",
                         "ProductId": 0,
                         "Value": "EMAIL"
                     },
                     {
                         "Description": "ONSITE",
                         "DisplayOrder": 0,
                         "IsConsensus": false,
                         "IsOther": false,
                         "Name": "Department",
                         "ProductCode": "",
                         "ProductId": 0,
                         "Value": "ONSITE"
                     },
                     {
                         "Description": "TELE",
                         "DisplayOrder": 0,
                         "IsConsensus": false,
                         "IsOther": false,
                         "Name": "Department",
                         "ProductCode": "",
                         "ProductId": 0,
                         "Value": "TELE"
                     },
                     {
                         "Description": "WEB",
                         "DisplayOrder": 0,
                         "IsConsensus": false,
                         "IsOther": false,
                         "Name": "Department",
                         "ProductCode": "",
                         "ProductId": 0,
                         "Value": "WEB"
                     }
                 ],
                 "Status": 0
             }
             

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessKey

Client access key.

globally unique identifier

Required

customFieldName

Custom field name your searching for.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Response object containing a list of CustomFieldValue objects.

ResponseOfListOfCustomFieldValue
NameDescriptionTypeAdditional information
ProcessCode

ProcessCode for the Response object.

string

None.

Status

Status for the Response object.

ServiceResponseStatusTypes

None.

Message

Message for the Response object.

string

None.

Result

Result for the Response object.

Collection of CustomFieldValue

None.

Response Formats

application/json, text/json

Sample:
{
  "<ProcessCode>k__BackingField": "sample string 1",
  "<Status>k__BackingField": "Success",
  "<Message>k__BackingField": "sample string 2",
  "<Result>k__BackingField": [
    {
      "<ProductId>k__BackingField": 1,
      "<ProductCode>k__BackingField": "sample string 2",
      "<Name>k__BackingField": "sample string 3",
      "<Value>k__BackingField": "sample string 4",
      "<Description>k__BackingField": "sample string 5",
      "<DisplayOrder>k__BackingField": 6,
      "<IsOther>k__BackingField": true,
      "<IsConsensus>k__BackingField": true
    },
    {
      "<ProductId>k__BackingField": 1,
      "<ProductCode>k__BackingField": "sample string 2",
      "<Name>k__BackingField": "sample string 3",
      "<Value>k__BackingField": "sample string 4",
      "<Description>k__BackingField": "sample string 5",
      "<DisplayOrder>k__BackingField": 6,
      "<IsOther>k__BackingField": true,
      "<IsConsensus>k__BackingField": true
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfListOfCustomFieldValue xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProcessCode>sample string 1</ProcessCode>
  <Status>Success</Status>
  <Message>sample string 2</Message>
  <Result>
    <CustomFieldValue>
      <ProductId>1</ProductId>
      <ProductCode>sample string 2</ProductCode>
      <Name>sample string 3</Name>
      <Value>sample string 4</Value>
      <Description>sample string 5</Description>
      <DisplayOrder>6</DisplayOrder>
      <IsOther>true</IsOther>
      <IsConsensus>true</IsConsensus>
    </CustomFieldValue>
    <CustomFieldValue>
      <ProductId>1</ProductId>
      <ProductCode>sample string 2</ProductCode>
      <Name>sample string 3</Name>
      <Value>sample string 4</Value>
      <Description>sample string 5</Description>
      <DisplayOrder>6</DisplayOrder>
      <IsOther>true</IsOther>
      <IsConsensus>true</IsConsensus>
    </CustomFieldValue>
  </Result>
</ResponseOfListOfCustomFieldValue>