POST api/Messages/FindRecipients

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Page	integer	None.
PageIndex	integer	None.
PageSize	integer	None.
Ordering	string	None.
Sort	Dictionary of string [key] and string [value]	None.
SortField	string	None.
SortOrder	string	None.
Filters	Collection of FilterModel	None.
FilterCondition	FilterConditionsEnum	None.
ContinuationToken	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Page": 1,
  "PageIndex": 1,
  "PageSize": 2,
  "Ordering": "sample string 1 sample string 2,sample string 3 sample string 4",
  "Sort": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "SortField": "sample string 3",
  "SortOrder": "sample string 4",
  "Filters": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Operator": 1,
      "RelatedField": "sample string 4",
      "RadioId": "sample string 5",
      "RenderValue": "sample string 6",
      "GroupId": "sample string 7"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Operator": 1,
      "RelatedField": "sample string 4",
      "RadioId": "sample string 5",
      "RenderValue": "sample string 6",
      "GroupId": "sample string 7"
    }
  ],
  "FilterCondition": 1,
  "ContinuationToken": "sample string 5"
}

application/xml, text/xml

Sample:

<PagedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FootballISM.Infrastructure.Pagination">
  <ContinuationToken>sample string 5</ContinuationToken>
  <FilterCondition>And</FilterCondition>
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/FootballISM.Infrastructure.Filtering">
    <d2p1:FilterModel>
      <d2p1:GroupId>sample string 7</d2p1:GroupId>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Operator>Equal</d2p1:Operator>
      <d2p1:RadioId>sample string 5</d2p1:RadioId>
      <d2p1:RelatedField>sample string 4</d2p1:RelatedField>
      <d2p1:RenderValue>sample string 6</d2p1:RenderValue>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:FilterModel>
    <d2p1:FilterModel>
      <d2p1:GroupId>sample string 7</d2p1:GroupId>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Operator>Equal</d2p1:Operator>
      <d2p1:RadioId>sample string 5</d2p1:RadioId>
      <d2p1:RelatedField>sample string 4</d2p1:RelatedField>
      <d2p1:RenderValue>sample string 6</d2p1:RenderValue>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:FilterModel>
  </Filters>
  <Page>1</Page>
  <PageSize>2</PageSize>
  <Sort xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Sort>
  <SortField>sample string 3</SortField>
  <SortOrder>sample string 4</SortOrder>
</PagedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResultOfPagedModelOfRecipientListItem

Name	Type	Additional information
Result	PagedModelOfRecipientListItem	None.
ErrorCode	ServiceErrorCode	None.
ErrorMessage	Collection of string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "PageIndex": 1,
    "PageSize": 2,
    "Rows": [
      {
        "Id": "84c2a788-0859-49d2-b01d-fca0fbd618e5",
        "Name": "sample string 2",
        "Photo": {
          "Id": "40a4cf61-ec09-4e17-acbf-7f04dca8dc67",
          "Name": "sample string 2",
          "Path": "sample string 3",
          "Description": "sample string 4",
          "TypeId": 1,
          "Token": "sample string 3"
        },
        "TeamOrDepartment": "sample string 3",
        "UserTypesIds": "sample string 4",
        "TeamId": "5d65b020-b92d-498a-b87b-6ae0bb761bb9"
      },
      {
        "Id": "84c2a788-0859-49d2-b01d-fca0fbd618e5",
        "Name": "sample string 2",
        "Photo": {
          "Id": "40a4cf61-ec09-4e17-acbf-7f04dca8dc67",
          "Name": "sample string 2",
          "Path": "sample string 3",
          "Description": "sample string 4",
          "TypeId": 1,
          "Token": "sample string 3"
        },
        "TeamOrDepartment": "sample string 3",
        "UserTypesIds": "sample string 4",
        "TeamId": "5d65b020-b92d-498a-b87b-6ae0bb761bb9"
      }
    ],
    "TotalPages": 3,
    "TotalRows": 4,
    "ContinuationToken": "sample string 5"
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.