| Required role: | Admin |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | int? | No | |
| IdGreaterThanOrEqualTo | query | int? | No | |
| IdGreaterThan | query | int? | No | |
| IdLessThan | query | int? | No | |
| IdLessThanOrEqualTo | query | int? | No | |
| IdNotEqualTo | query | int? | No | |
| IdBetween | query | int[] | No | |
| IdIn | query | int[] | No | |
| EventType | query | string | No | |
| EventTypeStartsWith | query | string | No | |
| EventTypeEndsWith | query | string | No | |
| EventTypeContains | query | string | No | |
| EventTypeLike | query | string | No | |
| EventTypeBetween | query | string[] | No | |
| EventTypeIn | query | string[] | No | |
| InvoiceUuid | query | string | No | |
| InvoiceUuidStartsWith | query | string | No | |
| InvoiceUuidEndsWith | query | string | No | |
| InvoiceUuidContains | query | string | No | |
| InvoiceUuidLike | query | string | No | |
| InvoiceUuidBetween | query | string[] | No | |
| InvoiceUuidIn | query | string[] | No | |
| ProcessingStatus | query | string | No | |
| ProcessingStatusStartsWith | query | string | No | |
| ProcessingStatusEndsWith | query | string | No | |
| ProcessingStatusContains | query | string | No | |
| ProcessingStatusLike | query | string | No | |
| ProcessingStatusBetween | query | string[] | No | |
| ProcessingStatusIn | query | string[] | No | |
| RawJson | query | string | No | |
| RawJsonStartsWith | query | string | No | |
| RawJsonEndsWith | query | string | No | |
| RawJsonContains | query | string | No | |
| RawJsonLike | query | string | No | |
| RawJsonBetween | query | string[] | No | |
| RawJsonIn | query | string[] | No | |
| RequestHeadersJson | query | string | No | |
| RequestHeadersJsonStartsWith | query | string | No | |
| RequestHeadersJsonEndsWith | query | string | No | |
| RequestHeadersJsonContains | query | string | No | |
| RequestHeadersJsonLike | query | string | No | |
| RequestHeadersJsonBetween | query | string[] | No | |
| RequestHeadersJsonIn | query | string[] | No | |
| CreatedUtc | query | DateTime? | No | |
| CreatedUtcGreaterThanOrEqualTo | query | DateTime? | No | |
| CreatedUtcGreaterThan | query | DateTime? | No | |
| CreatedUtcLessThan | query | DateTime? | No | |
| CreatedUtcLessThanOrEqualTo | query | DateTime? | No | |
| CreatedUtcNotEqualTo | query | DateTime? | No | |
| CreatedUtcBetween | query | DateTime[] | No | |
| CreatedUtcIn | query | DateTime[] | No | |
| ModifiedUtc | query | DateTime? | No | |
| ModifiedUtcGreaterThanOrEqualTo | query | DateTime? | No | |
| ModifiedUtcGreaterThan | query | DateTime? | No | |
| ModifiedUtcLessThan | query | DateTime? | No | |
| ModifiedUtcLessThanOrEqualTo | query | DateTime? | No | |
| ModifiedUtcNotEqualTo | query | DateTime? | No | |
| ModifiedUtcBetween | query | DateTime[] | No | |
| ModifiedUtcIn | query | DateTime[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| EventType | form | string | No | |
| InvoiceUuid | form | string | No | |
| ProcessingStatus | form | string | No | |
| RawJson | form | string | No | |
| RequestHeadersJson | form | string | No | |
| CreatedUtc | form | DateTime | No | |
| ModifiedUtc | form | DateTime | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}