BokaMera.API.Host

<back to all web services

WidgetConfigurationQuery

Requires Authentication
The following routes are available for this service:
GET/widget/configurationList or get widget configurationsReturns widget configurations. If slug is provided, returns a single configuration matching that slug. Otherwise returns all configurations for the company.
WidgetConfigurationQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SlugquerystringNoOptional slug to fetch a single configuration (e.g., 'hairsalon-001'). If provided, ignores other filter parameters.
SchemaVersionqueryint?NoFilter by schema version.
Skipqueryint?NoNumber of records to skip
Takequeryint?NoNumber of records to take
OrderByquerystringYesSort field
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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.

GET /widget/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: String,
			Name: String,
			Slug: String,
			Description: String,
			Configuration: String,
			SchemaVersion: 0,
			UpdatedDate: 0001-01-01T00:00:00.0000000+00:00,
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: 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
		}
	}
}