Public API - Revision history

2A02:C7C:C489:9900:86:B433:6F70:6262: /* Usage from Javascript/ Typescript */

2025-04-30T11:51:48Z

Usage from Javascript/ Typescript

← Older revision		Revision as of 11:51, 30 April 2025
Line 5:		Line 5:
	== Usage from Javascript/ Typescript ==		== Usage from Javascript/ Typescript ==

	~~todo~~		[[Loop]] and graphs created with the [[Graph Editor]] are common ways to access data. Graphs are particularly useful when you have content types that [[Dynamic Content Types\|do not exist at compile time]], and Loop is great for typical lists of content. Sometimes though you will be wanting to use custom endpoints or have more control over the loading and display of your content in which case you would use the public API from your Javascript or Typescript frontend files.

			<syntaxhighlight lang="typescript">
			import userApi from 'Api/User';

			...

			userApi.list().then(userSet => {
			console.log(userSet.results);
			});
			</syntaxhighlight>

	== Common API structure ==		== Common API structure ==

2A02:C7C:C489:9900:86:B433:6F70:6262 at 11:45, 30 April 2025

2025-04-30T11:45:39Z

← Older revision		Revision as of 11:45, 30 April 2025
Line 1:		Line 1:
	SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].		SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].

	The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints~~\|Custom_Endpoints~~]] for more general details on how to create new endpoints.		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[Custom Endpoints\|custom endpoints]] for more general details on how to create new endpoints.

	== Usage from Javascript/ Typescript ==		== Usage from Javascript/ Typescript ==

2A02:C7C:C489:9900:86:B433:6F70:6262 at 11:45, 30 April 2025

2025-04-30T11:45:25Z

← Older revision		Revision as of 11:45, 30 April 2025
Line 1:		Line 1:
	SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].		SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].

	The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints\|~~Custom Endpoints~~]] for more general details on how to create new endpoints.		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints\|Custom_Endpoints]] for more general details on how to create new endpoints.

	== Usage from Javascript/ Typescript ==		== Usage from Javascript/ Typescript ==

2A02:C7C:C489:9900:86:B433:6F70:6262 at 11:45, 30 April 2025

2025-04-30T11:45:03Z

← Older revision		Revision as of 11:45, 30 April 2025
Line 3:		Line 3:
	The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints\|Custom Endpoints]] for more general details on how to create new endpoints.		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints\|Custom Endpoints]] for more general details on how to create new endpoints.

	== Usage from Javascript/ Typescript =		== Usage from Javascript/ Typescript ==

	todo		todo

2A02:C7C:C489:9900:86:B433:6F70:6262 at 11:44, 30 April 2025

2025-04-30T11:44:45Z

← Older revision		Revision as of 11:44, 30 April 2025
Line 1:		Line 1:
	SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].		SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].

	~~Note that~~ it is ~~somewhat uncommon to directly use the API via something like javascript fetch~~. ~~Most of the time people use~~ [[~~Loop~~]]~~, [[Forms]], [[Content]] and occasionally [[webRequest]]. webRequest is a thin wrapper over fetch with a variety of conveniences built in~~.		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. See [[custom endpoints\|Custom Endpoints]] for more general details on how to create new endpoints.

	~~The controllers themselves are extendible - for example if~~ you ~~wanted /v1/user/say-hello~~ to ~~exist, you can do so without editing~~ the ~~underlying ThirdParty default UserController~~ as ~~it is~~ a ~~partial class. Controllers~~ for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:		== Usage from Javascript/ Typescript =

			todo

			== Common API structure ==

			If you want to call the web API externally such as via a standalone tool or another web service, controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:

	''In all cases if you don't have permission, it will error on you.''		''In all cases if you don't have permission, it will error on you.''


	* GET /v1/thing/list - Lists everything of this entity type.		* GET /v1/thing/list - Lists everything of this entity type.

Luke at 15:03, 15 March 2023

2023-03-15T15:03:57Z

← Older revision		Revision as of 15:03, 15 March 2023
Line 17:		Line 17:
	</syntaxhighlight>		</syntaxhighlight>

			It can also contain pageSize, pageIndex, sort and includeTotal to fine tune the list.

			<syntaxhighlight lang="json">
			{"query":"Token=?", "args":["the-token-value"], "pageSize": 10, "pageIndex": 0, "includeTotal": true, "sort": {"field": "Name", "direction": "asc"}}
			</syntaxhighlight>

			Including the total will return the total number of results when you are receiving a partial set of them, for example because you are specifying a page size which is less than the total number of matches.

	* POST /v1/thing - Creates a new entity of the given type. The payload is simply the fields and properties of the entity.		* POST /v1/thing - Creates a new entity of the given type. The payload is simply the fields and properties of the entity.

Luke at 16:25, 8 March 2023

2023-03-08T16:25:17Z

← Older revision		Revision as of 16:25, 8 March 2023
Line 1:		Line 1:
	SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].		SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].

	Note that it is somewhat uncommon to directly use the API. Most of the time people use [[Loop]], [[Forms]], [[Content]] and occasionally webRequest.		Note that it is somewhat uncommon to directly use the API via something like javascript fetch. Most of the time people use [[Loop]], [[Forms]], [[Content]] and occasionally [[webRequest]]. webRequest is a thin wrapper over fetch with a variety of conveniences built in.

	The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying default UserController as it is a partial class. Controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying ThirdParty default UserController as it is a partial class. Controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:

	''In all cases if you don't have permission, it will error on you.''		''In all cases if you don't have permission, it will error on you.''

Luke at 16:24, 8 March 2023

2023-03-08T16:24:01Z

← Older revision		Revision as of 16:24, 8 March 2023
Line 1:		Line 1:
	SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].		SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules\|API modules]].

	Note that it is somewhat uncommon to directly use the API. Most of the time people use [[Loop]], Content and occasionally webRequest.		Note that it is somewhat uncommon to directly use the API. Most of the time people use [[Loop]], [[Forms]], [[Content]] and occasionally webRequest.

	The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying default UserController as it is a partial class. Controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:		The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying default UserController as it is a partial class. Controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:

2A02:C7F:22BE:A500:498:3225:1A16:A72D at 18:24, 5 July 2022

2022-07-05T18:24:52Z

← Older revision		Revision as of 18:24, 5 July 2022
Line 6:		Line 6:

	''In all cases if you don't have permission, it will error on you.''		''In all cases if you don't have permission, it will error on you.''


	* GET /v1/thing/list - Lists everything of this entity type.		* GET /v1/thing/list - Lists everything of this entity type.

	* POST /v1/thing/list~~, lists~~ based on a POSTed [[filter]], where the post payload is:
			* POST /v1/thing/list - Lists based on a POSTed [[Filters\|filter]], where the post payload is:

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{"query":"Token=?", "args":["the-token-value"]}		{"query":"Token=?", "args":["the-token-value"]}
	</syntaxhighlight>		</syntaxhighlight>


	* POST /v1/thing - Creates a new entity of the given type. The payload is simply the fields and properties of the entity.		* POST /v1/thing - Creates a new entity of the given type. The payload is simply the fields and properties of the entity.

	Properties are set as well if you need some more advanced temporary values. This is used by, for example, "password" on User which is not directly stored but instead a hash of it is.		Properties are set as well if you need some more advanced temporary values. This is used by, for example, "password" on User which is not directly stored but instead a hash of it is.


	* POST /v1/thing/14 - Where 14 is an ID. Updates the entity with the given ID. The payload is the same as for creation.		* POST /v1/thing/14 - Where 14 is an ID. Updates the entity with the given ID. The payload is the same as for creation.


	* DELETE /v1/thing/14 - Deletes the given entity by its ID. Returns the entity as it was just before it was deleted.		* DELETE /v1/thing/14 - Deletes the given entity by its ID. Returns the entity as it was just before it was deleted.

	* GET /v1/thing/14 - ~~Gets~~ a single item by its ID. This is what <[[Content]]> uses internally, via webRequest.
			* GET /v1/thing/14 - Loads a single item by its ID. This is what <[[Content]]> uses internally, via webRequest.

			= Includes =

			[[Includes]] are a mechanism in SocialStack for getting related data in the same API call. They are available on core endpoints such as load and list, and are simply a query string parameter of the includable fields that you would like to obtain.

			GET /v1/thing/14?includes=creatorUser


			If you're not sure what includes the API currently has, you can use a wildcard:

			GET /v1/thing/14?includes=*


			If there is more than one that you would like, they are comma separated:

			GET /v1/thing/14?includes=creatorUser,tags

2A02:C7F:22BE:A500:498:3225:1A16:A72D: Created page with "SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see t..."

2022-07-05T18:14:47Z

Created page with "SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see t..."

New page

SocialStack API's (the C# binary) have a REST web API whose available endpoints originate from the set of controllers in the project. For more detail on the controllers, see the page about [[API Modules|API modules]].

Note that it is somewhat uncommon to directly use the API. Most of the time people use [[Loop]], Content and occasionally webRequest.

The controllers themselves are extendible - for example if you wanted /v1/user/say-hello to exist, you can do so without editing the underlying default UserController as it is a partial class. Controllers for entity types, which is to say for most parts of a typical SocialStack API, have some common endpoints which are as follows:

''In all cases if you don't have permission, it will error on you.''

* GET /v1/thing/list - Lists everything of this entity type.

* POST /v1/thing/list, lists based on a POSTed [[filter]], where the post payload is:

<syntaxhighlight lang="json">
{"query":"Token=?", "args":["the-token-value"]}
</syntaxhighlight>

* POST /v1/thing - Creates a new entity of the given type. The payload is simply the fields and properties of the entity.

Properties are set as well if you need some more advanced temporary values. This is used by, for example, "password" on User which is not directly stored but instead a hash of it is.

* POST /v1/thing/14 - Where 14 is an ID. Updates the entity with the given ID. The payload is the same as for creation.

* DELETE /v1/thing/14 - Deletes the given entity by its ID. Returns the entity as it was just before it was deleted.

* GET /v1/thing/14 - Gets a single item by its ID. This is what <[[Content]]> uses internally, via webRequest.