Axway · Example Payload

Axway Provider Consumercreate Example

API ManagementEnterpriseIntegrationSecurity

Axway Provider Consumercreate Example is an example object payload from Axway, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "provider_consumerCreate",
  "method": "POST",
  "path": "/provider/{provider_id}/consumer",
  "summary": "Axway Create Consumer Organization",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ProviderConsumercreate200Example",
      "example": "example_value"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "EXISTING_ORG_NAME",
      "example": {
        "success": false,
        "description": "Organization names must be unique. Please enter a different organization name.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "FORBIDDEN",
      "example": {
        "$ref": "#/components/examples/FORBIDDEN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "INVALID_EMAIL_DOMAIN",
      "example": {
        "success": false,
        "description": "Sign-up is not allowed for this email domain.",
        "code": 400,
        "internalCode": 14
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "NEW_USER_SIGNUP",
      "example": {
        "success": false,
        "description": "You must be a new user to sign up.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PROVIDER_CONSUMER_DISABLED",
      "example": {
        "success": false,
        "description": "Consumer organization access is disabled.",
        "code": 400,
        "internalCode": 431
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "NOT_FOUND",
      "example": {
        "$ref": "#/components/examples/NOT_FOUND/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "USER_NOT_ADMIN",
      "example": {
        "$ref": "#/components/examples/USER_NOT_ADMIN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "LOGIN_REQUIRED",
      "example": {
        "$ref": "#/components/examples/LOGIN_REQUIRED/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PARAM_INVALID",
      "example": {
        "$ref": "#/components/examples/PARAM_INVALID/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PARAM_REQUIRED",
      "example": {
        "$ref": "#/components/examples/PARAM_REQUIRED/value"
      }
    }
  ]
}