Bombshell Agency Platform Service

<back to all web services

NoteRequest

The following routes are available for this service:
POST,PUT,OPTIONS/Note

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/NoteRequest HTTP/1.1 
Host: api.responsible-advisor.com 
Content-Type: application/xml
Content-Length: length

<NoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <Delete>false</Delete>
  <InputObject>
    <CreatedBy>String</CreatedBy>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateUpdated>0001-01-01T00:00:00</DateUpdated>
    <FieldName>String</FieldName>
    <Id>0</Id>
    <NoteText>String</NoteText>
    <NoteType>
      <FieldName>String</FieldName>
      <FieldNameId>0</FieldNameId>
      <NoteTypeId>Agent_Appointment_Counts</NoteTypeId>
      <NotetypeDescription>String</NotetypeDescription>
      <TableName>String</TableName>
      <TableNameId>0</TableNameId>
    </NoteType>
    <NoteTypeId>Agent_Appointment_Counts</NoteTypeId>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
    <UpdatedBy>String</UpdatedBy>
  </InputObject>
  <Insert>false</Insert>
  <Update>false</Update>
</NoteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <OutputObject>
    <CreatedBy>String</CreatedBy>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateUpdated>0001-01-01T00:00:00</DateUpdated>
    <FieldName>String</FieldName>
    <Id>0</Id>
    <NoteText>String</NoteText>
    <NoteType>
      <FieldName>String</FieldName>
      <FieldNameId>0</FieldNameId>
      <NoteTypeId>Agent_Appointment_Counts</NoteTypeId>
      <NotetypeDescription>String</NotetypeDescription>
      <TableName>String</TableName>
      <TableNameId>0</TableNameId>
    </NoteType>
    <NoteTypeId>Agent_Appointment_Counts</NoteTypeId>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
    <UpdatedBy>String</UpdatedBy>
  </OutputObject>
  <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>
</NoteResponse>