Jump to

• Request
• Response

Create a Service Provider Preference

post

/locations/{locationGid}/servprovPrefs

Request

Path Parameters

• locationGid(required): string
  Resource ID

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefGid":{
            "description":"The unique identifier of location service provider preference.",
            "type":"string"
        },
        "locationServprovPrefXid":{
            "description":"The XID of location service provider preference.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The Service Provider GID.",
            "type":"string"
        },
        "maxSlotsPerDay":{
            "description":"The maximum number of slots per day.",
            "type":"number",
            "format":"int32"
        },
        "serviceLocationGid":{
            "description":"Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.servprovPrefs.details

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefGid":{
            "description":"The unique identifier of location service provider preference.",
            "type":"string"
        },
        "locationServprovPrefXid":{
            "description":"The XID of location service provider preference.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The Service Provider GID.",
            "type":"string"
        },
        "maxSlotsPerDay":{
            "description":"The maximum number of slots per day.",
            "type":"number",
            "format":"int32"
        },
        "serviceLocationGid":{
            "description":"Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.servprovPrefs.details

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefGid":{
            "description":"The unique identifier of location service provider preference.",
            "type":"string"
        },
        "locationServprovPrefXid":{
            "description":"The XID of location service provider preference.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The Service Provider GID.",
            "type":"string"
        },
        "maxSlotsPerDay":{
            "description":"The maximum number of slots per day.",
            "type":"number",
            "format":"int32"
        },
        "serviceLocationGid":{
            "description":"Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.servprovPrefs.details

Type: object

Show Source

• 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.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top