BokaMera.API.Host

<back to all web services

CreateWidgetConfigurationSchema

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/widget/configurationschemaCreate a widget configuration schemaCreates a new schema. SuperAdmin only. Schemas are global and immutable: there is no PUT or DELETE.
CreateWidgetConfigurationSchema Parameters:
NameParameterData TypeRequiredDescription
VersionbodyintYesThe schema version. Must be unique.
SchemabodyDictionary<string, Object>YesThe JSON Schema document.
WidgetConfigurationSchemaResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
VersionformintNo
SchemaformDictionary<string, Object>Yes
CreatedDateformDateTimeNo
ResponseStatusformResponseStatusYes

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 /widget/configurationschema HTTP/1.1 
Host: api.bookmore.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Version":0,"Schema":{"String":{}}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Version":0,"Schema":{"String":{}},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}