Click or drag to resize
ParaPlan Logo

Return Objects

All calls will return a SimpleResponse or a ListResponse.

Data objects

SimpleResponse<T>

This type of response will be used when only one object is returned

.list will only be populated if success is true.

SimpleResponse<T>
{
        .tokenExists : bool
        .tokenIsValid : bool
        .success : bool
        .errorMessage : string
        .response : T
}
SimpleList<T>

This type of response will be used when a list of objects are returned

.response will only be populated if success is true.

SimpleList<T>
{
        .tokenExists : bool
        .tokenIsValid : bool
        .success : bool
        .errorMessage : string
        .list : Array<T>
}
More Information

T is any ParaPlan type

.errorMessage will only be populated if success if false.