Pera ServiceStack

<back to all web services

CRM_AttachmentRequest

The following routes are available for this service:
GET,PUT,DELETE,OPTIONS/v1/CRM_Attachment/{AttachmentId}
POST,OPTIONS/v1/CRM_Attachment/{TableName}/{FieldName}/{RecordId}
POST,OPTIONS/v1/CRM_Attachment/{TableName}/{FieldName}/{RecordId}/{NeedsOCR}

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/CRM_AttachmentRequest HTTP/1.1 
Host: api2.publicemployeeretirementassistance.com 
Content-Type: application/xml
Content-Length: length

<CRM_AttachmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraServiceStackLibrary">
  <Attachment>
    <CRM_Attachment>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </CRM_Attachment>
  </Attachment>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <FieldName>String</FieldName>
  <NeedsOCR>false</NeedsOCR>
  <RecordId>0</RecordId>
  <TableName>String</TableName>
</CRM_AttachmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRM_AttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraServiceStackLibrary">
  <Attachment>
    <CRM_Attachment>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </CRM_Attachment>
  </Attachment>
  <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>
</CRM_AttachmentResponse>