GET api/Branches/BranchCalendars?includeShared={includeShared}

Gets all calendars for all branches.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeShared

If shared calenders should be in the response or not

 boolean

Default value is True

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

List of BranchCalendarResponse

Collection of BranchCalendarResponse
NameDescriptionTypeAdditional information
CalendarId

integer

Required
BranchId

integer

Required
Name

string

Max length: 255
CalendarKey

string

Required
BranchCalendarArticlePackageResponses

Collection of BranchCalendarArticlePackageResponse

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CalendarId": 1,
    "BranchId": 2,
    "Name": "sample string 3",
    "CalendarKey": "sample string 4",
    "BranchCalendarArticlePackageResponses": [
      {
        "ArticlePackageHeadId": "dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c",
        "PublicAccess": true,
        "SeasonalTyreChange": true,
        "AddOnArticle": true,
        "ShowPrice": true,
        "ShowDuration": true
      },
      {
        "ArticlePackageHeadId": "dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c",
        "PublicAccess": true,
        "SeasonalTyreChange": true,
        "AddOnArticle": true,
        "ShowPrice": true,
        "ShowDuration": true
      }
    ]
  },
  {
    "CalendarId": 1,
    "BranchId": 2,
    "Name": "sample string 3",
    "CalendarKey": "sample string 4",
    "BranchCalendarArticlePackageResponses": [
      {
        "ArticlePackageHeadId": "dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c",
        "PublicAccess": true,
        "SeasonalTyreChange": true,
        "AddOnArticle": true,
        "ShowPrice": true,
        "ShowDuration": true
      },
      {
        "ArticlePackageHeadId": "dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c",
        "PublicAccess": true,
        "SeasonalTyreChange": true,
        "AddOnArticle": true,
        "ShowPrice": true,
        "ShowDuration": true
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBranchCalendarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
  <BranchCalendarResponse>
    <BranchCalendarArticlePackageResponses>
      <BranchCalendarArticlePackageResponse>
        <AddOnArticle>true</AddOnArticle>
        <ArticlePackageHeadId>dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c</ArticlePackageHeadId>
        <PublicAccess>true</PublicAccess>
        <SeasonalTyreChange>true</SeasonalTyreChange>
        <ShowDuration>true</ShowDuration>
        <ShowPrice>true</ShowPrice>
      </BranchCalendarArticlePackageResponse>
      <BranchCalendarArticlePackageResponse>
        <AddOnArticle>true</AddOnArticle>
        <ArticlePackageHeadId>dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c</ArticlePackageHeadId>
        <PublicAccess>true</PublicAccess>
        <SeasonalTyreChange>true</SeasonalTyreChange>
        <ShowDuration>true</ShowDuration>
        <ShowPrice>true</ShowPrice>
      </BranchCalendarArticlePackageResponse>
    </BranchCalendarArticlePackageResponses>
    <BranchId>2</BranchId>
    <CalendarId>1</CalendarId>
    <CalendarKey>sample string 4</CalendarKey>
    <Name>sample string 3</Name>
  </BranchCalendarResponse>
  <BranchCalendarResponse>
    <BranchCalendarArticlePackageResponses>
      <BranchCalendarArticlePackageResponse>
        <AddOnArticle>true</AddOnArticle>
        <ArticlePackageHeadId>dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c</ArticlePackageHeadId>
        <PublicAccess>true</PublicAccess>
        <SeasonalTyreChange>true</SeasonalTyreChange>
        <ShowDuration>true</ShowDuration>
        <ShowPrice>true</ShowPrice>
      </BranchCalendarArticlePackageResponse>
      <BranchCalendarArticlePackageResponse>
        <AddOnArticle>true</AddOnArticle>
        <ArticlePackageHeadId>dd63732d-4c6b-4b4c-b7a5-aa5079f2d15c</ArticlePackageHeadId>
        <PublicAccess>true</PublicAccess>
        <SeasonalTyreChange>true</SeasonalTyreChange>
        <ShowDuration>true</ShowDuration>
        <ShowPrice>true</ShowPrice>
      </BranchCalendarArticlePackageResponse>
    </BranchCalendarArticlePackageResponses>
    <BranchId>2</BranchId>
    <CalendarId>1</CalendarId>
    <CalendarKey>sample string 4</CalendarKey>
    <Name>sample string 3</Name>
  </BranchCalendarResponse>
</ArrayOfBranchCalendarResponse>