POST api/partner/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BrokerCode	string	None.
FirstName	string	None.
SurName	string	None.
TradingName	string	None.
Telephone	string	None.
Town	string	None.
County	string	None.
AddressLine	string	None.
Postcode	string	None.
Suspended	boolean	None.
BusinessLeft	boolean	None.
EmailAddress	string	None.
ActiveFromDate	date	None.
ActiveToDate	date	None.
InactiveToDate	date	None.
PartnerType	integer	None.
StartDate	date	None.
AccountManagerID	integer	None.
AccountManagerName	string	None.
EndDate	date	None.
NumClientStart	integer	None.
NumClientEnd	integer	None.
ComValueStart	decimal number	None.
ComValueEnd	decimal number	None.
SignedFromDate	date	None.
SignedToDate	date	None.
ShowStatistics	boolean	None.
ShowTotalComm	boolean	None.
SortOrder	string	None.
SortOrderID	integer	None.
PageIndex	integer	None.
PageSize	integer	None.
userTypeId	integer	None.
ExpiringIn	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "BrokerCode": "sample string 1",
  "FirstName": "sample string 2",
  "SurName": "sample string 3",
  "TradingName": "sample string 4",
  "Telephone": "sample string 5",
  "Town": "sample string 6",
  "County": "sample string 7",
  "AddressLine": "sample string 8",
  "Postcode": "sample string 9",
  "Suspended": true,
  "BusinessLeft": true,
  "EmailAddress": "sample string 12",
  "ActiveFromDate": "2026-08-14T17:38:46.9964947+01:00",
  "ActiveToDate": "2026-08-14T17:38:46.9964947+01:00",
  "InactiveToDate": "2026-08-14T17:38:46.9964947+01:00",
  "PartnerType": 13,
  "StartDate": "2026-08-14T17:38:46.9964947+01:00",
  "AccountManagerID": 14,
  "AccountManagerName": "sample string 15",
  "EndDate": "2026-08-14T17:38:46.9964947+01:00",
  "NumClientStart": 1,
  "NumClientEnd": 1,
  "ComValueStart": 1.0,
  "ComValueEnd": 1.0,
  "SignedFromDate": "2026-08-14T17:38:46.9964947+01:00",
  "SignedToDate": "2026-08-14T17:38:46.9964947+01:00",
  "ShowStatistics": true,
  "ShowTotalComm": true,
  "SortOrder": "sample string 18",
  "SortOrderID": 19,
  "PageIndex": 20,
  "PageSize": 21,
  "userTypeId": 22,
  "ExpiringIn": 23
}

application/xml, text/xml

Sample:

<PartnerSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <AccountManagerID>14</AccountManagerID>
  <AccountManagerName>sample string 15</AccountManagerName>
  <ActiveFromDate>2026-08-14T17:38:46.9964947+01:00</ActiveFromDate>
  <ActiveToDate>2026-08-14T17:38:46.9964947+01:00</ActiveToDate>
  <AddressLine>sample string 8</AddressLine>
  <BrokerCode>sample string 1</BrokerCode>
  <BusinessLeft>true</BusinessLeft>
  <ComValueEnd>1</ComValueEnd>
  <ComValueStart>1</ComValueStart>
  <County>sample string 7</County>
  <EmailAddress>sample string 12</EmailAddress>
  <EndDate>2026-08-14T17:38:46.9964947+01:00</EndDate>
  <ExpiringIn>23</ExpiringIn>
  <FirstName>sample string 2</FirstName>
  <InactiveToDate>2026-08-14T17:38:46.9964947+01:00</InactiveToDate>
  <NumClientEnd>1</NumClientEnd>
  <NumClientStart>1</NumClientStart>
  <PageIndex>20</PageIndex>
  <PageSize>21</PageSize>
  <PartnerType>13</PartnerType>
  <Postcode>sample string 9</Postcode>
  <ShowStatistics>true</ShowStatistics>
  <ShowTotalComm>true</ShowTotalComm>
  <SignedFromDate>2026-08-14T17:38:46.9964947+01:00</SignedFromDate>
  <SignedToDate>2026-08-14T17:38:46.9964947+01:00</SignedToDate>
  <SortOrder>sample string 18</SortOrder>
  <SortOrderID>19</SortOrderID>
  <StartDate>2026-08-14T17:38:46.9964947+01:00</StartDate>
  <SurName>sample string 3</SurName>
  <Suspended>true</Suspended>
  <Telephone>sample string 5</Telephone>
  <Town>sample string 6</Town>
  <TradingName>sample string 4</TradingName>
  <userTypeId>22</userTypeId>
</PartnerSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponseOfGridPageResultOfBrokerListItemDto

Name	Type	Additional information
Data	GridPageResultOfBrokerListItemDto	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "TotalRecords": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "PageCount": 4,
    "Records": [
      {
        "BrokerCode": "sample string 1",
        "BrokerType": "sample string 2",
        "Name": "sample string 3",
        "TelephoneNo": "sample string 4",
        "MobileNo": "sample string 5",
        "FaxNo": "sample string 6",
        "Town": "sample string 7",
        "ExpiredOn": "2026-08-14T17:38:46.9984955+01:00",
        "ExpiredInMonths": "sample string 9"
      },
      {
        "BrokerCode": "sample string 1",
        "BrokerType": "sample string 2",
        "Name": "sample string 3",
        "TelephoneNo": "sample string 4",
        "MobileNo": "sample string 5",
        "FaxNo": "sample string 6",
        "Town": "sample string 7",
        "ExpiredOn": "2026-08-14T17:38:46.9984955+01:00",
        "ExpiredInMonths": "sample string 9"
      }
    ]
  },
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ApiResponseOfGridPageResultOfBrokerListItemDtoVcCOJ51bVcCOJ51b xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Data>
    <PageCount>4</PageCount>
    <PageIndex>2</PageIndex>
    <PageSize>3</PageSize>
    <Records>
      <BrokerListItemDto>
        <BrokerCode>sample string 1</BrokerCode>
        <BrokerType>sample string 2</BrokerType>
        <ExpiredInMonths>sample string 9</ExpiredInMonths>
        <ExpiredOn>2026-08-14T17:38:46.9984955+01:00</ExpiredOn>
        <FaxNo>sample string 6</FaxNo>
        <MobileNo>sample string 5</MobileNo>
        <Name>sample string 3</Name>
        <TelephoneNo>sample string 4</TelephoneNo>
        <Town>sample string 7</Town>
      </BrokerListItemDto>
      <BrokerListItemDto>
        <BrokerCode>sample string 1</BrokerCode>
        <BrokerType>sample string 2</BrokerType>
        <ExpiredInMonths>sample string 9</ExpiredInMonths>
        <ExpiredOn>2026-08-14T17:38:46.9984955+01:00</ExpiredOn>
        <FaxNo>sample string 6</FaxNo>
        <MobileNo>sample string 5</MobileNo>
        <Name>sample string 3</Name>
        <TelephoneNo>sample string 4</TelephoneNo>
        <Town>sample string 7</Town>
      </BrokerListItemDto>
    </Records>
    <TotalRecords>1</TotalRecords>
  </Data>
</ApiResponseOfGridPageResultOfBrokerListItemDtoVcCOJ51bVcCOJ51b>