Test

<back to all web services

DummyTypes


export class HelloResponse
{
    public result: string;

    public constructor(init?: Partial<HelloResponse>) { (Object as any).assign(this, init); }
}

export class ListResult
{
    public result: string;

    public constructor(init?: Partial<ListResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CancelRequest implements IPost, IMeta
{
    // @DataMember(Order=1)
    public tag: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<CancelRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CancelRequestResponse implements IMeta
{
    // @DataMember(Order=1)
    public tag: string;

    // @DataMember(Order=2)
    public elapsed: string;

    // @DataMember(Order=3)
    public meta: { [index: string]: string; };

    // @DataMember(Order=4)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<CancelRequestResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateEventSubscriber implements IPost
{
    // @DataMember(Order=1)
    public id: string;

    // @DataMember(Order=2)
    public subscribeChannels: string[];

    // @DataMember(Order=3)
    public unsubscribeChannels: string[];

    public constructor(init?: Partial<UpdateEventSubscriber>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateEventSubscriberResponse
{
    // @DataMember(Order=1)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<UpdateEventSubscriberResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetApiKeys implements IGet, IMeta
{
    // @DataMember(Order=1)
    public environment: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<GetApiKeys>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UserApiKey implements IMeta
{
    // @DataMember(Order=1)
    public key: string;

    // @DataMember(Order=2)
    public keyType: string;

    // @DataMember(Order=3)
    public expiryDate?: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<UserApiKey>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetApiKeysResponse implements IMeta
{
    // @DataMember(Order=1)
    public results: UserApiKey[];

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    // @DataMember(Order=3)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetApiKeysResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class RegenerateApiKeys implements IPost, IMeta
{
    // @DataMember(Order=1)
    public environment: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<RegenerateApiKeys>) { (Object as any).assign(this, init); }
}

// @DataContract
export class RegenerateApiKeysResponse implements IMeta
{
    // @DataMember(Order=1)
    public results: UserApiKey[];

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    // @DataMember(Order=3)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<RegenerateApiKeysResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ConvertSessionToToken implements IPost, IMeta
{
    // @DataMember(Order=1)
    public preserveSession: boolean;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ConvertSessionToToken>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ConvertSessionToTokenResponse implements IMeta
{
    // @DataMember(Order=1)
    public meta: { [index: string]: string; };

    // @DataMember(Order=2)
    public accessToken: string;

    // @DataMember(Order=3)
    public refreshToken: string;

    // @DataMember(Order=4)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ConvertSessionToTokenResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAccessToken implements IPost, IMeta
{
    // @DataMember(Order=1)
    public refreshToken: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<GetAccessToken>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAccessTokenResponse implements IMeta
{
    // @DataMember(Order=1)
    public accessToken: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    // @DataMember(Order=3)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAccessTokenResponse>) { (Object as any).assign(this, init); }
}

export class NavItem implements IMeta
{
    public label: string;
    public href: string;
    public exact?: boolean;
    public id: string;
    public className: string;
    public iconClass: string;
    public iconSrc: string;
    public show: string;
    public hide: string;
    public children: NavItem[];
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<NavItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetNavItems
{
    // @DataMember(Order=1)
    public name: string;

    public constructor(init?: Partial<GetNavItems>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetNavItemsResponse implements IMeta
{
    // @DataMember(Order=1)
    public baseUrl: string;

    // @DataMember(Order=2)
    public results: NavItem[];

    // @DataMember(Order=3)
    public navItemsMap: { [index: string]: NavItem[]; };

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetNavItemsResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class EmptyResponse
{
    // @DataMember(Order=1)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<EmptyResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class IdResponse
{
    // @DataMember(Order=1)
    public id: string;

    // @DataMember(Order=2)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<IdResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class StringResponse implements IMeta
{
    // @DataMember(Order=1)
    public result: string;

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    // @DataMember(Order=3)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<StringResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class StringsResponse implements IMeta
{
    // @DataMember(Order=1)
    public results: string[];

    // @DataMember(Order=2)
    public meta: { [index: string]: string; };

    // @DataMember(Order=3)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<StringsResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AuditBase
{
    // @DataMember(Order=1)
    public createdDate: string;

    // @DataMember(Order=2)
    // @Required()
    public createdBy: string;

    // @DataMember(Order=3)
    public modifiedDate: string;

    // @DataMember(Order=4)
    // @Required()
    public modifiedBy: string;

    // @DataMember(Order=5)
    public deletedDate?: string;

    // @DataMember(Order=6)
    public deletedBy: string;

    public constructor(init?: Partial<AuditBase>) { (Object as any).assign(this, init); }
}

export class DummyTypes
{
    public helloResponses: HelloResponse[];
    public listResult: ListResult[];
    public arrayResult: ArrayResult[];
    public cancelRequest: CancelRequest;
    public cancelRequestResponse: CancelRequestResponse;
    public updateEventSubscriber: UpdateEventSubscriber;
    public updateEventSubscriberResponse: UpdateEventSubscriberResponse;
    public getApiKeys: GetApiKeys;
    public getApiKeysResponse: GetApiKeysResponse;
    public regenerateApiKeys: RegenerateApiKeys;
    public regenerateApiKeysResponse: RegenerateApiKeysResponse;
    public userApiKey: UserApiKey;
    public convertSessionToToken: ConvertSessionToToken;
    public convertSessionToTokenResponse: ConvertSessionToTokenResponse;
    public getAccessToken: GetAccessToken;
    public getAccessTokenResponse: GetAccessTokenResponse;
    public navItem: NavItem;
    public getNavItems: GetNavItems;
    public getNavItemsResponse: GetNavItemsResponse;
    public emptyResponse: EmptyResponse;
    public idResponse: IdResponse;
    public stringResponse: StringResponse;
    public stringsResponse: StringsResponse;
    public auditBase: AuditBase;

    public constructor(init?: Partial<DummyTypes>) { (Object as any).assign(this, init); }
}

export class ArrayResult
{
    public result: string;

    public constructor(init?: Partial<ArrayResult>) { (Object as any).assign(this, init); }
}

TypeScript DummyTypes DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/oneway/DummyTypes HTTP/1.1 
Host: test.servicestack.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"helloResponses":[{"result":"String"}],"listResult":[{"result":"String"}],"arrayResult":[{"result":"String"}],"cancelRequest":{"tag":"String","meta":{"String":"String"}},"cancelRequestResponse":{"tag":"String","elapsed":"PT0S","meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"updateEventSubscriber":{"id":"String","subscribeChannels":["String"],"unsubscribeChannels":["String"]},"updateEventSubscriberResponse":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"getApiKeys":{"environment":"String","meta":{"String":"String"}},"getApiKeysResponse":{"results":[{"key":"String","keyType":"String","expiryDate":"\/Date(-62135596800000-0000)\/","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"regenerateApiKeys":{"environment":"String","meta":{"String":"String"}},"regenerateApiKeysResponse":{"results":[{"key":"String","keyType":"String","expiryDate":"\/Date(-62135596800000-0000)\/","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"userApiKey":{"key":"String","keyType":"String","expiryDate":"\/Date(-62135596800000-0000)\/","meta":{"String":"String"}},"convertSessionToToken":{"preserveSession":false,"meta":{"String":"String"}},"convertSessionToTokenResponse":{"meta":{"String":"String"},"accessToken":"String","refreshToken":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"getAccessToken":{"refreshToken":"String","meta":{"String":"String"}},"getAccessTokenResponse":{"accessToken":"String","meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"navItem":{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{}],"meta":{"String":"String"}}],"meta":{"String":"String"}}],"meta":{"String":"String"}},"getNavItems":{"name":"String"},"getNavItemsResponse":{"baseUrl":"String","results":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}],"meta":{"String":"String"}}],"navItemsMap":{"String":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","children":[{"label":"String","href":"String","exact":false,"id":"String","className":"String","iconClass":"String","iconSrc":"String","show":"String","hide":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}],"meta":{"String":"String"}}]},"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"emptyResponse":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"idResponse":{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"stringResponse":{"result":"String","meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}},"stringsResponse":{"results":["String"],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}