Bombshell Agency Platform Service

<back to all web services

ContactNoteRequest

The following routes are available for this service:
POST,OPTIONS/v1/ContactNote
GET,POST,PUT,DELETE,OPTIONS/v1/ContactNote/{ContactNoteId}
GET,OPTIONS/v1/ContactNote/Contact/{ContactId}

To override the Content-type in your clients 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.

POST /xml/reply/ContactNoteRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: application/xml
Content-Length: length

<ContactNoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <ContactNoteId>0</ContactNoteId>
  <Note>
    <ContactId>0</ContactId>
    <ContactNoteId>0</ContactNoteId>
    <CreatedBy>String</CreatedBy>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <NoteText>String</NoteText>
    <UpdatedBy>String</UpdatedBy>
    <UpdatedByUserId>00000000-0000-0000-0000-000000000000</UpdatedByUserId>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
  </Note>
</ContactNoteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <Notes>
    <ContactNote>
      <ContactId>0</ContactId>
      <ContactNoteId>0</ContactNoteId>
      <CreatedBy>String</CreatedBy>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedDate>
      <NoteText>String</NoteText>
      <UpdatedBy>String</UpdatedBy>
      <UpdatedByUserId>00000000-0000-0000-0000-000000000000</UpdatedByUserId>
      <UpdatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </UpdatedDate>
    </ContactNote>
  </Notes>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</ContactNoteResponse>