POST api/Referrals

Creates a new referral or updates an existent referral's information.

Request Information

URI Parameters

None.

Body Parameters

ReferralModel
NameDescriptionTypeAdditional information
Name

Name of the referral.

 string

None.
IsDefault

Indicates whether the referral is default or not.

 boolean

None.
SortOrder

Sort order of the referral.

 integer

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "isDefault": true,
  "sortOrder": 3,
  "id": "52f17d62-c9b3-4821-ae0d-6637d6f0024f",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<ReferralModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Referrals">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 5</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">52f17d62-c9b3-4821-ae0d-6637d6f0024f</Id>
  <IsDefault>true</IsDefault>
  <Name>sample string 1</Name>
  <SortOrder>3</SortOrder>
</ReferralModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReferralModel'.

Response Information

Resource Description

ReferralModel
NameDescriptionTypeAdditional information
Name

Name of the referral.

 string

None.
IsDefault

Indicates whether the referral is default or not.

 boolean

None.
SortOrder

Sort order of the referral.

 integer

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "isDefault": true,
  "sortOrder": 3,
  "id": "43280840-1cce-4c88-b9d6-a3ceb1e35daa",
  "externalId": "sample string 5"
}

application/xml, text/xml

Sample: 
<ReferralModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Referrals">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 5</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">43280840-1cce-4c88-b9d6-a3ceb1e35daa</Id>
  <IsDefault>true</IsDefault>
  <Name>sample string 1</Name>
  <SortOrder>3</SortOrder>
</ReferralModel>