Documentation for GET api/user/rep/{repDIDorURL}/info?returnCancelledOverride={returnCancelledOverride}

GET api/user/rep/{repDIDorURL}/info?returnCancelledOverride={returnCancelledOverride}

Returns profile information for a specific representative. RepDID takes precedence in results if a Rep has the same RepDID as another Rep's URL.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDIDorURL	Representative identifier	string	Required
returnCancelledOverride	Flag to override existent setting to allow return cancel reps.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

IRepInfoViewModel

Name	Type	Additional information
RepID	integer	None.
RepDID	string	None.
Company	string	None.
FirstName	string	None.
LastName	string	None.
RomanizedCompany	string	None.
RomanizedFirstName	string	None.
RomanizedLastName	string	None.
Email	string	None.
BillStreet1	string	None.
BillStreet2	string	None.
BillCity	string	None.
BillState	string	None.
BillPostalCode	string	None.
BillCounty	string	None.
BillCountry	string	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipState	string	None.
ShipPostalCode	string	None.
ShipCounty	string	None.
ShipCountry	string	None.
Phone1	string	None.
Phone2	string	None.
Phone3	string	None.
Phone4	string	None.
Phone5	string	None.
Phone6	string	None.
PictureFilename	string	None.
PublicImageUrl	string	None.
ReplicatedSiteText	string	None.
SponsorRepDID	string	None.
SponsorRepCount	integer	None.
RankTypeID	integer	None.
RepStatusTypeID	integer	None.
RepStatusType	string	None.
URL	string	None.
UplineRepDID	string	None.
JoinDate	date	None.
RepTypeID	integer	None.
CustomField1	string	None.
CustomField2	string	None.
CustomField3	string	None.
CustomField4	string	None.
CustomField5	string	None.
CustomField6	string	None.
RenewalDate	string	None.
RepRenewalSKU	string	None.
MI	string	None.
PayToName	string	None.
DefaultLocaleID	integer	None.
Gender	string	None.
PreferredCulture	integer	None.
DateofBirth	date	None.
DivisionID	integer	None.
PasswordSet	boolean	None.
IsPasswordSet	boolean	None.
TaxID1	string	None.
TaxID2	string	None.
BonusAccountNumber	string	None.
BonusRoutingNumber	string	None.
BonusVendorName	string	None.
BonusAccountType	integer	None.
HasTaxID	boolean	None.
RepEntityTypeID	integer	None.
RepEntityType	string	None.
PreferredPlacement	string	None.

Response Formats

application/xml, text/xml

Sample:

<RepInfoViewModel>
  <RepID>0</RepID>
  <RepDID />
  <Company />
  <FirstName />
  <LastName />
  <RomanizedCompany />
  <RomanizedFirstName />
  <RomanizedLastName />
  <Email />
  <BillStreet1 />
  <BillStreet2 />
  <BillCity />
  <BillState />
  <BillPostalCode />
  <BillCounty />
  <BillCountry />
  <ShipStreet1 />
  <ShipStreet2 />
  <ShipCity />
  <ShipState />
  <ShipPostalCode />
  <ShipCounty />
  <ShipCountry />
  <Phone1 />
  <Phone2 />
  <Phone3 />
  <Phone4 />
  <Phone5 />
  <Phone6 />
  <PictureFilename />
  <PublicImageUrl />
  <ReplicatedSiteText />
  <SponsorRepDID />
  <SponsorRepCount>0</SponsorRepCount>
  <RankTypeID>0</RankTypeID>
  <RepStatusTypeID>0</RepStatusTypeID>
  <RepStatusType />
  <URL />
  <UplineRepDID />
  <JoinDate>01/01/0001 00:00:00</JoinDate>
  <RepTypeID>0</RepTypeID>
  <CustomField1 />
  <CustomField2 />
  <CustomField3 />
  <CustomField4 />
  <CustomField5 />
  <CustomField6 />
  <RenewalDate />
  <RepRenewalSKU />
  <MI />
  <PayToName />
  <DefaultLocaleID />
  <Gender />
  <PreferredCulture>0</PreferredCulture>
  <DateofBirth>01/01/0001 00:00:00</DateofBirth>
  <DivisionID>0</DivisionID>
  <PasswordSet>False</PasswordSet>
  <IsPasswordSet>False</IsPasswordSet>
  <TaxID1 />
  <TaxID2 />
  <BonusAccountNumber />
  <BonusRoutingNumber />
  <BonusVendorName />
  <BonusAccountType>0</BonusAccountType>
  <HasTaxID>False</HasTaxID>
  <RepEntityTypeID>0</RepEntityTypeID>
  <RepEntityType />
  <PreferredPlacement />
</RepInfoViewModel>

application/json, text/json

Sample:

{
  "RepID": 0,
  "SponsorRepCount": 0,
  "RankTypeID": 0,
  "RepStatusTypeID": 0,
  "JoinDate": "0001-01-01T00:00:00",
  "RepTypeID": 0,
  "PreferredCulture": 0,
  "DateofBirth": "0001-01-01T00:00:00",
  "DivisionID": 0,
  "IsPasswordSet": false,
  "BonusAccountType": 0,
  "HasTaxID": false,
  "RepEntityTypeID": 0
}