GET api/v1/portals/{portalUid}/customer/referralsources
Gets the referral sources.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
The portal UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the referral sources for the customers portal.
Collection of ReferralSourceViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name. |
string |
None. |
| Description |
The description. |
string |
None. |
| Code |
The description. |
string |
None. |
| ReferralSourceGuid |
The unique identifier for the referral source |
globally unique identifier |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"ReferralSourceGuid": "62dd9360-eff2-4986-a9cc-547260f47b35",
"Uid": "4eef3a2a-a8ff-4b18-a31f-51d5dc1b8c39",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:58:19.4243795+00:00",
"UpdatedBy": "sample string 6"
},
{
"Name": "sample string 1",
"Description": "sample string 2",
"Code": "sample string 3",
"ReferralSourceGuid": "62dd9360-eff2-4986-a9cc-547260f47b35",
"Uid": "4eef3a2a-a8ff-4b18-a31f-51d5dc1b8c39",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:58:19.4243795+00:00",
"UpdatedBy": "sample string 6"
}
]
application/xml, text/xml
Sample:
<ArrayOfReferralSourceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<ReferralSourceViewModel>
<DateUpdated>2025-10-27T13:58:19.4243795+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>4eef3a2a-a8ff-4b18-a31f-51d5dc1b8c39</Uid>
<UpdatedBy>sample string 6</UpdatedBy>
<Code>sample string 3</Code>
<Description>sample string 2</Description>
<Name>sample string 1</Name>
<ReferralSourceGuid>62dd9360-eff2-4986-a9cc-547260f47b35</ReferralSourceGuid>
</ReferralSourceViewModel>
<ReferralSourceViewModel>
<DateUpdated>2025-10-27T13:58:19.4243795+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>4eef3a2a-a8ff-4b18-a31f-51d5dc1b8c39</Uid>
<UpdatedBy>sample string 6</UpdatedBy>
<Code>sample string 3</Code>
<Description>sample string 2</Description>
<Name>sample string 1</Name>
<ReferralSourceGuid>62dd9360-eff2-4986-a9cc-547260f47b35</ReferralSourceGuid>
</ReferralSourceViewModel>
</ArrayOfReferralSourceViewModel>