Jump to

• Request
• Response

Create a subscription availability schedule

post

/crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability

Request

Path Parameters

• ExceptionPuid(required): string
  The public unique identifier of the subscription exception.

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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.
• 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.
• NoBreakFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether it has any break record associated with the exception.
• ObjectCode(required): string
  Maximum Length: 30

  The code of the object as defined in OBJECTS Metadata.
• ObjectId(required): 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.

{
    "required":[
        "ObjectCode",
        "ObjectId"
    ],
    "type":"object",
    "properties":{
        "Availability":{
            "title":"Availability",
            "maxLength":1000,
            "type":"string",
            "description":"The name of the availability.",
            "nullable":true
        },
        "AvailabilityCode":{
            "title":"Hours",
            "maxLength":30,
            "type":"string",
            "description":"The code of the availaility.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AvailabilityPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the availability.",
            "nullable":true
        },
        "AvailableDay":{
            "title":"Days",
            "type":"string",
            "description":"The available day for the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the event.",
            "format":"date",
            "nullable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the subcription.",
            "nullable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the subcription.",
            "nullable":true
        },
        "EventDay":{
            "title":"Date",
            "maxLength":300,
            "type":"string",
            "description":"The day of the event.",
            "nullable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":300,
            "type":"string",
            "description":"The name of the event.",
            "nullable":true
        },
        "FriYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Friday.",
            "nullable":true
        },
        "MonYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Monday.",
            "nullable":true
        },
        "MonthCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the month associated with the week.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoBreakFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it has any break record associated with the exception.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the object as defined in OBJECTS Metadata.",
            "nullable":false
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique idetifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OneTimeFlag":{
            "title":"Once",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event is a one time event.",
            "nullable":true
        },
        "OptionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The option code associted with the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SatYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Saturday.",
            "nullable":true
        },
        "SelectedDays":{
            "type":"object",
            "description":"The days selected for the subscription.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the event.",
            "format":"date",
            "nullable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the subscription.",
            "nullable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the subcription.",
            "nullable":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-post-request"
            }
        },
        "SunYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Sunday.",
            "nullable":true
        },
        "ThuYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Thursday.",
            "nullable":true
        },
        "TueYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Tuesday.",
            "nullable":true
        },
        "WedYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Wednesday.",
            "nullable":true
        },
        "WeekCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the week associated wth the week.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : subscriptionCoverageExceptions-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-post-request

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.
• EndHour: number
  The end hour of the break.
• EndMinute: number
  The end minute of the break.
• 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":{
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BreakId":{
            "type":"integer",
            "description":"The unique identifier of the break",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BreakPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the break.",
            "nullable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the break.",
            "nullable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the break.",
            "nullable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the object.",
            "nullable":false
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the break.",
            "nullable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the break.",
            "nullable":true
        }
    }
}

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-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
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  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
  Read Only: true

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

  Read Only: true

  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.
• ExceptionPuid: string
  Read Only: true

  Maximum Length: 120

  The value that uniquely identifies the parent coverage exception against an availability.
• FriYn: string
  Maximum Length: 1

  Indicates if subscription coverage is available on Friday.
• IntervalPuid: string
  Read Only: true

  Maximum Length: 120

  The value that uniquely identifies the parent coverage interval against an availability.
• 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.
• NoBreakFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether it has any break record associated with the exception.
• 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":{
        "Availability":{
            "title":"Availability",
            "maxLength":1000,
            "type":"string",
            "description":"The name of the availability.",
            "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
        },
        "AvailabilityHours":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The availability hours for the subscription.",
            "nullable":false,
            "readOnly":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
        },
        "AvailabilityPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the availability.",
            "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"
            }
        },
        "AvailableDayMeaning":{
            "type":"string",
            "description":"The day when the subscritpion coverage is available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BreakTime":{
            "title":"Break",
            "type":"string",
            "description":"The break time associated with the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the subcription.",
            "nullable":true,
            "x-queryable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the subcription.",
            "nullable":true,
            "x-queryable":true
        },
        "EventDay":{
            "title":"Date",
            "maxLength":300,
            "type":"string",
            "description":"The day of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":300,
            "type":"string",
            "description":"The name of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the parent coverage exception against an availability.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "FriYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Friday.",
            "nullable":true,
            "x-queryable":true
        },
        "IntervalPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the parent coverage interval against an availability.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MonYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Monday.",
            "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
        },
        "NoBreakFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it has any break record associated with the exception.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique idetifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OneTimeFlag":{
            "title":"Once",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event is a one time event.",
            "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
        },
        "SatYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Saturday.",
            "nullable":true,
            "x-queryable":true
        },
        "SelectedDays":{
            "type":"object",
            "description":"The days selected for the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute of the subcription.",
            "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"
            }
        },
        "SunYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Sunday.",
            "nullable":true,
            "x-queryable":true
        },
        "ThuYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Thursday.",
            "nullable":true,
            "x-queryable":true
        },
        "TueYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Tuesday.",
            "nullable":true,
            "x-queryable":true
        },
        "WedYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if subscription coverage is available on Wednesday.",
            "nullable":true,
            "x-queryable":true
        },
        "WeekCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the week associated wth the week.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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-SubscriptionCoverageBreak-item-response

Type: object

Show Source

• AvailabilityId: integer (int64)
  The unique identifier of the availability.
• AvailabilityPuid: string
  Read Only: true

  Maximum Length: 120

  The value that uniquely identifies the parent coverage availability against a break.
• 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":{
        "AvailabilityId":{
            "type":"integer",
            "description":"The unique identifier of the availability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailabilityPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the parent coverage availability against a break.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BreakId":{
            "type":"integer",
            "description":"The unique identifier of the break",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BreakPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier 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
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndHour":{
            "type":"number",
            "description":"The end hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "EndMinute":{
            "type":"number",
            "description":"The end minute of the break.",
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the object.",
            "nullable":false,
            "x-queryable":true
        },
        "StartHour":{
            "type":"number",
            "description":"The start hour of the break.",
            "nullable":true,
            "x-queryable":true
        },
        "StartMinute":{
            "type":"number",
            "description":"The start minute 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"
            }
        }
    }
}

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"
    }
}

Links

AvailabilityMeaningVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_SCHED_HOURS

The list of values indicating the code of the availaility .

The following properties are defined on the LOV link relation:

• Source Attribute: AvailabilityCode; Target Attribute: LookupCode
• Display Attribute: Meaning

MonthVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_SCHED_RELATIVE_MONTH

The list of values indicating the month code.

The following properties are defined on the LOV link relation:

• Source Attribute: MonthCode; Target Attribute: LookupCode
• Display Attribute: Meaning

OptionCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_SCHED_RELATIVE_ORDER

The list of values indicating the option code associted with the event.

The following properties are defined on the LOV link relation:

• Source Attribute: OptionCode; Target Attribute: LookupCode
• Display Attribute: Meaning

SubscriptionCoverageBreak

Operation: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak

Parameters:

• AvailabilityPuid: $request.path.AvailabilityPuid
• ExceptionPuid: $request.path.ExceptionPuid

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.

WeekVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_DAY_OF_WEEK

The list of values indicating the day codes in a week.

The following properties are defined on the LOV link relation:

• Source Attribute: WeekCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top