Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
EmailFrom | query | string | No | |
EmailFromStartsWith | query | string | No | |
EmailFromEndsWith | query | string | No | |
EmailFromContains | query | string | No | |
EmailFromLike | query | string | No | |
EmailFromBetween | query | string[] | No | |
EmailFromIn | query | string[] | No | |
EmailTo | query | string | No | |
EmailToStartsWith | query | string | No | |
EmailToEndsWith | query | string | No | |
EmailToContains | query | string | No | |
EmailToLike | query | string | No | |
EmailToBetween | query | string[] | No | |
EmailToIn | query | string[] | No | |
RequestReadReceipt | query | bool? | No | |
EmailCC | query | string | No | |
EmailCCStartsWith | query | string | No | |
EmailCCEndsWith | query | string | No | |
EmailCCContains | query | string | No | |
EmailCCLike | query | string | No | |
EmailCCBetween | query | string[] | No | |
EmailCCIn | query | string[] | No | |
EmailBCC | query | string | No | |
EmailBCCStartsWith | query | string | No | |
EmailBCCEndsWith | query | string | No | |
EmailBCCContains | query | string | No | |
EmailBCCLike | query | string | No | |
EmailBCCBetween | query | string[] | No | |
EmailBCCIn | query | string[] | No | |
EmailSubject | query | string | No | |
EmailSubjectStartsWith | query | string | No | |
EmailSubjectEndsWith | query | string | No | |
EmailSubjectContains | query | string | No | |
EmailSubjectLike | query | string | No | |
EmailSubjectBetween | query | string[] | No | |
EmailSubjectIn | query | string[] | No | |
EmailBody | query | string | No | |
EmailBodyStartsWith | query | string | No | |
EmailBodyEndsWith | query | string | No | |
EmailBodyContains | query | string | No | |
EmailBodyLike | query | string | No | |
EmailBodyBetween | query | string[] | No | |
EmailBodyIn | query | string[] | No | |
CreatedByStaffID | query | string | No | |
CreatedByStaffIDStartsWith | query | string | No | |
CreatedByStaffIDEndsWith | query | string | No | |
CreatedByStaffIDContains | query | string | No | |
CreatedByStaffIDLike | query | string | No | |
CreatedByStaffIDBetween | query | string[] | No | |
CreatedByStaffIDIn | query | string[] | No | |
CreatedDateTime | query | DateTime? | No | |
CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeGreaterThan | query | DateTime? | No | |
CreatedDateTimeLessThan | query | DateTime? | No | |
CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
CreatedDateTimeNotEqualTo | query | DateTime? | No | |
CreatedDateTimeBetween | query | DateTime[] | No | |
CreatedDateTimeIn | query | DateTime[] | No | |
LastSavedByStaffID | query | string | No | |
LastSavedByStaffIDStartsWith | query | string | No | |
LastSavedByStaffIDEndsWith | query | string | No | |
LastSavedByStaffIDContains | query | string | No | |
LastSavedByStaffIDLike | query | string | No | |
LastSavedByStaffIDBetween | query | string[] | No | |
LastSavedByStaffIDIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
DefaultItem | query | bool? | 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 |
---|---|---|---|---|
RecID | form | string | No | |
Name | form | string | No | |
EmailFrom | form | string | No | |
EmailTo | form | string | No | |
RequestReadReceipt | form | bool? | No | |
EmailCC | form | string | No | |
EmailBCC | form | string | No | |
EmailSubject | form | string | No | |
EmailBody | form | string | No | |
CreatedByStaffID | form | string | No | |
CreatedDateTime | form | DateTime | No | |
LastSavedByStaffID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
DefaultItem | form | bool? | 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/EM_TemplatesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<EM_TemplatesQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<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>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<CreatedByStaffID>String</CreatedByStaffID>
<CreatedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreatedByStaffIDBetween>
<CreatedByStaffIDContains>String</CreatedByStaffIDContains>
<CreatedByStaffIDEndsWith>String</CreatedByStaffIDEndsWith>
<CreatedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreatedByStaffIDIn>
<CreatedByStaffIDLike>String</CreatedByStaffIDLike>
<CreatedByStaffIDStartsWith>String</CreatedByStaffIDStartsWith>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CreatedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</CreatedDateTimeBetween>
<CreatedDateTimeGreaterThan>0001-01-01T00:00:00</CreatedDateTimeGreaterThan>
<CreatedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeGreaterThanOrEqualTo>
<CreatedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</CreatedDateTimeIn>
<CreatedDateTimeLessThan>0001-01-01T00:00:00</CreatedDateTimeLessThan>
<CreatedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeLessThanOrEqualTo>
<CreatedDateTimeNotEqualTo>0001-01-01T00:00:00</CreatedDateTimeNotEqualTo>
<DefaultItem>false</DefaultItem>
<EmailBCC>String</EmailBCC>
<EmailBCCBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailBCCBetween>
<EmailBCCContains>String</EmailBCCContains>
<EmailBCCEndsWith>String</EmailBCCEndsWith>
<EmailBCCIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailBCCIn>
<EmailBCCLike>String</EmailBCCLike>
<EmailBCCStartsWith>String</EmailBCCStartsWith>
<EmailBody>String</EmailBody>
<EmailBodyBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailBodyBetween>
<EmailBodyContains>String</EmailBodyContains>
<EmailBodyEndsWith>String</EmailBodyEndsWith>
<EmailBodyIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailBodyIn>
<EmailBodyLike>String</EmailBodyLike>
<EmailBodyStartsWith>String</EmailBodyStartsWith>
<EmailCC>String</EmailCC>
<EmailCCBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailCCBetween>
<EmailCCContains>String</EmailCCContains>
<EmailCCEndsWith>String</EmailCCEndsWith>
<EmailCCIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailCCIn>
<EmailCCLike>String</EmailCCLike>
<EmailCCStartsWith>String</EmailCCStartsWith>
<EmailFrom>String</EmailFrom>
<EmailFromBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailFromBetween>
<EmailFromContains>String</EmailFromContains>
<EmailFromEndsWith>String</EmailFromEndsWith>
<EmailFromIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailFromIn>
<EmailFromLike>String</EmailFromLike>
<EmailFromStartsWith>String</EmailFromStartsWith>
<EmailSubject>String</EmailSubject>
<EmailSubjectBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailSubjectBetween>
<EmailSubjectContains>String</EmailSubjectContains>
<EmailSubjectEndsWith>String</EmailSubjectEndsWith>
<EmailSubjectIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailSubjectIn>
<EmailSubjectLike>String</EmailSubjectLike>
<EmailSubjectStartsWith>String</EmailSubjectStartsWith>
<EmailTo>String</EmailTo>
<EmailToBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailToBetween>
<EmailToContains>String</EmailToContains>
<EmailToEndsWith>String</EmailToEndsWith>
<EmailToIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EmailToIn>
<EmailToLike>String</EmailToLike>
<EmailToStartsWith>String</EmailToStartsWith>
<LastSavedByStaffID>String</LastSavedByStaffID>
<LastSavedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastSavedByStaffIDBetween>
<LastSavedByStaffIDContains>String</LastSavedByStaffIDContains>
<LastSavedByStaffIDEndsWith>String</LastSavedByStaffIDEndsWith>
<LastSavedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</LastSavedByStaffIDIn>
<LastSavedByStaffIDLike>String</LastSavedByStaffIDLike>
<LastSavedByStaffIDStartsWith>String</LastSavedByStaffIDStartsWith>
<LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
<LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeBetween>
<LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
<LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
<LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</LastSavedDateTimeIn>
<LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
<LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
<LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
<Name>String</Name>
<NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameBetween>
<NameContains>String</NameContains>
<NameEndsWith>String</NameEndsWith>
<NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameIn>
<NameLike>String</NameLike>
<NameStartsWith>String</NameStartsWith>
<RecID>String</RecID>
<RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDBetween>
<RecIDContains>String</RecIDContains>
<RecIDEndsWith>String</RecIDEndsWith>
<RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RecIDIn>
<RecIDLike>String</RecIDLike>
<RecIDStartsWith>String</RecIDStartsWith>
<RequestReadReceipt>false</RequestReadReceipt>
</EM_TemplatesQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfEM_Templates7kRqkrSv 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_Templates> <d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField> <d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreatedDateTime_x003E_k__BackingField> <d2p1:_x003C_DefaultItem_x003E_k__BackingField>false</d2p1:_x003C_DefaultItem_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_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_LastSavedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_RequestReadReceipt_x003E_k__BackingField>false</d2p1:_x003C_RequestReadReceipt_x003E_k__BackingField> </d2p1:EM_Templates> </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_Templates7kRqkrSv>