Pera ServiceStack

<back to all web services

NoteRequest

The following routes are available for this service:
GET,PUT,DELETE,OPTIONS/v1/Note/{NoteId}
GET,POST,OPTIONS/v1/Note/{NoteTypeId}/{RecordId}

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: api2.publicemployeeretirementassistance.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/PeraServiceStackLibrary">
  <Note xmlns:d2p1="http://schemas.datacontract.org/2004/07/PeraEntities.PeraModels">
    <d2p1:CreatedBy>String</d2p1:CreatedBy>
    <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
    <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
    <d2p1:FieldName>0</d2p1:FieldName>
    <d2p1:NoteId>0</d2p1:NoteId>
    <d2p1:NoteText>String</d2p1:NoteText>
    <d2p1:NoteType>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:FieldNameId>0</d2p1:FieldNameId>
      <d2p1:NoteTypeId>Agent_Appointment_Counts</d2p1:NoteTypeId>
      <d2p1:Notes i:nil="true" />
      <d2p1:NotetypeDescription>String</d2p1:NotetypeDescription>
      <d2p1:TableName>String</d2p1:TableName>
      <d2p1:TableNameId>0</d2p1:TableNameId>
    </d2p1:NoteType>
    <d2p1:NoteTypeId>Agent_Appointment_Counts</d2p1:NoteTypeId>
    <d2p1:RecordId>0</d2p1:RecordId>
    <d2p1:TableName>0</d2p1:TableName>
    <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
  </Note>
  <NoteId>0</NoteId>
  <NoteTypeId>0</NoteTypeId>
  <RecordId>0</RecordId>
</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/PeraServiceStackLibrary">
  <Notes xmlns:d2p1="http://schemas.datacontract.org/2004/07/PeraEntities.PeraModels">
    <d2p1:Note>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:FieldName>0</d2p1:FieldName>
      <d2p1:NoteId>0</d2p1:NoteId>
      <d2p1:NoteText>String</d2p1:NoteText>
      <d2p1:NoteType>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:FieldNameId>0</d2p1:FieldNameId>
        <d2p1:NoteTypeId>Agent_Appointment_Counts</d2p1:NoteTypeId>
        <d2p1:Notes i:nil="true" />
        <d2p1:NotetypeDescription>String</d2p1:NotetypeDescription>
        <d2p1:TableName>String</d2p1:TableName>
        <d2p1:TableNameId>0</d2p1:TableNameId>
      </d2p1:NoteType>
      <d2p1:NoteTypeId>Agent_Appointment_Counts</d2p1:NoteTypeId>
      <d2p1:RecordId>0</d2p1:RecordId>
      <d2p1:TableName>0</d2p1:TableName>
      <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    </d2p1:Note>
  </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>
</NoteResponse>