Get Activity Details
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns all the details of a specific activity. You must pass the activity Id in the API URL. To get the activity Id, use any of the retrieve activities API.
API URL
URL
GET
https://{host}/v2/ProspectActivity.svc/GetActivityDetails?accessKey=AccessKey&secretKey=SecretKey&activityId=activityId
URL Parameters
| Parameter | Description |
|---|---|
| activityId | The Id of the activity you want to retrieve. |
Response
200 OK
Content-Type: application/json
{
"ID":"e85e72ee-a9a9-498c-9b26-ffd9db2df311",
"Name":"Home Visit",
"DisplayName":"Home Visit",
"Fields":[
{
"SchemaName":"mx_Custom_1",
"InternalName":"mx_Custom_1",
"DisplayName":"Purpose",
"Value":"Weight Gain",
"DataType":"SearchableDropdown",
"IsMandatory":false,
"ShowInForm":true,
"Sequence":1,
"ParentField":"",
"OptionSet":"[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Weight Gain\",\"Order\":0,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Weight Loss\",\"Order\":1,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0}]",
"DependentOptionSet":"",
"IsDefault":false,
"IsReadOnly":false,
"RenderType":"",
"ExportAsPlainText":false,
"IsMultiSelectDropdown":false,
"IncludeOthersOption":false,
"BehaviorOnMissingDropdownOption":0,
"IsOthersValue":false,
"InternalSchemaName":"",
"CustomObjectType":2,
"MaxFieldLength":200
},
{
"SchemaName":"Status",
"InternalName":"Status",
"DisplayName":"Status",
"Value":"",
"DataType":"SearchableDropdown",
"IsMandatory":false,
"ShowInForm":true,
"Sequence":1,
"ParentField":"",
"OptionSet":"[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Active\",\"Order\":0,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Inactive\",\"Order\":1,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0}]",
"DependentOptionSet":"",
"IsDefault":true,
"IsReadOnly":false,
"RenderType":"",
"ExportAsPlainText":false,
"IsMultiSelectDropdown":false,
"IncludeOthersOption":false,
"BehaviorOnMissingDropdownOption":0,
"IsOthersValue":false,
"InternalSchemaName":"",
"CustomObjectType":2,
"MaxFieldLength":200
},
{
"SchemaName":"Owner",
"InternalName":"Owner",
"DisplayName":"Owner",
"Value":"",
"DataType":"ActiveUsers",
"IsMandatory":false,
"ShowInForm":true,
"Sequence":1,
"ParentField":"",
"OptionSet":"",
"DependentOptionSet":"",
"IsDefault":true,
"IsReadOnly":false,
"RenderType":"",
"ExportAsPlainText":false,
"IsMultiSelectDropdown":false,
"IncludeOthersOption":false,
"BehaviorOnMissingDropdownOption":0,
"IsOthersValue":false,
"InternalSchemaName":"",
"CustomObjectType":2,
"MaxFieldLength":200
},
{
"SchemaName":"mx_Custom_3",
"InternalName":"mx_Custom_3",
"DisplayName":"Scheduled Date",
"Value":"",
"DataType":"String",
"IsMandatory":false,
"ShowInForm":true,
"Sequence":3,
"ParentField":"",
"OptionSet":"",
"DependentOptionSet":"",
"IsDefault":false,
"IsReadOnly":false,
"RenderType":"",
"ExportAsPlainText":false,
"IsMultiSelectDropdown":false,
"IncludeOthersOption":false,
"BehaviorOnMissingDropdownOption":0,
"IsOthersValue":false,
"InternalSchemaName":"",
"CustomObjectType":2,
"MaxFieldLength":200
}
],
"CreatedByName":"Sri ",
"CreatedOn":"/Date(1597302600000+0000)/",
"RelatedProspectId":"bf790f89-2ea3-4885-95cb-2290df591a93",
"IsEditable":1,
"ActivityEvent":161,
"CreatedOnString":"2020-08-13 07:10:00",
"ActivityEventType":"2",
"FormLayout":{
"AvailableFields":[
{
"Colspan":1,
"SchemaName":"Status"
},
{
"Colspan":1,
"SchemaName":"Owner"
}
],
"Sections":[
{
"DisplayName":"Activity Details",
"Fields":[
{
"Colspan":1,
"SchemaName":"ActivityEventName"
},
{
"Colspan":1,
"SchemaName":"CreatedOn"
},
{
"Colspan":1,
"SchemaName":"AssociatedEntityIdName"
},
{
"Colspan":2,
"SchemaName":"ActivityEvent_Note"
},
{
"Colspan":1,
"SchemaName":"mx_Custom_1"
},
{
"Colspan":1,
"SchemaName":"mx_Custom_3"
}
]
}
]
},
"AllowPreDatedActivity":true,
"VCardFormLayout":{
"AvailableFields":[
],
"Sections":[
],
"VCardColor":null
},
"ModifiedOn":"/Date(1597302660000+0000)/",
"ModifiedBy":"1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"ModifiedByName":"Sri",
"IsActive":true,
"LockActivity":{
"CanLock":false,
"Roles":null
},
"EntityType":2,
"ActivityEventPluralName":"",
"RelatedEntityType":0
}
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. |
