Jump to

• Request
• Response

Get a Profile Sharing Group

get

/bcws/webresources/v1.0/sharing/profiles/{id}

Gets the profile sharing group that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the profile sharing group.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The profile sharing group was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ProfileServExtratingType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileServExtratingType"
    }
}

Nested Schema : ProfileServExtratingType

Type: object

Show Source

• accountObj(required): object ResourceRef
• creationDate: string (date-time)
  The date and time the profile was created.
• dataArray: array dataArray
  A list of extended rating attributes (ERAs).
• effectiveDate: string (date-time)
  The date and time the profile is effective from.
• extension: object extension
  The extended attributes.
• extrating: object Extrating
  Information about an extended rating attribute.
• id(required): object ResourceRef
• multiValued: boolean
  Whether the profile has multiple values (true) or not (false).
• name: string
  The name of the profile.
• parentName: string
  The name of the parent profile.
• selected: boolean
  Whether the profile is selected (true) or not (false).
• serviceObj: object ResourceRef

{
    "required":[
        "accountObj",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        },
        "dataArray":{
            "type":"array",
            "description":"A list of extended rating attributes (ERAs).",
            "items":{
                "$ref":"#/components/schemas/DataArray"
            }
        },
        "extrating":{
            "$ref":"#/components/schemas/Extrating"
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : dataArray

Type: array

A list of extended rating attributes (ERAs).

Show Source

• Array of: object DataArray
  A list of extended rating attributes (ERAs).

{
    "type":"array",
    "description":"A list of extended rating attributes (ERAs).",
    "items":{
        "$ref":"#/components/schemas/DataArray"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Extrating

Type: object

Information about an extended rating attribute.

Show Source

• label: string
  The ERA's label name.
• referenceCount: integer (int32)
  A number that keeps the reference count. For purchases, the counter is incremented by one. For cancellations, the counter is decreased by one.
• status: integer (int32)
  The provisioning status. Can be one of the following:

  • 0: No operation
  • 1: Provisioning ERA
  • 2: Provisioning ERA failed
  • 3: ERA active
  • 4: Unprovisioning ERA
  • 5: Unprovisioning ERA failed
  • 6: ERA unprovisioned
  • 7: Suspending ERA
  • 8: ERA suspension failed
  • 9: ERA suspended

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"The ERA's label name."
        },
        "referenceCount":{
            "type":"integer",
            "description":"A number that keeps the reference count. For purchases, the counter is incremented by one. For cancellations, the counter is decreased by one.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The provisioning status. Can be one of the following: <ul><li><b>0</b>: No operation</li><li><b>1</b>: Provisioning ERA</li><li><b>2</b>: Provisioning ERA failed</li><li><b>3</b>: ERA active</li><li><b>4</b>: Unprovisioning ERA</li><li><b>5</b>: Unprovisioning ERA failed</li><li><b>6</b>: ERA unprovisioned</li><li><b>7</b>: Suspending ERA</li><li><b>8</b>: ERA suspension failed</li><li><b>9</b>: ERA suspended</li></ul>",
            "format":"int32"
        }
    },
    "description":"Information about an extended rating attribute."
}

Nested Schema : DataArray

Type: object

A list of extended rating attributes (ERAs).

Show Source

• elem: integer (int32)
  The position of the entry in the array. For example, the first item in the array would have an elem value of 1.
• name: string
  The ERA's name.
• validFrom: string (date-time)
  The date and time the ERA's validity period starts.
• validTo: string (date-time)
  The date and time the ERA's validity period ends.
• value: string
  The ERA's value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The ERA's name."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the ERA's validity period starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the ERA's validity period ends.",
            "format":"date-time"
        },
        "value":{
            "type":"string",
            "description":"The ERA's value."
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in the array would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"A list of extended rating attributes (ERAs)."
}

500 Response

An internal server error occurred.

Back to Top