Get Object Types Association Details
Returns the field data of all the Object Type Associations linked with an Object Type, along with the AssociationFieldSchemaName
Note: The
InternalName is available on the Object Type Settings page.
API URL
URL
GET
https://{host}/v2/LeadTypes.svc/LeadTypeAssociation/GetAssociation?accessKey=AccessKey&secretKey=SecretKey&ObjectType=ObjectType&Page=Page&PageSize=PageSize
URL Parameters
| Parameter | Description |
|---|---|
| ObjectType | Pass the Internal Name for the Object Type for which you want to get the associated Object Types. |
| Page | Pass 1 |
| PageSize | The page size. |
Response
200 OK
Content-Type: application/json
{
"RecordCount": 2,
"TotalCount": 2,
"AssociationConfigurations": [
{
"AssociationFieldSchemaName": "LeadTypeAssociation_OT_1_OT_0",
"ChildLeadType": "OT_0",
"Direction": "Bidirectional",
"AssociationLimit": 15,
"DisplayFields": "mx_First_Name,LastName,ModifiedOn,ProspectID,mx_Zip",
"AssociatedDefaultField": "mx_First_Name",
"SecondaryDisplayFields": "EmailAddress,Phone,FirstName",
"AssociatedSecondaryDefaultField": "FirstName"
},
{
"AssociationFieldSchemaName": "LeadTypeAssociation_OT_1_OT_3",
"ChildLeadType": "OT_3",
"Direction": "Bidirectional",
"AssociationLimit": 4,
"DisplayFields": "CreatedOn,EmailAddress",
"AssociatedDefaultField": "EmailAddress",
"SecondaryDisplayFields": "CreatedByName,EmailAddress,OwnerId",
"AssociatedSecondaryDefaultField": "EmailAddress"
}
]
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK |
This is the status code for successful API call. |
| 401 Unauthorized |
The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request |
The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found |
The API could not be found. Please check the API signature. |
| 429 Too Many Requests |
API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error |
The API called failed. There could be many reasons for it. Check the exception message to get more details. |
