Difference between revisions of "API/Account/AddNote"

From Emersion
Jump to: navigation, search
(Created page with "Start")
 
 
Line 1: Line 1:
−
Start
+
'''Purpose '''
 +
 
 +
The purpose of this API call is to permit the caller to add additional notes in the system against a customer..
 +
 
 +
 
 +
'''Inputs'''
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
      <acc:AddNote>
 +
        <acc:ObjectTypeID>1</acc:ObjectTypeID>
 +
        <acc:ObjectTypeValue>9999999</acc:ObjectTypeValue>
 +
        <acc:NoteSubject>Dummy</acc:NoteSubject>
 +
        <acc:NoteDetail>Dummy</acc:NoteDetail>
 +
        <acc:ExternalReferences>
 +
            <!--Zero or more repetitions:-->
 +
            <ext:ExternalReference Type=""></ext:ExternalReference>
 +
        </acc:ExternalReferences>
 +
        <!--Optional:-->
 +
        <acc:CategoryID>999</acc:CategoryID>
 +
        <!--Optional:-->
 +
        <acc:StaffID>999</acc:StaffID>
 +
        <!--Optional:-->
 +
        <acc:CustomerVisible></acc:CustomerVisible>
 +
      </acc:AddNote>
 +
  </soapenv:Body>
 +
 
 +
 
 +
 
 +
 
 +
'''Output'''
 +
  <SOAP-ENV:Body>
 +
      <ns1:AddNoteResponse>
 +
        <ns1:NoteID>999999</ns1:NoteID>
 +
      </ns1:AddNoteResponse>
 +
  </SOAP-ENV:Body>
 +
 
 +
 
 +
'''Error Strings'''
 +
 
 +
* "Object Type ID does not exist in the system" - Provided Object Type ID does not exist in the system
 +
* "Object Type ID must be 1 or 5" - Provided Object Type ID is out of Predefined Values (1 for Account, 5 for Service)
 +
* "Object Type ID must be Integer" - Provided Object Type ID is Not an Integer
 +
* "Missing mandatory Object Type ID" - Mandatory input parameter Object Type ID is not provided
 +
* "Object Type Value must be Integer" - Provided Object Type Value is Not an Integer
 +
* "Missing mandatory Object Type Value" - Mandatory input parameter Object Type Value is not provided
 +
* "Provided Account ID does not belong to caller Account" - Account specified in Object Type Value is not a Child of the Calling Account
 +
* "Invalid Account ID" - Account specified in Object Type Value does not exist in the system
 +
* "Invalid Service ID" - Service specified in Object Type Value does not exist in the system
 +
* "Provided Service ID does not belong to caller Account" - Service specified in Object Type Value belongs to an Account which is Not a Child of the Calling Account
 +
* "Provided Service ID does not belong to a Valid Account" - Service specified in Object Type ID does not belong to a Valid Account
 +
* "Invalid Category ID" - Category ID provided does not exist in the system under Note Ticket Category
 +
* "Category ID must be Integer" - Category ID provided is Not an Integer
 +
* "Provided Cumulus User ID is not a Staff Member" - Cumulus User ID specified as Staff ID does not belong to a Contact of Type "Staff"
 +
* "Provided Cumulus User ID does not belong to caller Account" - Cumulus User ID specified as Staff ID belongs to an Account which is Not a Child of the Calling Account
 +
* "Provided Staff ID does not exist in system" - No Cumulus User exists with the provided Staff ID
 +
* "Staff ID must be Integer" - Provided Staff ID is Not an Integer
 +
* "Customer Visible flag must be 0 or 1" - Customer Visible Flag provided does not belong to Predefined Values (0 and 1)

Latest revision as of 12:25, 23 June 2016

Purpose

The purpose of this API call is to permit the caller to add additional notes in the system against a customer..


Inputs 

  <soapenv:Header/>
  <soapenv:Body>
     <acc:AddNote>
        <acc:ObjectTypeID>1</acc:ObjectTypeID>
        <acc:ObjectTypeValue>9999999</acc:ObjectTypeValue>
        <acc:NoteSubject>Dummy</acc:NoteSubject>
        <acc:NoteDetail>Dummy</acc:NoteDetail>
        <acc:ExternalReferences>
           <ext:ExternalReference Type=""></ext:ExternalReference>
        </acc:ExternalReferences>
        <acc:CategoryID>999</acc:CategoryID>
        <acc:StaffID>999</acc:StaffID>
        <acc:CustomerVisible></acc:CustomerVisible>
     </acc:AddNote>
  </soapenv:Body>



Output 

  <SOAP-ENV:Body>
     <ns1:AddNoteResponse>
        <ns1:NoteID>999999</ns1:NoteID>
     </ns1:AddNoteResponse>
  </SOAP-ENV:Body>


Error Strings

  • "Object Type ID does not exist in the system" - Provided Object Type ID does not exist in the system
  • "Object Type ID must be 1 or 5" - Provided Object Type ID is out of Predefined Values (1 for Account, 5 for Service)
  • "Object Type ID must be Integer" - Provided Object Type ID is Not an Integer
  • "Missing mandatory Object Type ID" - Mandatory input parameter Object Type ID is not provided
  • "Object Type Value must be Integer" - Provided Object Type Value is Not an Integer
  • "Missing mandatory Object Type Value" - Mandatory input parameter Object Type Value is not provided
  • "Provided Account ID does not belong to caller Account" - Account specified in Object Type Value is not a Child of the Calling Account
  • "Invalid Account ID" - Account specified in Object Type Value does not exist in the system
  • "Invalid Service ID" - Service specified in Object Type Value does not exist in the system
  • "Provided Service ID does not belong to caller Account" - Service specified in Object Type Value belongs to an Account which is Not a Child of the Calling Account
  • "Provided Service ID does not belong to a Valid Account" - Service specified in Object Type ID does not belong to a Valid Account
  • "Invalid Category ID" - Category ID provided does not exist in the system under Note Ticket Category
  • "Category ID must be Integer" - Category ID provided is Not an Integer
  • "Provided Cumulus User ID is not a Staff Member" - Cumulus User ID specified as Staff ID does not belong to a Contact of Type "Staff"
  • "Provided Cumulus User ID does not belong to caller Account" - Cumulus User ID specified as Staff ID belongs to an Account which is Not a Child of the Calling Account
  • "Provided Staff ID does not exist in system" - No Cumulus User exists with the provided Staff ID
  • "Staff ID must be Integer" - Provided Staff ID is Not an Integer
  • "Customer Visible flag must be 0 or 1" - Customer Visible Flag provided does not belong to Predefined Values (0 and 1)
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Account/AddNote&oldid=4654"