JiwaAPI

<back to all web services

EM_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/EM_MainRetrieves a list of email messages.
EM_MainQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
EmailNoquerystringNo
EmailNoStartsWithquerystringNo
EmailNoEndsWithquerystringNo
EmailNoContainsquerystringNo
EmailNoLikequerystringNo
EmailNoBetweenquerystring[]No
EmailNoInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DateCreatedqueryDateTime?No
DateCreatedGreaterThanOrEqualToqueryDateTime?No
DateCreatedGreaterThanqueryDateTime?No
DateCreatedLessThanqueryDateTime?No
DateCreatedLessThanOrEqualToqueryDateTime?No
DateCreatedNotEqualToqueryDateTime?No
DateCreatedBetweenqueryDateTime[]No
DateCreatedInqueryDateTime[]No
DateSentqueryDateTime?No
DateSentGreaterThanOrEqualToqueryDateTime?No
DateSentGreaterThanqueryDateTime?No
DateSentLessThanqueryDateTime?No
DateSentLessThanOrEqualToqueryDateTime?No
DateSentNotEqualToqueryDateTime?No
DateSentBetweenqueryNullable<DateTime>[]No
DateSentInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
SourceTypequerystringNo
SourceTypeStartsWithquerystringNo
SourceTypeEndsWithquerystringNo
SourceTypeContainsquerystringNo
SourceTypeLikequerystringNo
SourceTypeBetweenquerystring[]No
SourceTypeInquerystring[]No
SourceDisplayNoquerystringNo
SourceDisplayNoStartsWithquerystringNo
SourceDisplayNoEndsWithquerystringNo
SourceDisplayNoContainsquerystringNo
SourceDisplayNoLikequerystringNo
SourceDisplayNoBetweenquerystring[]No
SourceDisplayNoInquerystring[]No
SY_Forms_ClassNamequerystringNo
SY_Forms_ClassNameStartsWithquerystringNo
SY_Forms_ClassNameEndsWithquerystringNo
SY_Forms_ClassNameContainsquerystringNo
SY_Forms_ClassNameLikequerystringNo
SY_Forms_ClassNameBetweenquerystring[]No
SY_Forms_ClassNameInquerystring[]No
EmailStatusquerybyte?No
EmailStatusGreaterThanOrEqualToquerybyte?No
EmailStatusGreaterThanquerybyte?No
EmailStatusLessThanquerybyte?No
EmailStatusLessThanOrEqualToquerybyte?No
EmailStatusNotEqualToquerybyte?No
EmailStatusBetweenqueryNullable<Byte>[]No
EmailStatusInqueryNullable<Byte>[]No
EmailFromquerystringNo
EmailFromStartsWithquerystringNo
EmailFromEndsWithquerystringNo
EmailFromContainsquerystringNo
EmailFromLikequerystringNo
EmailFromBetweenquerystring[]No
EmailFromInquerystring[]No
EmailToquerystringNo
EmailToStartsWithquerystringNo
EmailToEndsWithquerystringNo
EmailToContainsquerystringNo
EmailToLikequerystringNo
EmailToBetweenquerystring[]No
EmailToInquerystring[]No
EmailCCquerystringNo
EmailCCStartsWithquerystringNo
EmailCCEndsWithquerystringNo
EmailCCContainsquerystringNo
EmailCCLikequerystringNo
EmailCCBetweenquerystring[]No
EmailCCInquerystring[]No
EmailBCCquerystringNo
EmailBCCStartsWithquerystringNo
EmailBCCEndsWithquerystringNo
EmailBCCContainsquerystringNo
EmailBCCLikequerystringNo
EmailBCCBetweenquerystring[]No
EmailBCCInquerystring[]No
EmailSubjectquerystringNo
EmailSubjectStartsWithquerystringNo
EmailSubjectEndsWithquerystringNo
EmailSubjectContainsquerystringNo
EmailSubjectLikequerystringNo
EmailSubjectBetweenquerystring[]No
EmailSubjectInquerystring[]No
EmailBodyquerystringNo
EmailBodyStartsWithquerystringNo
EmailBodyEndsWithquerystringNo
EmailBodyContainsquerystringNo
EmailBodyLikequerystringNo
EmailBodyBetweenquerystring[]No
EmailBodyInquerystring[]No
RequestReadReceiptquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EM_Main Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
EmailNoformstringNo
LastSavedDateTimeformDateTimeNo
DateCreatedformDateTimeNo
DateSentformDateTime?No
StaffIDformstringNo
ReferenceformstringNo
SourceIDformstringNo
SourceTypeformstringNo
SourceDisplayNoformstringNo
SY_Forms_ClassNameformstringNo
EmailStatusformbyte?No
EmailFromformstringNo
EmailToformstringNo
EmailCCformstringNo
EmailBCCformstringNo
EmailSubjectformstringNo
EmailBodyformstringNo
RequestReadReceiptformbool?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.

GET /Queries/EM_Main HTTP/1.1 
Host: localhost 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEM_Main7kRqkrSv 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/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:EM_Main>
      <d2p1:_x003C_DateCreated_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateCreated_x003E_k__BackingField>
      <d2p1:_x003C_DateSent_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateSent_x003E_k__BackingField>
      <d2p1:_x003C_EmailBCC_x003E_k__BackingField>String</d2p1:_x003C_EmailBCC_x003E_k__BackingField>
      <d2p1:_x003C_EmailBody_x003E_k__BackingField>String</d2p1:_x003C_EmailBody_x003E_k__BackingField>
      <d2p1:_x003C_EmailCC_x003E_k__BackingField>String</d2p1:_x003C_EmailCC_x003E_k__BackingField>
      <d2p1:_x003C_EmailFrom_x003E_k__BackingField>String</d2p1:_x003C_EmailFrom_x003E_k__BackingField>
      <d2p1:_x003C_EmailNo_x003E_k__BackingField>String</d2p1:_x003C_EmailNo_x003E_k__BackingField>
      <d2p1:_x003C_EmailStatus_x003E_k__BackingField>0</d2p1:_x003C_EmailStatus_x003E_k__BackingField>
      <d2p1:_x003C_EmailSubject_x003E_k__BackingField>String</d2p1:_x003C_EmailSubject_x003E_k__BackingField>
      <d2p1:_x003C_EmailTo_x003E_k__BackingField>String</d2p1:_x003C_EmailTo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Reference_x003E_k__BackingField>String</d2p1:_x003C_Reference_x003E_k__BackingField>
      <d2p1:_x003C_RequestReadReceipt_x003E_k__BackingField>false</d2p1:_x003C_RequestReadReceipt_x003E_k__BackingField>
      <d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>String</d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>
      <d2p1:_x003C_SourceDisplayNo_x003E_k__BackingField>String</d2p1:_x003C_SourceDisplayNo_x003E_k__BackingField>
      <d2p1:_x003C_SourceID_x003E_k__BackingField>String</d2p1:_x003C_SourceID_x003E_k__BackingField>
      <d2p1:_x003C_SourceType_x003E_k__BackingField>String</d2p1:_x003C_SourceType_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    </d2p1:EM_Main>
  </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>
</QueryResponseOfEM_Main7kRqkrSv>