POST Dealer/getscheduledactivity

Get a list of scheduled activities optionally filtered by Activity Type.

Request Information

URI Parameters

None.

Body Parameters

GetScheduledActivityRequest
NameDescriptionTypeAdditional information
activityType

Activity Type

string

None.

token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "activityType": "sample string 1",
  "token": "92ec6db7-ee16-40c4-9ca3-22cb32ab0966"
}

application/xml, text/xml

Sample:
<GetScheduledActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Dealer">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">92ec6db7-ee16-40c4-9ca3-22cb32ab0966</token>
  <activityType>sample string 1</activityType>
</GetScheduledActivityRequest>

Response Information

Resource Description

GetScheduledActivityResponse
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

ScheduledActivityList

Scheduled Activity list

Collection of ScheduledActivityItem

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ScheduledActivityList": [
    {
      "EntityID": "5f0ec3ee-c4d8-41e5-bfaa-3dab1a09a417",
      "ActivityID": 2
    },
    {
      "EntityID": "5f0ec3ee-c4d8-41e5-bfaa-3dab1a09a417",
      "ActivityID": 2
    }
  ],
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<GetScheduledActivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Dealer">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <ScheduledActivityList>
    <ScheduledActivityItem>
      <ActivityID>2</ActivityID>
      <EntityID>5f0ec3ee-c4d8-41e5-bfaa-3dab1a09a417</EntityID>
    </ScheduledActivityItem>
    <ScheduledActivityItem>
      <ActivityID>2</ActivityID>
      <EntityID>5f0ec3ee-c4d8-41e5-bfaa-3dab1a09a417</EntityID>
    </ScheduledActivityItem>
  </ScheduledActivityList>
</GetScheduledActivityResponse>