POST api/admin/getgeneraldashboarddetails

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Header		RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GetGeneralDashBoardDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Admin.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
</GetGeneralDashBoardDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetGeneralDashBoardDetailsResponse

Name	Description	Type	Additional information
Details		AdminGeneralDashboardDetail	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Details": {
    "TotalPolicies": 1,
    "ActivePolicies": 2,
    "ExpiringSoonPolicies": 3,
    "RecentlyExpiredPolicies": 4,
    "TotalFirms": 5,
    "FirmsWithActivePolicies": 6,
    "FirmsWithOnlyExpiredPolicies": 7,
    "FirmsAddedThisMonth": 8,
    "FirmsAddedLastMonth": 9,
    "FirmsAddedThisYear": 10,
    "ActiveLives": 11,
    "LivesAddedThroughEndorsement": 12,
    "LivesDeletedThroughEndorsement": 13,
    "TotalEndorsements": 14,
    "EndorsementsOnInForcePolicies": 15,
    "EndorsementsThisMonth": 16,
    "EndorsementsThisYear": 17,
    "EndorsementsProcessed": 18,
    "EndorsementsFailed": 19,
    "EndorsementsInProgress": 20,
    "AddEndorsements": 21,
    "DeleteEndorsements": 22,
    "DataCorrectionEndorsements": 23,
    "PremiumCorrectionEndorsements": 24
  },
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetGeneralDashBoardDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Admin.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
  <Details xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Admin">
    <d2p1:ActiveLives>11</d2p1:ActiveLives>
    <d2p1:ActivePolicies>2</d2p1:ActivePolicies>
    <d2p1:AddEndorsements>21</d2p1:AddEndorsements>
    <d2p1:DataCorrectionEndorsements>23</d2p1:DataCorrectionEndorsements>
    <d2p1:DeleteEndorsements>22</d2p1:DeleteEndorsements>
    <d2p1:EndorsementsFailed>19</d2p1:EndorsementsFailed>
    <d2p1:EndorsementsInProgress>20</d2p1:EndorsementsInProgress>
    <d2p1:EndorsementsOnInForcePolicies>15</d2p1:EndorsementsOnInForcePolicies>
    <d2p1:EndorsementsProcessed>18</d2p1:EndorsementsProcessed>
    <d2p1:EndorsementsThisMonth>16</d2p1:EndorsementsThisMonth>
    <d2p1:EndorsementsThisYear>17</d2p1:EndorsementsThisYear>
    <d2p1:ExpiringSoonPolicies>3</d2p1:ExpiringSoonPolicies>
    <d2p1:FirmsAddedLastMonth>9</d2p1:FirmsAddedLastMonth>
    <d2p1:FirmsAddedThisMonth>8</d2p1:FirmsAddedThisMonth>
    <d2p1:FirmsAddedThisYear>10</d2p1:FirmsAddedThisYear>
    <d2p1:FirmsWithActivePolicies>6</d2p1:FirmsWithActivePolicies>
    <d2p1:FirmsWithOnlyExpiredPolicies>7</d2p1:FirmsWithOnlyExpiredPolicies>
    <d2p1:LivesAddedThroughEndorsement>12</d2p1:LivesAddedThroughEndorsement>
    <d2p1:LivesDeletedThroughEndorsement>13</d2p1:LivesDeletedThroughEndorsement>
    <d2p1:PremiumCorrectionEndorsements>24</d2p1:PremiumCorrectionEndorsements>
    <d2p1:RecentlyExpiredPolicies>4</d2p1:RecentlyExpiredPolicies>
    <d2p1:TotalEndorsements>14</d2p1:TotalEndorsements>
    <d2p1:TotalFirms>5</d2p1:TotalFirms>
    <d2p1:TotalPolicies>1</d2p1:TotalPolicies>
  </Details>
</GetGeneralDashBoardDetailsResponse>