GET api/ContactUdfValues

Returns a list of all contact udf values in your database. This list is searchable using the OData protocol.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContactUdfValue

Name	Type	Additional information
ContactUdfValueId	integer	None.
UnitId	integer	None.
ContactId	integer	None.
UdfFieldId	integer	None.
DataType	UdfDataType	None.
Value	Object	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContactUdfValueId": 1,
    "UnitId": 2,
    "ContactId": 3,
    "UdfFieldId": 4,
    "DataType": {
      "UdfDataTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "Value": {},
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "ContactUdfValueId": 1,
    "UnitId": 2,
    "ContactId": 3,
    "UdfFieldId": 4,
    "DataType": {
      "UdfDataTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "Value": {},
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactUdfValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <ContactUdfValue>
    <ContactId>3</ContactId>
    <ContactUdfValueId>1</ContactUdfValueId>
    <DataType>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsSystemDefined>true</IsSystemDefined>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <OrganizationId>2</OrganizationId>
      <UdfDataTypeId>1</UdfDataTypeId>
    </DataType>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <UdfFieldId>4</UdfFieldId>
    <UnitId>2</UnitId>
    <Value />
  </ContactUdfValue>
  <ContactUdfValue>
    <ContactId>3</ContactId>
    <ContactUdfValueId>1</ContactUdfValueId>
    <DataType>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsSystemDefined>true</IsSystemDefined>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <OrganizationId>2</OrganizationId>
      <UdfDataTypeId>1</UdfDataTypeId>
    </DataType>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <UdfFieldId>4</UdfFieldId>
    <UnitId>2</UnitId>
    <Value />
  </ContactUdfValue>
</ArrayOfContactUdfValue>