GET /api/apps/versions/{AppVersionID}/contracts

Returns information about API contracts for the specified app version, as an RSS feed.

Note: GET /api/apps/versions/{AppVersionID}/contracts (list contracts, with custom Accept header) returns the same information as a JSON object. We recommend using that operation rather than this one.

Authorization Roles/Permissions: Must have read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/contracts[?][Environment=environment]
[&][ActivatedOnly=Boolean][&][IncludeActions=Boolean][&][IncludeAPIEndpoints=Boolean]

Back to top

Sample Request

The example below is a request for contract info for the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/9ezRSOnifci8EYNndZu79U6w.acmepaymentscorp/contracts

Sample request headers

GET /api/apps/versions/9ezRSOnifci8EYNndZu79U6w.acmepaymentscorp/contracts HTTP/1.1
Host:api.acmepaymentscorp.com
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept text/xml or application/json
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
AppVersionID Path string Required The unique ID for a specific app version.
Environment Query string Optional The environment (implementation) (Sandbox or Production). If not specified, results are returned for all environments.
ActivatedOnly Query boolean Optional Indicates whether only activated contracts should be returned in the response. If not specified, defaults to false.
IncludeActions Query boolean Optional Indicates whether workflow actions currently valid for the resource should be included in the results. Default: true. For valid workflow actions, see Workflow Actions.
IncludeAPIEndpoints Query boolean Optional Indicates whether API endpoints currently valid for the resource should be included in the results. Default: true.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the app versions in an RSS channel.

Back to top

Sample Response

The sample response below shows the contract versions for the specified app.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Thu, 16 Oct 2014 11:32:16 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "Application Contracts",
    "item" : [ {
      "title" : "6ffa9ff3-e53a-4b32-9ad9-83e08728af2c.acmepaymentscorp",
      "category" : [ {
        "value" : "Sandbox",
        "domain" : "uddi:soa.com:environment"
      }, {
        "value" : "apicontract.status.activated",
        "domain" : "uddi:soa.com:wfstate"
      }, {
        "value" : "com.soa.apicontract.inforce",
        "domain" : "uddi:soa.com:status"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:restrictedscope"
      } ],
      "guid" : {
        "value" : "6ffa9ff3-e53a-4b32-9ad9-83e08728af2c.acmepaymentscorp"
      },
      "Endpoints" : {
        "Endpoint" : [ {
          "CName" : "acme-payments-api.10.1.20.137",
          "Category" : "Production",
          "Uri" : "http://10.1.20.137:9901/",
          "ConnectionProperties" : [ ],
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.production.virtual",
          "BindingType" : "binding.http",
          "EndpointKey" : "uddi:937b32ee-5540-11e4-9358-dbbe78cfdf00"
        }, {
          "CName" : "acme-payments-api.10.1.20.137",
          "Category" : "Sandbox",
          "Uri" : "http://10.1.20.137:9901/",
          "ConnectionProperties" : [ ],
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.sandbox.virtual",
          "BindingType" : "binding.http",
          "EndpointKey" : "uddi:944783df-5540-11e4-9358-dbbe78cfdf00"
        } ]
      },
      "Image" : [ {
        "Url" : "http://acmepaymentscorp.local/api/apis/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/avatar",
        "Title" : "api",
        "Link" : "#/api/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/versions/000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp/details"
      }, {
        "Url" : "http://acmepaymentscorp.local/api/apps/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/avatar",
        "Title" : "app",
        "Link" : "#/app/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/versions/6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp/details"
      } ],
      "Actions" : {
        "Action" : [ {
          "value" : "apicontract.action.suspend",
          "label" : "apicontract.action.suspend"
        }, {
          "value" : "apicontract.action.cancel",
          "label" : "apicontract.action.cancel"
        } ]
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "1.0",
          "Guid" : "000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp",
          "Category" : [ {
            "value" : "apiversion",
            "domain" : "uddi:soa.com:resourcetype"
          }, {
            "value" : "Limited",
            "domain" : "uddi:soa.com:visibility"
          }, {
            "value" : "uddi:soa.com:api:resource-level-permissions-supported",
            "domain" : "uddi:soa.com:api:resource-level-permissions"
          } ]
        }, {
          "Title" : "ACME Payments API",
          "Guid" : "f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp",
          "Category" : [ {
            "value" : "api",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Title" : "1.0",
          "Guid" : "6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp",
          "Category" : [ {
            "value" : "app-version",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Title" : "crosfhocal",
          "Guid" : "8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp",
          "Category" : [ {
            "value" : "app",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Guid" : "contract_request10557.acmepaymentscorp",
          "Category" : [ {
            "value" : "board-item",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    }, {
      "title" : "e9a9f10f-ee3c-4caa-84d7-826dd504456f.acmepaymentscorp",
      "category" : [ {
        "value" : "Production",
        "domain" : "uddi:soa.com:environment"
      }, {
        "value" : "apicontract.status.pending_approval",
        "domain" : "uddi:soa.com:wfstate"
      }, {
        "value" : "com.soa.apicontract.draft",
        "domain" : "uddi:soa.com:status"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:restrictedscope"
      } ],
      "guid" : {
        "value" : "e9a9f10f-ee3c-4caa-84d7-826dd504456f.acmepaymentscorp"
      },
      "Endpoints" : {
        "Endpoint" : [ {
          "CName" : "acme-payments-api.10.1.20.137",
          "Category" : "Production",
          "Uri" : "http://10.1.20.137:9901/",
          "ConnectionProperties" : [ ],
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.production.virtual",
          "BindingType" : "binding.http",
          "EndpointKey" : "uddi:937b32ee-5540-11e4-9358-dbbe78cfdf00"
        }, {
          "CName" : "acme-payments-api.10.1.20.137",
          "Category" : "Sandbox",
          "Uri" : "http://10.1.20.137:9901/",
          "ConnectionProperties" : [ ],
          "BindingQName" : "{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.sandbox.virtual",
          "BindingType" : "binding.http",
          "EndpointKey" : "uddi:944783df-5540-11e4-9358-dbbe78cfdf00"
        } ]
      },
      "Image" : [ {
        "Url" : "http://acmepaymentscorp.local/api/apis/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/avatar",
        "Title" : "api",
        "Link" : "#/api/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/versions/000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp/details"
      }, {
        "Url" : "http://acmepaymentscorp.local/api/apps/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/avatar",
        "Title" : "app",
        "Link" : "#/app/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/versions/6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp/details"
      } ],
      "Actions" : {
        "Action" : [ {
          "value" : "apicontract.action.reject",
          "label" : "apicontract.action.reject"
        }, {
          "value" : "apicontract.action.cancel",
          "label" : "apicontract.action.cancel"
        }, {
          "value" : "apicontract.action.editscope",
          "label" : "apicontract.action.editscope"
        }, {
          "value" : "apicontract.action.edit",
          "label" : "apicontract.action.edit"
        } ]
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "1.0",
          "Guid" : "000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp",
          "Category" : [ {
            "value" : "apiversion",
            "domain" : "uddi:soa.com:resourcetype"
          }, {
            "value" : "Limited",
            "domain" : "uddi:soa.com:visibility"
          }, {
            "value" : "uddi:soa.com:api:resource-level-permissions-supported",
            "domain" : "uddi:soa.com:api:resource-level-permissions"
          } ]
        }, {
          "Title" : "ACME Payments API",
          "Guid" : "f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp",
          "Category" : [ {
            "value" : "api",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Title" : "1.0",
          "Guid" : "6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp",
          "Category" : [ {
            "value" : "app-version",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Title" : "crosfhocal",
          "Guid" : "8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp",
          "Category" : [ {
            "value" : "app",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Guid" : "contract_request10560.acmepaymentscorp",
          "Category" : [ {
            "value" : "board-item",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        }, {
          "Title" : "Bronze",
          "Guid" : "671bb0b8-7089-4f31-b7fe-06cda72150f8.acmepaymentscorp",
          "Category" : [ {
            "value" : "license",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Sample response headers: text/xml

HTTP/1.1 200 OK
Date: Thu, 16 Oct 2014 11:35:41 GMT
Content-Type: text/xml

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/rss/1.0" xmlns:ns5="http://soa.com/xsd/comment/1.0" xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns7="http://soa.com/xsd/resource/1.0" xmlns:ns8="http://soa.com/xsd/legals/1.0" xmlns:ns9="http://soa.com/xsd/dnmodel/1.0" xmlns:ns10="http://soa.com/xsd/fault/1.0" xmlns:ns11="http://soa.com/xsd/api/1.0" xmlns:ns12="http://soa.com/xsd/board/1.0" xmlns:ns13="http://soa.com/xsd/search/1.0" xmlns:ns14="http://soa.com/xsd/workflow/1.0" version="1.0">
  <channel>
    <title>Application Contracts</title>
    <item>
      <title>6ffa9ff3-e53a-4b32-9ad9-83e08728af2c.acmepaymentscorp</title>
      <category domain="uddi:soa.com:environment">Sandbox</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.activated</category>
      <category domain="uddi:soa.com:status">com.soa.apicontract.inforce</category>
      <category domain="uddi:soa.com:restrictedscope">false</category>
      <guid>6ffa9ff3-e53a-4b32-9ad9-83e08728af2c.acmepaymentscorp</guid>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
          <ns4:Category domain="uddi:soa.com:visibility">Limited</ns4:Category>
          <ns4:Category domain="uddi:soa.com:api:resource-level-permissions">uddi:soa.com:api:resource-level-permissions-supported</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>ACME Payments API</Title>
          <Guid>f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>crosfhocal</Title>
          <Guid>8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Guid>contract_request10557.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">board-item</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Image>
        <Url>http://acmepaymentscorp.local/api/apis/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/avatar</Url>
        <Title>api</Title>
        <Link>#/api/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/versions/000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Image>
        <Url>http://acmepaymentscorp.local/api/apps/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/avatar</Url>
        <Title>app</Title>
        <Link>#/app/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/versions/6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns11:Endpoints>
        <ns11:Endpoint>
          <ns11:Category>Production</ns11:Category>
          <ns11:Uri>http://10.1.20.137:9901/</ns11:Uri>
          <ns11:CName>acme-payments-api.10.1.20.137</ns11:CName>
          <ns11:BindingQName>{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.production.virtual</ns11:BindingQName>
          <ns11:BindingType>binding.http</ns11:BindingType>
          <ns11:EndpointKey>uddi:937b32ee-5540-11e4-9358-dbbe78cfdf00</ns11:EndpointKey>
        </ns11:Endpoint>
        <ns11:Endpoint>
          <ns11:Category>Sandbox</ns11:Category>
          <ns11:Uri>http://10.1.20.137:9901/</ns11:Uri>
          <ns11:CName>acme-payments-api.10.1.20.137</ns11:CName>
          <ns11:BindingQName>{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.sandbox.virtual</ns11:BindingQName>
          <ns11:BindingType>binding.http</ns11:BindingType>
          <ns11:EndpointKey>uddi:944783df-5540-11e4-9358-dbbe78cfdf00</ns11:EndpointKey>
        </ns11:Endpoint>
      </ns11:Endpoints>
      <ns4:Actions>
        <ns4:Action label="apicontract.action.suspend">apicontract.action.suspend</ns4:Action>
        <ns4:Action label="apicontract.action.cancel">apicontract.action.cancel</ns4:Action>
      </ns4:Actions>
    </item>
    <item>
      <title>e9a9f10f-ee3c-4caa-84d7-826dd504456f.acmepaymentscorp</title>
      <category domain="uddi:soa.com:environment">Production</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.pending_approval</category>
      <category domain="uddi:soa.com:status">com.soa.apicontract.draft</category>
      <category domain="uddi:soa.com:restrictedscope">true</category>
      <guid>e9a9f10f-ee3c-4caa-84d7-826dd504456f.acmepaymentscorp</guid>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
          <ns4:Category domain="uddi:soa.com:visibility">Limited</ns4:Category>
          <ns4:Category domain="uddi:soa.com:api:resource-level-permissions">uddi:soa.com:api:resource-level-permissions-supported</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>ACME Payments API</Title>
          <Guid>f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>crosfhocal</Title>
          <Guid>8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Guid>contract_request10560.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">board-item</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>Bronze</Title>
          <Guid>671bb0b8-7089-4f31-b7fe-06cda72150f8.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">license</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Image>
        <Url>http://acmepaymentscorp.local/api/apis/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/avatar</Url>
        <Title>api</Title>
        <Link>#/api/f4ff81a9-02cc-4a02-ba2b-b90ec056a1c6.acmepaymentscorp/versions/000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Image>
        <Url>http://acmepaymentscorp.local/api/apps/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/avatar</Url>
        <Title>app</Title>
        <Link>#/app/8bed5703-e495-4aec-83da-ac0ffb2ecfd3.acmepaymentscorp/versions/6y5QK80GdG07BCMoO6MzLH86.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns11:Endpoints>
        <ns11:Endpoint>
          <ns11:Category>Production</ns11:Category>
          <ns11:Uri>http://10.1.20.137:9901/</ns11:Uri>
          <ns11:CName>acme-payments-api.10.1.20.137</ns11:CName>
          <ns11:BindingQName>{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.production.virtual</ns11:BindingQName>
          <ns11:BindingType>binding.http</ns11:BindingType>
          <ns11:EndpointKey>uddi:937b32ee-5540-11e4-9358-dbbe78cfdf00</ns11:EndpointKey>
        </ns11:Endpoint>
        <ns11:Endpoint>
          <ns11:Category>Sandbox</ns11:Category>
          <ns11:Uri>http://10.1.20.137:9901/</ns11:Uri>
          <ns11:CName>acme-payments-api.10.1.20.137</ns11:CName>
          <ns11:BindingQName>{uri:acmepaymentscorp}Binding_svc_000e4b2e-a84f-478a-91f3-08a90b300eb7.acmepaymentscorp.sandbox.virtual</ns11:BindingQName>
          <ns11:BindingType>binding.http</ns11:BindingType>
          <ns11:EndpointKey>uddi:944783df-5540-11e4-9358-dbbe78cfdf00</ns11:EndpointKey>
        </ns11:Endpoint>
      </ns11:Endpoints>
      <ns4:Actions>
        <ns4:Action label="apicontract.action.reject">apicontract.action.reject</ns4:Action>
        <ns4:Action label="apicontract.action.cancel">apicontract.action.cancel</ns4:Action>
        <ns4:Action label="apicontract.action.editscope">apicontract.action.editscope</ns4:Action>
        <ns4:Action label="apicontract.action.edit">apicontract.action.edit</ns4:Action>
      </ns4:Actions>
    </item>
  </channel>
</rss>

Back to top

Response Headers

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

Header Description
Content-Type text/xml or application/json

Back to top

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is Application Contracts. Each item in the channel represents a contract that the app version has with an API, and includes the information listed below.

Name Description
title The unique ID for the contract.
category

One or more categories. Each category is a set of two name/value pairs. The second item defines the Domain, and the first defines the actual value for the property. For example, the set of values below shows that the contract is in the Live implementation:

{
  "value": "Production",
  "domain": "uddi:soa.com:environment"
}

The domains for which values are defined are:

  • Environment: uddi:soa.com:environment
  • Contract state: uddi:soa.com:wfstate
guid GUID for the contract.
Endpoints The URI for the endpoint the contract relates to.
Image URI, Title, and Link for one or more images associated with the contract.
Actions Workflow actions that are valid for the contract.
EntityReferences

One or more entity references. Each includes:

  • Title
  • GUID: GUID for the API version the legal agreement relates to.
  • Category: one or more sets of name/value pairs conveying information about the contract.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics