Class ServiceApiException

ServiceApiException is thrown when an underlying service API call results in an error.

Inheritance

System.Object

System.Exception

ServiceApiException

Implements

System.Runtime.Serialization.ISerializable

Namespace: Adobe.DocumentCloud.Services.exception

Assembly: Adobe.DocumentCloud.Services.Doc.dll

Syntax

public class ServiceApiException : Exception, ISerializable

Constructors

ServiceApiException()

Constructs a {@code ServiceApiException}.

Declaration

public ServiceApiException()

ServiceApiException(String)

Constructs a ServiceApiException with the specified detail message.

Declaration

public ServiceApiException(string message)

Parameters

Type	Name	Description
System.String	message	the detail message

ServiceApiException(String, Exception)

Constructs a ServiceApiException with the specified detail message and a reference to the inner exception that is the cause of this exception.

Declaration

public ServiceApiException(string message, Exception inner)

Parameters

Type	Name	Description
System.String	message	the detail message
System.Exception	inner	a reference to the inner exception

ServiceApiException(String, String, Int32)

Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.

Declaration

public ServiceApiException(string message, string requestId, int statusCode)

Parameters

Type	Name	Description
System.String	message	the detail message
System.String	requestId	X-Request-Id header value to track the request
System.Int32	statusCode	HTTP Status code returned in API response

ServiceApiException(String, String, Int32, Exception)

Constructs a ServiceApiException with the specified detail message, requestId, returned HTTP status code and a reference to the inner exception that is the cause of this exception.

Declaration

public ServiceApiException(string message, string requestId, int statusCode, Exception inner)

Parameters

Type	Name	Description
System.String	message	the detail message
System.String	requestId	X-Request-Id header value to track the request
System.Int32	statusCode	HTTP Status code returned in API response
System.Exception	inner	a reference to the inner exception

Properties

RequestId

Tracking id for the failed http request

Declaration

public string RequestId { get; }

Property Value

Type	Description
System.String

StatusCode

The http status code of the response

Declaration

public int StatusCode { get; }

Property Value

Type	Description
System.Int32

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String	the string reprensentation of ServiceApiException

Overrides

System.Exception.ToString()

Implements

System.Runtime.Serialization.ISerializable