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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/OpenApiCallbackSdiQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OpenApiCallbackSdiQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
  <CreatedUtcBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedUtcBetween>
  <CreatedUtcGreaterThan>0001-01-01T00:00:00</CreatedUtcGreaterThan>
  <CreatedUtcGreaterThanOrEqualTo>0001-01-01T00:00:00</CreatedUtcGreaterThanOrEqualTo>
  <CreatedUtcIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedUtcIn>
  <CreatedUtcLessThan>0001-01-01T00:00:00</CreatedUtcLessThan>
  <CreatedUtcLessThanOrEqualTo>0001-01-01T00:00:00</CreatedUtcLessThanOrEqualTo>
  <CreatedUtcNotEqualTo>0001-01-01T00:00:00</CreatedUtcNotEqualTo>
  <EventType>String</EventType>
  <EventTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypeBetween>
  <EventTypeContains>String</EventTypeContains>
  <EventTypeEndsWith>String</EventTypeEndsWith>
  <EventTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypeIn>
  <EventTypeLike>String</EventTypeLike>
  <EventTypeStartsWith>String</EventTypeStartsWith>
  <Id>0</Id>
  <IdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdBetween>
  <IdGreaterThan>0</IdGreaterThan>
  <IdGreaterThanOrEqualTo>0</IdGreaterThanOrEqualTo>
  <IdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdIn>
  <IdLessThan>0</IdLessThan>
  <IdLessThanOrEqualTo>0</IdLessThanOrEqualTo>
  <IdNotEqualTo>0</IdNotEqualTo>
  <InvoiceUuid>String</InvoiceUuid>
  <InvoiceUuidBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceUuidBetween>
  <InvoiceUuidContains>String</InvoiceUuidContains>
  <InvoiceUuidEndsWith>String</InvoiceUuidEndsWith>
  <InvoiceUuidIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceUuidIn>
  <InvoiceUuidLike>String</InvoiceUuidLike>
  <InvoiceUuidStartsWith>String</InvoiceUuidStartsWith>
  <ModifiedUtc>0001-01-01T00:00:00</ModifiedUtc>
  <ModifiedUtcBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ModifiedUtcBetween>
  <ModifiedUtcGreaterThan>0001-01-01T00:00:00</ModifiedUtcGreaterThan>
  <ModifiedUtcGreaterThanOrEqualTo>0001-01-01T00:00:00</ModifiedUtcGreaterThanOrEqualTo>
  <ModifiedUtcIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ModifiedUtcIn>
  <ModifiedUtcLessThan>0001-01-01T00:00:00</ModifiedUtcLessThan>
  <ModifiedUtcLessThanOrEqualTo>0001-01-01T00:00:00</ModifiedUtcLessThanOrEqualTo>
  <ModifiedUtcNotEqualTo>0001-01-01T00:00:00</ModifiedUtcNotEqualTo>
  <ProcessingStatus>String</ProcessingStatus>
  <ProcessingStatusBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProcessingStatusBetween>
  <ProcessingStatusContains>String</ProcessingStatusContains>
  <ProcessingStatusEndsWith>String</ProcessingStatusEndsWith>
  <ProcessingStatusIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProcessingStatusIn>
  <ProcessingStatusLike>String</ProcessingStatusLike>
  <ProcessingStatusStartsWith>String</ProcessingStatusStartsWith>
  <RawJson>String</RawJson>
  <RawJsonBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RawJsonBetween>
  <RawJsonContains>String</RawJsonContains>
  <RawJsonEndsWith>String</RawJsonEndsWith>
  <RawJsonIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RawJsonIn>
  <RawJsonLike>String</RawJsonLike>
  <RawJsonStartsWith>String</RawJsonStartsWith>
  <RequestHeadersJson>String</RequestHeadersJson>
  <RequestHeadersJsonBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RequestHeadersJsonBetween>
  <RequestHeadersJsonContains>String</RequestHeadersJsonContains>
  <RequestHeadersJsonEndsWith>String</RequestHeadersJsonEndsWith>
  <RequestHeadersJsonIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RequestHeadersJsonIn>
  <RequestHeadersJsonLike>String</RequestHeadersJsonLike>
  <RequestHeadersJsonStartsWith>String</RequestHeadersJsonStartsWith>
</OpenApiCallbackSdiQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfOpenApiCallbackSdiCYQkyN_Pr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
    <d2p1:OpenApiCallbackSdi>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:EventType>String</d2p1:EventType>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InvoiceUuid>String</d2p1:InvoiceUuid>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
      <d2p1:ModifiedUtc>0001-01-01T00:00:00</d2p1:ModifiedUtc>
      <d2p1:ProcessingStatus>String</d2p1:ProcessingStatus>
      <d2p1:RawJson>String</d2p1:RawJson>
      <d2p1:RequestHeadersJson>String</d2p1:RequestHeadersJson>
    </d2p1:OpenApiCallbackSdi>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfOpenApiCallbackSdiCYQkyN_Pr>