GET api/negotiator/my/groups/favourite?pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 10

pageNumber

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfFavouriteGroupDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of FavouriteGroupDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Name": "sample string 1",
      "GroupIcon": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "GroupType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "PrimaryGroupMember": {
        "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": "2018-11-12T19:43:37.3455162Z",
              "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": "2018-11-12T19:43:37.3455162Z",
              "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
      },
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "GroupIcon": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "GroupType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "PrimaryGroupMember": {
        "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": "2018-11-12T19:43:37.3455162Z",
              "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": "2018-11-12T19:43:37.3455162Z",
              "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
      },
      "Id": 2
    }
  ]
}