Retrieve a Reseller Microsoft Partner Agreement Signature Status

GET /v1/Resellers/microsoft-partner-agreement-signature-status

Gets the microsoft partner agreement status for a microsoft indirect reseller by its mpn id. This request is only valid when using a Microsoft tenant/provider. Available to the roles: csp

Headers

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

  • tenantId string Required

    The Microsoft tenant identifier to use in request to Microsoft.

  • mpnId string Required

    The mpn id of the reseller.

Responses

  • OK

    Hide response attributes Show response attributes object
    • errorCode string | null

      The code of the error response from the Partner Center API when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • errorMessage string | null

      The error message from the Partner Center API that occured when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • isAgreementSigned boolean | null

      The property that indicates if the reseller has signed the Microsoft Partner Agreement in the same region of the CSP or not. When an error happens, this property is ommited in the response of the API.

    Hide response attributes Show response attributes object
    • errorCode string | null

      The code of the error response from the Partner Center API when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • errorMessage string | null

      The error message from the Partner Center API that occured when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • isAgreementSigned boolean | null

      The property that indicates if the reseller has signed the Microsoft Partner Agreement in the same region of the CSP or not. When an error happens, this property is ommited in the response of the API.

    Hide response attributes Show response attributes object
    • errorCode string | null

      The code of the error response from the Partner Center API when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • errorMessage string | null

      The error message from the Partner Center API that occured when verifying if a reseller has the Microsoft Partner Agreement signed in the same region of the CSP.

    • isAgreementSigned boolean | null

      The property that indicates if the reseller has signed the Microsoft Partner Agreement in the same region of the CSP or not. When an error happens, this property is ommited in the response of the API.

  • Bad Request

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

  • Unauthorized

  • Forbidden

  • Internal Server Error

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.

GET /v1/Resellers/microsoft-partner-agreement-signature-status
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Resellers/microsoft-partner-agreement-signature-status?tenantId=string&mpnId=string \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
{
  "errorCode": "string",
  "errorMessage": "string",
  "isAgreementSigned": true
}
Response examples (200)
{
  "errorCode": "string",
  "errorMessage": "string",
  "isAgreementSigned": true
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}