GET api/globalsearch/groups
Search for Groups across the system.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Term | string |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| BranchId | integer |
None. |
|
| GroupTypes | Collection of GroupSearchType |
None. |
|
| ExcludeDeleted | boolean |
None. |
|
| ExcludeArchived | boolean |
None. |
|
| LastUpdated | date |
None. |
|
| ServiceType | string |
None. |
|
| PaginationLastDocumentId | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfGlobalSearchGroupResultDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| CurrentCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Collection | Collection of GlobalSearchGroupResultDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"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"
},
"Members": [
{
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Telephones": [
{
"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
}
],
"Emails": [
{
"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
}
],
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DisplayAddress": "sample string 4",
"Id": 5
},
{
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Telephones": [
{
"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
}
],
"Emails": [
{
"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
}
],
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DisplayAddress": "sample string 4",
"Id": 5
}
],
"PrimaryMemberId": 6,
"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-07-09T21:31:28.8956121Z",
"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
},
"CompanyServiceTypes": [
"sample string 1",
"sample string 2"
],
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"LastUpdated": "2020-07-09T21:31:28.8956121Z",
"Id": 7
},
{
"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"
},
"Members": [
{
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Telephones": [
{
"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
}
],
"Emails": [
{
"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
}
],
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DisplayAddress": "sample string 4",
"Id": 5
},
{
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Telephones": [
{
"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
}
],
"Emails": [
{
"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
}
],
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DisplayAddress": "sample string 4",
"Id": 5
}
],
"PrimaryMemberId": 6,
"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-07-09T21:31:28.8956121Z",
"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
},
"CompanyServiceTypes": [
"sample string 1",
"sample string 2"
],
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"LastUpdated": "2020-07-09T21:31:28.8956121Z",
"Id": 7
}
]
}