GET api/referrals/partners

This method will retrieve all partners that were signed up by user

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of

Collection of PartnerResponseModel
NameDescriptionTypeAdditional information
PartnerId

integer

None.

Name

string

None.

Company

string

None.

Phone

string

None.

Email

string

None.

AffiliateCode

string

None.

TotalReportCount

integer

None.

TotalLastMonthReportCount

integer

None.

TotalReferralCount

integer

None.

TotalLastMonthReferralCount

integer

None.

SignupDate

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "partnerId": 1,
    "name": "sample string 2",
    "company": "sample string 3",
    "phone": "sample string 4",
    "email": "sample string 5",
    "affiliateCode": "sample string 6",
    "totalReportCount": 7,
    "totalLastMonthReportCount": 8,
    "totalReferralCount": 9,
    "totalLastMonthReferralCount": 10,
    "signupDate": "sample string 11"
  },
  {
    "partnerId": 1,
    "name": "sample string 2",
    "company": "sample string 3",
    "phone": "sample string 4",
    "email": "sample string 5",
    "affiliateCode": "sample string 6",
    "totalReportCount": 7,
    "totalLastMonthReportCount": 8,
    "totalReferralCount": 9,
    "totalLastMonthReferralCount": 10,
    "signupDate": "sample string 11"
  }
]

text/html

Sample:
[{"partnerId":1,"name":"sample string 2","company":"sample string 3","phone":"sample string 4","email":"sample string 5","affiliateCode":"sample string 6","totalReportCount":7,"totalLastMonthReportCount":8,"totalReferralCount":9,"totalLastMonthReferralCount":10,"signupDate":"sample string 11"},{"partnerId":1,"name":"sample string 2","company":"sample string 3","phone":"sample string 4","email":"sample string 5","affiliateCode":"sample string 6","totalReportCount":7,"totalLastMonthReportCount":8,"totalReferralCount":9,"totalLastMonthReferralCount":10,"signupDate":"sample string 11"}]

application/xml, text/xml

Sample:
<ArrayOfPartnerResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Referrals">
  <PartnerResponseModel>
    <AffiliateCode>sample string 6</AffiliateCode>
    <Company>sample string 3</Company>
    <Email>sample string 5</Email>
    <Name>sample string 2</Name>
    <PartnerId>1</PartnerId>
    <Phone>sample string 4</Phone>
    <SignupDate>sample string 11</SignupDate>
    <TotalLastMonthReferralCount>10</TotalLastMonthReferralCount>
    <TotalLastMonthReportCount>8</TotalLastMonthReportCount>
    <TotalReferralCount>9</TotalReferralCount>
    <TotalReportCount>7</TotalReportCount>
  </PartnerResponseModel>
  <PartnerResponseModel>
    <AffiliateCode>sample string 6</AffiliateCode>
    <Company>sample string 3</Company>
    <Email>sample string 5</Email>
    <Name>sample string 2</Name>
    <PartnerId>1</PartnerId>
    <Phone>sample string 4</Phone>
    <SignupDate>sample string 11</SignupDate>
    <TotalLastMonthReferralCount>10</TotalLastMonthReferralCount>
    <TotalLastMonthReportCount>8</TotalLastMonthReportCount>
    <TotalReferralCount>9</TotalReferralCount>
    <TotalReportCount>7</TotalReportCount>
  </PartnerResponseModel>
</ArrayOfPartnerResponseModel>