GET api/CommonApi/GetPolicyDetailsByEntityId?entityId={entityId}

Get policy details by Endity Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityId

integer

Required

Body Parameters

None.

Response Information

Resource Description

PolicyMemberDetails

Collection of PolicyMemberDetails
NameDescriptionTypeAdditional information
EntityId

integer

None.
MemberId

string

None.
FirstName

string

None.
LastName

string

None.
IsPrimary

boolean

None.
IsLoggedInMember

boolean

None.
Relationship

string

None.
ProductCategories

Collection of string

None.
ClaimType

Collection of string

None.
ClaimTypeOptions

Collection of ClaimTypeOption

None.
Policies

Collection of EntityPolicyDetails

None.
Email

string

None.
CountryOfResidence

string

None.
UserProfitRegion

string

None.
UserProductCategory

string

None.
UserProduct

string

None.
UserGroupId

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "EntityId": 1,
    "MemberId": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "IsPrimary": true,
    "IsLoggedInMember": true,
    "Relationship": "sample string 6",
    "ProductCategories": [
      "sample string 1",
      "sample string 2"
    ],
    "ClaimType": [
      "sample string 1",
      "sample string 2"
    ],
    "ClaimTypeOptions": [
      {
        "ClaimType": "sample string 1",
        "EnableApplyToNextInvoice": true
      },
      {
        "ClaimType": "sample string 1",
        "EnableApplyToNextInvoice": true
      }
    ],
    "Policies": [
      {
        "PolicyId": 1,
        "EffectiveDate": "2025-05-02T07:26:30.7734407-07:00",
        "Product": "sample string 3",
        "PolicyNumber": "sample string 4",
        "ProductCategory": "sample string 5",
        "ClaimType": "sample string 6"
      },
      {
        "PolicyId": 1,
        "EffectiveDate": "2025-05-02T07:26:30.7734407-07:00",
        "Product": "sample string 3",
        "PolicyNumber": "sample string 4",
        "ProductCategory": "sample string 5",
        "ClaimType": "sample string 6"
      }
    ],
    "Email": "sample string 7",
    "CountryOfResidence": "sample string 8",
    "UserProfitRegion": "sample string 9",
    "UserProductCategory": "sample string 10",
    "UserProduct": "sample string 11",
    "UserGroupId": "sample string 12"
  },
  {
    "EntityId": 1,
    "MemberId": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "IsPrimary": true,
    "IsLoggedInMember": true,
    "Relationship": "sample string 6",
    "ProductCategories": [
      "sample string 1",
      "sample string 2"
    ],
    "ClaimType": [
      "sample string 1",
      "sample string 2"
    ],
    "ClaimTypeOptions": [
      {
        "ClaimType": "sample string 1",
        "EnableApplyToNextInvoice": true
      },
      {
        "ClaimType": "sample string 1",
        "EnableApplyToNextInvoice": true
      }
    ],
    "Policies": [
      {
        "PolicyId": 1,
        "EffectiveDate": "2025-05-02T07:26:30.7734407-07:00",
        "Product": "sample string 3",
        "PolicyNumber": "sample string 4",
        "ProductCategory": "sample string 5",
        "ClaimType": "sample string 6"
      },
      {
        "PolicyId": 1,
        "EffectiveDate": "2025-05-02T07:26:30.7734407-07:00",
        "Product": "sample string 3",
        "PolicyNumber": "sample string 4",
        "ProductCategory": "sample string 5",
        "ClaimType": "sample string 6"
      }
    ],
    "Email": "sample string 7",
    "CountryOfResidence": "sample string 8",
    "UserProfitRegion": "sample string 9",
    "UserProductCategory": "sample string 10",
    "UserProduct": "sample string 11",
    "UserGroupId": "sample string 12"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPolicyMemberDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Policy">
  <PolicyMemberDetails>
    <ClaimType xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ClaimType>
    <ClaimTypeOptions>
      <ClaimTypeOption>
        <ClaimType>sample string 1</ClaimType>
        <EnableApplyToNextInvoice>true</EnableApplyToNextInvoice>
      </ClaimTypeOption>
      <ClaimTypeOption>
        <ClaimType>sample string 1</ClaimType>
        <EnableApplyToNextInvoice>true</EnableApplyToNextInvoice>
      </ClaimTypeOption>
    </ClaimTypeOptions>
    <CountryOfResidence>sample string 8</CountryOfResidence>
    <Email>sample string 7</Email>
    <EntityId>1</EntityId>
    <FirstName>sample string 3</FirstName>
    <IsLoggedInMember>true</IsLoggedInMember>
    <IsPrimary>true</IsPrimary>
    <LastName>sample string 4</LastName>
    <MemberId>sample string 2</MemberId>
    <Policies>
      <EntityPolicyDetails>
        <ClaimType>sample string 6</ClaimType>
        <EffectiveDate>2025-05-02T07:26:30.7734407-07:00</EffectiveDate>
        <PolicyId>1</PolicyId>
        <PolicyNumber>sample string 4</PolicyNumber>
        <Product>sample string 3</Product>
        <ProductCategory>sample string 5</ProductCategory>
      </EntityPolicyDetails>
      <EntityPolicyDetails>
        <ClaimType>sample string 6</ClaimType>
        <EffectiveDate>2025-05-02T07:26:30.7734407-07:00</EffectiveDate>
        <PolicyId>1</PolicyId>
        <PolicyNumber>sample string 4</PolicyNumber>
        <Product>sample string 3</Product>
        <ProductCategory>sample string 5</ProductCategory>
      </EntityPolicyDetails>
    </Policies>
    <ProductCategories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductCategories>
    <Relationship>sample string 6</Relationship>
    <UserGroupId>sample string 12</UserGroupId>
    <UserProduct>sample string 11</UserProduct>
    <UserProductCategory>sample string 10</UserProductCategory>
    <UserProfitRegion>sample string 9</UserProfitRegion>
  </PolicyMemberDetails>
  <PolicyMemberDetails>
    <ClaimType xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ClaimType>
    <ClaimTypeOptions>
      <ClaimTypeOption>
        <ClaimType>sample string 1</ClaimType>
        <EnableApplyToNextInvoice>true</EnableApplyToNextInvoice>
      </ClaimTypeOption>
      <ClaimTypeOption>
        <ClaimType>sample string 1</ClaimType>
        <EnableApplyToNextInvoice>true</EnableApplyToNextInvoice>
      </ClaimTypeOption>
    </ClaimTypeOptions>
    <CountryOfResidence>sample string 8</CountryOfResidence>
    <Email>sample string 7</Email>
    <EntityId>1</EntityId>
    <FirstName>sample string 3</FirstName>
    <IsLoggedInMember>true</IsLoggedInMember>
    <IsPrimary>true</IsPrimary>
    <LastName>sample string 4</LastName>
    <MemberId>sample string 2</MemberId>
    <Policies>
      <EntityPolicyDetails>
        <ClaimType>sample string 6</ClaimType>
        <EffectiveDate>2025-05-02T07:26:30.7734407-07:00</EffectiveDate>
        <PolicyId>1</PolicyId>
        <PolicyNumber>sample string 4</PolicyNumber>
        <Product>sample string 3</Product>
        <ProductCategory>sample string 5</ProductCategory>
      </EntityPolicyDetails>
      <EntityPolicyDetails>
        <ClaimType>sample string 6</ClaimType>
        <EffectiveDate>2025-05-02T07:26:30.7734407-07:00</EffectiveDate>
        <PolicyId>1</PolicyId>
        <PolicyNumber>sample string 4</PolicyNumber>
        <Product>sample string 3</Product>
        <ProductCategory>sample string 5</ProductCategory>
      </EntityPolicyDetails>
    </Policies>
    <ProductCategories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductCategories>
    <Relationship>sample string 6</Relationship>
    <UserGroupId>sample string 12</UserGroupId>
    <UserProduct>sample string 11</UserProduct>
    <UserProductCategory>sample string 10</UserProductCategory>
    <UserProfitRegion>sample string 9</UserProfitRegion>
  </PolicyMemberDetails>
</ArrayOfPolicyMemberDetails>