GET v1/Policies/TransformationStation/Products?policyID={policyID}

Get products that are assigned to the carrier assigned to the policy

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyID

Id of the policy

string

Required

Body Parameters

None.

Response Information

Resource Description

Products that are assigned to the carrier assigned to the policy

PageOfOfTsProductDTO
NameDescriptionTypeAdditional information
Data

Collection of TsProductDTO

None.

PageNumber

integer

None.

PagesTotal

integer

None.

TotalItems

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

DisplayMessage

string

None.

Links

Collection of PageLink

None.

Href

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "HasLocalSecurity": true,
      "VendorDefinedCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "States": [
        "sample string 1",
        "sample string 2"
      ],
      "Commands": [
        {
          "Id": "sample string 1",
          "AcceptsAttachments": true,
          "Type": "sample string 3",
          "Description": "sample string 4",
          "AlwaysAvailable": true,
          "FormattedDisplayName": "sample string 6",
          "RemoteCredentials": {
            "EntityID": 1,
            "CommandId": "sample string 2",
            "TSRemoteUserName": "sample string 3",
            "TSRemoteUserPassword": "sample string 4"
          }
        },
        {
          "Id": "sample string 1",
          "AcceptsAttachments": true,
          "Type": "sample string 3",
          "Description": "sample string 4",
          "AlwaysAvailable": true,
          "FormattedDisplayName": "sample string 6",
          "RemoteCredentials": {
            "EntityID": 1,
            "CommandId": "sample string 2",
            "TSRemoteUserName": "sample string 3",
            "TSRemoteUserPassword": "sample string 4"
          }
        }
      ],
      "Carriers": [
        {
          "Id": 1,
          "ProductId": "sample string 2",
          "CarrierId": 3,
          "CarrierDisplayName": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": "sample string 2",
          "CarrierId": 3,
          "CarrierDisplayName": "sample string 4"
        }
      ],
      "CarriersDisplayString": "sample string 4, sample string 4",
      "CarrierIDs": [
        3,
        3
      ]
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "HasLocalSecurity": true,
      "VendorDefinedCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "States": [
        "sample string 1",
        "sample string 2"
      ],
      "Commands": [
        {
          "Id": "sample string 1",
          "AcceptsAttachments": true,
          "Type": "sample string 3",
          "Description": "sample string 4",
          "AlwaysAvailable": true,
          "FormattedDisplayName": "sample string 6",
          "RemoteCredentials": {
            "EntityID": 1,
            "CommandId": "sample string 2",
            "TSRemoteUserName": "sample string 3",
            "TSRemoteUserPassword": "sample string 4"
          }
        },
        {
          "Id": "sample string 1",
          "AcceptsAttachments": true,
          "Type": "sample string 3",
          "Description": "sample string 4",
          "AlwaysAvailable": true,
          "FormattedDisplayName": "sample string 6",
          "RemoteCredentials": {
            "EntityID": 1,
            "CommandId": "sample string 2",
            "TSRemoteUserName": "sample string 3",
            "TSRemoteUserPassword": "sample string 4"
          }
        }
      ],
      "Carriers": [
        {
          "Id": 1,
          "ProductId": "sample string 2",
          "CarrierId": 3,
          "CarrierDisplayName": "sample string 4"
        },
        {
          "Id": 1,
          "ProductId": "sample string 2",
          "CarrierId": 3,
          "CarrierDisplayName": "sample string 4"
        }
      ],
      "CarriersDisplayString": "sample string 4, sample string 4",
      "CarrierIDs": [
        3,
        3
      ]
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:
<PageOfTsProductDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.RealTimeInquiry">
    <d2p1:TsProductDTO>
      <d2p1:CarrierIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>3</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </d2p1:CarrierIDs>
      <d2p1:Carriers>
        <d2p1:TsProductCarrierDTO>
          <d2p1:CarrierDisplayName>sample string 4</d2p1:CarrierDisplayName>
          <d2p1:CarrierId>3</d2p1:CarrierId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:ProductId>sample string 2</d2p1:ProductId>
        </d2p1:TsProductCarrierDTO>
        <d2p1:TsProductCarrierDTO>
          <d2p1:CarrierDisplayName>sample string 4</d2p1:CarrierDisplayName>
          <d2p1:CarrierId>3</d2p1:CarrierId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:ProductId>sample string 2</d2p1:ProductId>
        </d2p1:TsProductCarrierDTO>
      </d2p1:Carriers>
      <d2p1:Commands>
        <d2p1:TsCommandDTO>
          <d2p1:AcceptsAttachments>true</d2p1:AcceptsAttachments>
          <d2p1:AlwaysAvailable>true</d2p1:AlwaysAvailable>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:FormattedDisplayName>sample string 6</d2p1:FormattedDisplayName>
          <d2p1:Id>sample string 1</d2p1:Id>
          <d2p1:RemoteCredentials>
            <d2p1:CommandId>sample string 2</d2p1:CommandId>
            <d2p1:EntityID>1</d2p1:EntityID>
            <d2p1:TSRemoteUserName>sample string 3</d2p1:TSRemoteUserName>
            <d2p1:TSRemoteUserPassword>sample string 4</d2p1:TSRemoteUserPassword>
          </d2p1:RemoteCredentials>
          <d2p1:Type>sample string 3</d2p1:Type>
        </d2p1:TsCommandDTO>
        <d2p1:TsCommandDTO>
          <d2p1:AcceptsAttachments>true</d2p1:AcceptsAttachments>
          <d2p1:AlwaysAvailable>true</d2p1:AlwaysAvailable>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:FormattedDisplayName>sample string 6</d2p1:FormattedDisplayName>
          <d2p1:Id>sample string 1</d2p1:Id>
          <d2p1:RemoteCredentials>
            <d2p1:CommandId>sample string 2</d2p1:CommandId>
            <d2p1:EntityID>1</d2p1:EntityID>
            <d2p1:TSRemoteUserName>sample string 3</d2p1:TSRemoteUserName>
            <d2p1:TSRemoteUserPassword>sample string 4</d2p1:TSRemoteUserPassword>
          </d2p1:RemoteCredentials>
          <d2p1:Type>sample string 3</d2p1:Type>
        </d2p1:TsCommandDTO>
      </d2p1:Commands>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:HasLocalSecurity>true</d2p1:HasLocalSecurity>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:States xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:States>
      <d2p1:VendorDefinedCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:VendorDefinedCodes>
    </d2p1:TsProductDTO>
    <d2p1:TsProductDTO>
      <d2p1:CarrierIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>3</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </d2p1:CarrierIDs>
      <d2p1:Carriers>
        <d2p1:TsProductCarrierDTO>
          <d2p1:CarrierDisplayName>sample string 4</d2p1:CarrierDisplayName>
          <d2p1:CarrierId>3</d2p1:CarrierId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:ProductId>sample string 2</d2p1:ProductId>
        </d2p1:TsProductCarrierDTO>
        <d2p1:TsProductCarrierDTO>
          <d2p1:CarrierDisplayName>sample string 4</d2p1:CarrierDisplayName>
          <d2p1:CarrierId>3</d2p1:CarrierId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:ProductId>sample string 2</d2p1:ProductId>
        </d2p1:TsProductCarrierDTO>
      </d2p1:Carriers>
      <d2p1:Commands>
        <d2p1:TsCommandDTO>
          <d2p1:AcceptsAttachments>true</d2p1:AcceptsAttachments>
          <d2p1:AlwaysAvailable>true</d2p1:AlwaysAvailable>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:FormattedDisplayName>sample string 6</d2p1:FormattedDisplayName>
          <d2p1:Id>sample string 1</d2p1:Id>
          <d2p1:RemoteCredentials>
            <d2p1:CommandId>sample string 2</d2p1:CommandId>
            <d2p1:EntityID>1</d2p1:EntityID>
            <d2p1:TSRemoteUserName>sample string 3</d2p1:TSRemoteUserName>
            <d2p1:TSRemoteUserPassword>sample string 4</d2p1:TSRemoteUserPassword>
          </d2p1:RemoteCredentials>
          <d2p1:Type>sample string 3</d2p1:Type>
        </d2p1:TsCommandDTO>
        <d2p1:TsCommandDTO>
          <d2p1:AcceptsAttachments>true</d2p1:AcceptsAttachments>
          <d2p1:AlwaysAvailable>true</d2p1:AlwaysAvailable>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:FormattedDisplayName>sample string 6</d2p1:FormattedDisplayName>
          <d2p1:Id>sample string 1</d2p1:Id>
          <d2p1:RemoteCredentials>
            <d2p1:CommandId>sample string 2</d2p1:CommandId>
            <d2p1:EntityID>1</d2p1:EntityID>
            <d2p1:TSRemoteUserName>sample string 3</d2p1:TSRemoteUserName>
            <d2p1:TSRemoteUserPassword>sample string 4</d2p1:TSRemoteUserPassword>
          </d2p1:RemoteCredentials>
          <d2p1:Type>sample string 3</d2p1:Type>
        </d2p1:TsCommandDTO>
      </d2p1:Commands>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:HasLocalSecurity>true</d2p1:HasLocalSecurity>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:States xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:States>
      <d2p1:VendorDefinedCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:VendorDefinedCodes>
    </d2p1:TsProductDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfTsProductDTO>