Get Activity Type Details
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns all the details of a specific activity type (including custom fields and their properties). You have to pass the activity code in the API URL.
API URL
URL
GET
https://{host}/v2/ProspectActivity.svc/CustomActivity/GetActivitySetting?accessKey=AccessKey&secretKey=SecretKey&code=Code
URL Parameters
| Parameter | Description |
|---|---|
| Code | Unique code of the activity type. |
Response
200 OK
Content-Type: application/json
{
"ID": "008e841a-5d3a-11e6-96be-22000aa8e760",
"Name": "New CA",
"DisplayName": "New CA",
"Fields": [
{
"SchemaName": "mx_Custom_1",
"DisplayName": "Custom 1",
"Value": null,
"DataType": "String",
"IsMandatory": true,
"ShowInForm": true,
"Sequence": 1,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_2",
"DisplayName": "Custom 2",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 2,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_3",
"DisplayName": "Custom 3",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 3,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_4",
"DisplayName": "Custom 4",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 4,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_5",
"DisplayName": "Custom 5",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 5,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_6",
"DisplayName": "Custom 6",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 6,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_7",
"DisplayName": "Custom 7",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 7,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_8",
"DisplayName": "Custom 8",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 8,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_9",
"DisplayName": "Custom 9",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 9,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_10",
"DisplayName": "Custom 10",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 10,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_11",
"DisplayName": "Custom 11",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 11,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_12",
"DisplayName": "Custom 12",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 12,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_13",
"DisplayName": "Custom 13",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 13,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_14",
"DisplayName": "Custom 14",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": false,
"Sequence": 14,
"OptionSet": ""
},
{
"SchemaName": "mx_Custom_15",
"DisplayName": " Custom 15",
"Value": null,
"DataType": "String",
"IsMandatory": false,
"ShowInForm": true,
"Sequence": 15,
"OptionSet": ""
}
],
"Score": 3,
"IsEditable": 1
}
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. |
