POST api/Stakeholder/search-download-csv

No documentation available.

Request Information

Parameters

Name	Description	Additional information
request	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Filters": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "<Field>k__BackingField": "sample string 1",
        "<Operator>k__BackingField": "sample string 2",
        "<Value>k__BackingField": {
          "$id": "4"
        },
        "<Logic>k__BackingField": "sample string 4",
        "<Filters>k__BackingField": {
          "$id": "5",
          "$values": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ]
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Page": 1,
  "PageSize": 2,
  "Sort": {
    "$id": "6",
    "Field": "sample string 1",
    "Dir": "sample string 2",
    "SecondaryField": "sample string 3",
    "SecondaryDir": "sample string 4",
    "ThirdField": "sample string 5",
    "ThirdDir": "sample string 6"
  },
  "PreviousPageSize": 3
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataSearchRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "$id": "2",
    "StakeholderId": 1,
    "GivenNames": "sample string 2",
    "Surname": "sample string 3",
    "Name": "sample string 4",
    "Email": "sample string 5",
    "MobilePhone": "sample string 6",
    "Organisation": "sample string 7",
    "OrganisationTypeLovId": 1,
    "StakeHolderTypeLovId": 1,
    "WorkPhone": "sample string 8",
    "HomePhone": "sample string 9",
    "Position": "sample string 10",
    "OrganisationType": "sample string 11",
    "AssociatedOrganisation": "sample string 12",
    "OrganisationId": 1,
    "ActiveFlag": true
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSvwStakeholderCSV xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SvwStakeholderCSV>
    <StakeholderId>1</StakeholderId>
    <GivenNames>sample string 2</GivenNames>
    <Surname>sample string 3</Surname>
    <Name>sample string 4</Name>
    <Email>sample string 5</Email>
    <MobilePhone>sample string 6</MobilePhone>
    <Organisation>sample string 7</Organisation>
    <OrganisationTypeLovId>1</OrganisationTypeLovId>
    <StakeHolderTypeLovId>1</StakeHolderTypeLovId>
    <WorkPhone>sample string 8</WorkPhone>
    <HomePhone>sample string 9</HomePhone>
    <Position>sample string 10</Position>
    <OrganisationType>sample string 11</OrganisationType>
    <AssociatedOrganisation>sample string 12</AssociatedOrganisation>
    <OrganisationId>1</OrganisationId>
    <ActiveFlag>true</ActiveFlag>
  </SvwStakeholderCSV>
  <SvwStakeholderCSV>
    <StakeholderId>1</StakeholderId>
    <GivenNames>sample string 2</GivenNames>
    <Surname>sample string 3</Surname>
    <Name>sample string 4</Name>
    <Email>sample string 5</Email>
    <MobilePhone>sample string 6</MobilePhone>
    <Organisation>sample string 7</Organisation>
    <OrganisationTypeLovId>1</OrganisationTypeLovId>
    <StakeHolderTypeLovId>1</StakeHolderTypeLovId>
    <WorkPhone>sample string 8</WorkPhone>
    <HomePhone>sample string 9</HomePhone>
    <Position>sample string 10</Position>
    <OrganisationType>sample string 11</OrganisationType>
    <AssociatedOrganisation>sample string 12</AssociatedOrganisation>
    <OrganisationId>1</OrganisationId>
    <ActiveFlag>true</ActiveFlag>
  </SvwStakeholderCSV>
  <SvwStakeholderCSV>
    <StakeholderId>1</StakeholderId>
    <GivenNames>sample string 2</GivenNames>
    <Surname>sample string 3</Surname>
    <Name>sample string 4</Name>
    <Email>sample string 5</Email>
    <MobilePhone>sample string 6</MobilePhone>
    <Organisation>sample string 7</Organisation>
    <OrganisationTypeLovId>1</OrganisationTypeLovId>
    <StakeHolderTypeLovId>1</StakeHolderTypeLovId>
    <WorkPhone>sample string 8</WorkPhone>
    <HomePhone>sample string 9</HomePhone>
    <Position>sample string 10</Position>
    <OrganisationType>sample string 11</OrganisationType>
    <AssociatedOrganisation>sample string 12</AssociatedOrganisation>
    <OrganisationId>1</OrganisationId>
    <ActiveFlag>true</ActiveFlag>
  </SvwStakeholderCSV>
</ArrayOfSvwStakeholderCSV>