POST WebPortal/UpdateWebPortal
Request Information
URI Parameters
None.
Body Parameters
WebPortal| Name | Description | Type | Additional information |
|---|---|---|---|
| webPortalKey | integer |
Required |
|
| friendlyName | string |
Required |
|
| displayName | string |
None. |
|
| contentPath | string |
None. |
|
| uploadPath | string |
None. |
|
| landingPageURL | string |
None. |
|
| DefaultLayoutPage | string |
None. |
|
| nextPublishDate | date |
Required |
|
| isActive | boolean |
Required |
|
| pageTitle | string |
None. |
|
| NotificationsActive | boolean |
None. |
|
| NotificationAddress | string |
None. |
|
| PortalDetails | Collection of WebPortalDetail |
None. |
|
| PortalConfigurations | Collection of WebPortalConfiguration |
None. |
|
| DuplicateUser | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"webPortalKey": 1,
"friendlyName": "sample string 2",
"displayName": "sample string 3",
"contentPath": "sample string 4",
"uploadPath": "sample string 5",
"landingPageURL": "sample string 6",
"DefaultLayoutPage": "sample string 7",
"nextPublishDate": "2025-11-02T17:19:38.464702-06:00",
"isActive": true,
"pageTitle": "sample string 10",
"NotificationsActive": true,
"NotificationAddress": "sample string 12",
"PortalDetails": [
{
"Id": 1,
"webPortalKey": 2,
"FriendlyName": "sample string 3",
"OwnerDesc": "sample string 4",
"ownerType": 5,
"ownerTypeValueId": 6,
"ownerKey": 7,
"nextPublishDate": "2025-11-02T17:19:38.464702-06:00",
"isActive": true,
"IncludeChildAff": true,
"AllowEnrollment": true,
"NotificationsActive": true,
"AuthCode": "sample string 13",
"NotificationAddress": "sample string 14"
},
{
"Id": 1,
"webPortalKey": 2,
"FriendlyName": "sample string 3",
"OwnerDesc": "sample string 4",
"ownerType": 5,
"ownerTypeValueId": 6,
"ownerKey": 7,
"nextPublishDate": "2025-11-02T17:19:38.464702-06:00",
"isActive": true,
"IncludeChildAff": true,
"AllowEnrollment": true,
"NotificationsActive": true,
"AuthCode": "sample string 13",
"NotificationAddress": "sample string 14"
}
],
"PortalConfigurations": [
{
"Id": 1,
"webPortalKey": 2,
"configurationTypeDesc": "sample string 3",
"ConfigurationTypeValueID": 4,
"configurationValue": "sample string 5"
},
{
"Id": 1,
"webPortalKey": 2,
"configurationTypeDesc": "sample string 3",
"ConfigurationTypeValueID": 4,
"configurationValue": "sample string 5"
}
],
"DuplicateUser": 13
}
application/xml, text/xml
Sample:
<WebPortal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
<DefaultLayoutPage>sample string 7</DefaultLayoutPage>
<DuplicateUser>13</DuplicateUser>
<NotificationAddress>sample string 12</NotificationAddress>
<NotificationsActive>true</NotificationsActive>
<PortalConfigurations>
<WebPortalConfiguration>
<ConfigurationTypeValueID>4</ConfigurationTypeValueID>
<Id>1</Id>
<configurationTypeDesc>sample string 3</configurationTypeDesc>
<configurationValue>sample string 5</configurationValue>
<webPortalKey>2</webPortalKey>
</WebPortalConfiguration>
<WebPortalConfiguration>
<ConfigurationTypeValueID>4</ConfigurationTypeValueID>
<Id>1</Id>
<configurationTypeDesc>sample string 3</configurationTypeDesc>
<configurationValue>sample string 5</configurationValue>
<webPortalKey>2</webPortalKey>
</WebPortalConfiguration>
</PortalConfigurations>
<PortalDetails>
<WebPortalDetail>
<AllowEnrollment>true</AllowEnrollment>
<AuthCode>sample string 13</AuthCode>
<FriendlyName>sample string 3</FriendlyName>
<Id>1</Id>
<IncludeChildAff>true</IncludeChildAff>
<NotificationAddress>sample string 14</NotificationAddress>
<NotificationsActive>true</NotificationsActive>
<OwnerDesc>sample string 4</OwnerDesc>
<isActive>true</isActive>
<nextPublishDate>2025-11-02T17:19:38.464702-06:00</nextPublishDate>
<ownerKey>7</ownerKey>
<ownerType>5</ownerType>
<ownerTypeValueId>6</ownerTypeValueId>
<webPortalKey>2</webPortalKey>
</WebPortalDetail>
<WebPortalDetail>
<AllowEnrollment>true</AllowEnrollment>
<AuthCode>sample string 13</AuthCode>
<FriendlyName>sample string 3</FriendlyName>
<Id>1</Id>
<IncludeChildAff>true</IncludeChildAff>
<NotificationAddress>sample string 14</NotificationAddress>
<NotificationsActive>true</NotificationsActive>
<OwnerDesc>sample string 4</OwnerDesc>
<isActive>true</isActive>
<nextPublishDate>2025-11-02T17:19:38.464702-06:00</nextPublishDate>
<ownerKey>7</ownerKey>
<ownerType>5</ownerType>
<ownerTypeValueId>6</ownerTypeValueId>
<webPortalKey>2</webPortalKey>
</WebPortalDetail>
</PortalDetails>
<contentPath>sample string 4</contentPath>
<displayName>sample string 3</displayName>
<friendlyName>sample string 2</friendlyName>
<isActive>true</isActive>
<landingPageURL>sample string 6</landingPageURL>
<nextPublishDate>2025-11-02T17:19:38.464702-06:00</nextPublishDate>
<pageTitle>sample string 10</pageTitle>
<uploadPath>sample string 5</uploadPath>
<webPortalKey>1</webPortalKey>
</WebPortal>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.