Get all subscription coverage availability details
get
/crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability
Request
Path Parameters
-
IntervalPuid(required): string
The public unique identifier of the interval.
-
SchedulePuid(required): string
The public unique identifier of the subscription coverage schedule.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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:- AvailabilityPuidAltKey: Finds the subscription availability exceptions with the specified availability PUID
Finder Variables:- AvailabilityPuid; string; The public unique identifier of the suscription covreage availbility.
- PrimaryKey: Finds the subscription availability exceptions with the specified availability ID
Finder Variables:- AvailabilityId; integer; The unique identifier of the subscritpion coverage availability.
- AvailabilityPuidAltKey: Finds the subscription availability exceptions with the specified availability PUID
-
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:- Availability; string; The name of the availability.
- AvailabilityCode; string; The code of the availaility.
- AvailabilityHours; string; The availability hours for the subscription.
- AvailabilityId; integer; The unique identifier of the avilability.
- AvailabilityPuid; string; The public unique identifier ot the availbility.
- AvailableDayMeaning; string; The day when the subscritpion coverage is available.
- BreakTime; string; The break time associated with the subscription.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- Duration; integer; The duration of the event.
- EndDate; string; The end date of the event.
- EndHour; number; The end hour of the subcription.
- EndMinute; number; The end minute of the subcription.
- EventDay; string; The day of the event.
- EventName; string; The name of the event.
- FriYn; string; Indicates if subscription coverage is available on Friday.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- MonYn; string; Indicates if subscription coverage is available on Monday.
- MonthCode; string; The code of the month associated with the week.
- ObjectCode; string; The code of the object as defined in OBJECTS Metadata.
- ObjectId; integer; The unique idetifier of the object.
- OneTimeFlag; boolean; Indicates if the event is a one time event.
- OptionCode; string; The option code associted with the event.
- SatYn; string; Indicates if subscription coverage is available on Saturday.
- SelectedDays; object; The days selected for the subscription.
- StartDate; string; The start date of the event.
- StartHour; number; The start hour of the subscription.
- StartMinute; number; The start minute of the subcription.
- SunYn; string; Indicates if subscription coverage is available on Sunday.
- ThuYn; string; Indicates if subscription coverage is available on Thursday.
- TueYn; string; Indicates if subscription coverage is available on Tuesday.
- WedYn; string; Indicates if subscription coverage is available on Wednesday.
- WeekCode; string; The code of the week associated wth the week.
-
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 TopResponse
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.
Root Schema : subscriptionCoverageSchedules-SubscriptionCoverageInterval-SubscriptionCoverageAvailability
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionCoverageSchedules-SubscriptionCoverageInterval-SubscriptionCoverageAvailability-item-response
Type:
Show Source
object
-
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 avilability.
-
AvailabilityPuid: string
Maximum Length:
120
The public unique identifier ot the availbility. -
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 schedule break details. The 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 schedule break details. The break object has details such as start hour, start minute, end hour, end minute
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionCoverageSchedules-SubscriptionCoverageInterval-SubscriptionCoverageAvailability-SubscriptionCoverageBreak-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source