PUT /api/apis/versions/{APIVersionID}

Updates information relating to an API version.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

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

Back to top

Sample Request

The example below adds a third tag to the API version.

Request URL

https://{hostname}/api/apis/versions/apiversion10022.acmepaymentscorp

Sample request headers

Content-Type: application/json
Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body: application/json

{
    "APIVersionID":"0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp",
    "APIID":"bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp",
    "Name":"1.1",
    "Description":"ADDITIONAL Update with enhancements and bug fixes.",
    "Type":"shttp",
    "DefaultProfile":"Any in and out",
    "Tag":[
      "payments"
    ],
    "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",
          "Input":[

          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"listPayments"
        },
        {
          "Method":"GET",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"getPayment"
        },
        {
          "Method":"POST",
          "Path":"/payments",
          "Input":[

          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"addPayment"
        },
        {
          "Method":"PUT",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"modifyPayment"
        },
        {
          "Method":"DELETE",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "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"
        }
      ]
    },
    "Policies":{
      "Policy":[
        {
          "PolicyKey":"10001-AtmosphereApplicationSecurityPolicy",
          "PolicyType":"Operational Policy"
        },
        {
          "PolicyKey":"10001-DetailedAuditing",
          "PolicyType":"Operational Policy"
        }
      ]
    },
    "TargetAPI":{
      "Endpoints":{
        "Endpoint":[
          {
            "Uri":"http://acmepaymentscorp.com/payment",
            "Category":"Production"
          },
          {
            "Uri":"http://acmepaymentscorp.com/s/payment",
            "Category":"Sandbox"
          }
        ]
      },
      "Type":"shttp",
      "Operations":{
        "Operation":[
          {
            "Method":"GET",
            "Path":"/payments",
            "Input":[

            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"listPayments"
          },
          {
            "Method":"GET",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"getPayment"
          },
          {
            "Method":"POST",
            "Path":"/payments",
            "Input":[

            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"addPayment"
          },
          {
            "Method":"PUT",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"modifyPayment"
          },
          {
            "Method":"DELETE",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"deletePayment"
          }
        ]
      },
      "Policies":{
        "Policy":[

        ]
      },
      "DefaultProfile":"Any in and out"
    },
    "Visibility":"Limited",
    "State":"com.soa.api.state.open",
    "ProductionEndpointAccessAutoApproved":true,
    "SandboxEndpointAccessAutoApproved":true,
    "SandboxAnonymousAccessAllowed":false,
    "ProductionAnonymousAccessAllowed":false,
    "ResourceLevelPermissionsSupported":true
  }

Sample request body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<APIVersion xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/legals/1.0" xmlns:ns4="http://soa.com/xsd/resource/1.0">
  <APIVersionID>0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp</APIVersionID>
  <APIID>bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp</APIID>
  <Name>1.1</Name>
  <Description>ADDITIONAL Update with enhancements and bug fixes.</Description>
  <Type>shttp</Type>
  <DefaultProfile>Any in and out</DefaultProfile>
  <Tag>payments</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>listPayments</Name>
      <Method>GET</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
    </Operation>
    <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>
    </Operation>
    <Operation>
      <Name>addPayment</Name>
      <Method>POST</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
    </Operation>
    <Operation>
      <Name>modifyPayment</Name>
      <Method>PUT</Method>
      <Path>/payments/{PaymentID}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>PaymentID</Name>
        <Type>path</Type>
      </Input>
    </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>
    </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>
    <Policy>
      <PolicyKey>10001-AtmosphereApplicationSecurityPolicy</PolicyKey>
      <PolicyType>Operational Policy</PolicyType>
    </Policy>
    <Policy>
      <PolicyKey>10001-DetailedAuditing</PolicyKey>
      <PolicyType>Operational Policy</PolicyType>
    </Policy>
  </Policies>
  <TargetAPI>
    <Type>shttp</Type>
    <DefaultProfile>Any in and out</DefaultProfile>
    <Endpoints>
      <Endpoint>
        <Category>Production</Category>
        <Uri>http://acmepaymentscorp.com/payment</Uri>
      </Endpoint>
      <Endpoint>
        <Category>Sandbox</Category>
        <Uri>http://acmepaymentscorp.com/s/payment</Uri>
      </Endpoint>
    </Endpoints>
    <Operations>
      <Operation>
        <Name>listPayments</Name>
        <Method>GET</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
      </Operation>
      <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>
      </Operation>
      <Operation>
        <Name>addPayment</Name>
        <Method>POST</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
      </Operation>
      <Operation>
        <Name>modifyPayment</Name>
        <Method>PUT</Method>
        <Path>/payments/{PaymentID}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>PaymentID</Name>
          <Type>path</Type>
        </Input>
      </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>
      </Operation>
    </Operations>
    <Policies />
  </TargetAPI>
  <Visibility>Limited</Visibility>
  <State>com.soa.api.state.open</State>
  <ProductionEndpointAccessAutoApproved>true</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. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path String Required The unique ID for a specific API version.
APIVersion Body APIVersion Required Includes information about an API version. The entire version, including the changed data.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows that the API version was successfully updated.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 22 Apr 2014 17:03:56 GMT

Sample response body: application/json

{
    "APIVersionID":"0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp",
    "APIID":"bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp",
    "Name":"1.1",
    "Description":"ADDITIONAL Update with enhancements and bug fixes.",
    "Type":"shttp",
    "DefaultProfile":"Any in and out",
    "Tag":[
      "payments"
    ],
    "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",
          "Input":[

          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"listPayments"
        },
        {
          "Method":"GET",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"getPayment"
        },
        {
          "Method":"POST",
          "Path":"/payments",
          "Input":[

          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"addPayment"
        },
        {
          "Method":"PUT",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "Type":"path"
            }
          ],
          "InputContentType":"*/*",
          "OutputContentType":"*/*",
          "FaultContentType":"*/*",
          "Name":"modifyPayment"
        },
        {
          "Method":"DELETE",
          "Path":"/payments/{PaymentID}",
          "Input":[
            {
              "Name":"PaymentID",
              "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"
        }
      ]
    },
    "Policies":{
      "Policy":[
        {
          "PolicyKey":"10001-AtmosphereApplicationSecurityPolicy",
          "PolicyType":"Operational Policy"
        },
        {
          "PolicyKey":"10001-DetailedAuditing",
          "PolicyType":"Operational Policy"
        }
      ]
    },
    "TargetAPI":{
      "Endpoints":{
        "Endpoint":[
          {
            "Uri":"http://acmepaymentscorp.com/payment",
            "Category":"Production"
          },
          {
            "Uri":"http://acmepaymentscorp.com/s/payment",
            "Category":"Sandbox"
          }
        ]
      },
      "Type":"shttp",
      "Operations":{
        "Operation":[
          {
            "Method":"GET",
            "Path":"/payments",
            "Input":[

            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"listPayments"
          },
          {
            "Method":"GET",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"getPayment"
          },
          {
            "Method":"POST",
            "Path":"/payments",
            "Input":[

            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"addPayment"
          },
          {
            "Method":"PUT",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"modifyPayment"
          },
          {
            "Method":"DELETE",
            "Path":"/payments/{PaymentID}",
            "Input":[
              {
                "Name":"PaymentID",
                "Type":"path"
              }
            ],
            "InputContentType":"*/*",
            "OutputContentType":"*/*",
            "FaultContentType":"*/*",
            "Name":"deletePayment"
          }
        ]
      },
      "Policies":{
        "Policy":[

        ]
      },
      "DefaultProfile":"Any in and out"
    },
    "Visibility":"Limited",
    "State":"com.soa.api.state.open",
    "ProductionEndpointAccessAutoApproved":true,
    "SandboxEndpointAccessAutoApproved":true,
    "SandboxAnonymousAccessAllowed":false,
    "ProductionAnonymousAccessAllowed":false,
    "ResourceLevelPermissionsSupported":true
  }

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<APIVersion xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/legals/1.0" xmlns:ns4="http://soa.com/xsd/resource/1.0">
  <APIVersionID>0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp</APIVersionID>
  <APIID>bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp</APIID>
  <Name>1.1</Name>
  <Description>ADDITIONAL Update with enhancements and bug fixes.</Description>
  <Type>shttp</Type>
  <DefaultProfile>Any in and out</DefaultProfile>
  <Tag>payments</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>listPayments</Name>
      <Method>GET</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
    </Operation>
    <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>
    </Operation>
    <Operation>
      <Name>addPayment</Name>
      <Method>POST</Method>
      <Path>/payments</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
    </Operation>
    <Operation>
      <Name>modifyPayment</Name>
      <Method>PUT</Method>
      <Path>/payments/{PaymentID}</Path>
      <InputContentType>*/*</InputContentType>
      <OutputContentType>*/*</OutputContentType>
      <FaultContentType>*/*</FaultContentType>
      <Input>
        <Name>PaymentID</Name>
        <Type>path</Type>
      </Input>
    </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>
    </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>
    <Policy>
      <PolicyKey>10001-AtmosphereApplicationSecurityPolicy</PolicyKey>
      <PolicyType>Operational Policy</PolicyType>
    </Policy>
    <Policy>
      <PolicyKey>10001-DetailedAuditing</PolicyKey>
      <PolicyType>Operational Policy</PolicyType>
    </Policy>
  </Policies>
  <TargetAPI>
    <Type>shttp</Type>
    <DefaultProfile>Any in and out</DefaultProfile>
    <Endpoints>
      <Endpoint>
        <Category>Production</Category>
        <Uri>http://acmepaymentscorp.com/payment</Uri>
      </Endpoint>
      <Endpoint>
        <Category>Sandbox</Category>
        <Uri>http://acmepaymentscorp.com/s/payment</Uri>
      </Endpoint>
    </Endpoints>
    <Operations>
      <Operation>
        <Name>listPayments</Name>
        <Method>GET</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
      </Operation>
      <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>
      </Operation>
      <Operation>
        <Name>addPayment</Name>
        <Method>POST</Method>
        <Path>/payments</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
      </Operation>
      <Operation>
        <Name>modifyPayment</Name>
        <Method>PUT</Method>
        <Path>/payments/{PaymentID}</Path>
        <InputContentType>*/*</InputContentType>
        <OutputContentType>*/*</OutputContentType>
        <FaultContentType>*/*</FaultContentType>
        <Input>
          <Name>PaymentID</Name>
          <Type>path</Type>
        </Input>
      </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>
      </Operation>
    </Operations>
    <Policies />
  </TargetAPI>
  <Visibility>Limited</Visibility>
  <State>com.soa.api.state.open</State>
  <ProductionEndpointAccessAutoApproved>true</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

Back to top

Response Body

Name Type Description
APIVersion APIVersion Includes information about an API version. The entire version, including the changed data, is returned.

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
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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics