GET api/v1/{facilityId}/insurance/summary

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

InsuranceSummaryResponseModel

Name	Description	Type	Additional information
insurance_summary		InsuranceSummaryDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "insurance_summary": {
    "insured_tenants_count": 1,
    "new_policies_count": 1,
    "cancelled_policies_count": 1,
    "percentage_of_tenants_insured": 1.0,
    "coverage_total": 1.0,
    "payment_total": 1.0,
    "refund_total": 1.0,
    "net_payment_amount": 1.0,
    "start_date": "sample string 1",
    "end_date": "sample string 2",
    "facility_policy_number": "sample string 3",
    "master_policy_number": "sample string 4"
  },
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "b7bfe4fd-29d4-4ace-8643-c6b6bc82d252",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<InsuranceSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Insurance">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>b7bfe4fd-29d4-4ace-8643-c6b6bc82d252</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <InsuranceSummary>
    <CancelledPoliciesCount>1</CancelledPoliciesCount>
    <CoverageTotal>1</CoverageTotal>
    <EndDate>sample string 2</EndDate>
    <FacilityPolicyNumber>sample string 3</FacilityPolicyNumber>
    <InsuredTenantsCount>1</InsuredTenantsCount>
    <MasterPolicyNumber>sample string 4</MasterPolicyNumber>
    <NetPaymentAmount>1</NetPaymentAmount>
    <NewPoliciesCount>1</NewPoliciesCount>
    <PaymentTotal>1</PaymentTotal>
    <PercentageOfTenantsInsured>1</PercentageOfTenantsInsured>
    <RefundTotal>1</RefundTotal>
    <StartDate>sample string 1</StartDate>
  </InsuranceSummary>
</InsuranceSummaryResponseModel>