Jump to

• Request
• Response

getProfileContextList

get

/ccadmin/v1/profileContextLists/{id}

Get Profile Context List. Get the specified profileContextList. A profileContextList contains a profileContexts property that specifies the ordered list of available profileContexts.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the profileContextList.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getProfileContextList_response

Type: object

Show Source

• id(optional): string
  The ID of the priceListGroup
• profileContexts(optional): array profileContexts
  The ordered list of profileContexts.

{
    "properties":{
        "profileContexts":{
            "description":"The ordered list of profileContexts.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "priceListGroupList":{
                        "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"ID of the priceListGroup. ",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "propertyName":{
                        "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
                        "type":"string"
                    },
                    "defaultPriceListGroup":{
                        "description":"The Default priceListGroup for the profileContext. Properties other than \"id\" may be visible.",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The ID of the default priceListGroup for the profileContext.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "id":{
            "description":"The ID of the priceListGroup",
            "type":"string"
        }
    }
}

Nested Schema : profileContexts

Type: array

The ordered list of profileContexts.

Show Source

• Array of: object items

{
    "description":"The ordered list of profileContexts.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "priceListGroupList":{
                "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"ID of the priceListGroup. ",
                            "type":"string"
                        }
                    }
                }
            },
            "propertyName":{
                "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
                "type":"string"
            },
            "defaultPriceListGroup":{
                "description":"The Default priceListGroup for the profileContext. Properties other than \"id\" may be visible.",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the default priceListGroup for the profileContext.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultPriceListGroup(optional): object defaultPriceListGroup
  The Default priceListGroup for the profileContext. Properties other than "id" may be visible.
• priceListGroupList(optional): array priceListGroupList
  The list of available priceListGroups for the profileContext. Properties other than "id" may be visible.
• propertyName(optional): string
  The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.

{
    "type":"object",
    "properties":{
        "priceListGroupList":{
            "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the priceListGroup. ",
                        "type":"string"
                    }
                }
            }
        },
        "propertyName":{
            "description":"The name of the profile boolean property that, when true on the current profile, will cause the profileContext to (potentially) be active.",
            "type":"string"
        },
        "defaultPriceListGroup":{
            "description":"The Default priceListGroup for the profileContext. Properties other than \"id\" may be visible.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The ID of the default priceListGroup for the profileContext.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : defaultPriceListGroup

Type: object

The Default priceListGroup for the profileContext. Properties other than "id" may be visible.

Show Source

• id(optional): string
  The ID of the default priceListGroup for the profileContext.

{
    "description":"The Default priceListGroup for the profileContext. Properties other than \"id\" may be visible.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the default priceListGroup for the profileContext.",
            "type":"string"
        }
    }
}

Nested Schema : priceListGroupList

Type: array

The list of available priceListGroups for the profileContext. Properties other than "id" may be visible.

Show Source

• Array of: object items

{
    "description":"The list of available priceListGroups for the profileContext. Properties other than \"id\" may be visible.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of the priceListGroup. ",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  ID of the priceListGroup.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the priceListGroup. ",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "profileContexts":[
        {
            "priceListGroupList":[
                {
                    "deleted":false,
                    "endDate":null,
                    "displayName":"Default Price Group",
                    "listPriceList":{
                    },
                    "active":true,
                    "salePriceList":{
                    },
                    "currency":{
                        "symbol":null,
                        "displayName":null,
                        "fractionalDigits":null,
                        "currencyCode":null,
                        "numericCode":null
                    },
                    "id":"defaultPriceGroup",
                    "locale":"en_US",
                    "shippingSurchargePriceList":{
                    },
                    "startDate":null
                }
            ],
            "propertyName":"active",
            "defaultPriceListGroup":{
                "deleted":false,
                "endDate":null,
                "displayName":"Default Price Group",
                "listPriceList":{
                },
                "active":true,
                "salePriceList":{
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"defaultPriceGroup",
                "locale":"en_US",
                "shippingSurchargePriceList":{
                },
                "startDate":null
            }
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/profileContextLists/defaultProfileContextList"
        }
    ],
    "id":"defaultProfileContextList"
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top