JiwaAPI

<back to all web services

EmailMessagePATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/EmailMessages/{EmailMessageID}Updates an email message.
EmailMessagePATCHRequest Parameters:
NameParameterData TypeRequiredDescription
EmailMessageIDpathstringNo
EmailMessage Parameters:
NameParameterData TypeRequiredDescription
EmailMessageIDformstringNo
EmailNoformstringNo
DateCreatedformDateTime?No
DateSentformDateTime?No
ReferenceformstringNo
SourceIDformstringNo
SourceTypeformstringNo
SourceDisplayNoformstringNo
SourceFormformstringNo
StatusformEmailStatuses?No
StaffformStaffMemberNo
EmailFromformstringNo
EmailToformstringNo
RequestReadReceiptformbool?No
EmailCCformstringNo
EmailBCCformstringNo
EmailSubjectformstringNo
EmailBodyformstringNo
AttachmentsformList<Document>No
BodyIsHTMLformbool?No
LastSavedDateTimeformDateTime?No
StaffMember Parameters:
NameParameterData TypeRequiredDescription
StaffIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
UsernameformstringNo
IsActiveformbool?No
IsEnabledformbool?No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]No
EmailMessage Parameters:
NameParameterData TypeRequiredDescription
EmailMessageIDformstringNo
EmailNoformstringNo
DateCreatedformDateTime?No
DateSentformDateTime?No
ReferenceformstringNo
SourceIDformstringNo
SourceTypeformstringNo
SourceDisplayNoformstringNo
SourceFormformstringNo
StatusformEmailStatuses?No
StaffformStaffMemberNo
EmailFromformstringNo
EmailToformstringNo
RequestReadReceiptformbool?No
EmailCCformstringNo
EmailBCCformstringNo
EmailSubjectformstringNo
EmailBodyformstringNo
AttachmentsformList<Document>No
BodyIsHTMLformbool?No
LastSavedDateTimeformDateTime?No

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.

PATCH /EmailMessages/{EmailMessageID} HTTP/1.1 
Host: localhost 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EmailMessagePATCHRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
  <_x003C_Attachments_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Documents" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">
    <d2p1:Document>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_DocumentID_x003E_k__BackingField>String</d2p1:_x003C_DocumentID_x003E_k__BackingField>
      <d2p1:_x003C_DocumentType_x003E_k__BackingField>
        <d2p1:_x003C_DefaultType_x003E_k__BackingField>false</d2p1:_x003C_DefaultType_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>String</d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>
        <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
        <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
        <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      </d2p1:_x003C_DocumentType_x003E_k__BackingField>
      <d2p1:_x003C_FileBinary_x003E_k__BackingField>AA==</d2p1:_x003C_FileBinary_x003E_k__BackingField>
      <d2p1:_x003C_FileID_x003E_k__BackingField>String</d2p1:_x003C_FileID_x003E_k__BackingField>
      <d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>
    </d2p1:Document>
  </_x003C_Attachments_x003E_k__BackingField>
  <_x003C_BodyIsHTML_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">false</_x003C_BodyIsHTML_x003E_k__BackingField>
  <_x003C_DateCreated_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_DateSent_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_EmailBCC_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailBCC_x003E_k__BackingField>
  <_x003C_EmailBody_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailBody_x003E_k__BackingField>
  <_x003C_EmailCC_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailCC_x003E_k__BackingField>
  <_x003C_EmailFrom_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailFrom_x003E_k__BackingField>
  <_x003C_EmailMessageID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_EmailNo_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_EmailSubject_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailSubject_x003E_k__BackingField>
  <_x003C_EmailTo_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_EmailTo_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_Reference_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">String</_x003C_Reference_x003E_k__BackingField>
  <_x003C_RequestReadReceipt_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">false</_x003C_RequestReadReceipt_x003E_k__BackingField>
  <_x003C_SourceDisplayNo_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_SourceForm_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_SourceID_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_SourceType_x003E_k__BackingField i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_Staff_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Staff" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email" />
  <_x003C_Status_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">Entered</_x003C_Status_x003E_k__BackingField>
  <_x003C_DateCreated_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateCreated_x003E_k__BackingField>
  <_x003C_DateSent_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateSent_x003E_k__BackingField>
  <_x003C_EmailMessageID_x003E_k__BackingField>String</_x003C_EmailMessageID_x003E_k__BackingField>
  <_x003C_EmailNo_x003E_k__BackingField>String</_x003C_EmailNo_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_SourceDisplayNo_x003E_k__BackingField>String</_x003C_SourceDisplayNo_x003E_k__BackingField>
  <_x003C_SourceForm_x003E_k__BackingField>String</_x003C_SourceForm_x003E_k__BackingField>
  <_x003C_SourceID_x003E_k__BackingField>String</_x003C_SourceID_x003E_k__BackingField>
  <_x003C_SourceType_x003E_k__BackingField>String</_x003C_SourceType_x003E_k__BackingField>
  <_x003C_Staff_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Staff">
    <d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
    <d2p1:_x003C_IsActive_x003E_k__BackingField>false</d2p1:_x003C_IsActive_x003E_k__BackingField>
    <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
    <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    <d2p1:_x003C_Surname_x003E_k__BackingField>String</d2p1:_x003C_Surname_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </_x003C_Staff_x003E_k__BackingField>
</EmailMessagePATCHRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Email">
  <_x003C_Attachments_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Documents">
    <d2p1:Document>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_DocumentID_x003E_k__BackingField>String</d2p1:_x003C_DocumentID_x003E_k__BackingField>
      <d2p1:_x003C_DocumentType_x003E_k__BackingField>
        <d2p1:_x003C_DefaultType_x003E_k__BackingField>false</d2p1:_x003C_DefaultType_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>String</d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>
        <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
        <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
        <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      </d2p1:_x003C_DocumentType_x003E_k__BackingField>
      <d2p1:_x003C_FileBinary_x003E_k__BackingField>AA==</d2p1:_x003C_FileBinary_x003E_k__BackingField>
      <d2p1:_x003C_FileID_x003E_k__BackingField>String</d2p1:_x003C_FileID_x003E_k__BackingField>
      <d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>
    </d2p1:Document>
  </_x003C_Attachments_x003E_k__BackingField>
  <_x003C_BodyIsHTML_x003E_k__BackingField>false</_x003C_BodyIsHTML_x003E_k__BackingField>
  <_x003C_DateCreated_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateCreated_x003E_k__BackingField>
  <_x003C_DateSent_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateSent_x003E_k__BackingField>
  <_x003C_EmailBCC_x003E_k__BackingField>String</_x003C_EmailBCC_x003E_k__BackingField>
  <_x003C_EmailBody_x003E_k__BackingField>String</_x003C_EmailBody_x003E_k__BackingField>
  <_x003C_EmailCC_x003E_k__BackingField>String</_x003C_EmailCC_x003E_k__BackingField>
  <_x003C_EmailFrom_x003E_k__BackingField>String</_x003C_EmailFrom_x003E_k__BackingField>
  <_x003C_EmailMessageID_x003E_k__BackingField>String</_x003C_EmailMessageID_x003E_k__BackingField>
  <_x003C_EmailNo_x003E_k__BackingField>String</_x003C_EmailNo_x003E_k__BackingField>
  <_x003C_EmailSubject_x003E_k__BackingField>String</_x003C_EmailSubject_x003E_k__BackingField>
  <_x003C_EmailTo_x003E_k__BackingField>String</_x003C_EmailTo_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Reference_x003E_k__BackingField>String</_x003C_Reference_x003E_k__BackingField>
  <_x003C_RequestReadReceipt_x003E_k__BackingField>false</_x003C_RequestReadReceipt_x003E_k__BackingField>
  <_x003C_SourceDisplayNo_x003E_k__BackingField>String</_x003C_SourceDisplayNo_x003E_k__BackingField>
  <_x003C_SourceForm_x003E_k__BackingField>String</_x003C_SourceForm_x003E_k__BackingField>
  <_x003C_SourceID_x003E_k__BackingField>String</_x003C_SourceID_x003E_k__BackingField>
  <_x003C_SourceType_x003E_k__BackingField>String</_x003C_SourceType_x003E_k__BackingField>
  <_x003C_Staff_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Staff">
    <d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
    <d2p1:_x003C_IsActive_x003E_k__BackingField>false</d2p1:_x003C_IsActive_x003E_k__BackingField>
    <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
    <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    <d2p1:_x003C_Surname_x003E_k__BackingField>String</d2p1:_x003C_Surname_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </_x003C_Staff_x003E_k__BackingField>
  <_x003C_Status_x003E_k__BackingField>Entered</_x003C_Status_x003E_k__BackingField>
</EmailMessage>