POST /api/apis/{APIID}/versions

Adds an additional API version to an existing API.

You can also add an API version by using the PUT /api/apis/versions/{APIVersionID} operation with a new API version object as part of the request, and including the applicable APIID. However, using POST /api/apis/{APIID}/versions is the recommended method.

Note: The initial API version is added as part of the POST apis operation when adding the API.

Authorization Roles/Permissions: Must have Modify permission for the resource. An API Admin or Business Admin.

Workflow: There is no default workflow for new API versions. However, a custom workflow might be in place. There is only one initial action valid for Akana API Platform workflows relating to API versions, the @Create initial action. For more information on workflow, see Executing Workflow Actions.

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/apis/{APIID}/versions

Back to top

Sample Request

The example below adds a version for the acmepaymentscorp API.

Request URL

https://{hostname}/api/apis/4e015aec-8224-4a43-a8d8-7ae969312307.acmepaymentscorp/versions

Sample request headers: application/json

Content-Type: application/json
Accept: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body: application/json

{ 
  "APIID":"7df17f3f-8ee2-4749-9719-52f5090c51da.acmepaymentscorp",
  "Name":"Version 2",
  "Description":"Major update.",
  "Type":"shttp",
  "DefaultProfile":"Any in and out",
  "Tag":[ 
    "payments",
    "ACME"
  ],
  "ProductionEndpoint":"http://acme-payments-api.10.1.20.137:9901/",
  "SandboxEndpoint":"http://acme-payments-api.10.1.20.137:9901/",
  "Operations":{ 
    "Operation":[ 
      { 
        "Method":"GET",
        "Path":"/payments/{paymentid}",
        "Input":[ 
          { 
            "Name":"paymentid",
            "Type":"path"
          }
        ],
        "InputContentType":"*/*",
        "OutputContentType":"*/*",
        "FaultContentType":"*/*",
        "Name":"getPayment"
      },
      { 
        "Method":"GET",
        "Path":"/payments/payments",
        "Input":[ 
         ],
        "InputContentType":"*/*",
        "OutputContentType":"*/*",
        "FaultContentType":"*/*",
        "Name":"listPayments"
      },
      { 
        "Method":"POST",
        "Path":"/payments",
        "Input":[ 
         ],
        "InputContentType":"*/*",
        "OutputContentType":"*/*",
        "FaultContentType":"*/*",
        "Name":"addPayment"
      },
      { 
        "Method":"DELETE",
        "Path":"/{path:.+|}",
        "Input":[ 
          { 
            "Name":"path",
            "Type":"path"
          }
        ],
        "InputContentType":"*/*",
        "OutputContentType":"*/*",
        "FaultContentType":"*/*",
        "Name":"deletePayment"
      }
    ]
  },
  "Endpoints":{ 
    "Endpoint":[ 
      { 
        "Uri":"http://acme-payments-api.10.1.20.137:9901/",
        "Category":"Production",
        "CName":"acme-payments-api.10.1.20.137",
        "DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
      },
      { 
        "Uri":"http://acme-payments-api.10.1.20.137:9901/",
        "Category":"Sandbox",
        "CName":"acme-payments-api.10.1.20.137",
        "DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
      }
    ]
  },
  "TargetAPI":{ 
    "Endpoints":{ 
      "Endpoint":[ 
        { 
          "Uri":"http://www.acmepayments.com/api",
          "Category":"Production"
        },
        { 
          "Uri":"http://www.acmepayments.com/apisb",
          "Category":"Sandbox"
        }
      ]
    },
    "Type":"shttp",
    "Operations":{ 
      "Operation":[ 
        { 
          "Method":"GET",
          "Path":"/payments/{paymentid}",
          "Input":[ 
            { 
              "Name":"paymentid",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"getPayment"
        },
        { 
          "Method":"GET",
          "Path":"/payments/payments",
          "Input":[ 
           ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"listPayments"
        },
        { 
          "Method":"POST",
          "Path":"/payments",
          "Input":[ 
           ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"addPayment"
        },
        { 
          "Method":"DELETE",
          "Path":"/payments/{paymentid}",
          "Input":[ 
            { 
              "Name":"paymentid",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"deletePayment"
        }
      ]
    },
    "Policies":{ 
      "Policy":[ 
       ]
    },
    "DefaultProfile":"Any in and out"
  },
  "Visibility":"Public",
  "State":"com.soa.api.state.open",
  "ProductionEndpointAccessAutoApproved":false,
  "SandboxEndpointAccessAutoApproved":true,
  "SandboxAnonymousAccessAllowed":false,
  "ProductionAnonymousAccessAllowed":false,
  "ResourceLevelPermissionsSupported":true,
  "Policies":{ 
    "Policy":[ 
     ]
  }
}

Sample request body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIVersion xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/resource/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns5="http://soa.com/xsd/legals/1.0">
  <APIID>7df17f3f-8ee2-4749-9719-52f5090c51da.acmepaymentscorp</APIID>
  <Name>Version 3</Name>
  <Description>Major update again!</Description>
  <Type>shttp</Type>
  <DefaultProfile>Any in and out</DefaultProfile>
  <Tag>payments</Tag>
  <Tag>ACME</Tag>
  <ProductionEndpoint>http://acme-payments-api.10.1.20.137:9901/</ProductionEndpoint>
  <SandboxEndpoint>http://acme-payments-api.10.1.20.137:9901/</SandboxEndpoint>
  <Operations>
    <Operation>
      <Name>getPayment</Name>
      <Method>GET</Method>
      <Path>/payments/{paymentid}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>paymentid</Name>
        <Type>path</Type>
      </Input>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>getPayment</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>listPayments</Name>
      <Method>GET</Method>
      <Path>/payments/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>listPayments</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>addPayment</Name>
      <Method>POST</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>addPayment</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>deletePayment</Name>
      <Method>DELETE</Method>
      <Path>/{path:.+|}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>path</Name>
        <Type>path</Type>
      </Input>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>deletePayment</WsdlOperationName>
    </Operation>
  </Operations>
  <Endpoints>
    <Endpoint>
      <Category>Production</Category>
      <Uri>http://acme-payments-api.10.1.20.137:9901/</Uri>
      <CName>acme-payments-api.10.1.20.137</CName>
      <DeploymentZoneRule>1b16623b-1609-4664-9900-06f8441bdefault-http0</DeploymentZoneRule>
    </Endpoint>
    <Endpoint>
      <Category>Sandbox</Category>
      <Uri>http://acme-payments-api.10.1.20.137:9901/</Uri>
      <CName>acme-payments-api.10.1.20.137</CName>
      <DeploymentZoneRule>1b16623b-1609-4664-9900-06f8441bdefault-http0</DeploymentZoneRule>
    </Endpoint>
  </Endpoints>
  <Policies />
  <TargetAPI>
    <Type>shttp</Type>
    <DefaultProfile>Any in and out</DefaultProfile>
    <Endpoints>
      <Endpoint>
        <Category>Production</Category>
        <Uri>http://www.acmepayments.com/api</Uri>
      </Endpoint>
      <Endpoint>
        <Category>Sandbox</Category>
        <Uri>http://www.acmepayments.com/apisc</Uri>
      </Endpoint>
    </Endpoints>
    <Operations>
      <Operation>
        <Name>getPayment</Name>
        <Method>GET</Method>
        <Path>/payments/{paymentid}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>paymentid</Name>
          <Type>path</Type>
        </Input>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>getPayment</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>listPayments</Name>
        <Method>GET</Method>
        <Path>/payments/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>listPayments</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>addPayment</Name>
        <Method>POST</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>addPayment</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>deletePayment</Name>
        <Method>DELETE</Method>
        <Path>/payments/{paymentid}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>paymentid</Name>
          <Type>path</Type>
        </Input>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>deletePayment</WsdlOperationName>
      </Operation>
    </Operations>
    <Policies />
  </TargetAPI>
  <Visibility>Public</Visibility>
  <State>com.soa.api.state.open</State>
  <ProductionEndpointAccessAutoApproved>false</ProductionEndpointAccessAutoApproved>
  <SandboxEndpointAccessAutoApproved>true</SandboxEndpointAccessAutoApproved>
  <SandboxAnonymousAccessAllowed>false</SandboxAnonymousAccessAllowed>
  <ProductionAnonymousAccessAllowed>false</ProductionAnonymousAccessAllowed>
  <ResourceLevelPermissionsSupported>true</ResourceLevelPermissionsSupported>
</APIVersion>

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIID Path string Required The unique ID for a specific API.
apiVersion Body APIVersion Required Includes information about an API version.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the complete API version object including APIVersionID.

Back to top

Sample Response

The sample response below shows that the API version in the request example was added. The API version information is returned along with the APIVersionID.

Sample response headers

Status Code: 200 OK
Atmo-Renew-Token: renew
Content-Type: application/json
Date: Thu, 12 Feb 2015 20:29:19 GMT

Sample response body: application/json

{
  "APIVersionID" : "53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp",
  "APIID" : "7df17f3f-8ee2-4749-9719-52f5090c51da.acmepaymentscorp",
  "Name" : "Version 2",
  "Description" : "Major update.",
  "Type" : "shttp",
  "DefaultProfile" : "Any in and out",
  "Tag" : [ "payments", "ACME" ],
  "ProductionEndpoint" : "http://acme-payments-api.10.1.20.137:9901/",
  "SandboxEndpoint" : "http://acme-payments-api.10.1.20.137:9901/",
  "Operations" : {
    "Operation" : [ {
      "Name" : "getPayment",
      "Method" : "GET",
      "Path" : "/payments/{paymentid}",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ {
        "Name" : "paymentid",
        "Type" : "path"
      } ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
      "WsdlOperationName" : "getPayment"
    }, {
      "Name" : "listPayments",
      "Method" : "GET",
      "Path" : "/payments/payments",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
      "WsdlOperationName" : "listPayments"
    }, {
      "Name" : "addPayment",
      "Method" : "POST",
      "Path" : "/payments",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
      "WsdlOperationName" : "addPayment"
    }, {
      "Name" : "deletePayment",
      "Method" : "DELETE",
      "Path" : "/{path:.+|}",
      "InputContentType" : "*/*",
      "OutputContentType" : "*/*",
      "FaultContentType" : "*/*",
      "Input" : [ {
        "Name" : "path",
        "Type" : "path"
      } ],
      "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
      "WsdlOperationName" : "deletePayment"
    } ]
  },
  "Endpoints" : {
    "Endpoint" : [ {
      "CName" : "acme-payments-api.10.1.20.137",
      "Category" : "Production",
      "Uri" : "http://acme-payments-api.10.1.20.137:9901/",
      "DeploymentZoneRule" : "1b16623b-1609-4664-9900-06f8441bdefault-http0",
      "ConnectionProperties" : [ ]
    }, {
      "CName" : "acme-payments-api.10.1.20.137",
      "Category" : "Sandbox",
      "Uri" : "http://acme-payments-api.10.1.20.137:9901/",
      "DeploymentZoneRule" : "1b16623b-1609-4664-9900-06f8441bdefault-http0",
      "ConnectionProperties" : [ ]
    } ]
  },
  "Policies" : {
    "Policy" : [ ]
  },
  "TargetAPI" : {
    "Type" : "shttp",
    "DefaultProfile" : "Any in and out",
    "Endpoints" : {
      "Endpoint" : [ {
        "Category" : "Production",
        "Uri" : "http://www.acmepayments.com/api",
        "ConnectionProperties" : [ ]
      }, {
        "Category" : "Sandbox",
        "Uri" : "http://www.acmepayments.com/apisc",
        "ConnectionProperties" : [ ]
      } ]
    },
    "Operations" : {
      "Operation" : [ {
        "Name" : "getPayment",
        "Method" : "GET",
        "Path" : "/payments/{paymentid}",
        "InputContentType" : "*/*",
        "OutputContentType" : "*/*",
        "FaultContentType" : "*/*",
        "Input" : [ {
          "Name" : "paymentid",
          "Type" : "path"
        } ],
        "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
        "WsdlOperationName" : "getPayment"
      }, {
        "Name" : "listPayments",
        "Method" : "GET",
        "Path" : "/payments/payments",
        "InputContentType" : "*/*",
        "OutputContentType" : "*/*",
        "FaultContentType" : "*/*",
        "Input" : [ ],
        "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
        "WsdlOperationName" : "listPayments"
      }, {
        "Name" : "addPayment",
        "Method" : "POST",
        "Path" : "/payments",
        "InputContentType" : "*/*",
        "OutputContentType" : "*/*",
        "FaultContentType" : "*/*",
        "Input" : [ ],
        "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
        "WsdlOperationName" : "addPayment"
      }, {
        "Name" : "deletePayment",
        "Method" : "DELETE",
        "Path" : "/payments/{paymentid}",
        "InputContentType" : "*/*",
        "OutputContentType" : "*/*",
        "FaultContentType" : "*/*",
        "Input" : [ {
          "Name" : "paymentid",
          "Type" : "path"
        } ],
        "InterfaceQName" : "{uri:acmepaymentscorp}PortType_svc_53c1ef5a-3043-449f-be6f-8c2dd9da2393.acmepaymentscorp.sandbox",
        "WsdlOperationName" : "deletePayment"
      } ]
    },
    "Policies" : {
      "Policy" : [ ]
    }
  },
  "Visibility" : "Public",
  "State" : "com.soa.api.state.open",
  "ProductionEndpointAccessAutoApproved" : false,
  "SandboxEndpointAccessAutoApproved" : true,
  "SandboxAnonymousAccessAllowed" : false,
  "ProductionAnonymousAccessAllowed" : false,
  "ResourceLevelPermissionsSupported" : true
}

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIVersion xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/resource/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns5="http://soa.com/xsd/legals/1.0">
  <APIVersionID>0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp</APIVersionID>
  <APIID>7df17f3f-8ee2-4749-9719-52f5090c51da.acmepaymentscorp</APIID>
  <Name>Version 3</Name>
  <Description>Major update again!</Description>
  <Type>shttp</Type>
  <DefaultProfile>Any in and out</DefaultProfile>
  <Tag>payments</Tag>
  <Tag>ACME</Tag>
  <ProductionEndpoint>http://acme-payments-api.10.1.20.137:9901/</ProductionEndpoint>
  <SandboxEndpoint>http://acme-payments-api.10.1.20.137:9901/</SandboxEndpoint>
  <Operations>
    <Operation>
      <Name>getPayment</Name>
      <Method>GET</Method>
      <Path>/payments/{paymentid}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>paymentid</Name>
        <Type>path</Type>
      </Input>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>getPayment</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>listPayments</Name>
      <Method>GET</Method>
      <Path>/payments/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>listPayments</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>addPayment</Name>
      <Method>POST</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>addPayment</WsdlOperationName>
    </Operation>
    <Operation>
      <Name>deletePayment</Name>
      <Method>DELETE</Method>
      <Path>/{path:.+|}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>path</Name>
        <Type>path</Type>
      </Input>
      <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
      <WsdlOperationName>deletePayment</WsdlOperationName>
    </Operation>
  </Operations>
  <Endpoints>
    <Endpoint>
      <Category>Production</Category>
      <Uri>http://acme-payments-api.10.1.20.137:9901/</Uri>
      <CName>acme-payments-api.10.1.20.137</CName>
      <DeploymentZoneRule>1b16623b-1609-4664-9900-06f8441bdefault-http0</DeploymentZoneRule>
    </Endpoint>
    <Endpoint>
      <Category>Sandbox</Category>
      <Uri>http://acme-payments-api.10.1.20.137:9901/</Uri>
      <CName>acme-payments-api.10.1.20.137</CName>
      <DeploymentZoneRule>1b16623b-1609-4664-9900-06f8441bdefault-http0</DeploymentZoneRule>
    </Endpoint>
  </Endpoints>
  <Policies />
  <TargetAPI>
    <Type>shttp</Type>
    <DefaultProfile>Any in and out</DefaultProfile>
    <Endpoints>
      <Endpoint>
        <Category>Production</Category>
        <Uri>http://www.acmepayments.com/api</Uri>
      </Endpoint>
      <Endpoint>
        <Category>Sandbox</Category>
        <Uri>http://www.acmepayments.com/apisc</Uri>
      </Endpoint>
    </Endpoints>
    <Operations>
      <Operation>
        <Name>getPayment</Name>
        <Method>GET</Method>
        <Path>/payments/{paymentid}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>paymentid</Name>
          <Type>path</Type>
        </Input>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>getPayment</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>listPayments</Name>
        <Method>GET</Method>
        <Path>/payments/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>listPayments</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>addPayment</Name>
        <Method>POST</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>addPayment</WsdlOperationName>
      </Operation>
      <Operation>
        <Name>deletePayment</Name>
        <Method>DELETE</Method>
        <Path>/payments/{paymentid}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>paymentid</Name>
          <Type>path</Type>
        </Input>
        <InterfaceQName>{uri:acmepaymentscorp}PortType_svc_0737e4d5-6c66-4ea7-8934-c5bfb65572e3.acmepaymentscorp.sandbox</InterfaceQName>
        <WsdlOperationName>deletePayment</WsdlOperationName>
      </Operation>
    </Operations>
    <Policies />
  </TargetAPI>
  <Visibility>Public</Visibility>
  <State>com.soa.api.state.open</State>
  <ProductionEndpointAccessAutoApproved>false</ProductionEndpointAccessAutoApproved>
  <SandboxEndpointAccessAutoApproved>true</SandboxEndpointAccessAutoApproved>
  <SandboxAnonymousAccessAllowed>false</SandboxAnonymousAccessAllowed>
  <ProductionAnonymousAccessAllowed>false</ProductionAnonymousAccessAllowed>
  <ResourceLevelPermissionsSupported>true</ResourceLevelPermissionsSupported>
</APIVersion>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

Atmo-Renew-Token renew

Back to top

Response Body

Name Type Description
ApiVersion ApiVersion Includes information about an API version. The response includes the unique APIVersionID assigned to the API version that was added.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you send malformed XML in your request, or if there is a typo in the URL.
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
404 The resource could not be found. For example, you might get this if you include an invalid APIID in the request.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics