Gemma.WebApi

<back to all web services

OpenApiCallbackSdiQuery

Requires Authentication
Required role:Admin
OpenApiCallbackSdiQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
EventTypequerystringNo
EventTypeStartsWithquerystringNo
EventTypeEndsWithquerystringNo
EventTypeContainsquerystringNo
EventTypeLikequerystringNo
EventTypeBetweenquerystring[]No
EventTypeInquerystring[]No
InvoiceUuidquerystringNo
InvoiceUuidStartsWithquerystringNo
InvoiceUuidEndsWithquerystringNo
InvoiceUuidContainsquerystringNo
InvoiceUuidLikequerystringNo
InvoiceUuidBetweenquerystring[]No
InvoiceUuidInquerystring[]No
ProcessingStatusquerystringNo
ProcessingStatusStartsWithquerystringNo
ProcessingStatusEndsWithquerystringNo
ProcessingStatusContainsquerystringNo
ProcessingStatusLikequerystringNo
ProcessingStatusBetweenquerystring[]No
ProcessingStatusInquerystring[]No
RawJsonquerystringNo
RawJsonStartsWithquerystringNo
RawJsonEndsWithquerystringNo
RawJsonContainsquerystringNo
RawJsonLikequerystringNo
RawJsonBetweenquerystring[]No
RawJsonInquerystring[]No
RequestHeadersJsonquerystringNo
RequestHeadersJsonStartsWithquerystringNo
RequestHeadersJsonEndsWithquerystringNo
RequestHeadersJsonContainsquerystringNo
RequestHeadersJsonLikequerystringNo
RequestHeadersJsonBetweenquerystring[]No
RequestHeadersJsonInquerystring[]No
CreatedUtcqueryDateTime?No
CreatedUtcGreaterThanOrEqualToqueryDateTime?No
CreatedUtcGreaterThanqueryDateTime?No
CreatedUtcLessThanqueryDateTime?No
CreatedUtcLessThanOrEqualToqueryDateTime?No
CreatedUtcNotEqualToqueryDateTime?No
CreatedUtcBetweenqueryDateTime[]No
CreatedUtcInqueryDateTime[]No
ModifiedUtcqueryDateTime?No
ModifiedUtcGreaterThanOrEqualToqueryDateTime?No
ModifiedUtcGreaterThanqueryDateTime?No
ModifiedUtcLessThanqueryDateTime?No
ModifiedUtcLessThanOrEqualToqueryDateTime?No
ModifiedUtcNotEqualToqueryDateTime?No
ModifiedUtcBetweenqueryDateTime[]No
ModifiedUtcInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
OpenApiCallbackSdi Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EventTypeformstringNo
InvoiceUuidformstringNo
ProcessingStatusformstringNo
RawJsonformstringNo
RequestHeadersJsonformstringNo
CreatedUtcformDateTimeNo
ModifiedUtcformDateTimeNo
MetaformDictionary<string, string>No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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/reply/OpenApiCallbackSdiQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	idGreaterThanOrEqualTo: 0,
	idGreaterThan: 0,
	idLessThan: 0,
	idLessThanOrEqualTo: 0,
	idNotEqualTo: 0,
	idBetween: 
	[
		0
	],
	idIn: 
	[
		0
	],
	eventType: String,
	eventTypeStartsWith: String,
	eventTypeEndsWith: String,
	eventTypeContains: String,
	eventTypeLike: String,
	eventTypeBetween: 
	[
		String
	],
	eventTypeIn: 
	[
		String
	],
	invoiceUuid: String,
	invoiceUuidStartsWith: String,
	invoiceUuidEndsWith: String,
	invoiceUuidContains: String,
	invoiceUuidLike: String,
	invoiceUuidBetween: 
	[
		String
	],
	invoiceUuidIn: 
	[
		String
	],
	processingStatus: String,
	processingStatusStartsWith: String,
	processingStatusEndsWith: String,
	processingStatusContains: String,
	processingStatusLike: String,
	processingStatusBetween: 
	[
		String
	],
	processingStatusIn: 
	[
		String
	],
	rawJson: String,
	rawJsonStartsWith: String,
	rawJsonEndsWith: String,
	rawJsonContains: String,
	rawJsonLike: String,
	rawJsonBetween: 
	[
		String
	],
	rawJsonIn: 
	[
		String
	],
	requestHeadersJson: String,
	requestHeadersJsonStartsWith: String,
	requestHeadersJsonEndsWith: String,
	requestHeadersJsonContains: String,
	requestHeadersJsonLike: String,
	requestHeadersJsonBetween: 
	[
		String
	],
	requestHeadersJsonIn: 
	[
		String
	],
	createdUtc: 0001-01-01T00:00:00,
	createdUtcGreaterThanOrEqualTo: 0001-01-01T00:00:00,
	createdUtcGreaterThan: 0001-01-01T00:00:00,
	createdUtcLessThan: 0001-01-01T00:00:00,
	createdUtcLessThanOrEqualTo: 0001-01-01T00:00:00,
	createdUtcNotEqualTo: 0001-01-01T00:00:00,
	createdUtcBetween: 
	[
		"0001-01-01T00: 00:00"
	],
	createdUtcIn: 
	[
		"0001-01-01T00: 00:00"
	],
	modifiedUtc: 0001-01-01T00:00:00,
	modifiedUtcGreaterThanOrEqualTo: 0001-01-01T00:00:00,
	modifiedUtcGreaterThan: 0001-01-01T00:00:00,
	modifiedUtcLessThan: 0001-01-01T00:00:00,
	modifiedUtcLessThanOrEqualTo: 0001-01-01T00:00:00,
	modifiedUtcNotEqualTo: 0001-01-01T00:00:00,
	modifiedUtcBetween: 
	[
		"0001-01-01T00: 00:00"
	],
	modifiedUtcIn: 
	[
		"0001-01-01T00: 00:00"
	],
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			eventType: String,
			invoiceUuid: String,
			processingStatus: String,
			rawJson: String,
			requestHeadersJson: 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
		}
	}
}