GET api/v1/Goals/{Email}/{AgencyId}

Request Information

URI Parameters

Name	Description	Type	Additional information
Email		string	Required
AgencyId		string	Required

Body Parameters

None.

Response Information

Resource Description

GoalsTransactionDetailsDTO

Name	Type	Additional information
ID	integer	None.
GoalID	string	None.
AgencyDatabaseID	string	None.
GoalType	string	None.
CarrierCompany	string	None.
GoalAmount	integer	None.
GoalStartDate	date	None.
GoalTargetDate	date	None.
GoalProgress	string	None.
Active	boolean	None.
Deleted	boolean	None.
IsLatest	boolean	None.
CreatedBy	string	None.
CreatedDateTime	date	None.
GoalTransactions	Collection of AgencyGoalsTransactionLogDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "GoalID": "sample string 2",
  "AgencyDatabaseID": "sample string 3",
  "GoalType": "sample string 4",
  "CarrierCompany": "sample string 5",
  "GoalAmount": 1,
  "GoalStartDate": "2025-04-29T13:53:50.5692348-04:00",
  "GoalTargetDate": "2025-04-29T13:53:50.5692348-04:00",
  "GoalProgress": "sample string 8",
  "Active": true,
  "Deleted": true,
  "IsLatest": true,
  "CreatedBy": "sample string 12",
  "CreatedDateTime": "2025-04-29T13:53:50.5692348-04:00",
  "GoalTransactions": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "GoalID": "sample string 1",
        "Premium": 1,
        "Commission": 1,
        "EstimatedPremium": 1,
        "EstimatedCommission": 1,
        "PolTypeLOB": "sample string 2",
        "LineOfBus": "sample string 3",
        "CarrierCompany": "sample string 4",
        "CompanyGroup": "sample string 5",
        "WrittingCompany": "sample string 6",
        "Description": "sample string 7",
        "CustomerFullName": "sample string 8",
        "PolNo": "sample string 9",
        "BatchID": "sample string 10",
        "InvoiceTransactionDescription": "sample string 11",
        "CustomerCity": "sample string 12",
        "CustomerState": "sample string 13",
        "CustomerZipCode": "sample string 14",
        "CustId": "sample string 15",
        "PolId": "sample string 16",
        "PolEffDate": "sample string 17",
        "PolExpDate": "sample string 18",
        "PostedDate": "2025-04-29T13:53:50.5692348-04:00",
        "InvNo": "sample string 19",
        "InvDate": "sample string 20",
        "GoalTranProgress": "sample string 21",
        "TranTypeDescription": "sample string 22",
        "CreatedDateTime": "2025-04-29T13:53:50.5692348-04:00"
      },
      {
        "$ref": "3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GoalsTransactionDetailsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAIS.API.Models.MobileApp">
  <Active>true</Active>
  <AgencyDatabaseID>sample string 3</AgencyDatabaseID>
  <CarrierCompany>sample string 5</CarrierCompany>
  <CreatedBy>sample string 12</CreatedBy>
  <CreatedDateTime>2025-04-29T13:53:50.5692348-04:00</CreatedDateTime>
  <Deleted>true</Deleted>
  <GoalAmount>1</GoalAmount>
  <GoalID>sample string 2</GoalID>
  <GoalProgress>sample string 8</GoalProgress>
  <GoalStartDate>2025-04-29T13:53:50.5692348-04:00</GoalStartDate>
  <GoalTargetDate>2025-04-29T13:53:50.5692348-04:00</GoalTargetDate>
  <GoalTransactions>
    <AgencyGoalsTransactionLogDTO>
      <BatchID>sample string 10</BatchID>
      <CarrierCompany>sample string 4</CarrierCompany>
      <Commission>1</Commission>
      <CompanyGroup>sample string 5</CompanyGroup>
      <CreatedDateTime>2025-04-29T13:53:50.5692348-04:00</CreatedDateTime>
      <CustId>sample string 15</CustId>
      <CustomerCity>sample string 12</CustomerCity>
      <CustomerFullName>sample string 8</CustomerFullName>
      <CustomerState>sample string 13</CustomerState>
      <CustomerZipCode>sample string 14</CustomerZipCode>
      <Description>sample string 7</Description>
      <EstimatedCommission>1</EstimatedCommission>
      <EstimatedPremium>1</EstimatedPremium>
      <GoalID>sample string 1</GoalID>
      <GoalTranProgress>sample string 21</GoalTranProgress>
      <InvDate>sample string 20</InvDate>
      <InvNo>sample string 19</InvNo>
      <InvoiceTransactionDescription>sample string 11</InvoiceTransactionDescription>
      <LineOfBus>sample string 3</LineOfBus>
      <PolEffDate>sample string 17</PolEffDate>
      <PolExpDate>sample string 18</PolExpDate>
      <PolId>sample string 16</PolId>
      <PolNo>sample string 9</PolNo>
      <PolTypeLOB>sample string 2</PolTypeLOB>
      <PostedDate>2025-04-29T13:53:50.5692348-04:00</PostedDate>
      <Premium>1</Premium>
      <TranTypeDescription>sample string 22</TranTypeDescription>
      <WrittingCompany>sample string 6</WrittingCompany>
    </AgencyGoalsTransactionLogDTO>
    <AgencyGoalsTransactionLogDTO>
      <BatchID>sample string 10</BatchID>
      <CarrierCompany>sample string 4</CarrierCompany>
      <Commission>1</Commission>
      <CompanyGroup>sample string 5</CompanyGroup>
      <CreatedDateTime>2025-04-29T13:53:50.5692348-04:00</CreatedDateTime>
      <CustId>sample string 15</CustId>
      <CustomerCity>sample string 12</CustomerCity>
      <CustomerFullName>sample string 8</CustomerFullName>
      <CustomerState>sample string 13</CustomerState>
      <CustomerZipCode>sample string 14</CustomerZipCode>
      <Description>sample string 7</Description>
      <EstimatedCommission>1</EstimatedCommission>
      <EstimatedPremium>1</EstimatedPremium>
      <GoalID>sample string 1</GoalID>
      <GoalTranProgress>sample string 21</GoalTranProgress>
      <InvDate>sample string 20</InvDate>
      <InvNo>sample string 19</InvNo>
      <InvoiceTransactionDescription>sample string 11</InvoiceTransactionDescription>
      <LineOfBus>sample string 3</LineOfBus>
      <PolEffDate>sample string 17</PolEffDate>
      <PolExpDate>sample string 18</PolExpDate>
      <PolId>sample string 16</PolId>
      <PolNo>sample string 9</PolNo>
      <PolTypeLOB>sample string 2</PolTypeLOB>
      <PostedDate>2025-04-29T13:53:50.5692348-04:00</PostedDate>
      <Premium>1</Premium>
      <TranTypeDescription>sample string 22</TranTypeDescription>
      <WrittingCompany>sample string 6</WrittingCompany>
    </AgencyGoalsTransactionLogDTO>
  </GoalTransactions>
  <GoalType>sample string 4</GoalType>
  <ID>1</ID>
  <IsLatest>true</IsLatest>
</GoalsTransactionDetailsDTO>