x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v11.0.0.0))
swagger: '2.0'
info:
  title: Absorb Integration API
  version: v2
consumes:
  - application/json
produces:
  - application/json
paths:
  /session-schedules/{id}:
    get:
      tags:
        - Session Schedules
      summary: Get session schedule.
      operationId: SessionSchedules_GetSessionSchedule
      parameters:
        - type: string
          name: id
          in: path
          required: true
          description: The ID of the session schedule.
          format: guid
          x-nullable: false
        - type: string
          name: x-api-key
          in: header
        - type: string
          name: x-api-version
          in: header
          description: '2'
      responses:
        '200':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/NonPagedSessionScheduleResource'
        '404':
          x-nullable: false
          description: Class not found.
          schema:
            $ref: '#/definitions/GenericErrorResponse'
      security:
        - api_key: []
  /session-schedules:
    get:
      tags:
        - Session Schedules
      summary: List session schedules.
      operationId: SessionSchedules_GetSessionSchedules
      parameters:
        - type: string
          name: _filter
          in: query
          description: >-
            One or more filter operations to be performed on the collection.

            The referenced fields must allow filtering. See the respective
            report's schema for which fields can be filtered. 
                        
            Supports most of the [OData filter
            syntax](http://docs.oasis-open.org/odata/odata/v4.01/cs01/part2-url-conventions/odata-v4.01-cs01-part2-url-conventions.html#sec_SystemQueryOptionfilter).
                        
            Supported operations:
                * eq,
                * ne,
                * gt,
                * ge,
                * lt,
                * le,
                * and,
                * or,
                * not,
                * ()

            Supported functions:
                * substringof('value',fieldName),
                * endswith(fieldName,'value'),
                * startswith(fieldName,'value'),
                * tolower(fieldName),
                * toupper(fieldName)
                        
            Examples:

            * _filter=`firstname eq 'Jeffrey'`

            * _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'`

            * _filter=`startsWith(lastname,'leb') or dateAdded ge
            datetime'1998-03-06T20:38:07Z'`
          x-nullable: true
        - type: string
          name: _sort
          in: query
          description: >-
            Optional list of comma-separated fields to sort the collection by.


            The referenced fields must allow sorting. See the respective
            report's schema for which fields can be sorted. 

            If not specified, all report fields are returned.


            To sort in a descending manner, prefix the field name with `-`. For
            example, 

            `_sort=name,-date`, sorts the collection of items by `name`
            (ascending) 

            and then by `date` (descending).
          x-nullable: true
        - type: string
          name: _limit
          in: query
          description: >-
            The maximum number of items to return in the current page of the
            collection.
          x-nullable: true
        - type: string
          name: _offset
          in: query
          description: The number of pages to offset into the collection.
          x-nullable: true
        - type: string
          name: x-api-key
          in: header
        - type: string
          name: x-api-version
          in: header
          description: '2'
      responses:
        '200':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/SessionSchedulesResource'
        '422':
          x-nullable: false
          description: A validation error occured with the provided parameters.
          schema:
            $ref: '#/definitions/GenericErrorResponse'
      security:
        - api_key: []
definitions:
  SessionScheduleResource:
    type: object
    description: >-
      Represents information about a session schedule for a Integration API
      endpoint.
    properties:
      id:
        type: string
        description: |-
          `Filterable` 

          The unique session schedule identifier.
        format: guid
      sessionId:
        type: string
        description: |-
          `Filterable` 

          The session schedule's session ID.
        format: guid
      venueId:
        type: string
        description: |-
          `Filterable` 

          The session schedule's venue ID.
        format: guid
      venueType:
        description: >-
          `Sortable` `Filterable` 


          The session schedule's venue type.


          Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3
          = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 =
          TeamsMeeting` `8 = WebexMeeting` 
        allOf:
          - $ref: '#/definitions/VenueType'
      venueName:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's venue name.
      dateStart:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's starting date.
        format: date-time
      dateEnd:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's end date.
        format: date-time
      timeZoneId:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's time zone ID.
      meetingId:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's meeting ID.
      meetingUsername:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's meeting username.
      meetingPassword:
        type: string
        description: |-
          `Sortable` `Filterable` 

          The session schedule's meeting password.
  Link:
    type: object
    properties:
      Rel:
        $ref: '#/definitions/Relation'
      Items:
        type: array
        items:
          $ref: '#/definitions/LinkItem'
  Relation:
    type: object
    properties:
      Name:
        type: string
  LinkItem:
    type: object
    properties:
      Href:
        type: string
      Name:
        type: string
      Templated:
        type: boolean
      Type:
        type: string
      Deprecation:
        type: string
      Profile:
        type: string
      Title:
        type: string
      Hreflang:
        type: string
  IEmbeddedResource:
    type: object
    x-abstract: true
    properties:
      Name:
        type: string
      Resources:
        type: array
        items:
          $ref: '#/definitions/IResource'
  IResource:
    type: object
    x-abstract: true
    properties:
      Links:
        type: array
        items:
          $ref: '#/definitions/Link'
      EmbeddedResources:
        type: array
        items:
          $ref: '#/definitions/IEmbeddedResource'
  VenueType:
    type: integer
    description: Defines an enumeration for the venue types.
    x-enumNames:
      - Classroom
      - ConnectPro
      - WebEx
      - GoToMeeting
      - Url
      - ZoomMeeting
      - ZoomWebinar
      - TeamsMeeting
      - WebexMeeting
    enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
  GenericErrorResponse:
    type: object
    description: |-
      This class is NOT to be used as an actual response. This is to be used as
      the return type for non-200 responses in `SwaggerResponse` attributes.
    properties:
      validations:
        type: array
        description: The validations (if any) which caused the error.
        items:
          type: string
      code:
        description: The status code returned.
        allOf:
          - $ref: '#/definitions/HttpStatusCode'
      message:
        type: string
        description: The error message.
      term:
        type: string
        description: The general error term.
      _meta:
        type: object
        description: 'A list of meta data (if any). '
        additionalProperties:
          type: string
  HttpStatusCode:
    type: integer
    description: ''
    x-enumNames:
      - Continue
      - SwitchingProtocols
      - OK
      - Created
      - Accepted
      - NonAuthoritativeInformation
      - NoContent
      - ResetContent
      - PartialContent
      - MultipleChoices
      - Ambiguous
      - MovedPermanently
      - Moved
      - Found
      - Redirect
      - SeeOther
      - RedirectMethod
      - NotModified
      - UseProxy
      - Unused
      - TemporaryRedirect
      - RedirectKeepVerb
      - BadRequest
      - Unauthorized
      - PaymentRequired
      - Forbidden
      - NotFound
      - MethodNotAllowed
      - NotAcceptable
      - ProxyAuthenticationRequired
      - RequestTimeout
      - Conflict
      - Gone
      - LengthRequired
      - PreconditionFailed
      - RequestEntityTooLarge
      - RequestUriTooLong
      - UnsupportedMediaType
      - RequestedRangeNotSatisfiable
      - ExpectationFailed
      - UpgradeRequired
      - InternalServerError
      - NotImplemented
      - BadGateway
      - ServiceUnavailable
      - GatewayTimeout
      - HttpVersionNotSupported
  NonPagedSessionScheduleResource:
    type: object
    description: >-
      This class is NOT to be used as an actual response. This is to be used as
      the `SwaggerResponse` return type for

      non-paginated endpoints that return SessionScheduleResource.
    properties:
      id:
        type: string
        description: The unique session schedule identifier.
        format: guid
      sessionId:
        type: string
        description: The session schedule's session ID.
        format: guid
      venueId:
        type: string
        description: The session schedule's venue ID.
        format: guid
      venueType:
        description: >-
          The session schedule's venue type.


          Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3
          = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 =
          TeamsMeeting` `8 = WebexMeeting` 
        allOf:
          - $ref: '#/definitions/VenueType'
      venueName:
        type: string
        description: The session schedule's venue name.
      dateStart:
        type: string
        description: The session schedule's starting date.
        format: date-time
      dateEnd:
        type: string
        description: The session schedule's end date.
        format: date-time
      timeZoneId:
        type: string
        description: The session schedule's time zone ID.
      meetingId:
        type: string
        description: The session schedule's meeting ID.
      meetingUsername:
        type: string
        description: The session schedule's meeting username.
      meetingPassword:
        type: string
        description: The session schedule's meeting password.
  SessionSchedulesResource:
    type: object
    description: Represents a collection of SessionScheduleResource.
    properties:
      totalItems:
        type: integer
        description: The total number of items in the unbounded collection
        format: int32
      returnedItems:
        type: integer
        description: The number of items in the bound collection being returned
        format: int32
      limit:
        type: integer
        description: The current page size for the collection
        format: int32
      offset:
        type: integer
        description: The current offset for the collection
        format: int32
      sessionSchedules:
        type: array
        description: The paged collection of resources.
        items:
          $ref: '#/definitions/SessionScheduleResource'
securityDefinitions:
  api_key:
    type: apiKey
    name: x-api-key
    in: header
tags:
  - name: Session Schedules
x-servers:
  - url: https://rest.myabsorb.com
    description: US
  - url: https://rest.myabsorb.ca
    description: CA
  - url: https://rest.myabsorb.eu
    description: EU
  - url: https://rest.myabsorb.com.au
    description: AU
