GET /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}

Returns information about the service for a specific API version implementation.

Authorization Roles/Permissions: Must be a user with Read authorization to view information about the API.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}

Back to top

Sample Request

The example below shows a request for the service information for the specified API version implementation.

Request URL

https://{hostname}/api/apis/versions/f10624ed-9a23-4cb9-90d4-595d4a7c64f9.acmepaymentscorp/implementations/Sandbox/services/uddi:e4a34db0-1eda-11e6-a076-bde7b81dff00

Sample request headers

Accept: application/json
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 application/json, application/vnd.soa.v81+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
APIVersionID Path string Required The unique ID for a specific API version.
ImplCode Path string Required A code for a specific implementation. Valid values: Live or Sandbox.
ServiceID Path string Required The unique ID for a specific service; either a proxied API service or a physical service. Sometimes also called the ServiceKey. If you're not sure how to find this value, run the GET /api/apis/versions/{APIVersionID}/implementations/{ImplCode} operation. For an explanation of where the physical and virtual service keys occur in the response, see Get the Service ID for the physical service.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the service asset.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Fri, 20 May 2016 23:37:50 GMT

Sample response body: application/json

{
  "ServiceKey" : "uddi:e4a34db0-1eda-11e6-a076-bde7b81dff00",
  "Name" : "Swagger_Slim_v1_Sandbox_Target",
  "Description" : "Swagger Slim Version",
  "ServiceType" : "Physical",
  "Created" : "2016-05-20T22:33:36Z",
  "Updated" : "2016-05-20T23:36:35Z",
  "ServiceBindings" : {
    "ServiceBinding" : [ {
      "BindingQName" : "{Swagger_Slim.json}Swagger_Slim_Binding_0",
      "BindingKey" : "uddi:e19d3b62-9014-2176-dd9a-98c0c65e6f7f",
      "BindingType" : "binding.http"
    } ]
  }
}

Back to top

Response Headers

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

Header Description
Content-Type application/json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
ServiceAsset ServiceAsset Contains information about a service asset for an API.

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