GET api/role/{id}/vendors

Get the members of a role by the role Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the role to get the owner information for

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of owners for the role or null if the role does not exist

RoleVendorDataContract
NameDescriptionTypeAdditional information
Name

string

None.

TeamAccessType

string

None.

Description

string

None.

GroupType

EnumDataContract

None.

GroupIcon

EnumDataContract

None.

GroupBackgroundImageUrl

string

None.

Notes

string

None.

Members

Collection of GroupMemberDataContract

None.

OwningTeamId

integer

None.

BranchId

integer

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "TeamAccessType": "sample string 2",
  "Description": "sample string 3",
  "GroupType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "GroupIcon": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "GroupBackgroundImageUrl": "sample string 4",
  "Notes": "sample string 5",
  "Members": [
    {
      "Person": {
        "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
        },
        "Addresses": [
          {
            "AddressType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ContactOrder": 1,
            "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 2",
            "OrganizationName": "sample string 3",
            "Number": "sample string 4",
            "BuildingName": "sample string 5",
            "Street": "sample string 6",
            "Town": "sample string 7",
            "Locality": "sample string 8",
            "County": "sample string 9",
            "Postcode": "sample string 10",
            "CreatedDate": "2020-12-02T12:45:44.8177784Z",
            "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": 12
          },
          {
            "AddressType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ContactOrder": 1,
            "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 2",
            "OrganizationName": "sample string 3",
            "Number": "sample string 4",
            "BuildingName": "sample string 5",
            "Street": "sample string 6",
            "Town": "sample string 7",
            "Locality": "sample string 8",
            "County": "sample string 9",
            "Postcode": "sample string 10",
            "CreatedDate": "2020-12-02T12:45:44.8177784Z",
            "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": 12
          }
        ],
        "ContactItems": [
          {
            "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
          },
          {
            "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
          }
        ],
        "MarketingPreferences": [
          {
            "ServiceType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ServiceStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Referral": true,
            "ReferralStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 2
          },
          {
            "ServiceType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ServiceStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Referral": true,
            "ReferralStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 2
          }
        ],
        "Id": 5
      },
      "RelationshipType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Order": 1,
      "Id": 2
    },
    {
      "Person": {
        "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
        },
        "Addresses": [
          {
            "AddressType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ContactOrder": 1,
            "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 2",
            "OrganizationName": "sample string 3",
            "Number": "sample string 4",
            "BuildingName": "sample string 5",
            "Street": "sample string 6",
            "Town": "sample string 7",
            "Locality": "sample string 8",
            "County": "sample string 9",
            "Postcode": "sample string 10",
            "CreatedDate": "2020-12-02T12:45:44.8177784Z",
            "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": 12
          },
          {
            "AddressType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ContactOrder": 1,
            "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 2",
            "OrganizationName": "sample string 3",
            "Number": "sample string 4",
            "BuildingName": "sample string 5",
            "Street": "sample string 6",
            "Town": "sample string 7",
            "Locality": "sample string 8",
            "County": "sample string 9",
            "Postcode": "sample string 10",
            "CreatedDate": "2020-12-02T12:45:44.8177784Z",
            "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": 12
          }
        ],
        "ContactItems": [
          {
            "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
          },
          {
            "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
          }
        ],
        "MarketingPreferences": [
          {
            "ServiceType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ServiceStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Referral": true,
            "ReferralStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 2
          },
          {
            "ServiceType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ServiceStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Referral": true,
            "ReferralStatusType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 2
          }
        ],
        "Id": 5
      },
      "RelationshipType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Order": 1,
      "Id": 2
    }
  ],
  "OwningTeamId": 6,
  "BranchId": 7,
  "Id": 8
}