Sha256: 24aa9290f92623087146fee0a694a4c4f8076253a76ed19cb5855ab8662b1903

Contents?: true

Size: 1.58 KB

Versions: 3

Compression:

Stored size: 1.58 KB

Contents

= caseblocks_api

Authenticate with CaseBlocks:

`caseblocks = CaseblocksAPI::Client.new("email@test.com", "some_password", "some_url")`

Create a new Case:

`caseblocks.create_case({:title => "This is a Case!", :due_at => "tomorrow")`

Searching for cases:

`caseblocks.search('CaseTypeName', {telephone_number: '12334', given_name: 'Smith'})`

Searching with pagination:

`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, page: 0, page_size: 10)`

Searching with sorting:

`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, sort_by: [{field: 'created_at', direction: 'desc'}])`
`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, sort_by: [{field: 'created_at', direction: 'asc'}])`

Searching for a reduced response:

`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, fields: ['id', 'given_name', ''created_at'])`

== Contributing to caseblocks_api
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2012 EmergeAdapt. See LICENSE.txt for
further details.



Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
caseblocks_api-0.2.16 README.md
caseblocks_api-0.2.15 README.md
caseblocks_api-0.2.14 README.md