GET api/cms/{platform}/documents/page-region/{pageRegion}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| platform | string |
Required |
|
| pageRegion | BO.BETResponseObjects.General.PageRegions |
Required |
Body Parameters
None.
Response Information
Resource Description
BO.BETResponseObjects.BaseResponseOfSystem.Collections.Generic.ListOfBO.BETResponseObjects.General.CmsDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseObject | Collection of BO.BETResponseObjects.General.CmsDocument |
None. |
|
| ResponseMessage | string |
None. |
|
| ResponseType | BO.Enums.ResponseType |
None. |
Response Formats
application/json, text/json
Sample:
{
"responseObject": [
{
"id": 1,
"parentId": 1,
"platformId": 2,
"title": "sample string 3",
"url": "sample string 4",
"path": "sample string 5",
"description": "sample string 6",
"body": "sample string 7",
"externalLink": "sample string 8",
"sortOrder": 9,
"showInHeader": true,
"showInFooter": true,
"hyperlinkKey": 1,
"isNewLink": true,
"trail": [
1,
2
],
"documentType": 1,
"facilities": [
{
"id": 1,
"name": "sample string 2",
"imageURL": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"imageURL": "sample string 3"
}
],
"icon": {
"imageId": 1,
"title": "sample string 2",
"imageURL": "sample string 3"
},
"useDefaultIcon": true,
"iframeCode": "sample string 14",
"disableBeforeLogin": true,
"disableAfterLogin": true,
"pageRegions": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"platformTypeId": 4
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"platformTypeId": 4
}
],
"target": 1
},
{
"id": 1,
"parentId": 1,
"platformId": 2,
"title": "sample string 3",
"url": "sample string 4",
"path": "sample string 5",
"description": "sample string 6",
"body": "sample string 7",
"externalLink": "sample string 8",
"sortOrder": 9,
"showInHeader": true,
"showInFooter": true,
"hyperlinkKey": 1,
"isNewLink": true,
"trail": [
1,
2
],
"documentType": 1,
"facilities": [
{
"id": 1,
"name": "sample string 2",
"imageURL": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"imageURL": "sample string 3"
}
],
"icon": {
"imageId": 1,
"title": "sample string 2",
"imageURL": "sample string 3"
},
"useDefaultIcon": true,
"iframeCode": "sample string 14",
"disableBeforeLogin": true,
"disableAfterLogin": true,
"pageRegions": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"platformTypeId": 4
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"platformTypeId": 4
}
],
"target": 1
}
],
"responseMessage": "sample string 1",
"responseType": 1
}
application/xml, text/xml
Sample:
<BaseResponseOfListOfCmsDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ResponseObject>
<CmsDocument>
<Id>1</Id>
<ParentId>1</ParentId>
<PlatformId>2</PlatformId>
<Title>sample string 3</Title>
<Url>sample string 4</Url>
<Path>sample string 5</Path>
<Description>sample string 6</Description>
<Body>sample string 7</Body>
<ExternalLink>sample string 8</ExternalLink>
<SortOrder>9</SortOrder>
<ShowInHeader>true</ShowInHeader>
<ShowInFooter>true</ShowInFooter>
<HyperlinkKey>TermsAndConditions</HyperlinkKey>
<IsNewLink>true</IsNewLink>
<Trail>
<int>1</int>
<int>2</int>
</Trail>
<DocumentType>MenuLink</DocumentType>
<Facilities>
<CmsFacility>
<Id>1</Id>
<Name>sample string 2</Name>
<ImageURL>sample string 3</ImageURL>
</CmsFacility>
<CmsFacility>
<Id>1</Id>
<Name>sample string 2</Name>
<ImageURL>sample string 3</ImageURL>
</CmsFacility>
</Facilities>
<Icon>
<ImageId>1</ImageId>
<Title>sample string 2</Title>
<ImageURL>sample string 3</ImageURL>
</Icon>
<UseDefaultIcon>true</UseDefaultIcon>
<IframeCode>sample string 14</IframeCode>
<DisableBeforeLogin>true</DisableBeforeLogin>
<DisableAfterLogin>true</DisableAfterLogin>
<PageRegions>
<CmsPageRegion>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<PlatformTypeId>4</PlatformTypeId>
</CmsPageRegion>
<CmsPageRegion>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<PlatformTypeId>4</PlatformTypeId>
</CmsPageRegion>
</PageRegions>
<Target>Default</Target>
</CmsDocument>
<CmsDocument>
<Id>1</Id>
<ParentId>1</ParentId>
<PlatformId>2</PlatformId>
<Title>sample string 3</Title>
<Url>sample string 4</Url>
<Path>sample string 5</Path>
<Description>sample string 6</Description>
<Body>sample string 7</Body>
<ExternalLink>sample string 8</ExternalLink>
<SortOrder>9</SortOrder>
<ShowInHeader>true</ShowInHeader>
<ShowInFooter>true</ShowInFooter>
<HyperlinkKey>TermsAndConditions</HyperlinkKey>
<IsNewLink>true</IsNewLink>
<Trail>
<int>1</int>
<int>2</int>
</Trail>
<DocumentType>MenuLink</DocumentType>
<Facilities>
<CmsFacility>
<Id>1</Id>
<Name>sample string 2</Name>
<ImageURL>sample string 3</ImageURL>
</CmsFacility>
<CmsFacility>
<Id>1</Id>
<Name>sample string 2</Name>
<ImageURL>sample string 3</ImageURL>
</CmsFacility>
</Facilities>
<Icon>
<ImageId>1</ImageId>
<Title>sample string 2</Title>
<ImageURL>sample string 3</ImageURL>
</Icon>
<UseDefaultIcon>true</UseDefaultIcon>
<IframeCode>sample string 14</IframeCode>
<DisableBeforeLogin>true</DisableBeforeLogin>
<DisableAfterLogin>true</DisableAfterLogin>
<PageRegions>
<CmsPageRegion>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<PlatformTypeId>4</PlatformTypeId>
</CmsPageRegion>
<CmsPageRegion>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<PlatformTypeId>4</PlatformTypeId>
</CmsPageRegion>
</PageRegions>
<Target>Default</Target>
</CmsDocument>
</ResponseObject>
<ResponseMessage>sample string 1</ResponseMessage>
<ResponseType>Success</ResponseType>
</BaseResponseOfListOfCmsDocument>