ErrorSets

Resource URI

/services/{serviceId}/errorSets

Items in curly braces represent variables.

Description

Error Sets are a collection, of which there must be at least one, of different Error Messages that are to be used by various Endpoints. Error Sets enable the specification of custom error messages. The Error Sets themselves are applied at the Endpoint level.

Resource Schema

fetch [GET]

Retrieves collection of ErrorSets in the identified Service Definition, returning an Array of ErrorSets

Parameters

Returns

Success

Array of ErrorSets for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "jsonp": true,
        "name": "dolor vel est donec",
        "type": "eget congue eget semper",
        "jsonpType": "in magna"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "jsonp": true,
        "name": "magna",
        "type": "augue luctus",
        "jsonpType": "convallis"
    }
]

fetch all [GET]

Retrieves the identified ErrorSet, returning a Service Definition ErrorSet

Parameters

Returns

Success

ErrorSet for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "jsonp": true,
        "name": "primis in faucibus",
        "type": "curabitur at ipsum ac",
        "jsonpType": "et eros vestibulum"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "jsonp": false,
        "name": "quis lectus",
        "type": "non mattis pulvinar nulla",
        "jsonpType": "aliquam sit amet"
    }
]

update [PUT]

Updates the identified ErrorSet.

Parameters

Returns

Success

ErrorSet as persisted If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"jsonp":false,"name":"neque libero","type":"accumsan tellus nisi","jsonpType":"tortor risus dapibus"}

Response

[
    {
        "jsonp": false,
        "name": "erat tortor sollicitudin",
        "type": "at",
        "jsonpType": "pede posuere nonummy integer"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"jsonp":true,"name":"libero ut massa","type":"ultrices posuere cubilia","jsonpType":"eleifend donec ut dolor"}

Response

[
    {
        "jsonp": true,
        "name": "nulla sed",
        "type": "viverra",
        "jsonpType": "cursus vestibulum proin"
    }
]

create [POST]

Creates a new ErrorSet in the given Service Definition.

Parameters

Returns

Success

ErrorSet as created If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"jsonp":true,"name":"suspendisse","type":"est","jsonpType":"porttitor lacus"}

Response

[
    {
        "jsonp": false,
        "name": "praesent blandit",
        "type": "pede ac diam cras",
        "jsonpType": "iaculis"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"jsonp":true,"name":"proin","type":"ultrices posuere","jsonpType":"quam turpis adipiscing lorem"}

Response

[
    {
        "jsonp": false,
        "name": "quam sollicitudin vitae consectetuer",
        "type": "natoque",
        "jsonpType": "tempus sit"
    }
]

delete [DELETE]

Deletes the identified ErrorSet.

Parameters

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/errorSets/{errorSetId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]