CRMInvoiceDetail.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an invoice detail and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InvoiceDetailId As String,
ByVal InInvoiceDetailXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string InvoiceDetailId,
string InInvoiceDetailXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* InvoiceDetailId,
String* InInvoiceDetailXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteInvoice and prvReadInvoice privileges and access rights on the object to be updated. See CUserAuth.
InvoiceDetailId
Specifies the ID of the invoice detail to be updated.
InInvoiceDetailXml
Specifies an XML string containing the invoice detail information. The XML schema is described by invoicedetail.xsd.
Return Value
Returns a String type that specifies the XML data containing the complete invoice detail information. The XML schema is described by invoicedetail.xsd.
Remarks
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMInvoiceDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMInvoiceDetail invoicedetail = new Microsoft.Crm.Platform.Proxy.CRMInvoiceDetail();
invoicedetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
invoicedetail.Url = strDir + "CRMInvoiceDetail.srf";
string strErrorMsg;
string strInvoiceDetailId = "{AP22D809-J752-8855-A2B0-51494C6957C3}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the invoice detail
string strInvoiceDetail = "<invoicedetail>";
strInvoiceDetail += "<description>desc 2</description>";
strInvoiceDetail += "</invoicedetail>";
// Update and then retrieve the invoice detail
string strInvoiceDetailXml = invoicedetail.UpdateAndRetrieve(userAuth, strInvoiceDetailId, strInvoiceDetail);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also