GET api/role/{roleId}/viewingsbasic?showCancelled={showCancelled}

Get a basic list of all viewings for a particular marketing role.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
roleId

The id of the marketing role to get the viewings for.

integer

Required

showCancelled

A true or false flag to indicate whether or not we want to include Cancelled Viewings (it is false by default).

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of BasicViewingDataContract
NameDescriptionTypeAdditional information
StartDate

date

None.

FeedbackTaken

boolean

None.

AttendingGroups

Collection of EventListAttendeeCollectionDataContract

None.

Address

AddressDataContract

None.

EventStatus

EnumDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "StartDate": "2020-12-04T09:03:24.3875476Z",
    "FeedbackTaken": true,
    "AttendingGroups": [
      {
        "EventId": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "OwningTeamId": 1,
          "BranchId": 2,
          "Name": "sample string 3",
          "TeamAccessType": "sample string 4",
          "Description": "sample string 5",
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "GroupIcon": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FinancialStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "PrimaryGroupMember": {
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 5
          },
          "Id": 6
        },
        "AttendingPeople": [
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          },
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          }
        ]
      },
      {
        "EventId": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "OwningTeamId": 1,
          "BranchId": 2,
          "Name": "sample string 3",
          "TeamAccessType": "sample string 4",
          "Description": "sample string 5",
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "GroupIcon": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FinancialStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "PrimaryGroupMember": {
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 5
          },
          "Id": 6
        },
        "AttendingPeople": [
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          },
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          }
        ]
      }
    ],
    "Address": {
      "Location": {
        "CenterPoint": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Extent": [
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          }
        ],
        "ViewPoints": [
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          },
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          }
        ],
        "Id": 1
      },
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 1",
      "OrganizationName": "sample string 2",
      "Number": "sample string 3",
      "BuildingName": "sample string 4",
      "Street": "sample string 5",
      "Town": "sample string 6",
      "Locality": "sample string 7",
      "County": "sample string 8",
      "Postcode": "sample string 9",
      "CreatedDate": "2020-12-04T09:03:24.4031884Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 11
    },
    "EventStatus": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Id": 3
  },
  {
    "StartDate": "2020-12-04T09:03:24.3875476Z",
    "FeedbackTaken": true,
    "AttendingGroups": [
      {
        "EventId": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "OwningTeamId": 1,
          "BranchId": 2,
          "Name": "sample string 3",
          "TeamAccessType": "sample string 4",
          "Description": "sample string 5",
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "GroupIcon": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FinancialStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "PrimaryGroupMember": {
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 5
          },
          "Id": 6
        },
        "AttendingPeople": [
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          },
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          }
        ]
      },
      {
        "EventId": 1,
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "OwningTeamId": 1,
          "BranchId": 2,
          "Name": "sample string 3",
          "TeamAccessType": "sample string 4",
          "Description": "sample string 5",
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "GroupIcon": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FinancialStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "PrimaryGroupMember": {
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 5
          },
          "Id": 6
        },
        "AttendingPeople": [
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          },
          {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Id": 3
          }
        ]
      }
    ],
    "Address": {
      "Location": {
        "CenterPoint": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Extent": [
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          }
        ],
        "ViewPoints": [
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          },
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          }
        ],
        "Id": 1
      },
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 1",
      "OrganizationName": "sample string 2",
      "Number": "sample string 3",
      "BuildingName": "sample string 4",
      "Street": "sample string 5",
      "Town": "sample string 6",
      "Locality": "sample string 7",
      "County": "sample string 8",
      "Postcode": "sample string 9",
      "CreatedDate": "2020-12-04T09:03:24.4031884Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 11
    },
    "EventStatus": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Id": 3
  }
]