GET api/affiliate/getBasicAffiliate?Id={Id}&Username={Username}&UserType={UserType}

Returns basic information about an affiliate. If no details are found it will return an error.

Request Information

URI Parameters

Name	Description	Type	Additional information
Id	The numeric ID of the affiliate.	integer	None.
Username	The LeadPageUrl username of the affiliate. Will be ignored if is provided.	string	None.
UserType	The type of affiliate to look up. Can only used together with .	AffiliateType	None.

Body Parameters

None.

Response Information

Resource Description

Basic affiliate information

AffiliateResponseOfAffiliateBasicInfo

Name	Type	Additional information
Message	string	None.
HasError	boolean	None.
Data	AffiliateBasicInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "hasError": true,
  "data": {
    "fullName": "sample string 1",
    "preferredName": "sample string 2",
    "id": "sample string 3",
    "country": "sample string 4",
    "state": "sample string 5",
    "stateCode": "sample string 6",
    "photoUrl": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<AffiliateResponseOfAffiliateBasicInfo20rHeOss xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Affiliates">
  <Data>
    <Country>sample string 4</Country>
    <FullName>sample string 1</FullName>
    <Id>sample string 3</Id>
    <PhotoUrl>sample string 7</PhotoUrl>
    <PreferredName>sample string 2</PreferredName>
    <State>sample string 5</State>
    <StateCode>sample string 6</StateCode>
  </Data>
  <Message>sample string 1</Message>
</AffiliateResponseOfAffiliateBasicInfo20rHeOss>