Test

<back to all web services

DummyTypes

DummyTypes Parameters:
NameParameterData TypeRequiredDescription
HelloResponsesqueryList<HelloResponse>No
ListResultqueryList<ListResult>No
ArrayResultqueryArrayResult[]No
CancelRequestqueryCancelRequestNo
CancelRequestResponsequeryCancelRequestResponseNo
UpdateEventSubscriberqueryUpdateEventSubscriberNo
UpdateEventSubscriberResponsequeryUpdateEventSubscriberResponseNo
GetApiKeysqueryGetApiKeysNo
GetApiKeysResponsequeryGetApiKeysResponseNo
RegenerateApiKeysqueryRegenerateApiKeysNo
RegenerateApiKeysResponsequeryRegenerateApiKeysResponseNo
UserApiKeyqueryUserApiKeyNo
ConvertSessionToTokenqueryConvertSessionToTokenNo
ConvertSessionToTokenResponsequeryConvertSessionToTokenResponseNo
GetAccessTokenqueryGetAccessTokenNo
GetAccessTokenResponsequeryGetAccessTokenResponseNo
NavItemqueryNavItemNo
GetNavItemsqueryGetNavItemsNo
GetNavItemsResponsequeryGetNavItemsResponseNo
EmptyResponsequeryEmptyResponseNo
IdResponsequeryIdResponseNo
StringResponsequeryStringResponseNo
StringsResponsequeryStringsResponseNo
AuditBasequeryAuditBaseNo
HelloResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformstringNo
ListResult Parameters:
NameParameterData TypeRequiredDescription
ResultformstringNo
ArrayResult Parameters:
NameParameterData TypeRequiredDescription
ResultformstringNo
CancelRequest Parameters:
NameParameterData TypeRequiredDescription
TagformstringNo
MetaformDictionary<string, string>No
CancelRequestResponse Parameters:
NameParameterData TypeRequiredDescription
TagformstringNo
ElapsedformTimeSpanNo
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
UpdateEventSubscriber Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SubscribeChannelsformstring[]No
UnsubscribeChannelsformstring[]No
UpdateEventSubscriberResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GetApiKeys Parameters:
NameParameterData TypeRequiredDescription
EnvironmentformstringNo
MetaformDictionary<string, string>No
GetApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<UserApiKey>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
UserApiKey Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
KeyTypeformstringNo
ExpiryDateformDateTime?No
MetaformDictionary<string, string>No
RegenerateApiKeys Parameters:
NameParameterData TypeRequiredDescription
EnvironmentformstringNo
MetaformDictionary<string, string>No
RegenerateApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<UserApiKey>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
ConvertSessionToToken Parameters:
NameParameterData TypeRequiredDescription
PreserveSessionformboolNo
MetaformDictionary<string, string>No
ConvertSessionToTokenResponse Parameters:
NameParameterData TypeRequiredDescription
MetaformDictionary<string, string>No
AccessTokenformstringNo
RefreshTokenformstringNo
ResponseStatusformResponseStatusNo
GetAccessToken Parameters:
NameParameterData TypeRequiredDescription
RefreshTokenformstringNo
MetaformDictionary<string, string>No
GetAccessTokenResponse Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
NavItem Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
HrefformstringNo
Exactformbool?No
IdformstringNo
ClassNameformstringNo
IconClassformstringNo
IconSrcformstringNo
ShowformstringNo
HideformstringNo
ChildrenformList<NavItem>No
MetaformDictionary<string, string>No
GetNavItems Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
GetNavItemsResponse Parameters:
NameParameterData TypeRequiredDescription
BaseUrlformstringNo
ResultsformList<NavItem>No
NavItemsMapformDictionary<string, List<NavItem>>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
EmptyResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ResponseStatusformResponseStatusNo
StringResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformstringNo
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
StringsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<string>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo

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

HTTP + JSV

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

POST /jsv/oneway/DummyTypes HTTP/1.1 
Host: test.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
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: 0001-01-01,
				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: 0001-01-01,
				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: 0001-01-01,
		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
			}
		}
	}
}