POST api/providers/filter?companyId={companyId}&RqUID={RqUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	None.
RqUID		string	None.

Body Parameters

RestProviderFilterDTO

Name	Type	Additional information
Term	string	None.
ClaimsActive	boolean	None.
Trusted	boolean	None.
ProviderIdExcluded	integer	None.
StartIndex	integer	Range: inclusive between 1 and 2147483647
EndIndex	integer	Range: inclusive between 1 and 2147483647

Request Formats

application/json, text/json

Sample:

{
  "Term": "sample string 1",
  "ClaimsActive": true,
  "Trusted": true,
  "ProviderIdExcluded": 1,
  "StartIndex": 2,
  "EndIndex": 3
}

application/xml, text/xml

Sample:

<RestProviderFilterDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Provider">
  <ClaimsActive>true</ClaimsActive>
  <EndIndex>3</EndIndex>
  <ProviderIdExcluded>1</ProviderIdExcluded>
  <StartIndex>2</StartIndex>
  <Term>sample string 1</Term>
  <Trusted>true</Trusted>
</RestProviderFilterDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RestListResponseDTOOfRestProviderFullDTO

Name	Type	Additional information
Count	integer	None.
List	Collection of RestProviderFullDTO	None.
RqUID	string	None.
Code	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Count": 1,
  "List": [
    {
      "Id": 1,
      "EntityCode": "sample string 2",
      "Trusted": true,
      "AddressList": [
        {
          "Address": "sample string 1",
          "PostCode": "sample string 2",
          "Locality": "sample string 3",
          "Province": "sample string 4"
        },
        {
          "Address": "sample string 1",
          "PostCode": "sample string 2",
          "Locality": "sample string 3",
          "Province": "sample string 4"
        }
      ],
      "ContactList": [
        {
          "Name": "sample string 1",
          "Phone": "sample string 2",
          "Mail": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Phone": "sample string 2",
          "Mail": "sample string 3"
        }
      ],
      "BOEntity": "sample string 4",
      "FirmName": "sample string 5",
      "CommercialName": "sample string 6"
    },
    {
      "Id": 1,
      "EntityCode": "sample string 2",
      "Trusted": true,
      "AddressList": [
        {
          "Address": "sample string 1",
          "PostCode": "sample string 2",
          "Locality": "sample string 3",
          "Province": "sample string 4"
        },
        {
          "Address": "sample string 1",
          "PostCode": "sample string 2",
          "Locality": "sample string 3",
          "Province": "sample string 4"
        }
      ],
      "ContactList": [
        {
          "Name": "sample string 1",
          "Phone": "sample string 2",
          "Mail": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Phone": "sample string 2",
          "Mail": "sample string 3"
        }
      ],
      "BOEntity": "sample string 4",
      "FirmName": "sample string 5",
      "CommercialName": "sample string 6"
    }
  ],
  "RqUID": "sample string 2",
  "Code": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<RestListResponseDTOOfRestProviderFullDTOoda9BAqG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">
  <Code>sample string 3</Code>
  <Message>sample string 4</Message>
  <RqUID>sample string 2</RqUID>
  <Count>1</Count>
  <List>
    <RestProviderFullDTO>
      <CommercialName>sample string 6</CommercialName>
      <FirmName>sample string 5</FirmName>
      <BOEntity>sample string 4</BOEntity>
      <AddressList>
        <RestAddressDTO>
          <Address>sample string 1</Address>
          <Locality>sample string 3</Locality>
          <PostCode>sample string 2</PostCode>
          <Province>sample string 4</Province>
        </RestAddressDTO>
        <RestAddressDTO>
          <Address>sample string 1</Address>
          <Locality>sample string 3</Locality>
          <PostCode>sample string 2</PostCode>
          <Province>sample string 4</Province>
        </RestAddressDTO>
      </AddressList>
      <ContactList>
        <RestContactDTO>
          <Mail>sample string 3</Mail>
          <Name>sample string 1</Name>
          <Phone>sample string 2</Phone>
        </RestContactDTO>
        <RestContactDTO>
          <Mail>sample string 3</Mail>
          <Name>sample string 1</Name>
          <Phone>sample string 2</Phone>
        </RestContactDTO>
      </ContactList>
      <EntityCode>sample string 2</EntityCode>
      <Id>1</Id>
      <Trusted>true</Trusted>
    </RestProviderFullDTO>
    <RestProviderFullDTO>
      <CommercialName>sample string 6</CommercialName>
      <FirmName>sample string 5</FirmName>
      <BOEntity>sample string 4</BOEntity>
      <AddressList>
        <RestAddressDTO>
          <Address>sample string 1</Address>
          <Locality>sample string 3</Locality>
          <PostCode>sample string 2</PostCode>
          <Province>sample string 4</Province>
        </RestAddressDTO>
        <RestAddressDTO>
          <Address>sample string 1</Address>
          <Locality>sample string 3</Locality>
          <PostCode>sample string 2</PostCode>
          <Province>sample string 4</Province>
        </RestAddressDTO>
      </AddressList>
      <ContactList>
        <RestContactDTO>
          <Mail>sample string 3</Mail>
          <Name>sample string 1</Name>
          <Phone>sample string 2</Phone>
        </RestContactDTO>
        <RestContactDTO>
          <Mail>sample string 3</Mail>
          <Name>sample string 1</Name>
          <Phone>sample string 2</Phone>
        </RestContactDTO>
      </ContactList>
      <EntityCode>sample string 2</EntityCode>
      <Id>1</Id>
      <Trusted>true</Trusted>
    </RestProviderFullDTO>
  </List>
</RestListResponseDTOOfRestProviderFullDTOoda9BAqG>