swagger: '2.0'
info:
  title: Orchard OWS Search API
  version: v1
host: qa-search.theorchard.io
basePath: /api/v1
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
tags:
  - name: Health Check
    description: Check the health of the application.
  - name: Ows Search API Endpoints
    description: Ows search api endpoints.
paths:
  /hello:
    get:
      tags:
        - Health Check
      description: Health check.
      summary: Check the health of the application
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/hello'
  /search:
    get:
      parameters:
        - in: query
          name: context
          type: string
          description: Search context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific search context.
          required: true
        - in: query
          name: term
          type: string
          description: Search term.
          required: true
        - in: query
          name: page_size
          type: integer
          description: Maximum number of search results returned per page. Default = 20.
          required: false
        - in: query
          name: page
          type: integer
          description: Request specific grouping of results based on number of results per page. Default = 1.
          required: false
        - in: query
          name: sort
          type: string
          description: Field to sort search results by.
          required: false
        - in: query
          name: sort_order
          type: integer
          description: Order of sort (ascending or descending).
          required: false
        - in: query
          name: filter_(?)
          type: string
          description: Sets an additional filter field. Only results that match the provided value for the specified
                       field will be returned.
          required: false
      description: Issues a basic search against the term specified, using search parameters set in context provided
                   combined with any provided as query parameters.
      summary: Basic search against the term specified
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseSearchAndBrowse'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
    post:
      parameters:
        - in: query
          name: context
          type: string
          description: Search context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific search context.
          required: true
        - in: query
          name: page_size
          type: integer
          description: Maximum number of search results returned per page. Default = 20.
          required: false
        - in: body
          name: body
          schema:
            $ref: '#/definitions/postRequestBodySearch'
          required: true
      description: Issues a basic search against the requested upcs, using search parameters set in context provided
                   combined with any provided as query parameters.
      summary: Search against the requested bulk upcs
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseSearchAndBrowse'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
  /browse:
    get:
      parameters:
        - in: query
          name: context
          type: string
          description: Browse context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific Browse context.
          required: true
        - in: query
          name: term
          type: string
          description: Browse term.
          required: false
        - in: query
          name: page_size
          type: integer
          description: Maximum number of search results returned per page. Default = 20.
          required: false
        - in: query
          name: page
          type: integer
          description: Request specific grouping of results based on number of results per page. Default = 1.
          required: false
        - in: query
          name: sort
          type: string
          description: Field to sort search results by.
          required: false
        - in: query
          name: sort_order
          type: integer
          description: Order of sort (ascending or descending).
          required: false
        - in: query
          name: filter_(?)
          type: string
          description: Sets an additional filter field. Only results that match the provided value for the specified
                       field will be returned.
          required: false
      description: Issues a basic browse against the term specified, using search parameters set in context provided
                   combined with any provided as query parameters.
      summary: Basic browse against the term specified
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseSearchAndBrowse'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
  /suggest:
    get:
      parameters:
        - in: query
          name: context
          type: string
          description: Suggest context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific suggest context.
          required: true
        - in: query
          name: page_size
          type: integer
          description: Maximum number of search results returned per page. Default = 20.
          required: false
        - in: query
          name: page
          type: integer
          description: Request specific grouping of results based on number of results per page. Default = 1.
          required: false
        - in: query
          name: sort
          type: string
          description: Field to sort search results by.
          required: false
        - in: query
          name: sort_order
          type: integer
          description: Order of sort (ascending or descending).
          required: false
        - in: query
          name: filter_(?)
          type: string
          description: Sets an additional filter field. Only results that match the provided value for the specified
                       field will be returned.
          required: false
      description: Issues a general retrieval of data with no search term specified, using search parameters set in context
                   provided combined with any provided as query parameters.
      summary: Basic suggest against the context specified
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseSuggest'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
  /item/releases/{releaseId}:
    get:
      parameters:
        - in: path
          name: releaseId
          type: integer
          description: Orchard release ID of record.
          required: true
        - in: query
          name: context
          type: string
          description: Suggest context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific item context.
          required: true
      description: Issues a search for the provided release ID, using search parameters set in context provided
                   combined with any provided as query parameters.
      summary: Search for the provided release ID
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseItemReleases'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
  /item/artists/{artistId}:
    get:
      parameters:
        - in: path
          name: artistId
          type: integer
          description: Orchard artist ID of record.
          required: true
        - in: query
          name: context
          type: string
          description: Suggest context that defines specific preset search parameters that refine search results.
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific item context.
          required: true
      description: Issues a search for the provided artist ID, using search parameters set in context provided
                   combined with any provided as query parameters.
      summary: Search for the provided artist ID
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseItemArtists'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
  /catalogsuggest:
    get:
      parameters:
        - in: query
          name: context
          type: array
          items:
            type: string
          description: Suggest with mutiple context that defines specific preset search parameters refine suggest results.
                       example - ['WORKSTATION_PROJECT','WORKSTATION_PRODUCT']
          required: true
        - in: query
          name: token
          type: string
          description: Unique string assigned to a specific suggest context.
          required: true
        - in: query
          name: page_size
          type: integer
          description: Maximum number of search results returned per page. Default = 20.
          required: false
        - in: query
          name: page
          type: integer
          description: Request specific grouping of results based on number of results per page. Default = 1.
          required: false
        - in: query
          name: sort
          type: string
          description: Field to sort search results by.
          required: false
        - in: query
          name: sort_order
          type: integer
          description: Order of sort (ascending or descending).
          required: false
        - in: query
          name: filter_(?)
          type: string
          description: Sets an additional filter field. Only results that match the provided value for the specified
                       field will be returned.
          required: true
      description: Issues a general retrieval of data with no term specified, using search parameters set in mutiple
                  context provided combined with any provided as query parameters.
      summary: Suggest against the mutiple context specified
      tags:
        - Ows Search API Endpoints
      responses:
        '200':
          description: 200 OK
          schema:
            $ref: '#/definitions/200ResponseCatalogSuggest'
        '404':
          description: 404 Not found
          schema:
            $ref: '#/definitions/404Response'
        '500':
          description: 500 Internal server error
          schema:
            $ref: '#/definitions/500Response'
definitions:
  hello:
    type: object
    properties:
      status:
        type: string
    example:
      status: ok
  404Response:
    description: 404 not found
    type: object
    required:
      - 'statusCode'
      - 'message'
      - 'timestamp'
    properties:
      statusCode:
        type: string
        example: 404
      message:
        type: string
        example: Invalid API call. Try /api/v1/{function}
      timestamp:
        type: integer
        example: 1491499190
  500Response:
    description: 500 Internal server error
    type: object
    required:
      - 'searchTerm'
      - 'searchTime'
      - 'totalHits'
      - 'startIndex'
      - 'pageSize'
      - 'currentPage'
      - 'totalPages'
      - 'results'
      - 'facets'
      - 'selectedFacets'
      - 'isError'
      - 'errorMessage'
      - 'errorType'
    properties:
      searchTerm:
        type: string
        example: 'null'
      searchTime:
        type: string
        example: 'null'
      totalHits:
        type: string
        example: 'null'
      startIndex:
        type: string
        example: 'null'
      pageSize:
        type: integer
        example: 20
      currentPage:
        type: string
        example: 'null'
      totalPages:
        type: string
        example: 'null'
      results:
        type: array
        items:
          type: string
        example: []
      facets:
        type: array
        items:
          type: string
        example: []
      selectedFacets:
        type: array
        items:
          type: string
        example: []
      isError:
        type: boolean
        example: true
      errorMessage:
        type: string
        example: 'Token \u0027c9047afefcd9\u0027 is not a valid token.'
      errorType:
        type: string
        example: 'Search Error'
  postRequestBodySearch:
    type: object
    required:
      - 'display_upcs'
    properties:
      display_upcs:
        type: array
        items:
          type: string
    example:
      display_upcs: ['918918291224', '187187281710']
  200ResponseSearchAndBrowse:
    description: 200 OK
    type: object
    required:
      - 'searchTerm'
      - 'searchTime'
      - 'totalHits'
      - 'startIndex'
      - 'pageSize'
      - 'currentPage'
      - 'totalPages'
      - 'results'
      - 'facets'
      - 'selectedFacets'
      - 'isError'
      - 'errorMessage'
      - 'errorType'
    properties:
      searchTerm:
        type: string
      searchTime:
        type: integer
      totalHits:
        type: integer
      startIndex:
        type: integer
      pageSize:
        type: string
      currentPage:
        type: integer
      totalPages:
        type: integer
      results:
        required:
          - 'rel999999'
        properties:
          rel999999:
            required:
              - 'release_status'
              - 'track_type'
              - 'release_month'
              - 'imprint'
              - 'featured'
              - 'sale_start_date'
              - 'configuration'
              - 'track_list'
              - 'label'
              - 'vendor_owner'
              - 'artist_id'
              - 'vendor_catalog_number'
              - 'product_type_id'
              - 'deletions'
              - 'release_id'
              - 'format'
              - 'vendor_id'
              - 'artist_name'
              - 'artist_name_facet'
              - 'c_line'
              - 'genre'
              - 'subgenre'
              - 'vendor_status'
              - 'product_type'
              - 'release_year'
              - 'release_date'
              - 'upc'
              - 'display_upc'
              - 'product_configuration'
              - 'isrc_list'
              - 'release_name'
              - 'display'
              - 'highlight_fields'
              - 'coverart_paths'
            properties:
              release_status:
                type: string
              track_type:
                type: array
                items:
                  type: string
              release_month:
                type: string
              imprint:
                type: string
              featured:
                type: string
              sale_start_date:
                type: string
              configuration:
                type: string
              track_list:
                type: array
                items:
                  type: string
              label:
                type: string
              vendor_owner:
                type: string
              artist_id:
                type: string
              vendor_catalog_number:
                type: string
              product_type_id:
                type: string
              deletions:
                type: string
              release_id:
                type: string
              format:
                type: string
              vendor_id:
                type: string
              artist_name:
                type: string
              artist_name_facet:
                type: string
              c_line:
                type: string
              genre:
                type: string
              subgenre:
                type: string
              vendor_status:
                type: string
              product_type:
                type: string
              release_year:
                type: string
              release_date:
                type: string
              upc:
                type: string
              display_upc:
                type: string
              product_configuration:
                type: string
              isrc_list:
                type: array
                items:
                  type: string
              release_name:
                type: string
              display:
                type: string
              highlight_fields:
                required:
                  - 'release_name'
                properties:
                  release_name:
                    type: string
                type: object
              coverart_paths:
                required:
                  - 'thumb'
                  - 'large'
                properties:
                  thumb:
                    type: string
                  large:
                    type: string
                type: object
            type: object
        type: object
      facets:
        required:
          - 'artist_name_facet'
          - 'genre'
          - 'label'
          - 'product_configuration'
          - 'product_type'
        properties:
          artist_name_facet:
            required:
              - 'Various Artists'
              - 'DC Squad'
              - 'Everybody Else'
            properties:
              Various Artists:
                type: integer
              DC Squad:
                type: integer
              Everybody Else:
                type: integer
            type: object
          genre:
            required:
              - 'Rock'
              - 'Jazz'
              - 'R&B'
              - 'Blues'
            properties:
              Rock:
                type: integer
              Jazz:
                type: integer
              R&B:
                type: integer
              Blues:
                type: integer
            type: object
          label:
            required:
              - 'Orchard Tech Records'
              - 'Ops Music'
              - '3rd Floor Productions'
            properties:
              Orchard Tech Records:
                type: integer
              Ops Music:
                type: integer
              3rd Floor Productions:
                type: integer
            type: object
          product_configuration:
            required:
              - 'Digital Audio'
              - 'Music Video'
              - 'TV Show'
              - 'Physical Audio'
              - 'Movie'
              - 'Other'
            properties:
              Digital Audio:
                type: integer
              Music Video:
                type: integer
              TV Show:
                type: integer
              Physical Audio:
                type: integer
              Movie:
                type: integer
              Other:
                type: integer
            type: object
          product_type:
            required:
              - 'Music'
              - 'TV'
              - 'Film'
              - 'Other'
            properties:
              Music:
                type: integer
              TV:
                type: integer
              Film:
                type: integer
              Other:
                type: integer
            type: object
        type: object
      selectedFacets:
        type: array
        items:
          type: string
      isError:
        type: boolean
      errorMessage:
        type: string
      errorType:
        type: string
    example:
      {
        'searchTerm': 'null',
        'searchTime': 9,
        'totalHits': 1324,
        'startIndex': 0,
        'pageSize': '1',
        'currentPage': 1,
        'totalPages': 662,
        'results': {
          'rel999999': {
            'release_status': 'in_content',
            'track_type': [
              'music'
            ],
            'release_month': '01',
            'imprint': 'Orchard Tech Records',
            'featured': 'N',
            'sale_start_date': '2016-01-01T00:00:00Z',
            'configuration': 'DIGITAL',
            'track_list': [
              'Tech Debt Week',
              'Fixathon Blues',
              'Orchard is Orange'
            ],
            'label': 'Orchard Tech Records',
            'vendor_owner': 'Orchard',
            'artist_id': '10001',
            'vendor_catalog_number': 'PLAT221',
            'product_type_id': '1',
            'deletions': 'N',
            'release_id': '999999',
            'format': 'EP',
            'vendor_id': '10001',
            'artist_name': 'DC Squad',
            'artist_name_facet': 'DC Squad',
            'c_line': '2016 Orchard Tech Records',
            'genre': 'R&B',
            'subgenre': 'Alternative',
            'vendor_status': 'signed',
            'product_type': 'Music',
            'release_year': '2016',
            'release_date': '2016-01-01T00:00:00Z',
            'upc': '123456789012',
            'display_upc': '123456789012',
            'product_configuration': 'Digital Audio',
            'isrc_list': [
              'USDCS1700001',
              'USDCS1700002',
              'USDCS1700003'
            ],
            'release_name': 'OWS Search',
            'display': 'Y',
            'highlight_fields': {
              'release_name': 'OWS <em>Search</em>'
            },
            'coverart_paths': {
              'thumb': 'http://images.theorchard.com/release/cover/123546/789/123456789012.jpg',
              'large': 'http://images.theorchard.com/release/large_cover/123456/789/123456789012.jpg'
            }
          }
        },
        'facets': {
          'artist_name_facet': {
            'Various Artists': 96,
            'DC Squad': 21,
            'Everybody Else': 14
          },
          'genre': {
            'Rock': 201,
            'Jazz': 110,
            'R&B': 14,
            'Blues': 8
          },
          'label': {
            'Orchard Tech Records': 76,
            'Ops Music': 50,
            '3rd Floor Productions': 36
          },
          'product_configuration': {
            'Digital Audio': 1258,
            'Music Video': 21,
            'TV Show': 16,
            'Physical Audio': 14,
            'Movie': 10,
            'Other': 5
          },
          'product_type': {
            'Music': 1293,
            'TV': 16,
            'Film': 10,
            'Other': 5
          }
        },
        'selectedFacets': [],
        'isError': false,
        'errorMessage': 'null',
        'errorType': 'null'
      }
  200ResponseSuggest:
    description: 200 OK
    type: object
    required:
      - 'searchTerm'
      - 'searchTime'
      - 'totalHits'
      - 'startIndex'
      - 'pageSize'
      - 'currentPage'
      - 'totalPages'
      - 'results'
      - 'facets'
      - 'selectedFacets'
      - 'isError'
      - 'errorMessage'
      - 'errorType'
    properties:
      searchTerm:
        type: string
      searchTime:
        type: integer
      totalHits:
        type: integer
      startIndex:
        type: integer
      pageSize:
        type: string
      currentPage:
        type: integer
      totalPages:
        type: integer
      results:
        required:
          - 'rel999999'
          - 'rel888888'
        properties:
          rel999999:
            required:
              - 'release_id'
              - 'release_name'
              - 'highlight_fields'
              - 'coverart_paths'
            properties:
              release_id:
                type: string
              release_name:
                type: string
              highlight_fields:
                required:
                  - 'release_name'
                properties:
                  release_name:
                    type: string
                type: object
              coverart_paths:
                required:
                  - 'thumb'
                  - 'large'
                properties:
                  thumb:
                    type: string
                  large:
                    type: string
                type: object
            type: object
          rel888888:
            required:
              - 'release_id'
              - 'release_name'
              - 'highlight_fields'
              - 'coverart_paths'
            properties:
              release_id:
                type: string
              release_name:
                type: string
              highlight_fields:
                required:
                  - 'release_name'
                properties:
                  release_name:
                    type: string
                type: object
              coverart_paths:
                required:
                  - 'thumb'
                  - 'large'
                properties:
                  thumb:
                    type: string
                  large:
                    type: string
                type: object
            type: object
        type: object
      facets:
        type: array
        items:
          type: string
      selectedFacets:
        type: array
        items:
          type: string
      isError:
        type: boolean
      errorMessage:
          type: string
      errorType:
        type: string
    example:
      {
        'searchTerm': 'sea',
        'searchTime': 9,
        'totalHits': 1324,
        'startIndex': 0,
        'pageSize': '1',
        'currentPage': 1,
        'totalPages': 662,
        'results': {
          'rel999999': {
            'release_id': '999999',
            'release_name': 'OWS Search',
            'highlight_fields': {
              'release_name': 'OWS <em>Search</em>'
            },
            'coverart_paths': {
              'thumb': 'http://images.theorchard.com/release/cover/123546/789/123456789012.jpg',
              'large': 'http://images.theorchard.com/release/large_cover/123456/789/123456789012.jpg'
            }
          },
          'rel888888': {
            'release_id': '888888',
            'release_name': 'Catalog Search',
            'highlight_fields': {
              'release_name': 'Catalog <em>Search</em>'
            },
            'coverart_paths': {
              'thumb': 'http://images.theorchard.com/release/cover/987654/321/987654321098.jpg',
              'large': 'http://images.theorchard.com/release/large_cover/987654/321/987654321098.jpg'
            }
          }
        },
        'facets': [],
        'selectedFacets': [],
        'isError': false,
        'errorMessage': 'null',
        'errorType': 'null'
      }
  200ResponseItemReleases:
    description: 200 OK
    type: object
    required:
      - 'release_status'
      - 'track_type'
      - 'release_month'
      - 'imprint'
      - 'featured'
      - 'sale_start_date'
      - 'configuration'
      - 'track_list'
      - 'label'
      - 'vendor_owner'
      - 'artist_id'
      - 'vendor_catalog_number'
      - 'product_type_id'
      - 'deletions'
      - 'release_id'
      - 'format'
      - 'vendor_id'
      - 'artist_name'
      - 'artist_name_facet'
      - 'c_line'
      - 'genre'
      - 'subgenre'
      - 'vendor_status'
      - 'product_type'
      - 'release_year'
      - 'release_date'
      - 'upc'
      - 'display_upc'
      - 'product_configuration'
      - 'isrc_list'
      - 'release_name'
      - 'display'
      - 'highlight_fields'
      - 'coverart_paths'
    properties:
      release_status:
        type: string
      track_type:
        type: array
        items:
          type: string
      release_month:
        type: string
      imprint:
        type: string
      featured:
        type: string
      sale_start_date:
        type: string
      configuration:
        type: string
      track_list:
        type: array
        items:
          type: string
      label:
        type: string
      vendor_owner:
        type: string
      artist_id:
        type: string
      vendor_catalog_number:
        type: string
      product_type_id:
        type: string
      deletions:
        type: string
      release_id:
        type: string
      format:
        type: string
      vendor_id:
        type: string
      artist_name:
        type: string
      artist_name_facet:
        type: string
      c_line:
        type: string
      genre:
        type: string
      subgenre:
        type: string
      vendor_status:
        type: string
      product_type:
        type: string
      release_year:
        type: string
      release_date:
        type: string
      upc:
        type: string
      display_upc:
        type: string
      product_configuration:
        type: string
      isrc_list:
        type: array
        items:
          type: string
      release_name:
        type: string
      display:
        type: string
      highlight_fields:
        required:
          - 'release_name'
        properties:
          release_name:
            type: string
        type: object
      coverart_paths:
        required:
          - 'thumb'
          - 'large'
        properties:
          thumb:
            type: string
          large:
            type: string
        type: object
    example:
      {
        'release_status': 'in_content',
        'track_type': [
          'music'
        ],
        'release_month': '01',
        'imprint': 'Orchard Tech Records',
        'featured': 'N',
        'sale_start_date': '2016-01-01T00:00:00Z',
        'configuration': 'DIGITAL',
        'track_list': [
          'Tech Debt Week',
          'Fixathon Blues',
          'Orchard is Orange'
        ],
        'label': 'Orchard Tech Records',
        'vendor_owner': 'Orchard',
        'artist_id': '10001',
        'vendor_catalog_number': 'PLAT221',
        'product_type_id': '1',
        'deletions': 'N',
        'release_id': '999999',
        'format': 'EP',
        'vendor_id': '10001',
        'artist_name': 'DC Squad',
        'artist_name_facet': 'DC Squad',
        'c_line': '2016 Orchard Tech Records',
        'genre': 'R&B',
        'subgenre': 'Alternative',
        'vendor_status': 'signed',
        'product_type': 'Music',
        'release_year': '2016',
        'release_date': '2016-01-01T00:00:00Z',
        'upc': '123456789012',
        'display_upc': '123456789012',
        'product_configuration': 'Digital Audio',
        'isrc_list': [
          'USDCS1700001',
          'USDCS1700002',
          'USDCS1700003'
        ],
        'release_name': 'OWS Search',
        'display': 'Y',
        'highlight_fields': {
          'release_name': 'OWS <em>Search</em>'
        },
        'coverart_paths': {
          'thumb': 'http://images.theorchard.com/release/cover/123546/789/123456789012.jpg',
          'large': 'http://images.theorchard.com/release/large_cover/123456/789/123456789012.jpg'
        }
      }
  200ResponseItemArtists:
    description: 200 OK
    type: object
    required:
      - 'release_status'
      - 'track_type'
      - 'release_month'
      - 'imprint'
      - 'featured'
      - 'sale_start_date'
      - 'configuration'
      - 'track_list'
      - 'label'
      - 'subaccount_id'
      - 'vendor_owner'
      - 'artist_id'
      - 'vendor_catalog_number'
      - 'product_type_id'
      - 'deletions'
      - 'release_id'
      - 'format'
      - 'vendor_id'
      - 'artist_name'
      - 'artist_name_facet'
      - 'c_line'
      - 'genre'
      - 'subgenre'
      - 'vendor_status'
      - 'project_id'
      - 'product_type'
      - 'release_year'
      - 'release_date'
      - 'upc'
      - 'display_upc'
      - 'product_configuration'
      - 'isrc_list'
      - 'release_name'
      - 'release_name_facet'
      - 'display'
      - 'coverart_paths'
    properties:
      release_status:
        type: string
      track_type:
        type: array
        items:
          type: string
      release_month:
        type: string
      imprint:
        type: string
      featured:
        type: string
      sale_start_date:
        type: string
      configuration:
        type: string
      track_list:
        type: array
        items:
          type: string
      label:
        type: string
      subaccount_id:
        type: string
      vendor_owner:
        type: string
      artist_id:
        type: string
      vendor_catalog_number:
        type: string
      product_type_id:
        type: string
      deletions:
        type: string
      release_id:
        type: string
      format:
        type: string
      vendor_id:
        type: string
      artist_name:
        type: string
      artist_name_facet:
        type: string
      c_line:
        type: string
      genre:
        type: string
      subgenre:
        type: string
      vendor_status:
        type: string
      project_id:
        type: string
      product_type:
        type: string
      release_year:
        type: string
      release_date:
        type: string
      upc:
        type: string
      display_upc:
        type: string
      product_configuration:
        type: string
      isrc_list:
        type: array
        items:
          type: string
      release_name:
        type: string
      release_name_facet:
        type: string
      display:
        type: string
      coverart_paths:
        required:
          - 'thumb'
          - 'large'
        properties:
          thumb:
            type: string
          large:
            type: string
        type: object
    example:
      {
        'release_status': 'in_content',
        'track_type': [
            'music'
        ],
        'release_month': '10',
        'imprint': 'Rizardo Records',
        'featured': 'N',
        'sale_start_date': '2010-10-04T00:00:00Z',
        'configuration': 'Digital',
        'track_list': [
            'Afrika'
        ],
        'label': 'Dadadam BV',
        'subaccount_id': '0',
        'vendor_owner': 'IODA-REVER',
        'artist_id': '491102',
        'vendor_catalog_number': 'RIZ010',
        'product_type_id': '1',
        'deletions': 'N',
        'release_id': '866286',
        'format': 'Full Length',
        'vendor_id': '20808',
        'artist_name': 'Franky Rizardo',
        'artist_name_facet': 'Franky Rizardo',
        'c_line': '2010 Rizardo Records',
        'genre': 'Electronic',
        'subgenre': 'House',
        'vendor_status': 'signed',
        'project_id': '2419996',
        'product_type': 'Music',
        'release_year': '2010',
        'release_date': '2010-10-04T00:00:00Z',
        'upc': '410224001095',
        'display_upc': '410224001095',
        'product_configuration': 'Digital Audio',
        'isrc_list': [
            'NLCM31000039',
            'NLCM31000040'
        ],
        'release_name': 'Afrika Remixes Part 2',
        'release_name_facet': 'Afrika Remixes Part 2',
        'display': 'Y',
        'coverart_paths': {
            'thumb': 'http://images.theorchard.com/release/cover/410224/001/410224001095.jpg',
            'large': 'http://images.theorchard.com/release/large_cover/410224/001/410224001095.jpg'
        }
      }
  200ResponseCatalogSuggest:
    description: 200 OK
    type: object
    required:
        - 'PROJECT'
        - 'PRODUCT'
    properties:
      PROJECT:
        required:
          - 'searchTerm'
          - 'searchTime'
          - 'totalHits'
          - 'startIndex'
          - 'pageSize'
          - 'currentPage'
          - 'totalPages'
          - 'results'
          - 'facets'
          - 'selectedFacets'
          - 'isError'
          - 'errorMessage'
          - 'errorType'
        properties:
          searchTerm:
            type: string
          searchTime:
            type: integer
          totalHits:
            type: integer
          startIndex:
            type: integer
          pageSize:
            type: string
          currentPage:
            type: integer
          totalPages:
            type: integer
          results:
            required:
              - 'proj3342499'
            properties:
              proj3342499:
                required:
                  - 'project_name'
                  - 'project_name_facet'
                  - 'vendor_id'
                  - 'artist_name'
                  - 'subaccount_id'
                  - 'artist_id'
                  - 'project_id'
                  - 'project_code'
                properties:
                  project_name:
                    type: string
                  project_name_facet:
                    type: string
                  vendor_id:
                    type: string
                  artist_name:
                    type: string
                  subaccount_id:
                    type: string
                  artist_id:
                    type: string
                  project_id:
                    type: string
                  project_code:
                    type: string
                type: object
            type: object
          facets:
            type: array
            items:
              type: string
          selectedFacets:
            type: array
            items:
              type: string
          isError:
            type: boolean
        type: object
      PRODUCT:
        required:
          - 'searchTerm'
          - 'searchTime'
          - 'totalHits'
          - 'startIndex'
          - 'pageSize'
          - 'currentPage'
          - 'totalPages'
          - 'results'
          - 'facets'
          - 'selectedFacets'
          - 'isError'
          - 'errorMessage'
          - 'errorType'
        properties:
          searchTerm:
            type: string
          searchTime:
            type: integer
          totalHits:
            type: integer
          startIndex:
            type: integer
          pageSize:
            type: string
          currentPage:
            type: integer
          totalPages:
            type: integer
          results:
            required:
              - 'rel1680074'
            properties:
              rel1680074:
                required:
                  - 'release_status'
                  - 'track_type'
                  - 'release_month'
                  - 'imprint'
                  - 'featured'
                  - 'sale_start_date'
                  - 'configuration'
                  - 'track_list'
                  - 'label'
                  - 'subaccount_id'
                  - 'vendor_owner'
                  - 'artist_id'
                  - 'vendor_catalog_number'
                  - 'product_type_id'
                  - 'deletions'
                  - 'release_id'
                  - 'format'
                  - 'vendor_id'
                  - 'artist_name'
                  - 'artist_name_facet'
                  - 'c_line'
                  - 'genre'
                  - 'subgenre'
                  - 'vendor_status'
                  - 'project_id'
                  - 'product_type'
                  - 'release_year'
                  - 'release_date'
                  - 'upc'
                  - 'display_upc'
                  - 'product_configuration'
                  - 'isrc_list'
                  - 'release_name'
                  - 'release_name_facet'
                  - 'display'
                  - 'coverart_paths'
                properties:
                  release_status:
                    type: string
                  track_type:
                    type: array
                    items:
                      type: string
                  release_month:
                    type: string
                  imprint:
                    type: string
                  featured:
                    type: string
                  sale_start_date:
                    type: string
                  configuration:
                    type: string
                  track_list:
                    type: array
                    items:
                      type: string
                  label:
                    type: string
                  subaccount_id:
                    type: string
                  vendor_owner:
                    type: string
                  artist_id:
                    type: string
                  vendor_catalog_number:
                    type: string
                  product_type_id:
                    type: string
                  deletions:
                    type: string
                  release_id:
                    type: string
                  format:
                    type: string
                  vendor_id:
                    type: string
                  artist_name:
                    type: string
                  artist_name_facet:
                    type: string
                  c_line:
                    type: string
                  genre:
                    type: string
                  subgenre:
                    type: string
                  vendor_status:
                    type: string
                  project_id:
                    type: string
                  product_type:
                    type: string
                  release_year:
                    type: string
                  release_date:
                    type: string
                  upc:
                    type: string
                  display_upc:
                    type: string
                  product_configuration:
                    type: string
                  isrc_list:
                    type: array
                    items:
                      type: string
                  release_name:
                    type: string
                  release_name_facet:
                    type: string
                  display:
                    type: string
                  coverart_paths:
                    required:
                      - 'thumb'
                      - 'large'
                    properties:
                      thumb:
                        type: string
                      large:
                        type: string
                    type: object
                type: object
            type: object
          facets:
            type: array
            items:
              type: string
          selectedFacets:
            type: array
            items:
              type: string
          isError:
            type: boolean
        type: object
    example:
      {
      	'PROJECT': {
          'searchTerm': 'solo',
          'searchTime': 2,
          'totalHits': 28,
          'startIndex': 0,
          'pageSize': '5',
          'currentPage': 1,
          'totalPages': 6,
          'results': {
            'proj3342499': {
              'project_name': 'Solo Quiero',
              'project_name_facet': 'Solo Quiero',
              'vendor_id': '24981',
              'artist_name': 'Itamar La Mami del Flow',
              'subaccount_id': '20913',
              'artist_id': '783662',
              'project_id': '3342499',
              'project_code': '889845720409'
            }
          },
          'facets': [],
          'selectedFacets': [],
          'isError': false,
          'errorMessage': null,
          'errorType': null
        },
      	'PRODUCT': {
          'searchTerm': 'solo',
          'searchTime': 4,
          'totalHits': 16,
          'startIndex': 0,
          'pageSize': '5',
          'currentPage': 1,
          'totalPages': 4,
          'results': {
            'rel1680074': {
              'release_status': 'in_content',
              'track_type': [
                  'music'
              ],
              'release_month': '11',
              'imprint': 'No Record Company',
              'featured': 'N',
              'sale_start_date': '2015-08-14T00:00:00Z',
              'configuration': 'Digital',
              'track_list': [
                'Roze',
                'Make It Clap',
                'Un Trago por Ella',
                'Pam Pam',
                'Tiburón',
                'Ambiente Salvaje',
                'Kiss My Lips',
                'Agresivo',
                'Amor Genuino',
                'Tu',
                'Vacaciones',
                'Ina the Bar (Ye Ye Ye)',
                'A Lo Under',
                'Tu y Yo'
              ],
              'label': 'Luigui Bleand Co Inc. (D3)',
              'subaccount_id': '20899',
              'vendor_owner': 'epsa',
              'artist_id': '769865',
              'vendor_catalog_number': 'JR00020',
              'product_type_id': '1',
              'deletions': 'N',
              'release_id': '1680074',
              'format': 'Full Length',
              'vendor_id': '24981',
              'artist_name': 'Buxxi & Jack Style',
              'artist_name_facet': 'Buxxi & Jack Style',
              'c_line': '2012 No Records Company',
              'genre': 'Latin Music',
              'subgenre': 'Latin',
              'vendor_status': 'signed',
              'project_id': '3292122',
              'product_type': 'Music',
              'release_year': '2012',
              'release_date': '2012-11-23T00:00:00Z',
              'upc': '889845479130',
              'display_upc': '889845479130',
              'product_configuration': 'Digital Audio',
              'isrc_list': [
                'QM6N21528992',
                'QM6N21528993',
                'QM6N21528994',
                'QM6N21528995',
                'QM6N21528996',
                'QM6N21528997',
                'QM6N21528998',
                'QM6N21528999',
                'QM6N21529000',
                'QM6N21529001',
                'QM6N21529002',
                'QM6N21529003',
                'QM6N21529004',
                'QM6N21529005'
              ],
              'release_name': 'Solo Éxitos',
              'release_name_facet': 'Solo Éxitos',
              'display': 'Y',
              'coverart_paths': {
                'thumb': 'http://images.theorchard.com/release/cover/889845/479/889845479130.jpg',
                'large': 'http://images.theorchard.com/release/large_cover/889845/479/889845479130.jpg'
              }
            }
          },
          'facets': [],
          'selectedFacets': [],
          'isError': false,
          'errorMessage': null,
          'errorType': null
        }
      }
securityDefinitions: {}