> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Red Letter Information List By Dates And Associate

> Get detailed red letter day information (redletter summary + individual day texts) for one or more days according to the given date interval.

The time portion of the dates is ignored. 
NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/GetRedLetterInformationListByDatesAndAssociate
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AppointmentAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Appointment/GetRedLetterInformationListByDatesAndAssociate:
    post:
      tags:
        - Appointment_Agent
      summary: Get Red Letter Information List By Dates And Associate
      description: "Get detailed red letter day information (redletter summary + individual day texts) for one or more days according to the given date interval.\n\nThe time portion of the dates is ignored. \r\nNsApiSlow threshold: 2000 ms."
      operationId: v1AppointmentAgent_GetRedLetterInformationListByDatesAndAssociate
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest
        description: StartDate, EndDate, AssociateId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
            text/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
            application/xml:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
            text/xml:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/SuperOffice.CRM.Services.RedLetterInformationListItem
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetRedLetterInformationListByDatesAndAssociateRequest:
      description: >-
        GetRedLetterInformationListByDatesAndAssociate: Get detailed red letter
        day information (redletter summary + individual day texts) for one or
        more days according to the given date interval. The time portion of the
        dates is ignored.
      type: object
      properties:
        StartDate:
          format: date-time
          type: string
        EndDate:
          format: date-time
          type: string
        AssociateId:
          format: int32
          type: integer
    SuperOffice.CRM.Services.RedLetterInformationListItem:
      description: "Detailed information on red-letter days, including both holidays and other days with their individual texts.\r\n<para />\r\nCarrier object for RedLetterInformationListItem.\r\nServices for the RedLetterInformationListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        Date:
          format: date-time
          description: >-
            Date that this item is valid for; there is exactly one item per
            date, ordered by date.
          type: string
        RedLetterInformation:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RedLetterSummary'
        RedLetterDetails:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.RedLetterDetails'
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.RedLetterSummary:
      description: "Summary of redletter day information - holiday in own country, and in other countries known to the system.\r\n<para />\r\nCarrier object for RedLetterSummary.\r\nServices for the RedLetterSummary Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        IsOwnCountryHoliday:
          description: >-
            If true, this day is a holiday in the country of the given
            associate.
          type: boolean
        IsOtherCountryHoliday:
          description: >-
            If true, this day is a holiday in at least one of the countries that
            has defined associates in the system, but not in the country of the
            associate whose diary is being scanned.
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.RedLetterDetails:
      description: "Red letter day text details, all the texts related to the given day.\r\n<para />\r\nCarrier object for RedLetterDetails.\r\nServices for the RedLetterDetails Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        OwnCountryDayTexts:
          description: >-
            Array - possibly empty - of the texts related to one day in the
            redletter system.
          type: array
          items:
            type: string
        OtherCountryDayTexts:
          description: >-
            Red letter day texts for other countries than the associates' own
            country
          type: array
          items:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Appointment GetRedLetterInformationListByDatesAndAssociateRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetRedLetterInformationListByDatesAndAssociateRequest.md)
- [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md)
- [SuperOffice.WebApi.Agents.AppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AppointmentAgent.md)
- [SuperOffice.WebApi.Agents.IAppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAppointmentAgent.md)
- [Get Day Information List By Dates And Associate](/en/api/reference/restful/agent/appointment_agent/get-day-information-list-by-dates-and-associate.md)
- [NSRedLetterInformationListItem](/en/automation/crmscript/reference/CRMScript.NetServer.NSRedLetterInformationListItem.md)
