POST v1/Groups/SearchBatch

The same as Search but you can enter multiple requests as a single batch to post to the server.

Request Information

Parameters

Name	Type	Description	Additional information
batchRequest	GroupSearchBatchRequest	Container for the Group Search Batch Request input parameters. See parameter details below.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "requests": [
    {
      "query": "sample string 1",
      "maxResults": 2,
      "sdkVersion": "sample string 3"
    },
    {
      "query": "sample string 1",
      "maxResults": 2,
      "sdkVersion": "sample string 3"
    },
    {
      "query": "sample string 1",
      "maxResults": 2,
      "sdkVersion": "sample string 3"
    }
  ],
  "sdkVersion": "sample string 1"
}

application/xml, text/xml

Sample:

<GroupSearchBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SdkVersion>sample string 1</SdkVersion>
  <Requests>
    <GroupSearchRequest>
      <SdkVersion>sample string 3</SdkVersion>
      <MaxResults>2</MaxResults>
      <Query>sample string 1</Query>
    </GroupSearchRequest>
    <GroupSearchRequest>
      <SdkVersion>sample string 3</SdkVersion>
      <MaxResults>2</MaxResults>
      <Query>sample string 1</Query>
    </GroupSearchRequest>
    <GroupSearchRequest>
      <SdkVersion>sample string 3</SdkVersion>
      <MaxResults>2</MaxResults>
      <Query>sample string 1</Query>
    </GroupSearchRequest>
  </Requests>
</GroupSearchBatchRequest>

Parameter Information

Parameter Name: batchRequest

Property	Type	Description
Requests	IList`1	A list of GroupSearchRequest objects. A max of 1000 requests will be processed.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "responses": [
    {
      "groups": [
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        }
      ],
      "errorOccurred": false,
      "errorMessages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "request": {
        "query": "sample string 1",
        "maxResults": 2,
        "sdkVersion": "sample string 3"
      }
    },
    {
      "groups": [
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        }
      ],
      "errorOccurred": false,
      "errorMessages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "request": {
        "query": "sample string 1",
        "maxResults": 2,
        "sdkVersion": "sample string 3"
      }
    },
    {
      "groups": [
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "organizationCount": 3
        }
      ],
      "errorOccurred": false,
      "errorMessages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "request": {
        "query": "sample string 1",
        "maxResults": 2,
        "sdkVersion": "sample string 3"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<GroupSearchBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Responses>
    <GroupSearchResponse>
      <ErrorMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </ErrorMessages>
      <ErrorOccurred>false</ErrorOccurred>
      <Request>
        <SdkVersion>sample string 3</SdkVersion>
        <MaxResults>2</MaxResults>
        <Query>sample string 1</Query>
      </Request>
      <Groups>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
      </Groups>
    </GroupSearchResponse>
    <GroupSearchResponse>
      <ErrorMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </ErrorMessages>
      <ErrorOccurred>false</ErrorOccurred>
      <Request>
        <SdkVersion>sample string 3</SdkVersion>
        <MaxResults>2</MaxResults>
        <Query>sample string 1</Query>
      </Request>
      <Groups>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
      </Groups>
    </GroupSearchResponse>
    <GroupSearchResponse>
      <ErrorMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </ErrorMessages>
      <ErrorOccurred>false</ErrorOccurred>
      <Request>
        <SdkVersion>sample string 3</SdkVersion>
        <MaxResults>2</MaxResults>
        <Query>sample string 1</Query>
      </Request>
      <Groups>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
        <Group>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <OrganizationCount>3</OrganizationCount>
        </Group>
      </Groups>
    </GroupSearchResponse>
  </Responses>
</GroupSearchBatchResponse>