Bookeasy - Get Vc Operator Ids( getVcOperatorIds )

Navigate to Bookeasy

Details

  • Name Get Vc Operator Ids
  • Description Responsible for returning Visitor Center operator ids.
  • MethodGroup Visitor Center

Parameters

  • q
    Type Int32
    Description The unique identifier for the visitor center you wish to get ids for.
    Example <a class="showCode" href="/be/getVcOperatorIds?q=4">/be/getVcOperatorIds?q=4</a>
  • OperatorCategoryId
    Type Int32
    Description The operator category which you are interested in. the category id can be found by calling getVcOperatorCategories
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&OperatorCategoryId=533">/be/getVcOperatorIds?q=85&OperatorCategoryId=533</a>
  • HotDealsOnly
    Type Boolean
    Description The operator category which you are interested in. the category id can be found by calling getVcOperatorCategories
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&HotDealsOnly=true">/be/getVcOperatorIds?q=85&HotDealsOnly=true</a>
  • CampaignId
    Type Int32
    Description Filters the operators by specific campaign information
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&CampaignId=6">/be/getVcOperatorIds?q=85&CampaignId=6</a>
  • BusinessTypeId
    Type Int32
    Description Filter the operators by Business Types. The business type id value can be found by calling the /be/getVcBusinessTypes sjp method
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&BusinessTypeId=833">/be/getVcOperatorIds?q=85&BusinessTypeId=833</a>
  • IncludeInternalOperators
    Type Boolean
    Description Include Internal Operators as well. This defaults to false, meaning InternalOperators will not be included.
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&IncludeInternalOperators=true">/be/getVcOperatorIds?q=85&IncludeInternalOperators=true</a>
  • Location
    Type Int32
    Description Filters the operators by specific location. The location id value can be found by calling the /api/getVcLocations method
    Example <a class="showCode" href="/be/getVcOperatorIds?q=85&Location=6">/be/getVcOperatorIds?q=85&Location=6</a>
  • uiView
    Type Boolean
  • IgnoreCache
    Type Boolean
  • ShowError
    Type Boolean
  • callback
    Type String

Response

  • Type <a href="/ui/Show?name=Get Vc Operator Ids Model">GetVcOperatorIdsModel</a>
    Name Get Vc Operator Ids Model
    Description Is the Model object for the get vc operator ids operation.

Faults

  • Name Json Result Error
    Description This error is thrown where something happens and it was unexpected.
    Type <a href="/ui/Show?name=Json Result Error">JsonResultError</a>