POST api/PIMS/GetVendorReport

Request Information

URI Parameters

None.

Body Parameters

GenerateReportReq
NameDescriptionTypeAdditional information
PropertyID

integer

None.

FromDate

string

None.

ToDate

string

None.

ReportType

string

None.

TimeOffset

integer

None.

Vendor

integer

None.

Entity

integer

None.

Maid

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PropertyID": 1,
  "FromDate": "sample string 2",
  "ToDate": "sample string 3",
  "ReportType": "sample string 4",
  "TimeOffset": 5,
  "Vendor": 6,
  "Entity": 7,
  "Maid": 8
}

application/xml, text/xml

Sample:
<GenerateReportReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PIMS.DTO">
  <Entity>7</Entity>
  <FromDate>sample string 2</FromDate>
  <Maid>8</Maid>
  <PropertyID>1</PropertyID>
  <ReportType>sample string 4</ReportType>
  <TimeOffset>5</TimeOffset>
  <ToDate>sample string 3</ToDate>
  <Vendor>6</Vendor>
</GenerateReportReq>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VendorReportModel
NameDescriptionTypeAdditional information
PropertyName

string

None.

vendorDetails

Collection of VendorDetails

None.

Total

Collection of TotalDetails

None.

vendorName

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "PropertyName": "sample string 1",
  "vendorDetails": [
    {
      "Name": "sample string 1",
      "Total": [
        1.1,
        2.1
      ],
      "cleaningFees": 2.1,
      "Rent": 3.1,
      "electricity": 4.1,
      "water": 5.1,
      "gas": 6.1,
      "cable": 7.1,
      "yardMaintenanace": 8.1,
      "entityName": "sample string 9"
    },
    {
      "Name": "sample string 1",
      "Total": [
        1.1,
        2.1
      ],
      "cleaningFees": 2.1,
      "Rent": 3.1,
      "electricity": 4.1,
      "water": 5.1,
      "gas": 6.1,
      "cable": 7.1,
      "yardMaintenanace": 8.1,
      "entityName": "sample string 9"
    }
  ],
  "Total": [
    {
      "Name": "sample string 1",
      "entityName": "sample string 2",
      "Total": 3.1,
      "UtilityTotal": 4.1,
      "Rent": 5.1
    },
    {
      "Name": "sample string 1",
      "entityName": "sample string 2",
      "Total": 3.1,
      "UtilityTotal": 4.1,
      "Rent": 5.1
    }
  ],
  "vendorName": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<VendorReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PIMS.DTO">
  <PropertyName>sample string 1</PropertyName>
  <Total>
    <TotalDetails>
      <Name>sample string 1</Name>
      <Rent>5.1</Rent>
      <Total>3.1</Total>
      <UtilityTotal>4.1</UtilityTotal>
      <entityName>sample string 2</entityName>
    </TotalDetails>
    <TotalDetails>
      <Name>sample string 1</Name>
      <Rent>5.1</Rent>
      <Total>3.1</Total>
      <UtilityTotal>4.1</UtilityTotal>
      <entityName>sample string 2</entityName>
    </TotalDetails>
  </Total>
  <vendorDetails>
    <VendorDetails>
      <Name>sample string 1</Name>
      <Rent>3.1</Rent>
      <Total xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:double>1.1</d4p1:double>
        <d4p1:double>2.1</d4p1:double>
      </Total>
      <cable>7.1</cable>
      <cleaningFees>2.1</cleaningFees>
      <electricity>4.1</electricity>
      <entityName>sample string 9</entityName>
      <gas>6.1</gas>
      <water>5.1</water>
      <yardMaintenanace>8.1</yardMaintenanace>
    </VendorDetails>
    <VendorDetails>
      <Name>sample string 1</Name>
      <Rent>3.1</Rent>
      <Total xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:double>1.1</d4p1:double>
        <d4p1:double>2.1</d4p1:double>
      </Total>
      <cable>7.1</cable>
      <cleaningFees>2.1</cleaningFees>
      <electricity>4.1</electricity>
      <entityName>sample string 9</entityName>
      <gas>6.1</gas>
      <water>5.1</water>
      <yardMaintenanace>8.1</yardMaintenanace>
    </VendorDetails>
  </vendorDetails>
  <vendorName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </vendorName>
</VendorReportModel>