POST corporate-pass/bookings/get

Request Information

URI Parameters

None.

Body Parameters

CorporatePassCalendarBookingVm
NameDescriptionTypeAdditional information
PassId

string

None.

Type

string

None.

Month

integer

None.

Year

integer

None.

UserId

string

None.

IsYearlyLimitReached

boolean

None.

YearlyLimit

integer

None.

IsQuarterlyLimitReached

boolean

None.

QuarterlyLimit

integer

None.

Details

Collection of CorporatePassCalendarBookingDetailVm

None.

Token

string

None.

Id

string

None.

IsActive

boolean

None.

Company

string

None.

Search

string

None.

CurrentPage

integer

None.

TotalPage

integer

None.

SizePerPage

integer

None.

SortBy

string

None.

searchFilter

Collection of ColFilter

None.

Request Formats

application/json, text/json

Sample:
{
  "PassId": "sample string 1",
  "Type": "sample string 2",
  "Month": 3,
  "Year": 4,
  "UserId": "sample string 5",
  "IsYearlyLimitReached": true,
  "YearlyLimit": 7,
  "IsQuarterlyLimitReached": true,
  "QuarterlyLimit": 9,
  "Details": [
    {
      "Day": 1,
      "DayOfWeek": 2,
      "DateDisplay": "sample string 3",
      "TotalAvailablePass": 4,
      "TotalAvailablePhysicalPass": 5,
      "IsPublicHoliday": true,
      "PublicHolidayName": "sample string 7",
      "IsFullyBooked": true,
      "IsDisabled": true,
      "Employees": [
        {
          "EmployeeName": "sample string 1",
          "TotalPassBooked": 2
        },
        {
          "EmployeeName": "sample string 1",
          "TotalPassBooked": 2
        }
      ]
    },
    {
      "Day": 1,
      "DayOfWeek": 2,
      "DateDisplay": "sample string 3",
      "TotalAvailablePass": 4,
      "TotalAvailablePhysicalPass": 5,
      "IsPublicHoliday": true,
      "PublicHolidayName": "sample string 7",
      "IsFullyBooked": true,
      "IsDisabled": true,
      "Employees": [
        {
          "EmployeeName": "sample string 1",
          "TotalPassBooked": 2
        },
        {
          "EmployeeName": "sample string 1",
          "TotalPassBooked": 2
        }
      ]
    }
  ],
  "Token": "sample string 10",
  "Id": "sample string 11",
  "IsActive": true,
  "Company": "sample string 13",
  "Search": "sample string 14",
  "CurrentPage": 15,
  "TotalPage": 16,
  "SizePerPage": 17,
  "SortBy": "sample string 18",
  "searchFilter": [
    {
      "name": "sample string 1",
      "val": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "name": "sample string 1",
      "val": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<CorporatePassCalendarBookingVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BoardRoom.ViewModels">
  <Company>sample string 13</Company>
  <CurrentPage>15</CurrentPage>
  <Id>sample string 11</Id>
  <IsActive>true</IsActive>
  <Search>sample string 14</Search>
  <SizePerPage>17</SizePerPage>
  <SortBy>sample string 18</SortBy>
  <Token>sample string 10</Token>
  <TotalPage>16</TotalPage>
  <searchFilter>
    <ColFilter>
      <name>sample string 1</name>
      <val xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </val>
    </ColFilter>
    <ColFilter>
      <name>sample string 1</name>
      <val xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </val>
    </ColFilter>
  </searchFilter>
  <Details>
    <CorporatePassCalendarBookingDetailVm>
      <DateDisplay>sample string 3</DateDisplay>
      <Day>1</Day>
      <DayOfWeek>2</DayOfWeek>
      <Employees>
        <CorporatePassCalendarBookingEmployeeVm>
          <EmployeeName>sample string 1</EmployeeName>
          <TotalPassBooked>2</TotalPassBooked>
        </CorporatePassCalendarBookingEmployeeVm>
        <CorporatePassCalendarBookingEmployeeVm>
          <EmployeeName>sample string 1</EmployeeName>
          <TotalPassBooked>2</TotalPassBooked>
        </CorporatePassCalendarBookingEmployeeVm>
      </Employees>
      <IsDisabled>true</IsDisabled>
      <IsFullyBooked>true</IsFullyBooked>
      <IsPublicHoliday>true</IsPublicHoliday>
      <PublicHolidayName>sample string 7</PublicHolidayName>
      <TotalAvailablePass>4</TotalAvailablePass>
      <TotalAvailablePhysicalPass>5</TotalAvailablePhysicalPass>
    </CorporatePassCalendarBookingDetailVm>
    <CorporatePassCalendarBookingDetailVm>
      <DateDisplay>sample string 3</DateDisplay>
      <Day>1</Day>
      <DayOfWeek>2</DayOfWeek>
      <Employees>
        <CorporatePassCalendarBookingEmployeeVm>
          <EmployeeName>sample string 1</EmployeeName>
          <TotalPassBooked>2</TotalPassBooked>
        </CorporatePassCalendarBookingEmployeeVm>
        <CorporatePassCalendarBookingEmployeeVm>
          <EmployeeName>sample string 1</EmployeeName>
          <TotalPassBooked>2</TotalPassBooked>
        </CorporatePassCalendarBookingEmployeeVm>
      </Employees>
      <IsDisabled>true</IsDisabled>
      <IsFullyBooked>true</IsFullyBooked>
      <IsPublicHoliday>true</IsPublicHoliday>
      <PublicHolidayName>sample string 7</PublicHolidayName>
      <TotalAvailablePass>4</TotalAvailablePass>
      <TotalAvailablePhysicalPass>5</TotalAvailablePhysicalPass>
    </CorporatePassCalendarBookingDetailVm>
  </Details>
  <IsQuarterlyLimitReached>true</IsQuarterlyLimitReached>
  <IsYearlyLimitReached>true</IsYearlyLimitReached>
  <Month>3</Month>
  <PassId>sample string 1</PassId>
  <QuarterlyLimit>9</QuarterlyLimit>
  <Type>sample string 2</Type>
  <UserId>sample string 5</UserId>
  <Year>4</Year>
  <YearlyLimit>7</YearlyLimit>
</CorporatePassCalendarBookingVm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.