Test Microsoft Pricing APIs-C3 connectivity

Get a list of active plans in C3 instance

URL

GET https://contoso-prod-api.azurewebsites.net/api/PartnerConsent/testMicrosoftPricingAPIConnectivity

Request headers

Key	Value
Authorization	Bearer <access_token>
Content-Type	Application/json

Request body

The request doesn’t require any parameters / body

Response body

An example response for the request to get active customers is as follows:

{
    "OperationType": null,
    "Status": "Success",
    "RequestCorrelationID": "d921dcf2-6f14-4589-a9b7-10c681e239ba",
    "ErrorMessage": null,
    "ErrorDetail": null,
    "Data": {
        "Response": "Success",
        "ResponseHeaders": null
    }
}

Here is the explanation for the properties in the response (JSON)

Property

Description

OperationType

Can be ignored

Status

Indicates the status of the request. Possible values – Success / Error

RequestCorrelationID

Internal ID generated by C3 for correspondence for troubleshooting issues, if any.

ErrorMessage

Message in case the request runs into an error during processing

ErrorDetail

Additional detail related to the error in case there is an error while processing the request

Data

Output type and explanation

Output

Meaning

Response is "Success"

    "Data": {
        "Response": "Success",
        "ResponseHeaders": null
    }

Connectivity is up & running

No Data

{
    "OperationType": null,
    "Status": "Error",
    "RequestCorrelationID": "b8a89841-229a-4d79-8830-a99e7ac6543e",
    "ErrorMessage": "{\"ErrorValue\":\"ERROR_DESC_MS_PRICING_API_FAILED_TO_GET_ACCESS\",\"ErrorNotifyType\":\"TranslateKey\"}",
    "ErrorDetail": "{\"ErrorValue\":\"ERROR_DESC_MS_PRICING_API_FAILED_TO_GET_ACCESS\",\"ErrorNotifyType\":\"TranslateKey\"}",
    "Data": []
}

Connectivity is broken