Knowledge Marketing
Home Reference

GET GetConsensusCustomFields?accessKey={accessKey}

This method returns a list of all of the consensus level dimensions in your UAD.

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");
                     Response response = client.GetConsensusCustomFields( guid);
             
                     // 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 response As Response = client.GetConsensusCustomFields( guid)
             
                     ' Always close the client.
                     client.Close()
                 End Sub
             End Class
             

JSON Examples

Request

             GET https://uadservices.kmpsgroup.com/UAD/UADService.svc/GetConsensusCustomFields?accessKey=00000000-0000-0000-0000-000000000000 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: 7259
             Cache-Control: private
             Content-Type: application/json; charset=utf-8
             Date: Tue, 26 Jul 2016 15:58:14 GMT
             Server: Microsoft-IIS/7.5
             X-AspNet-Version: 4.0.30319
             X-Powered-By: ASP.NET
             
             {
                 "Message": "Success",
                 "ProcessCode": "6D95ElMP5uGO_07262016_10:58:14",
                 "Result": [
                     {
                         "DisplayName": "Job Function",
                         "DisplayOrder": 6,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Job Function",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Number of Employees",
                         "DisplayOrder": 8,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Number of Employees",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Organization Type of Business",
                         "DisplayOrder": 11,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Organization Type of Business",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Primary Job Title",
                         "DisplayOrder": 12,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Primary Job Title",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "PUBCODE",
                         "DisplayOrder": 13,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "PUBCODE",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Event Class",
                         "DisplayOrder": 16,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Event Class",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Department",
                         "DisplayOrder": 17,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Department",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Conference Status",
                         "DisplayOrder": 18,
                         "IsActive": true,
                         "IsAdHoc": false,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Conference Status",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Account Rep Name",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Account Rep Name",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Changed By Name",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Changed By Name",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Changed On",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Changed On",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Event End Date",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Event End Date",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Event Order #",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Event Order #",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     },
                     {
                         "DisplayName": "Event Order Total",
                         "DisplayOrder": 0,
                         "IsActive": true,
                         "IsAdHoc": true,
                         "IsMultipleValue": false,
                         "IsRequired": false,
                         "Name": "Event Order Total",
                         "ProductCode": "Consensus",
                         "ProductId": 0
                     }
                 ],
                 "Status": 0
             }
             

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessKey

Client access key.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Response object containing a list of CustomField objects.

ResponseOfListOfCustomField
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 CustomField

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",
      "<DisplayName>k__BackingField": "sample string 4",
      "<DisplayOrder>k__BackingField": 5,
      "<IsMultipleValue>k__BackingField": true,
      "<IsRequired>k__BackingField": true,
      "<IsActive>k__BackingField": true,
      "<IsAdHoc>k__BackingField": true
    },
    {
      "<ProductId>k__BackingField": 1,
      "<ProductCode>k__BackingField": "sample string 2",
      "<Name>k__BackingField": "sample string 3",
      "<DisplayName>k__BackingField": "sample string 4",
      "<DisplayOrder>k__BackingField": 5,
      "<IsMultipleValue>k__BackingField": true,
      "<IsRequired>k__BackingField": true,
      "<IsActive>k__BackingField": true,
      "<IsAdHoc>k__BackingField": true
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfListOfCustomField 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>
    <CustomField>
      <ProductId>1</ProductId>
      <ProductCode>sample string 2</ProductCode>
      <Name>sample string 3</Name>
      <DisplayName>sample string 4</DisplayName>
      <DisplayOrder>5</DisplayOrder>
      <IsMultipleValue>true</IsMultipleValue>
      <IsRequired>true</IsRequired>
      <IsActive>true</IsActive>
      <IsAdHoc>true</IsAdHoc>
    </CustomField>
    <CustomField>
      <ProductId>1</ProductId>
      <ProductCode>sample string 2</ProductCode>
      <Name>sample string 3</Name>
      <DisplayName>sample string 4</DisplayName>
      <DisplayOrder>5</DisplayOrder>
      <IsMultipleValue>true</IsMultipleValue>
      <IsRequired>true</IsRequired>
      <IsActive>true</IsActive>
      <IsAdHoc>true</IsAdHoc>
    </CustomField>
  </Result>
</ResponseOfListOfCustomField>