Get Service Provider Preferences
get
/locations/{locationGid}/servprovPrefs
Request
Path Parameters
-
locationGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : locations.servprovPrefs
Type:
Show Source
object
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
locationServprovPrefGid: string
The unique identifier of location service provider preference.
-
locationServprovPrefXid: string
The XID of location service provider preference.
-
maxSlotsPerDay: number
(int32)
The maximum number of slots per day.
-
serviceLocationGid: string
Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
-
servprovGid: string
The Service Provider GID.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.servprovPrefs.details
Type:
Show Source
object
-
begin: number
(int32)
The begin time.
-
dayOfWeek: number
(int32)
The day of week.
-
domainName: string
Database domain where this data is stored.
-
duration: number
(int32)
The duration of the time window.
-
isStanding: boolean
Indicates if the defined preference is for standing appointment.
-
links: array
links
Read Only:
true
-
locationResourceGid: string
Indicates the resource that preference defined on.
-
locationServprovPrefDSeq: number
(int64)
Sequence with in a particular location service provider preference GID.
-
maxSlot: number
(int32)
The maximum number of slots during this time.
-
preferenceLevel: number
(int32)
The preference level.