TUI Group Contents API

openapi: 3.2.0
info:
  title: NewSkies-Digital-Api Contents API
  version: 4.8.6.23
  description: Navitaire Digital Api
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
security:
- JWT: []
tags:
- name: contents
paths:
  /api/nsk/v1/contents/news:
    get:
      tags:
      - contents
      summary: Retrieves the available news metadata.
      description: "News or sometimes referred to as FYI Content notes are created by management about your carrier operations. They can be viewed by reservation agents and station agents.\n\nNews notes are a quick way for airlines to distribute important information to reservation and check-in agents.\n\nIf your carrier has a new fare rule, you can use FYI Content to enter this information and set the FYI type to specify how and when this information is displayed.You can also determine who reads this information by assigning roles to it. \n\nYou can also use news content to store pertinent station info, such as passenger disruption reports or journal entries. By saving the content as type No Alert, you leave it in the database, where other users can access it with a search.You can group station reports by Domain, Department, Role, Date, Name, and so on.\n\nRelated endpoints:\n- `GET /resources/contents` which contents generic data for all content types including new contents\n- `GET /resources/contents/{contentID}/data` which allows you to view the data for a specific content item including news content.\n\nThe `StartDate` and `EndDate` will default to the current date if not provided.\n\nThe data is only returned if the content data type is text based. Other content data types such as `JPEG` or `PNG` will be returned as null.\n\nGraphQL endpoint: news"
      operationId: nsk_v1_contents_news_get
      parameters:
      - name: PageSize
        in: query
        description: "The number of items to return for this request. Defaults to the minimum value of 10. The max value is 20.\n            "
        schema:
          type:
          - integer
          - 'null'
          maximum: 20.0
          minimum: 10.0
        x-position: 1
      - name: LastPageKey
        in: query
        description: "The LastPageKey, where to start paged query.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 100
          minLength: 0
        x-position: 2
      - name: StartDate
        in: query
        description: "The start effective date. This will default to today if not provided.\n            "
        schema:
          type: string
          format: date-time
        x-position: 3
      - name: EndDate
        in: query
        description: "The end effective date. This will default to today if not provided.\n            "
        schema:
          type: string
          format: date-time
        x-position: 4
      - name: Type
        in: query
        description: "The news type to search.\n             \nEnumeration values: 0 = All, 1 = Alert, 2 = OneTimeRead, 3 = Daily, 4 = NoAlert"
        schema:
          $ref: '#/components/schemas/FindNewsType'
        x-position: 5
      - name: RequestType
        in: query
        description: "The news request type.\n             \nEnumeration values: 0 = Default, 1 = Unread, 2 = UnreadAlert, 3 = UnreadDailyAndOneTimeRead"
        schema:
          $ref: '#/components/schemas/NewsRequestType'
        x-position: 6
      - name: DomainCode
        in: query
        description: "The domain code. See /resources/Domains for the valid codes.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 3
          minLength: 0
        x-position: 7
      - name: DepartmentCode
        in: query
        description: "The department code. See /resources/Departments for the valid codes.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 4
          minLength: 0
        x-position: 8
      - name: RoleCode
        in: query
        description: "The role code. See /resources/Roles for the valid codes.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 4
          minLength: 0
        x-position: 9
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPagedFindNewsResponse'
              examples:
                News retrieved successfully:
                  description: Example when news are retrieved successfully.
                  value:
                    data:
                      newsList:
                      - data: test 1
                        contentId: 100
                        name: test1
                        description: description1
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 1
                        size: 6
                        type: 1
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: '{\rtf1\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}

                          \viewkind4\uc1\pard\f0\fs17 TEST 2\par

                          }

                          '
                        contentId: 101
                        name: test2
                        description: description2
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 2
                        size: 138
                        type: 2
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 102
                        name: test3
                        description: description3
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 3
                        size: 138
                        type: 3
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 103
                        name: test4
                        description: description4
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 4
                        size: 138
                        type: 4
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 104
                        name: test5
                        description: description5
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 5
                        size: 138
                        type: 1
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 105
                        name: test6
                        description: description6
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 6
                        size: 138
                        type: 2
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 106
                        name: test7
                        description: description7
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 7
                        size: 138
                        type: 3
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: <!DOCTYPE html><html><body><h1>Digital API HTML Heading</h1><p>If you are reading this correctly, it means that the news content is successfully created.</p></body></html>
                        contentId: 107
                        name: test8
                        description: description8
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 8
                        size: 171
                        type: 4
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 108
                        name: test9
                        description: description9
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 9
                        size: 138
                        type: 1
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: https://www.navitaire.com
                        contentId: 109
                        name: test10
                        description: description10
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 10
                        size: 10
                        type: 2
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      - data: null
                        contentId: 110
                        name: test11
                        description: description11
                        createdUserKey: MQ--
                        createdDate: '2024-12-02T05:01:50.2+00:00'
                        dataType: 11
                        size: 138
                        type: 3
                        organizationCode: SYSTEM
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effectiveDate: '2024-12-02T00:00:00'
                        discontinueDate: '2024-12-03T00:00:00'
                        retentionDate: '2024-12-04T00:00:00'
                      totalCount: 11
                      lastPageKey: MTAwMA--
                No matching news item:
                  description: Example when no news items match the search criteria.
                  value:
                    data:
                      newsList: []
                      totalCount: 0
                      lastPageKey: MTAwMA--
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Retrieving news is not allowed:
                  description: Example when retrieving news is not allowed.
                  value:
                    errors:
                    - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701
                      code: nsk:News:RetrieveNewsNotAllowed
                      message: Retrieving news is not allowed.
                      type: Validation
                      details: null
                      rawMessage: Retrieving news is not allowed.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Retrieving content is not allowed:
                  description: Example when retrieving content is not allowed.
                  value:
                    errors:
                    - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701
                      code: nsk:News:RetrieveContentNotAllowed
                      message: Retrieving content is not allowed.
                      type: Validation
                      details: null
                      rawMessage: Retrieving content is not allowed.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Start date is later than the end date.:
                  description: Example when the start date is later than the end date.
                  value:
                    errors:
                    - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701
                      code: nsk:News:StartDateLaterThanEndDate
                      message: The start effective date cannot be later than the end effective date.
                      type: Validation
                      details:
                        endDate: 10/15/2024 12:00:00 AM
                        startDate: 10/16/2024 12:00:00 AM
                      rawMessage: The start effective date cannot be later than the end effective date.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Page size is out of range.:
                  description: Example when the page size is out of range. The minimum is 10 and the maxiumum is 20.
                  value:
                    errors:
                    - id: b79d85c8-b090-baa6-5efa-dbc168844eeb
                      code: FindNewsRequest.PageSize:RangeAttribute
                      message: The field FindNewsRequest must be between 10 and 20.
                      type: Validation
                      details:
                        validation: RangeAttribute
                        model: FindNewsRequest
                        member: PageSize
                      rawMessage: The field FindNewsRequest must be between 10 and 20.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Last page key exceeds maximum length.:
                  description: Example when the last page key exceeds the maximum length of 100.
                  value:
                    errors:
                    - id: b79d85c8-b090-baa6-5efa-dbc168844eeb
                      code: FindNewsRequest.LastPageKey:StringLengthAttribute
                      message: The field FindNewsRequest must be a string with a maximum length of 100.
                      type: Validation
                      details:
                        validation: StringLengthAttribute
                        model: FindNewsRequest
                        member: LastPageKey
                      rawMessage: The field FindNewsRequest must be a string with a maximum length of 100.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Domain code exceeds maximum length.:
                  description: Example when the domain code exceeds the maximum length of 3.
                  value:
                    errors:
                    - id: b79d85c8-b090-baa6-5efa-dbc168844eeb
                      code: FindNewsRequest.DomainCode:StringLengthAttribute
                      message: The field FindNewsRequest must be a string with a maximum length of 3.
                      type: Validation
                      details:
                        validation: StringLengthAttribute
                        model: FindNewsRequest
                        member: DomainCode
                      rawMessage: The field FindNewsRequest must be a string with a maximum length of 3.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Department code exceeds maximum length.:
                  description: Example when the department code exceeds the maximum length of 4.
                  value:
                    errors:
                    - id: b79d85c8-b090-baa6-5efa-dbc168844eeb
                      code: FindNewsRequest.DepartmentCode:StringLengthAttribute
                      message: The field FindNewsRequest must be a string with a maximum length of 4.
                      type: Validation
                      details:
                        validation: StringLengthAttribute
                        model: FindNewsRequest
                        member: DepartmentCode
                      rawMessage: The field FindNewsRequest must be a string with a maximum length of 4.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Role code exceeds maximum length.:
                  description: Example when the role code exceeds the maximum length of 4.
                  value:
                    errors:
                    - id: b79d85c8-b090-baa6-5efa-dbc168844eeb
                      code: FindNewsRequest.RoleCode:StringLengthAttribute
                      message: The field FindNewsRequest must be a string with a maximum length of 4.
                      type: Validation
                      details:
                        validation: StringLengthAttribute
                        model: FindNewsRequest
                        member: RoleCode
                      rawMessage: The field FindNewsRequest must be a string with a maximum length of 4.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
    post:
      tags:
      - contents
      summary: Add a new news content item.
      description: "Add news or sometimes referred to as FYI Content notes.\n\nRelated endpoints:\n- `GET /resources/contents/{contentID}/data`: Allows you to view the data for a specific content item including news content.\n- `GET /contents/news`: Allows you to search for news content items.\n\nThe `OrganizationCode` is automatically set to the `OrganizationCode` of the logged in \nagent if the `DomainCode`, `DepartmentCode`, and `RoleCode` are all set in the request.\n\nOnly text based content data types are allowed. Other content data types such as `JPEG` or `PNG` must be stored elsewhere.\n\nGraphQL endpoint: newsAdd"
      operationId: nsk_v1_contents_news_post
      requestBody:
        x-name: addNewsRequest
        description: The add news request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNewsRequest'
            examples:
              Request with content data type set to text.:
                description: Example when the content data type is set to text.
                value:
                  name: NewsWithText
                  description: News with a text data
                  type: 1
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: '2024-10-16T00:00:00'
                  retentionDate: '2024-10-17T00:00:00'
                  dataType: 1
                  data: Sample text file for Digital API Testing.
                  domainCode: ''
                  departmentCode: ''
                  roleCode: ''
              Request with content data type set to rich text format.:
                description: Example when the content data type is set to rich text format.
                value:
                  name: NewsWithRichTextFormat
                  description: News with a rich text format data
                  type: 2
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: '2024-10-16T00:00:00'
                  retentionDate: '2024-10-17T00:00:00'
                  dataType: 2
                  data: '{\rtf1\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}

                    \viewkind4\uc1\pard\f0\fs17 Sample rich text format file\par

                    }

                    '
                  domainCode: ''
                  departmentCode: ''
                  roleCode: ''
              Request with content data type set to HTML.:
                description: Example when the content data type is set to HTML.
                value:
                  name: NewsWithHtml
                  description: News with a html data
                  type: 3
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: '2024-10-16T00:00:00'
                  retentionDate: '2024-10-17T00:00:00'
                  dataType: 8
                  data: <!DOCTYPE html><html><body><h1>Digital API HTML Heading</h1><p>If you are reading this correctly, it means that the news content is successfully created.</p></body></html>
                  domainCode: ''
                  departmentCode: ''
                  roleCode: ''
              Request with content data type set to URI.:
                description: Example when the content data type is set to URI.
                value:
                  name: NewsWithUri
                  description: News with an Uri data
                  type: 4
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: '2024-10-16T00:00:00'
                  retentionDate: '2024-10-17T00:00:00'
                  dataType: 10
                  data: https://www.navitaire.com
                  domainCode: ''
                  departmentCode: ''
                  roleCode: ''
              Request with no discontinue date and retention date.:
                description: Example when the discontinue date and the retention date is not set.
                value:
                  name: test1
                  description: description
                  type: 1
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: null
                  retentionDate: null
                  dataType: 1
                  data: text
                  domainCode: ''
                  departmentCode: ''
                  roleCode: ''
              News added successfully with organization code automatically set.:
                description: Example when news is added successfully with the organization code automatically set to the logged in agent's organization.
                value:
                  name: test1
                  description: description
                  type: 1
                  effectiveDate: '2024-10-15T00:00:00'
                  discontinueDate: '2024-10-16T00:00:00'
                  retentionDate: '2024-10-17T00:00:00'
                  dataType: 1
                  data: text
                  domainCode: EXT
                  departmentCode: TA
                  roleCode: TAW3
        required: true
        x-position: 1
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfAddNewsResponse'
              examples:
                News with text data type is added successfully.:
                  description: Example when a news with a text data type is added successfully.
                  value:
                    data:
                      news:
                        contentId: 240
                        name: NewsWithText
                        description: News with a text data
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:08:37.69+00:00'
                        dataType: 1
                        size: 41
                        type: 1
                        organizationCode: null
                        domainCode: null
                        departmentCode: null
                        roleCode: null
                        effectiveDate: '2024-10-15T00:00:00'
                        discontinueDate: '2024-10-16T00:00:00'
                        retentionDate: '2024-10-17T00:00:00'
                News with rich text format data type is added successfully.:
                  description: Example when a news with a rich text format data type is added successfully.
                  value:
                    data:
                      news:
                        contentId: 240
                        name: NewsWithRichTextFormat
                        description: News with a rich text format data
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:08:37.69+00:00'
                        dataType: 2
                        size: 160
                        type: 2
                        organizationCode: null
                        domainCode: null
                        departmentCode: null
                        roleCode: null
                        effectiveDate: '2024-10-15T00:00:00'
                        discontinueDate: '2024-10-16T00:00:00'
                        retentionDate: '2024-10-17T00:00:00'
                News with HTML data type is added successfully.:
                  description: Example when a news with a HTML data type is added successfully.
                  value:
                    data:
                      news:
                        contentId: 240
                        name: NewsWithHtml
                        description: News with a html data
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:08:37.69+00:00'
                        dataType: 8
                        size: 171
                        type: 3
                        organizationCode: null
                        domainCode: null
                        departmentCode: null
                        roleCode: null
                        effectiveDate: '2024-10-15T00:00:00'
                        discontinueDate: '2024-10-16T00:00:00'
                        retentionDate: '2024-10-17T00:00:00'
                News with URI data type is added successfully.:
                  description: Example when a news with an URI data type is added successfully.
                  value:
                    data:
                      news:
                        contentId: 240
                        name: NewsWithUri
                        description: News with an Uri data
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:08:37.69+00:00'
                        dataType: 10
                        size: 25
                        type: 4
                        organizationCode: null
                        domainCode: null
                        departmentCode: null
                        roleCode: null
                        effectiveDate: '2024-10-15T00:00:00'
                        discontinueDate: '2024-10-16T00:00:00'
                        retentionDate: '2024-10-17T00:00:00'
                News added successfully with no discontinue date and retention date.:
                  description: Example when news is added with no discontinue date and retention date.
                  value:
                    data:
                      news:
                        contentId: 241
                        name: test1
                        description: description
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:09:06.263+00:00'
                        dataType: 1
                        size: 3
                        type: 1
                        organizationCode: null
                        domainCode: null
                        departmentCode: null
                        roleCode: null
                        effectiveDate: '2024-10-15T00:00:00'
                        discontinueDate: null
                        retentionDate: null
                News added successfully with organization code automatically set.:
                  description: Example when news is added successfully with the organization code automatically set to the logged in agent's organization.
                  value:
                    data:
                      news:
                        contentId: 242
                        name: test1
                        description: description
                        createdUserKey: MTE5MDY-
                        createdDate: '2024-10-15T02:27:43.83+00:00'
                        dataType: 1
                        size: 3
                        type: 1
                        organizationCode: '88887777'
                        domainCode: EXT
                        departmentCode: TA
                        roleCode: TAW3
                        effect

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-contents-api-openapi.yml