Jump to

• Request
• Response

getService

get

/ccstore/v1/services/{id}

Get a particular service associated with a user.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of an asset.

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getService_response

Type: object

Show Source

• items(optional): array items
  The service object.

{
    "properties":{
        "items":{
            "description":"The service object.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deactivationDate":{
                        "description":"Date on which the service contract ends.",
                        "type":"string"
                    },
                    "rootDisplay":{
                        "description":"The public, non-unique key for the root product instance. For example, phone number or serial number.",
                        "type":"string"
                    },
                    "rootAsset":{
                        "description":"Root asset information.",
                        "type":"object",
                        "properties":{
                            "assetId":{
                                "description":"Id of asset.",
                                "type":"string"
                            },
                            "serviceId":{
                                "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                                "type":"string"
                            }
                        }
                    },
                    "displayName":{
                        "description":"The public, non-unique key for the product instance. For example, phone number or serial number.",
                        "type":"string"
                    },
                    "discountAmount":{
                        "description":"The discount amount.",
                        "type":"object",
                        "properties":{
                            "currency":{
                                "description":"Currency code for the discount amount.",
                                "type":"string"
                            },
                            "value":{
                                "description":"Amount value for the discount amount.",
                                "type":"number"
                            }
                        }
                    },
                    "recurringChargeFrequency":{
                        "description":"The period for the fixed recurring charge. For example, Per Month.",
                        "type":"string"
                    },
                    "dateAdded":{
                        "description":"System field indicating the date on which the Resource was created.",
                        "type":"string"
                    },
                    "price":{
                        "description":"The price.",
                        "type":"object",
                        "properties":{
                            "currency":{
                                "description":"Currency code for the price.",
                                "type":"string"
                            },
                            "value":{
                                "description":"Amount value for the price.",
                                "type":"number"
                            }
                        }
                    },
                    "assetId":{
                        "description":"Id of asset.",
                        "type":"string"
                    },
                    "currency":{
                        "description":"The currency code.",
                        "type":"object",
                        "properties":{
                            "currencyCode":{
                                "description":"Unique currency code for the currency.",
                                "type":"string"
                            }
                        }
                    },
                    "usageNetAmount":{
                        "description":"The usage information.",
                        "type":"object",
                        "properties":{
                            "currency":{
                                "description":"Currency code for the usage net amount.",
                                "type":"string"
                            },
                            "value":{
                                "description":"Amount value for the usage net amount.",
                                "type":"number"
                            }
                        }
                    },
                    "serviceId":{
                        "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                        "type":"string"
                    },
                    "skuId":{
                        "description":"The SKU Id.",
                        "type":"string"
                    },
                    "serviceAccountId":{
                        "description":"The customer that owns the product.",
                        "type":"string"
                    },
                    "quantity":{
                        "description":"The quantity of the asset.",
                        "type":"integer"
                    },
                    "recurringChargeDuration":{
                        "description":"The payment terms. For example, Net 30.",
                        "type":"string"
                    },
                    "discountPercent":{
                        "description":"The percent of discount received.",
                        "type":"integer"
                    },
                    "dateModified":{
                        "description":"System field indicating the date on which the Resource was last modified.",
                        "type":"string"
                    },
                    "transactionDate":{
                        "description":"ISO formatted Date on which the service action should be triggered.",
                        "type":"string"
                    },
                    "usageUnitOfMeasure":{
                        "description":"The unit of measure for the usage charges. For example, Per Copy or Per Minute.",
                        "type":"string"
                    },
                    "suspendDate":{
                        "description":"Date on which the service suspends.",
                        "type":"string"
                    },
                    "parentDisplay":{
                        "description":"The public, non-unique key for the parent product instance. For example, phone number or serial number.",
                        "type":"string"
                    },
                    "attributes":{
                        "description":"A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.",
                        "type":"string"
                    },
                    "activationDate":{
                        "description":"Date on which the service contract starts.",
                        "type":"string"
                    },
                    "parentAsset":{
                        "description":"Parent asset information.",
                        "type":"object",
                        "properties":{
                            "assetId":{
                                "description":"Id of asset.",
                                "type":"string"
                            },
                            "serviceId":{
                                "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                                "type":"string"
                            }
                        }
                    },
                    "resumeDate":{
                        "description":"Date on which the service contract resumes.",
                        "type":"string"
                    },
                    "recurringCharge":{
                        "description":"The recurring charge.",
                        "type":"object",
                        "properties":{
                            "currency":{
                                "description":"Currency code for the recurring amount.",
                                "type":"string"
                            },
                            "value":{
                                "description":"Amount value for the recurring amount.",
                                "type":"number"
                            }
                        }
                    },
                    "status":{
                        "description":"The status information.",
                        "type":"object",
                        "properties":{
                            "displayValue":{
                                "description":"Translated display value of the fixed list of value for status.",
                                "type":"string"
                            },
                            "lookupCode":{
                                "description":"Language independent code of the fixed list of value for status.",
                                "type":"string"
                            },
                            "id":{
                                "description":"Id of the fixed list of value for status.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The service object.

Show Source

• Array of: object items

{
    "description":"The service object.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deactivationDate":{
                "description":"Date on which the service contract ends.",
                "type":"string"
            },
            "rootDisplay":{
                "description":"The public, non-unique key for the root product instance. For example, phone number or serial number.",
                "type":"string"
            },
            "rootAsset":{
                "description":"Root asset information.",
                "type":"object",
                "properties":{
                    "assetId":{
                        "description":"Id of asset.",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                        "type":"string"
                    }
                }
            },
            "displayName":{
                "description":"The public, non-unique key for the product instance. For example, phone number or serial number.",
                "type":"string"
            },
            "discountAmount":{
                "description":"The discount amount.",
                "type":"object",
                "properties":{
                    "currency":{
                        "description":"Currency code for the discount amount.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Amount value for the discount amount.",
                        "type":"number"
                    }
                }
            },
            "recurringChargeFrequency":{
                "description":"The period for the fixed recurring charge. For example, Per Month.",
                "type":"string"
            },
            "dateAdded":{
                "description":"System field indicating the date on which the Resource was created.",
                "type":"string"
            },
            "price":{
                "description":"The price.",
                "type":"object",
                "properties":{
                    "currency":{
                        "description":"Currency code for the price.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Amount value for the price.",
                        "type":"number"
                    }
                }
            },
            "assetId":{
                "description":"Id of asset.",
                "type":"string"
            },
            "currency":{
                "description":"The currency code.",
                "type":"object",
                "properties":{
                    "currencyCode":{
                        "description":"Unique currency code for the currency.",
                        "type":"string"
                    }
                }
            },
            "usageNetAmount":{
                "description":"The usage information.",
                "type":"object",
                "properties":{
                    "currency":{
                        "description":"Currency code for the usage net amount.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Amount value for the usage net amount.",
                        "type":"number"
                    }
                }
            },
            "serviceId":{
                "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                "type":"string"
            },
            "skuId":{
                "description":"The SKU Id.",
                "type":"string"
            },
            "serviceAccountId":{
                "description":"The customer that owns the product.",
                "type":"string"
            },
            "quantity":{
                "description":"The quantity of the asset.",
                "type":"integer"
            },
            "recurringChargeDuration":{
                "description":"The payment terms. For example, Net 30.",
                "type":"string"
            },
            "discountPercent":{
                "description":"The percent of discount received.",
                "type":"integer"
            },
            "dateModified":{
                "description":"System field indicating the date on which the Resource was last modified.",
                "type":"string"
            },
            "transactionDate":{
                "description":"ISO formatted Date on which the service action should be triggered.",
                "type":"string"
            },
            "usageUnitOfMeasure":{
                "description":"The unit of measure for the usage charges. For example, Per Copy or Per Minute.",
                "type":"string"
            },
            "suspendDate":{
                "description":"Date on which the service suspends.",
                "type":"string"
            },
            "parentDisplay":{
                "description":"The public, non-unique key for the parent product instance. For example, phone number or serial number.",
                "type":"string"
            },
            "attributes":{
                "description":"A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.",
                "type":"string"
            },
            "activationDate":{
                "description":"Date on which the service contract starts.",
                "type":"string"
            },
            "parentAsset":{
                "description":"Parent asset information.",
                "type":"object",
                "properties":{
                    "assetId":{
                        "description":"Id of asset.",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                        "type":"string"
                    }
                }
            },
            "resumeDate":{
                "description":"Date on which the service contract resumes.",
                "type":"string"
            },
            "recurringCharge":{
                "description":"The recurring charge.",
                "type":"object",
                "properties":{
                    "currency":{
                        "description":"Currency code for the recurring amount.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Amount value for the recurring amount.",
                        "type":"number"
                    }
                }
            },
            "status":{
                "description":"The status information.",
                "type":"object",
                "properties":{
                    "displayValue":{
                        "description":"Translated display value of the fixed list of value for status.",
                        "type":"string"
                    },
                    "lookupCode":{
                        "description":"Language independent code of the fixed list of value for status.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of the fixed list of value for status.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• activationDate(optional): string
  Date on which the service contract starts.
• assetId(optional): string
  Id of asset.
• attributes(optional): string
  A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.
• currency(optional): object currency
  The currency code.
• dateAdded(optional): string
  System field indicating the date on which the Resource was created.
• dateModified(optional): string
  System field indicating the date on which the Resource was last modified.
• deactivationDate(optional): string
  Date on which the service contract ends.
• discountAmount(optional): object discountAmount
  The discount amount.
• discountPercent(optional): integer
  The percent of discount received.
• displayName(optional): string
  The public, non-unique key for the product instance. For example, phone number or serial number.
• parentAsset(optional): object parentAsset
  Parent asset information.
• parentDisplay(optional): string
  The public, non-unique key for the parent product instance. For example, phone number or serial number.
• price(optional): object price
  The price.
• quantity(optional): integer
  The quantity of the asset.
• recurringCharge(optional): object recurringCharge
  The recurring charge.
• recurringChargeDuration(optional): string
  The payment terms. For example, Net 30.
• recurringChargeFrequency(optional): string
  The period for the fixed recurring charge. For example, Per Month.
• resumeDate(optional): string
  Date on which the service contract resumes.
• rootAsset(optional): object rootAsset
  Root asset information.
• rootDisplay(optional): string
  The public, non-unique key for the root product instance. For example, phone number or serial number.
• serviceAccountId(optional): string
  The customer that owns the product.
• serviceId(optional): string
  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
• skuId(optional): string
  The SKU Id.
• status(optional): object status
  The status information.
• suspendDate(optional): string
  Date on which the service suspends.
• transactionDate(optional): string
  ISO formatted Date on which the service action should be triggered.
• usageNetAmount(optional): object usageNetAmount
  The usage information.
• usageUnitOfMeasure(optional): string
  The unit of measure for the usage charges. For example, Per Copy or Per Minute.

{
    "type":"object",
    "properties":{
        "deactivationDate":{
            "description":"Date on which the service contract ends.",
            "type":"string"
        },
        "rootDisplay":{
            "description":"The public, non-unique key for the root product instance. For example, phone number or serial number.",
            "type":"string"
        },
        "rootAsset":{
            "description":"Root asset information.",
            "type":"object",
            "properties":{
                "assetId":{
                    "description":"Id of asset.",
                    "type":"string"
                },
                "serviceId":{
                    "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                    "type":"string"
                }
            }
        },
        "displayName":{
            "description":"The public, non-unique key for the product instance. For example, phone number or serial number.",
            "type":"string"
        },
        "discountAmount":{
            "description":"The discount amount.",
            "type":"object",
            "properties":{
                "currency":{
                    "description":"Currency code for the discount amount.",
                    "type":"string"
                },
                "value":{
                    "description":"Amount value for the discount amount.",
                    "type":"number"
                }
            }
        },
        "recurringChargeFrequency":{
            "description":"The period for the fixed recurring charge. For example, Per Month.",
            "type":"string"
        },
        "dateAdded":{
            "description":"System field indicating the date on which the Resource was created.",
            "type":"string"
        },
        "price":{
            "description":"The price.",
            "type":"object",
            "properties":{
                "currency":{
                    "description":"Currency code for the price.",
                    "type":"string"
                },
                "value":{
                    "description":"Amount value for the price.",
                    "type":"number"
                }
            }
        },
        "assetId":{
            "description":"Id of asset.",
            "type":"string"
        },
        "currency":{
            "description":"The currency code.",
            "type":"object",
            "properties":{
                "currencyCode":{
                    "description":"Unique currency code for the currency.",
                    "type":"string"
                }
            }
        },
        "usageNetAmount":{
            "description":"The usage information.",
            "type":"object",
            "properties":{
                "currency":{
                    "description":"Currency code for the usage net amount.",
                    "type":"string"
                },
                "value":{
                    "description":"Amount value for the usage net amount.",
                    "type":"number"
                }
            }
        },
        "serviceId":{
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "type":"string"
        },
        "skuId":{
            "description":"The SKU Id.",
            "type":"string"
        },
        "serviceAccountId":{
            "description":"The customer that owns the product.",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity of the asset.",
            "type":"integer"
        },
        "recurringChargeDuration":{
            "description":"The payment terms. For example, Net 30.",
            "type":"string"
        },
        "discountPercent":{
            "description":"The percent of discount received.",
            "type":"integer"
        },
        "dateModified":{
            "description":"System field indicating the date on which the Resource was last modified.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "usageUnitOfMeasure":{
            "description":"The unit of measure for the usage charges. For example, Per Copy or Per Minute.",
            "type":"string"
        },
        "suspendDate":{
            "description":"Date on which the service suspends.",
            "type":"string"
        },
        "parentDisplay":{
            "description":"The public, non-unique key for the parent product instance. For example, phone number or serial number.",
            "type":"string"
        },
        "attributes":{
            "description":"A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.",
            "type":"string"
        },
        "activationDate":{
            "description":"Date on which the service contract starts.",
            "type":"string"
        },
        "parentAsset":{
            "description":"Parent asset information.",
            "type":"object",
            "properties":{
                "assetId":{
                    "description":"Id of asset.",
                    "type":"string"
                },
                "serviceId":{
                    "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
                    "type":"string"
                }
            }
        },
        "resumeDate":{
            "description":"Date on which the service contract resumes.",
            "type":"string"
        },
        "recurringCharge":{
            "description":"The recurring charge.",
            "type":"object",
            "properties":{
                "currency":{
                    "description":"Currency code for the recurring amount.",
                    "type":"string"
                },
                "value":{
                    "description":"Amount value for the recurring amount.",
                    "type":"number"
                }
            }
        },
        "status":{
            "description":"The status information.",
            "type":"object",
            "properties":{
                "displayValue":{
                    "description":"Translated display value of the fixed list of value for status.",
                    "type":"string"
                },
                "lookupCode":{
                    "description":"Language independent code of the fixed list of value for status.",
                    "type":"string"
                },
                "id":{
                    "description":"Id of the fixed list of value for status.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

The currency code.

Show Source

• currencyCode(optional): string
  Unique currency code for the currency.

{
    "description":"The currency code.",
    "type":"object",
    "properties":{
        "currencyCode":{
            "description":"Unique currency code for the currency.",
            "type":"string"
        }
    }
}

Nested Schema : discountAmount

Type: object

The discount amount.

Show Source

• currency(optional): string
  Currency code for the discount amount.
• value(optional): number
  Amount value for the discount amount.

{
    "description":"The discount amount.",
    "type":"object",
    "properties":{
        "currency":{
            "description":"Currency code for the discount amount.",
            "type":"string"
        },
        "value":{
            "description":"Amount value for the discount amount.",
            "type":"number"
        }
    }
}

Nested Schema : parentAsset

Type: object

Parent asset information.

Show Source

• assetId(optional): string
  Id of asset.
• serviceId(optional): string
  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.

{
    "description":"Parent asset information.",
    "type":"object",
    "properties":{
        "assetId":{
            "description":"Id of asset.",
            "type":"string"
        },
        "serviceId":{
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "type":"string"
        }
    }
}

Nested Schema : price

Type: object

The price.

Show Source

• currency(optional): string
  Currency code for the price.
• value(optional): number
  Amount value for the price.

{
    "description":"The price.",
    "type":"object",
    "properties":{
        "currency":{
            "description":"Currency code for the price.",
            "type":"string"
        },
        "value":{
            "description":"Amount value for the price.",
            "type":"number"
        }
    }
}

Nested Schema : recurringCharge

Type: object

The recurring charge.

Show Source

• currency(optional): string
  Currency code for the recurring amount.
• value(optional): number
  Amount value for the recurring amount.

{
    "description":"The recurring charge.",
    "type":"object",
    "properties":{
        "currency":{
            "description":"Currency code for the recurring amount.",
            "type":"string"
        },
        "value":{
            "description":"Amount value for the recurring amount.",
            "type":"number"
        }
    }
}

Nested Schema : rootAsset

Type: object

Root asset information.

Show Source

• assetId(optional): string
  Id of asset.
• serviceId(optional): string
  An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.

{
    "description":"Root asset information.",
    "type":"object",
    "properties":{
        "assetId":{
            "description":"Id of asset.",
            "type":"string"
        },
        "serviceId":{
            "description":"An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.",
            "type":"string"
        }
    }
}

Nested Schema : status

Type: object

The status information.

Show Source

• displayValue(optional): string
  Translated display value of the fixed list of value for status.
• id(optional): string
  Id of the fixed list of value for status.
• lookupCode(optional): string
  Language independent code of the fixed list of value for status.

{
    "description":"The status information.",
    "type":"object",
    "properties":{
        "displayValue":{
            "description":"Translated display value of the fixed list of value for status.",
            "type":"string"
        },
        "lookupCode":{
            "description":"Language independent code of the fixed list of value for status.",
            "type":"string"
        },
        "id":{
            "description":"Id of the fixed list of value for status.",
            "type":"string"
        }
    }
}

Nested Schema : usageNetAmount

Type: object

The usage information.

Show Source

• currency(optional): string
  Currency code for the usage net amount.
• value(optional): number
  Amount value for the usage net amount.

{
    "description":"The usage information.",
    "type":"object",
    "properties":{
        "currency":{
            "description":"Currency code for the usage net amount.",
            "type":"string"
        },
        "value":{
            "description":"Amount value for the usage net amount.",
            "type":"number"
        }
    }
}

Example Response (application/json)

{
    "rootDisplay":null,
    "deactivationDate":null,
    "rootAsset":{
        "assetId":null,
        "serviceId":null
    },
    "displayName":"Service 3",
    "discountAmount":{
        "currency":null,
        "value":null
    },
    "recurringChargeFrequency":null,
    "dateAdded":"2017-06-14T18:00:58.163Z",
    "assetId":"36489424",
    "price":{
        "currency":"USD",
        "value":30
    },
    "currency":{
        "currencyCode":"USD"
    },
    "usageNetAmount":{
        "currency":null,
        "value":null
    },
    "serviceId":"serv3",
    "skuId":"part3",
    "serviceAccountId":"vision",
    "quantity":1,
    "recurringChargeDuration":null,
    "discountPercent":null,
    "dateModified":"2017-06-14T18:00:58.163Z",
    "transactionDate":"2018-06-27T12:59:59Z",
    "usageUnitOfMeasure":null,
    "suspendDate":null,
    "parentDisplay":null,
    "attributes":null,
    "activationDate":null,
    "parentAsset":{
        "assetId":null,
        "serviceId":null
    },
    "resumeDate":null,
    "recurringCharge":{
        "currency":null,
        "value":null
    },
    "status":{
        "displayValue":null,
        "lookupCode":null,
        "id":null
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |551000|Could not get customers profile.| |551001|Customer has no service account.| |551002|Error retrieving customers service account.| |551003|Error retrieving account assets.| |551004|Error validating contact account ids in Order. |551005|Invalid account asset id. |551006|Account asset authorization error. |551007|Owner of the account asset could not be determined. |551008|Error submitting action request. |551009|Invalid transactionDate.

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