Jump to

• Request
• Response

Get Promotion Types (ERAs)

get

/profiles/promotiontypes

Gets promotion types and localized labels for the specified account or service scope.

Request

Query Parameters

• locale: string
  Locale for promotion type labels; defaults to en_US.

  Default Value: en_US
• scope: string
  BRM account or service type, such as /account or /service/telco/gsm; defaults to /account.

  Default Value: /account

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Promotion types were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PromotionType

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

Nested Schema : PromotionType

Type: object

Show Source

• extension: object extension
  The extended attributes.
• localizedStrings(required): object LocalizedStrings
  The localized name and description of the promotion.
• name(required): string
  The name of the promotion

{
    "required":[
        "localizedStrings",
        "name"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "name":{
            "type":"string",
            "description":"The name of the promotion"
        },
        "localizedStrings":{
            "$ref":"#/components/schemas/LocalizedStrings"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : LocalizedStrings

Type: object

The localized name and description of the promotion.

Show Source

• description(required): string
  Localized description of the promotion.
• descriptionId: integer (int32)
  The locale ID for the description of the promotion.
• name(required): string
  Localized name of the promotion.
• nameId: integer (int32)
  Locale ID for name of the promotion.

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Localized name of the promotion."
        },
        "description":{
            "type":"string",
            "description":"Localized description of the promotion."
        },
        "nameId":{
            "type":"integer",
            "description":"Locale ID for name of the promotion.",
            "format":"int32"
        },
        "descriptionId":{
            "type":"integer",
            "description":"The locale ID for the description of the promotion.",
            "format":"int32"
        }
    },
    "description":"The localized name and description of the promotion."
}

500 Response

An internal server error occurred.

Back to Top