POST api/Content/CmsBlocksByIdentity

Returns the CMSBlock(s) based on the request.

Request Information

URI Parameters

None.

Body Parameters

cmsBlocksByIdentityRequest is a JSON object POSTed as the Body.

Name	Description	Type	Additional information
ArcNumber	ArcNumber is the agency id for the current user.	string	Required Max length: 10 Min length: 0
SiteCode	SiteCode should be a constant VAXPRO.	string	Required Max length: 10 Min length: 6
SubSite	SubSite can be blank to indicate the CMSBlocks come from the root site, non-blank values indicate which VendorCenterVendor's CMSBlocks to use.	string	Required Max length: 10 Min length: 0
IsLoggedIn	IsLoggedIn is true/false based on the current user.	boolean	Required
BlockLocations	BlockLocations is a list of string "BlockLocation" keys for the CMSBlocks.	Collection of string	Required

Request Formats

application/json, text/json

Sample:

{
  "ArcNumber": "sample string 1",
  "SiteCode": "sample string 2",
  "SubSite": "sample string 3",
  "IsLoggedIn": true,
  "BlockLocations": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:

<CmsBlocksByIdentityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Trisept.UI.WebApi.VAXAgentApi.Models">
  <ArcNumber>sample string 1</ArcNumber>
  <BlockLocations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BlockLocations>
  <IsLoggedIn>true</IsLoggedIn>
  <SiteCode>sample string 2</SiteCode>
  <SubSite>sample string 3</SubSite>
</CmsBlocksByIdentityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CmsBlockResponse

CmsBlocksResponse

Name	Description	Type	Additional information
CmsBlocks		Collection of CmsBlock	None.

Response Formats

application/json, text/json

Sample:

{
  "CmsBlocks": [
    {
      "BlockLocation": "sample string 1",
      "Content": "sample string 2",
      "Id": 3,
      "IsCacheable": true
    },
    {
      "BlockLocation": "sample string 1",
      "Content": "sample string 2",
      "Id": 3,
      "IsCacheable": true
    }
  ]
}

text/xml

Sample:

<CmsBlocksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Trisept.TB.Services.Content.DataContracts/2008/06">
  <CmsBlocks>
    <CmsBlock>
      <BlockLocation>sample string 1</BlockLocation>
      <Content>sample string 2</Content>
      <Id>3</Id>
      <IsCacheable>true</IsCacheable>
    </CmsBlock>
    <CmsBlock>
      <BlockLocation>sample string 1</BlockLocation>
      <Content>sample string 2</Content>
      <Id>3</Id>
      <IsCacheable>true</IsCacheable>
    </CmsBlock>
  </CmsBlocks>
</CmsBlocksResponse>