Jump to

• Request
• Response

Get all subscription availability exceptions

get

/crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ExceptionPuidAltKey: Finds the subscription availability exceptions with the specified exception PUID
    Finder Variables:
    • ExceptionPuid; string; The public unique identifier of the exception.
  • PrimaryKey: Finds the subscription availability exceptions with the specified exception ID
    Finder Variables:
    • ExceptionId; integer; The unique identifier of the exception.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • ExceptionId; integer; The unique identifier of the exception.
  • ExceptionName; string; The name of the exception.
  • ExceptionPuid; string; The public unique identifier of the subscription exception.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionCoverageExceptions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageExceptions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionCoverageExceptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageExceptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionCoverageExceptions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• ExceptionId: integer (int64)
  The unique identifier of the exception.
• ExceptionName: string
  Title: Exception Name

  Maximum Length: 300

  The name of the exception.
• ExceptionPuid: string
  Title: Exception PUID

  Maximum Length: 120

  The public unique identifier of the subscription exception.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubscriptionCoverageAvailability: array Subscription Coverage Availabilities
  Title: Subscription Coverage Availabilities

  The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionPuid":{
            "title":"Exception PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the subscription exception.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionCoverageAvailability":{
            "title":"Subscription Coverage Availabilities",
            "type":"array",
            "description":"The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageExceptions-SubscriptionCoverageAvailability-item-response"
            }
        },
        "ExceptionId":{
            "type":"integer",
            "description":"The unique identifier of the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionName":{
            "title":"Exception Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the exception.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Coverage Availabilities

Type: array

Title: Subscription Coverage Availabilities

The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.

Show Source

• Array of: object subscriptionCoverageExceptions-SubscriptionCoverageAvailability-item-response

{
    "title":"Subscription Coverage Availabilities",
    "type":"array",
    "description":"The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageExceptions-SubscriptionCoverageAvailability-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionCoverageExceptions-SubscriptionCoverageAvailability-item-response

Type: object

Show Source

• Availability: string
  Title: Availability

  Maximum Length: 1000

  The name of the availability.
• AvailabilityCode: string
  Title: Hours

  Maximum Length: 30

  The code of the availaility.
• AvailabilityHours: string
  The availability hours for the subscription.
• AvailabilityId: integer (int64)
  The unique identifier of the availability.
• AvailabilityPuid: string
  Maximum Length: 120

  The public unique identifier of the availability.
• AvailableDay: string
  Title: Days

  The available day for the subscription.
• AvailableDayMeaning: string
  The day when the subscritpion coverage is available.
• BreakTime: string
  Title: Break

  The break time associated with the subscription.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• Duration: integer (int32)
  Title: Duration

  The duration of the event.
• EndDate: string (date)
  The end date of the event.
• EndHour: number
  The end hour of the subcription.
• EndMinute: number
  The end minute of the subcription.
• EventDay: string
  Title: Date

  Maximum Length: 300

  The day of the event.
• EventName: string
  Title: Event

  Maximum Length: 300

  The name of the event.
• FriYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Friday.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonthCode: string
  Maximum Length: 30

  The code of the month associated with the week.
• MonYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Monday.
• ObjectCode: string
  Maximum Length: 30

  The code of the object as defined in OBJECTS Metadata.
• ObjectId: integer (int64)
  The unique idetifier of the object.
• OneTimeFlag: boolean
  Title: Once

  Maximum Length: 1

  Indicates if the event is a one time event.
• OptionCode: string
  Maximum Length: 30

  The option code associted with the event.
• SatYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Saturday.
• SelectedDays: object SelectedDays
  The days selected for the subscription.
• StartDate: string (date)
  The start date of the event.
• StartHour: number
  The start hour of the subscription.
• StartMinute: number
  The start minute of the subcription.
• SubscriptionCoverageBreak: array Subscription Coverage Breaks
  Title: Subscription Coverage Breaks

  The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.
• SunYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Sunday.
• ThuYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Thursday.
• TueYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Tuesday.
• WedYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Wednesday.
• WeekCode: string
  Maximum Length: 30

  The code of the week associated wth the week.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectedDays":{
            "type":"object",
            "description":"The days selected for the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "SatYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Saturday.",
            "nullable":true,
            "x-queryable":true
        },
        "ThuYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Thursday.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The option code associted with the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "TueYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Tuesday.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MonYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Monday.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the availability.",
            "nullable":true,
            "x-queryable":true
        },
        "WedYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Wednesday.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionCoverageBreak":{
            "title":"Subscription Coverage Breaks",
            "type":"array",
            "description":"The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response"
            }
        },
        "WeekCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the week associated wth the week.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the subcription.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OneTimeFlag":{
            "title":"Once",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the event is a one time event.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the month associated with the week.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BreakTime":{
            "title":"Break",
            "type":"string",
            "description":"The break time associated with the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Availability":{
            "title":"Availability",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the availability.",
            "nullable":true,
            "x-queryable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the subcription.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique idetifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SunYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Sunday.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableDayMeaning":{
            "type":"string",
            "description":"The day when the subscritpion coverage is available.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityCode":{
            "title":"Hours",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the availaility.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the subcription.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventDay":{
            "title":"Date",
            "maxLength":"300",
            "type":"string",
            "description":"The day of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableDay":{
            "title":"Days",
            "type":"string",
            "description":"The available day for the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AvailabilityHours":{
            "type":"string",
            "description":"The availability hours for the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "FriYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if subscription coverage is available on Friday.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : SelectedDays

Type: object

The days selected for the subscription.

Nested Schema : Subscription Coverage Breaks

Type: array

Title: Subscription Coverage Breaks

The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.

Show Source

• Array of: object subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response

{
    "title":"Subscription Coverage Breaks",
    "type":"array",
    "description":"The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response"
    }
}

Nested Schema : subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response

Type: object

Show Source

• AvailabilityId: integer (int64)
  The unique identifier of the availability.
• BreakId: integer (int64)
  The unique identifier of the break
• BreakPuid: string
  Maximum Length: 120

  The public unique identifier of the break.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EndHour: number
  The end hour of the break.
• EndMinute: number
  The end minute of the break.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Maximum Length: 30

  The code associated with the object.
• StartHour: number
  The start hour of the break.
• StartMinute: number
  The start minute of the break.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the object.",
            "nullable":false,
            "x-queryable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "BreakPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BreakId":{
            "type":"integer",
            "description":"The unique identifier of the break",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top