Table of Contents

ApiResult

IsSuccess

Indicates if the request was successful.

Messages

A list of informational messages.

SentOnUtc

The date and time, in UTC, that this result was created. It will be in the format 'YYYY-MM-DDZHH:MM:SS'.

TraceId

The unique identifier for this operation. It is automatically assigned when the API receives the request. It will be unique for each request and response.
You will need this value when contacting OSG regarding this request.

CorrelationId

This element is used to track a unit of work across multiple systems. If the caller provides a value on the initial request it will be used. Otherwise, a unique correlation id will be generated.

For example, a caller may use accountnumber-statements-statementdate. This value will be propagated across all systems and returned on all requests. This allows a caller to track work across both their internal system and OSG systems.