Capsule API

Case API History

Data Reference

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<historyItem>
    <
id>100</id> <!-- integer -->
    <
type>Note</type> <!-- read-only -->
    <
entryDate>2009-09-11T16:07:49Z</entryDate
        <!-- 
optional, default to now -- >
    <
creator>jdoe</creator> <!-- optional, default to current user -- >
    <
subject>Lorem ipsum dolor sit ametconsectetur adipiscing elit
Nulla mollis ullam...</subject> <!-- read only -- >
    <
note>Lorem ipsum dolor sit ametconsectetur adipiscing elit
Nulla mollis ullamcorper vehicula.</note> <!-- required -->
    <
attachments> <!-- attachments are read-only -->
        <
attachment>
            <
id>20</id>
            <
filename>latin.doc</filename>
        </
attachment>
    </
attachments>
</
historyItem

List History for Case

GET /api/kase/{case-id}/history

History of notes and emails for case records.

Example response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<history size="1">
    <
historyItem>
        <
id>100</id>
        <
type>Note</type>
        <
entryDate>2009-09-11T16:07:49Z</entryDate>
        <
creator>jdoe</creator>
        <
subject>Lorem ipsum dolor sit ametconsectetur adipiscing elitNulla mollis ullam...</subject>
        <
note>Lorem ipsum dolor sit ametconsectetur adipiscing elitNulla mollis ullamcorper vehicula.</note>
        <
attachments>
            <
attachment>
                <
id>20</id>
                <
filename>latin.doc</filename>
            </
attachment>
        </
attachments>
    </
historyItem>
</
history

Add Note to Case

POST /api/kase/{case-id}/history

Entry date and creator can be excluded when adding the note. When excluded the entry date will be defaulted to now and the creator will be defaulted to the authenticated user.

Example request:

<?xml version="1.0"?>
<historyItem>
    <
note>Lorem ipsum dolor sit ametconsectetur adipisicing elitsed do eiusmod tempor incididunt.</note>
</
historyItem

Update Note on Case

PUT /api/kase/{case-id}/history/{history-id}

 

Delete Note from Case

DELETE /api/kase/{case-id}/history/{history-id}

 

 

Capsule is a service of Zestia Ltd which is a company registered in England with company number 06418281. © 2008-2012 Zestia Ltd. All Rights Reserved.