Core Case Data - Data store API

CallbackEndpoint

getPrintableDocumentsUsingPOST

Get printable documents

Retrieve a list of printable documents for a case


/callback/jurisdictions/{jid}/case-types/{ctid}/documents

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/callback/jurisdictions/{jid}/case-types/{ctid}/documents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallbackEndpointApi;

import java.io.File;
import java.util.*;

public class CallbackEndpointApiExample {

    public static void main(String[] args) {
        
        CallbackEndpointApi apiInstance = new CallbackEndpointApi();
        CaseDetails caseDetails = ; // CaseDetails | caseDetails
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        try {
            array[Document] result = apiInstance.getPrintableDocumentsUsingPOST(caseDetails, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackEndpointApi#getPrintableDocumentsUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallbackEndpointApi;

public class CallbackEndpointApiExample {

    public static void main(String[] args) {
        CallbackEndpointApi apiInstance = new CallbackEndpointApi();
        CaseDetails caseDetails = ; // CaseDetails | caseDetails
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        try {
            array[Document] result = apiInstance.getPrintableDocumentsUsingPOST(caseDetails, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackEndpointApi#getPrintableDocumentsUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDetails *caseDetails = ; // caseDetails
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID

CallbackEndpointApi *apiInstance = [[CallbackEndpointApi alloc] init];

// Get printable documents
[apiInstance getPrintableDocumentsUsingPOSTWith:caseDetails
    ctid:ctid
    jid:jid
              completionHandler: ^(array[Document] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CallbackEndpointApi()

var caseDetails = ; // {CaseDetails} caseDetails

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrintableDocumentsUsingPOST(caseDetails, ctid, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPrintableDocumentsUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CallbackEndpointApi();
            var caseDetails = new CaseDetails(); // CaseDetails | caseDetails
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID

            try
            {
                // Get printable documents
                array[Document] result = apiInstance.getPrintableDocumentsUsingPOST(caseDetails, ctid, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackEndpointApi.getPrintableDocumentsUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CallbackEndpointApi();
$caseDetails = ; // CaseDetails | caseDetails
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID

try {
    $result = $api_instance->getPrintableDocumentsUsingPOST($caseDetails, $ctid, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackEndpointApi->getPrintableDocumentsUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallbackEndpointApi;

my $api_instance = WWW::SwaggerClient::CallbackEndpointApi->new();
my $caseDetails = WWW::SwaggerClient::Object::CaseDetails->new(); # CaseDetails | caseDetails
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID

eval { 
    my $result = $api_instance->getPrintableDocumentsUsingPOST(caseDetails => $caseDetails, ctid => $ctid, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CallbackEndpointApi->getPrintableDocumentsUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CallbackEndpointApi()
caseDetails =  # CaseDetails | caseDetails
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID

try: 
    # Get printable documents
    api_response = api_instance.get_printable_documents_using_post(caseDetails, ctid, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallbackEndpointApi->getPrintableDocumentsUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
Body parameters
Name Description
caseDetails *

Responses

Status: 200 - Printable documents list retrieved


CaseAccessEndpoint

findCaseIdsGivenUserIdHasAccessToUsingGET

Get case ids

Retrieve case ids for given users ids


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/ids

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/ids?userId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseAccessEndpointApi;

import java.io.File;
import java.util.*;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        String userId = userId_example; // String | User id searching for
        try {
            array['String'] result = apiInstance.findCaseIdsGivenUserIdHasAccessToUsingGET(ctid, jid, uid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#findCaseIdsGivenUserIdHasAccessToUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseAccessEndpointApi;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        String userId = userId_example; // String | User id searching for
        try {
            array['String'] result = apiInstance.findCaseIdsGivenUserIdHasAccessToUsingGET(ctid, jid, uid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#findCaseIdsGivenUserIdHasAccessToUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
Integer *uid = 56; // Idam user ID
String *userId = userId_example; // User id searching for

CaseAccessEndpointApi *apiInstance = [[CaseAccessEndpointApi alloc] init];

// Get case ids
[apiInstance findCaseIdsGivenUserIdHasAccessToUsingGETWith:ctid
    jid:jid
    uid:uid
    userId:userId
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseAccessEndpointApi()

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = 56; // {Integer} Idam user ID

var userId = userId_example; // {String} User id searching for


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaseIdsGivenUserIdHasAccessToUsingGET(ctid, jid, uid, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaseIdsGivenUserIdHasAccessToUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseAccessEndpointApi();
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = 56;  // Integer | Idam user ID
            var userId = userId_example;  // String | User id searching for

            try
            {
                // Get case ids
                array['String'] result = apiInstance.findCaseIdsGivenUserIdHasAccessToUsingGET(ctid, jid, uid, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseAccessEndpointApi.findCaseIdsGivenUserIdHasAccessToUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseAccessEndpointApi();
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = 56; // Integer | Idam user ID
$userId = userId_example; // String | User id searching for

try {
    $result = $api_instance->findCaseIdsGivenUserIdHasAccessToUsingGET($ctid, $jid, $uid, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseAccessEndpointApi->findCaseIdsGivenUserIdHasAccessToUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseAccessEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseAccessEndpointApi->new();
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = 56; # Integer | Idam user ID
my $userId = userId_example; # String | User id searching for

eval { 
    my $result = $api_instance->findCaseIdsGivenUserIdHasAccessToUsingGET(ctid => $ctid, jid => $jid, uid => $uid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseAccessEndpointApi->findCaseIdsGivenUserIdHasAccessToUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseAccessEndpointApi()
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = 56 # Integer | Idam user ID
userId = userId_example # String | User id searching for

try: 
    # Get case ids
    api_response = api_instance.find_case_ids_given_user_id_has_access_to_using_get(ctid, jid, uid, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseAccessEndpointApi->findCaseIdsGivenUserIdHasAccessToUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
Integer (int32)
Idam user ID
Required
Query parameters
Name Description
userId*
String
User id searching for
Required

Responses

Status: 200 - List of cases ids found

Status: 400 - Invalid case ID


grantAccessToCaseUsingPOST

Grant access to case


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseAccessEndpointApi;

import java.io.File;
import java.util.*;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        UserId id = ; // UserId | id
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            apiInstance.grantAccessToCaseUsingPOST(cid, ctid, id, jid, uid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#grantAccessToCaseUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseAccessEndpointApi;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        UserId id = ; // UserId | id
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            apiInstance.grantAccessToCaseUsingPOST(cid, ctid, id, jid, uid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#grantAccessToCaseUsingPOST");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
UserId *id = ; // id
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseAccessEndpointApi *apiInstance = [[CaseAccessEndpointApi alloc] init];

// Grant access to case
[apiInstance grantAccessToCaseUsingPOSTWith:cid
    ctid:ctid
    id:id
    jid:jid
    uid:uid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseAccessEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var id = ; // {UserId} id

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.grantAccessToCaseUsingPOST(cid, ctid, id, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class grantAccessToCaseUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseAccessEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var id = new UserId(); // UserId | id
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Grant access to case
                apiInstance.grantAccessToCaseUsingPOST(cid, ctid, id, jid, uid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseAccessEndpointApi.grantAccessToCaseUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseAccessEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$id = ; // UserId | id
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $api_instance->grantAccessToCaseUsingPOST($cid, $ctid, $id, $jid, $uid);
} catch (Exception $e) {
    echo 'Exception when calling CaseAccessEndpointApi->grantAccessToCaseUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseAccessEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseAccessEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $id = WWW::SwaggerClient::Object::UserId->new(); # UserId | id
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    $api_instance->grantAccessToCaseUsingPOST(cid => $cid, ctid => $ctid, id => $id, jid => $jid, uid => $uid);
};
if ($@) {
    warn "Exception when calling CaseAccessEndpointApi->grantAccessToCaseUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseAccessEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
id =  # UserId | id
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Grant access to case
    api_instance.grant_access_to_case_using_post(cid, ctid, id, jid, uid)
except ApiException as e:
    print("Exception when calling CaseAccessEndpointApi->grantAccessToCaseUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
id *

Responses

Status: 201 - Grant successful

Status: 400 - Invalid case ID


revokeAccessToCaseUsingDELETE

Revoke access to case


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users/{idToDelete}

Usage and SDK Samples

curl -X DELETE "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users/{idToDelete}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseAccessEndpointApi;

import java.io.File;
import java.util.*;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String idToDelete = idToDelete_example; // String | Id to delete
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        try {
            apiInstance.revokeAccessToCaseUsingDELETE(cid, ctid, idToDelete, jid, uid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#revokeAccessToCaseUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseAccessEndpointApi;

public class CaseAccessEndpointApiExample {

    public static void main(String[] args) {
        CaseAccessEndpointApi apiInstance = new CaseAccessEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String idToDelete = idToDelete_example; // String | Id to delete
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        try {
            apiInstance.revokeAccessToCaseUsingDELETE(cid, ctid, idToDelete, jid, uid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseAccessEndpointApi#revokeAccessToCaseUsingDELETE");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *idToDelete = idToDelete_example; // Id to delete
String *jid = jid_example; // Jurisdiction ID
Integer *uid = 56; // Idam user ID

CaseAccessEndpointApi *apiInstance = [[CaseAccessEndpointApi alloc] init];

// Revoke access to case
[apiInstance revokeAccessToCaseUsingDELETEWith:cid
    ctid:ctid
    idToDelete:idToDelete
    jid:jid
    uid:uid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseAccessEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var idToDelete = idToDelete_example; // {String} Id to delete

var jid = jid_example; // {String} Jurisdiction ID

var uid = 56; // {Integer} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.revokeAccessToCaseUsingDELETE(cid, ctid, idToDelete, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class revokeAccessToCaseUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new CaseAccessEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var idToDelete = idToDelete_example;  // String | Id to delete
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = 56;  // Integer | Idam user ID

            try
            {
                // Revoke access to case
                apiInstance.revokeAccessToCaseUsingDELETE(cid, ctid, idToDelete, jid, uid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseAccessEndpointApi.revokeAccessToCaseUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseAccessEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$idToDelete = idToDelete_example; // String | Id to delete
$jid = jid_example; // String | Jurisdiction ID
$uid = 56; // Integer | Idam user ID

try {
    $api_instance->revokeAccessToCaseUsingDELETE($cid, $ctid, $idToDelete, $jid, $uid);
} catch (Exception $e) {
    echo 'Exception when calling CaseAccessEndpointApi->revokeAccessToCaseUsingDELETE: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseAccessEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseAccessEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $idToDelete = idToDelete_example; # String | Id to delete
my $jid = jid_example; # String | Jurisdiction ID
my $uid = 56; # Integer | Idam user ID

eval { 
    $api_instance->revokeAccessToCaseUsingDELETE(cid => $cid, ctid => $ctid, idToDelete => $idToDelete, jid => $jid, uid => $uid);
};
if ($@) {
    warn "Exception when calling CaseAccessEndpointApi->revokeAccessToCaseUsingDELETE: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseAccessEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
idToDelete = idToDelete_example # String | Id to delete
jid = jid_example # String | Jurisdiction ID
uid = 56 # Integer | Idam user ID

try: 
    # Revoke access to case
    api_instance.revoke_access_to_case_using_delete(cid, ctid, idToDelete, jid, uid)
except ApiException as e:
    print("Exception when calling CaseAccessEndpointApi->revokeAccessToCaseUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
idToDelete*
String
Id to delete
Required
jid*
String
Jurisdiction ID
Required
uid*
Integer (int32)
Idam user ID
Required

Responses

Status: 204 - Access revoked

Status: 400 - Invalid case ID


CaseDetailsEndpoint

createCaseEventForCaseWorkerUsingPOST

Submit event creation as Case worker

Complete the event creation process. This requires a valid event token to be provided, as generated by `startEventForCaseworker`.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.createCaseEventForCaseWorkerUsingPOST(cid, content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#createCaseEventForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.createCaseEventForCaseWorkerUsingPOST(cid, content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#createCaseEventForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Submit event creation as Case worker
[apiInstance createCaseEventForCaseWorkerUsingPOSTWith:cid
    content:content
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCaseEventForCaseWorkerUsingPOST(cid, content, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCaseEventForCaseWorkerUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Submit event creation as Case worker
                CaseDetails result = apiInstance.createCaseEventForCaseWorkerUsingPOST(cid, content, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.createCaseEventForCaseWorkerUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->createCaseEventForCaseWorkerUsingPOST($cid, $content, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->createCaseEventForCaseWorkerUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->createCaseEventForCaseWorkerUsingPOST(cid => $cid, content => $content, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->createCaseEventForCaseWorkerUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Submit event creation as Case worker
    api_response = api_instance.create_case_event_for_case_worker_using_post(cid, content, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->createCaseEventForCaseWorkerUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Case event created

Status: 409 - Case altered outside of transaction

Status: 422 - Event submission failed


createCaseEventForCitizenUsingPOST

Submit event creation as Citizen

Complete the event creation process. This requires a valid event token to be provided, as generated by `startEventForCitizen`.


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.createCaseEventForCitizenUsingPOST(cid, content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#createCaseEventForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.createCaseEventForCitizenUsingPOST(cid, content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#createCaseEventForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Submit event creation as Citizen
[apiInstance createCaseEventForCitizenUsingPOSTWith:cid
    content:content
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCaseEventForCitizenUsingPOST(cid, content, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCaseEventForCitizenUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Submit event creation as Citizen
                CaseDetails result = apiInstance.createCaseEventForCitizenUsingPOST(cid, content, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.createCaseEventForCitizenUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->createCaseEventForCitizenUsingPOST($cid, $content, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->createCaseEventForCitizenUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->createCaseEventForCitizenUsingPOST(cid => $cid, content => $content, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->createCaseEventForCitizenUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Submit event creation as Citizen
    api_response = api_instance.create_case_event_for_citizen_using_post(cid, content, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->createCaseEventForCitizenUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Case event created

Status: 409 - Case altered outside of transaction

Status: 422 - Event submission failed


findCaseDetailsForCaseworkerUsingGET

Get case

Retrieve an existing case with its state and data


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.findCaseDetailsForCaseworkerUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#findCaseDetailsForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.findCaseDetailsForCaseworkerUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#findCaseDetailsForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get case
[apiInstance findCaseDetailsForCaseworkerUsingGETWith:cid
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaseDetailsForCaseworkerUsingGET(cid, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaseDetailsForCaseworkerUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Get case
                CaseDetails result = apiInstance.findCaseDetailsForCaseworkerUsingGET(cid, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.findCaseDetailsForCaseworkerUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->findCaseDetailsForCaseworkerUsingGET($cid, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCaseworkerUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->findCaseDetailsForCaseworkerUsingGET(cid => $cid, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCaseworkerUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Get case
    api_response = api_instance.find_case_details_for_caseworker_using_get(cid, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCaseworkerUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required

Responses

Status: 200 - Case found for the given ID

Status: 400 - Invalid case ID

Status: 404 - No case found for the given ID


findCaseDetailsForCitizenUsingGET

Get case

Retrieve an existing case with its state and data


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.findCaseDetailsForCitizenUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#findCaseDetailsForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            CaseDetails result = apiInstance.findCaseDetailsForCitizenUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#findCaseDetailsForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get case
[apiInstance findCaseDetailsForCitizenUsingGETWith:cid
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaseDetailsForCitizenUsingGET(cid, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaseDetailsForCitizenUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Get case
                CaseDetails result = apiInstance.findCaseDetailsForCitizenUsingGET(cid, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.findCaseDetailsForCitizenUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->findCaseDetailsForCitizenUsingGET($cid, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCitizenUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->findCaseDetailsForCitizenUsingGET(cid => $cid, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCitizenUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Get case
    api_response = api_instance.find_case_details_for_citizen_using_get(cid, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->findCaseDetailsForCitizenUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required

Responses

Status: 200 - Case found for the given ID

Status: 400 - Invalid case ID

Status: 404 - No case found for the given ID


getDocumentsForEventUsingGET

Get a list of printable documents for the given case type


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/documents

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/documents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        try {
            array[Document] result = apiInstance.getDocumentsForEventUsingGET(cid, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#getDocumentsForEventUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        try {
            array[Document] result = apiInstance.getDocumentsForEventUsingGET(cid, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#getDocumentsForEventUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // cid
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get a list of printable documents for the given case type 
[apiInstance getDocumentsForEventUsingGETWith:cid
    ctid:ctid
    jid:jid
              completionHandler: ^(array[Document] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} cid

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDocumentsForEventUsingGET(cid, ctid, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDocumentsForEventUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | cid
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid

            try
            {
                // Get a list of printable documents for the given case type 
                array[Document] result = apiInstance.getDocumentsForEventUsingGET(cid, ctid, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.getDocumentsForEventUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | cid
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid

try {
    $result = $api_instance->getDocumentsForEventUsingGET($cid, $ctid, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->getDocumentsForEventUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | cid
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid

eval { 
    my $result = $api_instance->getDocumentsForEventUsingGET(cid => $cid, ctid => $ctid, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->getDocumentsForEventUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | cid
ctid = ctid_example # String | ctid
jid = jid_example # String | jid

try: 
    # Get a list of printable documents for the given case type 
    api_response = api_instance.get_documents_for_event_using_get(cid, ctid, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->getDocumentsForEventUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
cid
Required
ctid*
String
ctid
Required
jid*
String
jid
Required

Responses

Status: 200 - Documents list for the given case type and id


saveCaseDetailsForCaseWorkerUsingPOST

Submit case creation as Case worker

Complete the case creation process. This requires a valid event token to be provided, as generated by `startCaseForCaseworker`.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored
        try {
            CaseDetails result = apiInstance.saveCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#saveCaseDetailsForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored
        try {
            CaseDetails result = apiInstance.saveCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#saveCaseDetailsForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToSubmit` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Submit case creation as Case worker
[apiInstance saveCaseDetailsForCaseWorkerUsingPOSTWith:content
    ctid:ctid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToSubmit` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saveCaseDetailsForCaseWorkerUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToSubmit` callback warnings be ignored (optional) 

            try
            {
                // Submit case creation as Case worker
                CaseDetails result = apiInstance.saveCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.saveCaseDetailsForCaseWorkerUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored

try {
    $result = $api_instance->saveCaseDetailsForCaseWorkerUsingPOST($content, $ctid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCaseWorkerUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToSubmit` callback warnings be ignored

eval { 
    my $result = $api_instance->saveCaseDetailsForCaseWorkerUsingPOST(content => $content, ctid => $ctid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCaseWorkerUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToSubmit` callback warnings be ignored (optional)

try: 
    # Submit case creation as Case worker
    api_response = api_instance.save_case_details_for_case_worker_using_post(content, ctid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCaseWorkerUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToSubmit` callback warnings be ignored

Responses

Status: 201 - Case created

Status: 409 - Case reference not unique

Status: 422 - Case submission failed


saveCaseDetailsForCitizenUsingPOST

Submit case creation as Citizen

Complete the case creation process. This requires a valid event token to be provided, as generated by `startCaseForCitizen`.


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored
        try {
            CaseDetails result = apiInstance.saveCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#saveCaseDetailsForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored
        try {
            CaseDetails result = apiInstance.saveCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#saveCaseDetailsForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToSubmit` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Submit case creation as Citizen
[apiInstance saveCaseDetailsForCitizenUsingPOSTWith:content
    ctid:ctid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(CaseDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToSubmit` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saveCaseDetailsForCitizenUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToSubmit` callback warnings be ignored (optional) 

            try
            {
                // Submit case creation as Citizen
                CaseDetails result = apiInstance.saveCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.saveCaseDetailsForCitizenUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToSubmit` callback warnings be ignored

try {
    $result = $api_instance->saveCaseDetailsForCitizenUsingPOST($content, $ctid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCitizenUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToSubmit` callback warnings be ignored

eval { 
    my $result = $api_instance->saveCaseDetailsForCitizenUsingPOST(content => $content, ctid => $ctid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCitizenUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToSubmit` callback warnings be ignored (optional)

try: 
    # Submit case creation as Citizen
    api_response = api_instance.save_case_details_for_citizen_using_post(content, ctid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->saveCaseDetailsForCitizenUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToSubmit` callback warnings be ignored

Responses

Status: 201 - Case created

Status: 409 - Case reference not unique

Status: 422 - Case submission failed


searchCasesForCaseWorkersUsingGET

Get case data for a given case type


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases?queryParameters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            array[CaseDetails] result = apiInstance.searchCasesForCaseWorkersUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesForCaseWorkersUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            array[CaseDetails] result = apiInstance.searchCasesForCaseWorkersUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesForCaseWorkersUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
String *queryParameters = queryParameters_example; // queryParameters

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get case data for a given case type
[apiInstance searchCasesForCaseWorkersUsingGETWith:ctid
    jid:jid
    queryParameters:queryParameters
              completionHandler: ^(array[CaseDetails] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var queryParameters = queryParameters_example; // {String} queryParameters


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCasesForCaseWorkersUsingGET(ctid, jid, queryParameters, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchCasesForCaseWorkersUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var queryParameters = queryParameters_example;  // String | queryParameters

            try
            {
                // Get case data for a given case type
                array[CaseDetails] result = apiInstance.searchCasesForCaseWorkersUsingGET(ctid, jid, queryParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.searchCasesForCaseWorkersUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$queryParameters = queryParameters_example; // String | queryParameters

try {
    $result = $api_instance->searchCasesForCaseWorkersUsingGET($ctid, $jid, $queryParameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->searchCasesForCaseWorkersUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $queryParameters = queryParameters_example; # String | queryParameters

eval { 
    my $result = $api_instance->searchCasesForCaseWorkersUsingGET(ctid => $ctid, jid => $jid, queryParameters => $queryParameters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->searchCasesForCaseWorkersUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
queryParameters = queryParameters_example # String | queryParameters

try: 
    # Get case data for a given case type
    api_response = api_instance.search_cases_for_case_workers_using_get(ctid, jid, queryParameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->searchCasesForCaseWorkersUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
Query parameters
Name Description
queryParameters*
String
queryParameters
Required

Responses

Status: 200 - List of case data for the given search criteria


searchCasesForCitizensUsingGET

Get case data for a given case type


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases?queryParameters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            array[CaseDetails] result = apiInstance.searchCasesForCitizensUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesForCitizensUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            array[CaseDetails] result = apiInstance.searchCasesForCitizensUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesForCitizensUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
String *queryParameters = queryParameters_example; // queryParameters

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get case data for a given case type
[apiInstance searchCasesForCitizensUsingGETWith:ctid
    jid:jid
    queryParameters:queryParameters
              completionHandler: ^(array[CaseDetails] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var queryParameters = queryParameters_example; // {String} queryParameters


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCasesForCitizensUsingGET(ctid, jid, queryParameters, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchCasesForCitizensUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var queryParameters = queryParameters_example;  // String | queryParameters

            try
            {
                // Get case data for a given case type
                array[CaseDetails] result = apiInstance.searchCasesForCitizensUsingGET(ctid, jid, queryParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.searchCasesForCitizensUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$queryParameters = queryParameters_example; // String | queryParameters

try {
    $result = $api_instance->searchCasesForCitizensUsingGET($ctid, $jid, $queryParameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->searchCasesForCitizensUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $queryParameters = queryParameters_example; # String | queryParameters

eval { 
    my $result = $api_instance->searchCasesForCitizensUsingGET(ctid => $ctid, jid => $jid, queryParameters => $queryParameters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->searchCasesForCitizensUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
queryParameters = queryParameters_example # String | queryParameters

try: 
    # Get case data for a given case type
    api_response = api_instance.search_cases_for_citizens_using_get(ctid, jid, queryParameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->searchCasesForCitizensUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
Query parameters
Name Description
queryParameters*
String
queryParameters
Required

Responses

Status: 200 - List of case data for the given search criteria


searchCasesMetadataForCaseworkersUsingGET

Get the pagination metadata for a case data search


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata?queryParameters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCaseworkersUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesMetadataForCaseworkersUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCaseworkersUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesMetadataForCaseworkersUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
String *queryParameters = queryParameters_example; // queryParameters

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get the pagination metadata for a case data search
[apiInstance searchCasesMetadataForCaseworkersUsingGETWith:ctid
    jid:jid
    queryParameters:queryParameters
              completionHandler: ^(PaginatedSearchMetadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var queryParameters = queryParameters_example; // {String} queryParameters


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCasesMetadataForCaseworkersUsingGET(ctid, jid, queryParameters, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchCasesMetadataForCaseworkersUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var queryParameters = queryParameters_example;  // String | queryParameters

            try
            {
                // Get the pagination metadata for a case data search
                PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCaseworkersUsingGET(ctid, jid, queryParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.searchCasesMetadataForCaseworkersUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$queryParameters = queryParameters_example; // String | queryParameters

try {
    $result = $api_instance->searchCasesMetadataForCaseworkersUsingGET($ctid, $jid, $queryParameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCaseworkersUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $queryParameters = queryParameters_example; # String | queryParameters

eval { 
    my $result = $api_instance->searchCasesMetadataForCaseworkersUsingGET(ctid => $ctid, jid => $jid, queryParameters => $queryParameters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCaseworkersUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
queryParameters = queryParameters_example # String | queryParameters

try: 
    # Get the pagination metadata for a case data search
    api_response = api_instance.search_cases_metadata_for_caseworkers_using_get(ctid, jid, queryParameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCaseworkersUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
Query parameters
Name Description
queryParameters*
String
queryParameters
Required

Responses

Status: 200 - Pagination metadata for the given search criteria


searchCasesMetadataForCitizensUsingGET

Get the pagination metadata for a case data search


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata?queryParameters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCitizensUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesMetadataForCitizensUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String queryParameters = queryParameters_example; // String | queryParameters
        try {
            PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCitizensUsingGET(ctid, jid, queryParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#searchCasesMetadataForCitizensUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
String *queryParameters = queryParameters_example; // queryParameters

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Get the pagination metadata for a case data search
[apiInstance searchCasesMetadataForCitizensUsingGETWith:ctid
    jid:jid
    queryParameters:queryParameters
              completionHandler: ^(PaginatedSearchMetadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var queryParameters = queryParameters_example; // {String} queryParameters


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCasesMetadataForCitizensUsingGET(ctid, jid, queryParameters, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchCasesMetadataForCitizensUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var queryParameters = queryParameters_example;  // String | queryParameters

            try
            {
                // Get the pagination metadata for a case data search
                PaginatedSearchMetadata result = apiInstance.searchCasesMetadataForCitizensUsingGET(ctid, jid, queryParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.searchCasesMetadataForCitizensUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$queryParameters = queryParameters_example; // String | queryParameters

try {
    $result = $api_instance->searchCasesMetadataForCitizensUsingGET($ctid, $jid, $queryParameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCitizensUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $queryParameters = queryParameters_example; # String | queryParameters

eval { 
    my $result = $api_instance->searchCasesMetadataForCitizensUsingGET(ctid => $ctid, jid => $jid, queryParameters => $queryParameters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCitizensUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
queryParameters = queryParameters_example # String | queryParameters

try: 
    # Get the pagination metadata for a case data search
    api_response = api_instance.search_cases_metadata_for_citizens_using_get(ctid, jid, queryParameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->searchCasesMetadataForCitizensUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
Query parameters
Name Description
queryParameters*
String
queryParameters
Required

Responses

Status: 200 - Pagination metadata for the given search criteria


startCaseForCaseworkerUsingGET

Start case creation as Case worker

Start the case creation process for a new case. Triggers `AboutToStart` callback.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startCaseForCaseworkerUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startCaseForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startCaseForCaseworkerUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startCaseForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // Case type ID
String *etid = etid_example; // Event ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToStart` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Start case creation as Case worker
[apiInstance startCaseForCaseworkerUsingGETWith:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(StartEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} Case type ID

var etid = etid_example; // {String} Event ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToStart` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startCaseForCaseworkerUsingGET(ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startCaseForCaseworkerUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | Case type ID
            var etid = etid_example;  // String | Event ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToStart` callback warnings be ignored (optional) 

            try
            {
                // Start case creation as Case worker
                StartEventTrigger result = apiInstance.startCaseForCaseworkerUsingGET(ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.startCaseForCaseworkerUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | Case type ID
$etid = etid_example; // String | Event ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored

try {
    $result = $api_instance->startCaseForCaseworkerUsingGET($ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->startCaseForCaseworkerUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | Case type ID
my $etid = etid_example; # String | Event ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToStart` callback warnings be ignored

eval { 
    my $result = $api_instance->startCaseForCaseworkerUsingGET(ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->startCaseForCaseworkerUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | Case type ID
etid = etid_example # String | Event ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToStart` callback warnings be ignored (optional)

try: 
    # Start case creation as Case worker
    api_response = api_instance.start_case_for_caseworker_using_get(ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->startCaseForCaseworkerUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
etid*
String
Event ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToStart` callback warnings be ignored

Responses

Status: 200 - Case creation process started

Status: 422 - Process could not be started


startCaseForCitizenUsingGET

Start case creation as Citizen

Start the case creation process for a new case. Triggers `AboutToStart` callback.


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startCaseForCitizenUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startCaseForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startCaseForCitizenUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startCaseForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // Case type ID
String *etid = etid_example; // Event ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToStart` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Start case creation as Citizen
[apiInstance startCaseForCitizenUsingGETWith:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(StartEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var ctid = ctid_example; // {String} Case type ID

var etid = etid_example; // {String} Event ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToStart` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startCaseForCitizenUsingGET(ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startCaseForCitizenUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var ctid = ctid_example;  // String | Case type ID
            var etid = etid_example;  // String | Event ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToStart` callback warnings be ignored (optional) 

            try
            {
                // Start case creation as Citizen
                StartEventTrigger result = apiInstance.startCaseForCitizenUsingGET(ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.startCaseForCitizenUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$ctid = ctid_example; // String | Case type ID
$etid = etid_example; // String | Event ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored

try {
    $result = $api_instance->startCaseForCitizenUsingGET($ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->startCaseForCitizenUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $ctid = ctid_example; # String | Case type ID
my $etid = etid_example; # String | Event ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToStart` callback warnings be ignored

eval { 
    my $result = $api_instance->startCaseForCitizenUsingGET(ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->startCaseForCitizenUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
ctid = ctid_example # String | Case type ID
etid = etid_example # String | Event ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToStart` callback warnings be ignored (optional)

try: 
    # Start case creation as Citizen
    api_response = api_instance.start_case_for_citizen_using_get(ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->startCaseForCitizenUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
etid*
String
Event ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToStart` callback warnings be ignored

Responses

Status: 200 - Case creation process started

Status: 422 - Process could not be started


startEventForCaseworkerUsingGET

Start event creation as Case worker

Start the event creation process for an existing case. Triggers `AboutToStart` callback.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startEventForCaseworkerUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startEventForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startEventForCaseworkerUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startEventForCaseworkerUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *etid = etid_example; // Event ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToStart` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Start event creation as Case worker
[apiInstance startEventForCaseworkerUsingGETWith:cid
    ctid:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(StartEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var etid = etid_example; // {String} Event ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToStart` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startEventForCaseworkerUsingGET(cid, ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startEventForCaseworkerUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var etid = etid_example;  // String | Event ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToStart` callback warnings be ignored (optional) 

            try
            {
                // Start event creation as Case worker
                StartEventTrigger result = apiInstance.startEventForCaseworkerUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.startEventForCaseworkerUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$etid = etid_example; // String | Event ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored

try {
    $result = $api_instance->startEventForCaseworkerUsingGET($cid, $ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->startEventForCaseworkerUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $etid = etid_example; # String | Event ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToStart` callback warnings be ignored

eval { 
    my $result = $api_instance->startEventForCaseworkerUsingGET(cid => $cid, ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->startEventForCaseworkerUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
etid = etid_example # String | Event ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToStart` callback warnings be ignored (optional)

try: 
    # Start event creation as Case worker
    api_response = api_instance.start_event_for_caseworker_using_get(cid, ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->startEventForCaseworkerUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
etid*
String
Event ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToStart` callback warnings be ignored

Responses

Status: 200 - Event creation process started

Status: 404 - No case found for the given ID

Status: 422 - Process could not be started


startEventForCitizenUsingGET

Start event creation as Citizen

Start the event creation process for an existing case. Triggers `AboutToStart` callback.


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startEventForCitizenUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startEventForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        Boolean ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored
        try {
            StartEventTrigger result = apiInstance.startEventForCitizenUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#startEventForCitizenUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *etid = etid_example; // Event ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID
Boolean *ignoreWarning = true; // Should `AboutToStart` callback warnings be ignored (optional)

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Start event creation as Citizen
[apiInstance startEventForCitizenUsingGETWith:cid
    ctid:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(StartEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var etid = etid_example; // {String} Event ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID

var opts = { 
  'ignoreWarning': true // {Boolean} Should `AboutToStart` callback warnings be ignored
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startEventForCitizenUsingGET(cid, ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startEventForCitizenUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var etid = etid_example;  // String | Event ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID
            var ignoreWarning = true;  // Boolean | Should `AboutToStart` callback warnings be ignored (optional) 

            try
            {
                // Start event creation as Citizen
                StartEventTrigger result = apiInstance.startEventForCitizenUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.startEventForCitizenUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$etid = etid_example; // String | Event ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID
$ignoreWarning = true; // Boolean | Should `AboutToStart` callback warnings be ignored

try {
    $result = $api_instance->startEventForCitizenUsingGET($cid, $ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->startEventForCitizenUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $etid = etid_example; # String | Event ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID
my $ignoreWarning = true; # Boolean | Should `AboutToStart` callback warnings be ignored

eval { 
    my $result = $api_instance->startEventForCitizenUsingGET(cid => $cid, ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->startEventForCitizenUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
etid = etid_example # String | Event ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID
ignoreWarning = true # Boolean | Should `AboutToStart` callback warnings be ignored (optional)

try: 
    # Start event creation as Citizen
    api_response = api_instance.start_event_for_citizen_using_get(cid, ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->startEventForCitizenUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
etid*
String
Event ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Query parameters
Name Description
ignore-warning
Boolean
Should `AboutToStart` callback warnings be ignored

Responses

Status: 200 - Event creation process started

Status: 404 - No case found for the given ID

Status: 422 - Process could not be started


validateCaseDetailsForCaseWorkerUsingPOST

Validate a set of fields as Case worker

Validate the case data entered during the case/event creation process.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            map['String', JsonNode] result = apiInstance.validateCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#validateCaseDetailsForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            map['String', JsonNode] result = apiInstance.validateCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#validateCaseDetailsForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Validate a set of fields as Case worker
[apiInstance validateCaseDetailsForCaseWorkerUsingPOSTWith:content
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(map['String', JsonNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCaseDetailsForCaseWorkerUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Validate a set of fields as Case worker
                map['String', JsonNode] result = apiInstance.validateCaseDetailsForCaseWorkerUsingPOST(content, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.validateCaseDetailsForCaseWorkerUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->validateCaseDetailsForCaseWorkerUsingPOST($content, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCaseWorkerUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->validateCaseDetailsForCaseWorkerUsingPOST(content => $content, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCaseWorkerUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Validate a set of fields as Case worker
    api_response = api_instance.validate_case_details_for_case_worker_using_post(content, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCaseWorkerUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *

Responses

Status: 200 - Validation OK

Status: 409 - Case reference not unique

Status: 422 - Field validation failed


validateCaseDetailsForCitizenUsingPOST

Validate a set of fields as Citizen

Validate the case data entered during the case/event creation process.


/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CaseDetailsEndpointApi;

import java.io.File;
import java.util.*;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            map['String', JsonNode] result = apiInstance.validateCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#validateCaseDetailsForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CaseDetailsEndpointApi;

public class CaseDetailsEndpointApiExample {

    public static void main(String[] args) {
        CaseDetailsEndpointApi apiInstance = new CaseDetailsEndpointApi();
        CaseDataContent content = ; // CaseDataContent | content
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            map['String', JsonNode] result = apiInstance.validateCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaseDetailsEndpointApi#validateCaseDetailsForCitizenUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDataContent *content = ; // content
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

CaseDetailsEndpointApi *apiInstance = [[CaseDetailsEndpointApi alloc] init];

// Validate a set of fields as Citizen
[apiInstance validateCaseDetailsForCitizenUsingPOSTWith:content
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(map['String', JsonNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.CaseDetailsEndpointApi()

var content = ; // {CaseDataContent} content

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCaseDetailsForCitizenUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new CaseDetailsEndpointApi();
            var content = new CaseDataContent(); // CaseDataContent | content
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Validate a set of fields as Citizen
                map['String', JsonNode] result = apiInstance.validateCaseDetailsForCitizenUsingPOST(content, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CaseDetailsEndpointApi.validateCaseDetailsForCitizenUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CaseDetailsEndpointApi();
$content = ; // CaseDataContent | content
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->validateCaseDetailsForCitizenUsingPOST($content, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCitizenUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CaseDetailsEndpointApi;

my $api_instance = WWW::SwaggerClient::CaseDetailsEndpointApi->new();
my $content = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | content
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->validateCaseDetailsForCitizenUsingPOST(content => $content, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCitizenUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CaseDetailsEndpointApi()
content =  # CaseDataContent | content
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Validate a set of fields as Citizen
    api_response = api_instance.validate_case_details_for_citizen_using_post(content, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CaseDetailsEndpointApi->validateCaseDetailsForCitizenUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
content *

Responses

Status: 200 - Validation OK

Status: 409 - Case reference not unique

Status: 422 - Field validation failed


DraftsEndpoint

saveDraftForCaseWorkerUsingPOST

Save draft as a caseworker.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts

Usage and SDK Samples

curl -X POST "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DraftsEndpointApi;

import java.io.File;
import java.util.*;

public class DraftsEndpointApiExample {

    public static void main(String[] args) {
        
        DraftsEndpointApi apiInstance = new DraftsEndpointApi();
        CaseDataContent caseDataContent = ; // CaseDataContent | caseDataContent
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event Trigger ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            DraftResponse result = apiInstance.saveDraftForCaseWorkerUsingPOST(caseDataContent, ctid, etid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftsEndpointApi#saveDraftForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DraftsEndpointApi;

public class DraftsEndpointApiExample {

    public static void main(String[] args) {
        DraftsEndpointApi apiInstance = new DraftsEndpointApi();
        CaseDataContent caseDataContent = ; // CaseDataContent | caseDataContent
        String ctid = ctid_example; // String | Case type ID
        String etid = etid_example; // String | Event Trigger ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            DraftResponse result = apiInstance.saveDraftForCaseWorkerUsingPOST(caseDataContent, ctid, etid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftsEndpointApi#saveDraftForCaseWorkerUsingPOST");
            e.printStackTrace();
        }
    }
}
CaseDataContent *caseDataContent = ; // caseDataContent
String *ctid = ctid_example; // Case type ID
String *etid = etid_example; // Event Trigger ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

DraftsEndpointApi *apiInstance = [[DraftsEndpointApi alloc] init];

// Save draft as a caseworker.
[apiInstance saveDraftForCaseWorkerUsingPOSTWith:caseDataContent
    ctid:ctid
    etid:etid
    jid:jid
    uid:uid
              completionHandler: ^(DraftResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.DraftsEndpointApi()

var caseDataContent = ; // {CaseDataContent} caseDataContent

var ctid = ctid_example; // {String} Case type ID

var etid = etid_example; // {String} Event Trigger ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveDraftForCaseWorkerUsingPOST(caseDataContent, ctid, etid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saveDraftForCaseWorkerUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new DraftsEndpointApi();
            var caseDataContent = new CaseDataContent(); // CaseDataContent | caseDataContent
            var ctid = ctid_example;  // String | Case type ID
            var etid = etid_example;  // String | Event Trigger ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Save draft as a caseworker.
                DraftResponse result = apiInstance.saveDraftForCaseWorkerUsingPOST(caseDataContent, ctid, etid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DraftsEndpointApi.saveDraftForCaseWorkerUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DraftsEndpointApi();
$caseDataContent = ; // CaseDataContent | caseDataContent
$ctid = ctid_example; // String | Case type ID
$etid = etid_example; // String | Event Trigger ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->saveDraftForCaseWorkerUsingPOST($caseDataContent, $ctid, $etid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftsEndpointApi->saveDraftForCaseWorkerUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DraftsEndpointApi;

my $api_instance = WWW::SwaggerClient::DraftsEndpointApi->new();
my $caseDataContent = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | caseDataContent
my $ctid = ctid_example; # String | Case type ID
my $etid = etid_example; # String | Event Trigger ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->saveDraftForCaseWorkerUsingPOST(caseDataContent => $caseDataContent, ctid => $ctid, etid => $etid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftsEndpointApi->saveDraftForCaseWorkerUsingPOST: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DraftsEndpointApi()
caseDataContent =  # CaseDataContent | caseDataContent
ctid = ctid_example # String | Case type ID
etid = etid_example # String | Event Trigger ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Save draft as a caseworker.
    api_response = api_instance.save_draft_for_case_worker_using_post(caseDataContent, ctid, etid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftsEndpointApi->saveDraftForCaseWorkerUsingPOST: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
etid*
String
Event Trigger ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
caseDataContent *

Responses

Status: 201 - Draft created

Status: 400 - Bad request


updateDraftForCaseWorkerUsingPUT

Update draft as a caseworker.


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts/{did}

Usage and SDK Samples

curl -X PUT "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts/{did}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DraftsEndpointApi;

import java.io.File;
import java.util.*;

public class DraftsEndpointApiExample {

    public static void main(String[] args) {
        
        DraftsEndpointApi apiInstance = new DraftsEndpointApi();
        CaseDataContent caseDataContent = ; // CaseDataContent | caseDataContent
        String ctid = ctid_example; // String | Case type ID
        String did = did_example; // String | Event Trigger ID
        String etid = etid_example; // String | Event Trigger ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            DraftResponse result = apiInstance.updateDraftForCaseWorkerUsingPUT(caseDataContent, ctid, did, etid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftsEndpointApi#updateDraftForCaseWorkerUsingPUT");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DraftsEndpointApi;

public class DraftsEndpointApiExample {

    public static void main(String[] args) {
        DraftsEndpointApi apiInstance = new DraftsEndpointApi();
        CaseDataContent caseDataContent = ; // CaseDataContent | caseDataContent
        String ctid = ctid_example; // String | Case type ID
        String did = did_example; // String | Event Trigger ID
        String etid = etid_example; // String | Event Trigger ID
        String jid = jid_example; // String | Jurisdiction ID
        String uid = uid_example; // String | Idam user ID
        try {
            DraftResponse result = apiInstance.updateDraftForCaseWorkerUsingPUT(caseDataContent, ctid, did, etid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftsEndpointApi#updateDraftForCaseWorkerUsingPUT");
            e.printStackTrace();
        }
    }
}
CaseDataContent *caseDataContent = ; // caseDataContent
String *ctid = ctid_example; // Case type ID
String *did = did_example; // Event Trigger ID
String *etid = etid_example; // Event Trigger ID
String *jid = jid_example; // Jurisdiction ID
String *uid = uid_example; // Idam user ID

DraftsEndpointApi *apiInstance = [[DraftsEndpointApi alloc] init];

// Update draft as a caseworker.
[apiInstance updateDraftForCaseWorkerUsingPUTWith:caseDataContent
    ctid:ctid
    did:did
    etid:etid
    jid:jid
    uid:uid
              completionHandler: ^(DraftResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.DraftsEndpointApi()

var caseDataContent = ; // {CaseDataContent} caseDataContent

var ctid = ctid_example; // {String} Case type ID

var did = did_example; // {String} Event Trigger ID

var etid = etid_example; // {String} Event Trigger ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = uid_example; // {String} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDraftForCaseWorkerUsingPUT(caseDataContent, ctid, did, etid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateDraftForCaseWorkerUsingPUTExample
    {
        public void main()
        {
            
            var apiInstance = new DraftsEndpointApi();
            var caseDataContent = new CaseDataContent(); // CaseDataContent | caseDataContent
            var ctid = ctid_example;  // String | Case type ID
            var did = did_example;  // String | Event Trigger ID
            var etid = etid_example;  // String | Event Trigger ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = uid_example;  // String | Idam user ID

            try
            {
                // Update draft as a caseworker.
                DraftResponse result = apiInstance.updateDraftForCaseWorkerUsingPUT(caseDataContent, ctid, did, etid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DraftsEndpointApi.updateDraftForCaseWorkerUsingPUT: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DraftsEndpointApi();
$caseDataContent = ; // CaseDataContent | caseDataContent
$ctid = ctid_example; // String | Case type ID
$did = did_example; // String | Event Trigger ID
$etid = etid_example; // String | Event Trigger ID
$jid = jid_example; // String | Jurisdiction ID
$uid = uid_example; // String | Idam user ID

try {
    $result = $api_instance->updateDraftForCaseWorkerUsingPUT($caseDataContent, $ctid, $did, $etid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftsEndpointApi->updateDraftForCaseWorkerUsingPUT: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DraftsEndpointApi;

my $api_instance = WWW::SwaggerClient::DraftsEndpointApi->new();
my $caseDataContent = WWW::SwaggerClient::Object::CaseDataContent->new(); # CaseDataContent | caseDataContent
my $ctid = ctid_example; # String | Case type ID
my $did = did_example; # String | Event Trigger ID
my $etid = etid_example; # String | Event Trigger ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = uid_example; # String | Idam user ID

eval { 
    my $result = $api_instance->updateDraftForCaseWorkerUsingPUT(caseDataContent => $caseDataContent, ctid => $ctid, did => $did, etid => $etid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftsEndpointApi->updateDraftForCaseWorkerUsingPUT: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DraftsEndpointApi()
caseDataContent =  # CaseDataContent | caseDataContent
ctid = ctid_example # String | Case type ID
did = did_example # String | Event Trigger ID
etid = etid_example # String | Event Trigger ID
jid = jid_example # String | Jurisdiction ID
uid = uid_example # String | Idam user ID

try: 
    # Update draft as a caseworker.
    api_response = api_instance.update_draft_for_case_worker_using_put(caseDataContent, ctid, did, etid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftsEndpointApi->updateDraftForCaseWorkerUsingPUT: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
Case type ID
Required
did*
String
Event Trigger ID
Required
etid*
String
Event Trigger ID
Required
jid*
String
Jurisdiction ID
Required
uid*
String
Idam user ID
Required
Body parameters
Name Description
caseDataContent *

Responses

Status: 200 - Draft updated

Status: 400 - Bad request


EventsEndpoint

findEventDetailsForCaseUsingGET

Get events for case

Retrieve all events for a case


/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsEndpointApi;

import java.io.File;
import java.util.*;

public class EventsEndpointApiExample {

    public static void main(String[] args) {
        
        EventsEndpointApi apiInstance = new EventsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        try {
            array[AuditEvent] result = apiInstance.findEventDetailsForCaseUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsEndpointApi#findEventDetailsForCaseUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsEndpointApi;

public class EventsEndpointApiExample {

    public static void main(String[] args) {
        EventsEndpointApi apiInstance = new EventsEndpointApi();
        String cid = cid_example; // String | Case ID
        String ctid = ctid_example; // String | Case type ID
        String jid = jid_example; // String | Jurisdiction ID
        Integer uid = 56; // Integer | Idam user ID
        try {
            array[AuditEvent] result = apiInstance.findEventDetailsForCaseUsingGET(cid, ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsEndpointApi#findEventDetailsForCaseUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // Case ID
String *ctid = ctid_example; // Case type ID
String *jid = jid_example; // Jurisdiction ID
Integer *uid = 56; // Idam user ID

EventsEndpointApi *apiInstance = [[EventsEndpointApi alloc] init];

// Get events for case
[apiInstance findEventDetailsForCaseUsingGETWith:cid
    ctid:ctid
    jid:jid
    uid:uid
              completionHandler: ^(array[AuditEvent] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.EventsEndpointApi()

var cid = cid_example; // {String} Case ID

var ctid = ctid_example; // {String} Case type ID

var jid = jid_example; // {String} Jurisdiction ID

var uid = 56; // {Integer} Idam user ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findEventDetailsForCaseUsingGET(cid, ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findEventDetailsForCaseUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EventsEndpointApi();
            var cid = cid_example;  // String | Case ID
            var ctid = ctid_example;  // String | Case type ID
            var jid = jid_example;  // String | Jurisdiction ID
            var uid = 56;  // Integer | Idam user ID

            try
            {
                // Get events for case
                array[AuditEvent] result = apiInstance.findEventDetailsForCaseUsingGET(cid, ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsEndpointApi.findEventDetailsForCaseUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EventsEndpointApi();
$cid = cid_example; // String | Case ID
$ctid = ctid_example; // String | Case type ID
$jid = jid_example; // String | Jurisdiction ID
$uid = 56; // Integer | Idam user ID

try {
    $result = $api_instance->findEventDetailsForCaseUsingGET($cid, $ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsEndpointApi->findEventDetailsForCaseUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsEndpointApi;

my $api_instance = WWW::SwaggerClient::EventsEndpointApi->new();
my $cid = cid_example; # String | Case ID
my $ctid = ctid_example; # String | Case type ID
my $jid = jid_example; # String | Jurisdiction ID
my $uid = 56; # Integer | Idam user ID

eval { 
    my $result = $api_instance->findEventDetailsForCaseUsingGET(cid => $cid, ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsEndpointApi->findEventDetailsForCaseUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EventsEndpointApi()
cid = cid_example # String | Case ID
ctid = ctid_example # String | Case type ID
jid = jid_example # String | Jurisdiction ID
uid = 56 # Integer | Idam user ID

try: 
    # Get events for case
    api_response = api_instance.find_event_details_for_case_using_get(cid, ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsEndpointApi->findEventDetailsForCaseUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
Case ID
Required
ctid*
String
Case type ID
Required
jid*
String
Jurisdiction ID
Required
uid*
Integer (int32)
Idam user ID
Required

Responses

Status: 200 - Events found for the given ID

Status: 400 - Invalid case ID

Status: 404 - No case found for the given ID


QueryEndpoint

findCaseUsingGET

Fetch a case for display


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        try {
            CaseView result = apiInstance.findCaseUsingGET(cid, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findCaseUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        try {
            CaseView result = apiInstance.findCaseUsingGET(cid, ctid, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findCaseUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // cid
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Fetch a case for display
[apiInstance findCaseUsingGETWith:cid
    ctid:ctid
    jid:jid
              completionHandler: ^(CaseView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var cid = cid_example; // {String} cid

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findCaseUsingGET(cid, ctid, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findCaseUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var cid = cid_example;  // String | cid
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid

            try
            {
                // Fetch a case for display
                CaseView result = apiInstance.findCaseUsingGET(cid, ctid, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.findCaseUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$cid = cid_example; // String | cid
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid

try {
    $result = $api_instance->findCaseUsingGET($cid, $ctid, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->findCaseUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $cid = cid_example; # String | cid
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid

eval { 
    my $result = $api_instance->findCaseUsingGET(cid => $cid, ctid => $ctid, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->findCaseUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
cid = cid_example # String | cid
ctid = ctid_example # String | ctid
jid = jid_example # String | jid

try: 
    # Fetch a case for display
    api_response = api_instance.find_case_using_get(cid, ctid, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->findCaseUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
cid
Required
ctid*
String
ctid
Required
jid*
String
jid
Required

Responses

Status: 200 - A displayable case


findDraftUsingGET

Fetch a draft for display


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/drafts/{did}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/drafts/{did}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String did = did_example; // String | did
        String jid = jid_example; // String | jid
        try {
            CaseView result = apiInstance.findDraftUsingGET(ctid, did, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findDraftUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String did = did_example; // String | did
        String jid = jid_example; // String | jid
        try {
            CaseView result = apiInstance.findDraftUsingGET(ctid, did, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findDraftUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *did = did_example; // did
String *jid = jid_example; // jid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Fetch a draft for display
[apiInstance findDraftUsingGETWith:ctid
    did:did
    jid:jid
              completionHandler: ^(CaseView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var ctid = ctid_example; // {String} ctid

var did = did_example; // {String} did

var jid = jid_example; // {String} jid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findDraftUsingGET(ctid, did, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findDraftUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var did = did_example;  // String | did
            var jid = jid_example;  // String | jid

            try
            {
                // Fetch a draft for display
                CaseView result = apiInstance.findDraftUsingGET(ctid, did, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.findDraftUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$ctid = ctid_example; // String | ctid
$did = did_example; // String | did
$jid = jid_example; // String | jid

try {
    $result = $api_instance->findDraftUsingGET($ctid, $did, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->findDraftUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $did = did_example; # String | did
my $jid = jid_example; # String | jid

eval { 
    my $result = $api_instance->findDraftUsingGET(ctid => $ctid, did => $did, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->findDraftUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
ctid = ctid_example # String | ctid
did = did_example # String | did
jid = jid_example # String | jid

try: 
    # Fetch a draft for display
    api_response = api_instance.find_draft_using_get(ctid, did, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->findDraftUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
did*
String
did
Required
jid*
String
jid
Required

Responses

Status: 200 - A displayable draft


findSearchInputDetailsUsingGET

Get Search Input details


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/inputs

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/inputs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        Integer uid = 56; // Integer | uid
        try {
            array[SearchInput] result = apiInstance.findSearchInputDetailsUsingGET(ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findSearchInputDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        Integer uid = 56; // Integer | uid
        try {
            array[SearchInput] result = apiInstance.findSearchInputDetailsUsingGET(ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findSearchInputDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
Integer *uid = 56; // uid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Get Search Input details
[apiInstance findSearchInputDetailsUsingGETWith:ctid
    jid:jid
    uid:uid
              completionHandler: ^(array[SearchInput] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var uid = 56; // {Integer} uid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findSearchInputDetailsUsingGET(ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findSearchInputDetailsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var uid = 56;  // Integer | uid

            try
            {
                // Get Search Input details
                array[SearchInput] result = apiInstance.findSearchInputDetailsUsingGET(ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.findSearchInputDetailsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$uid = 56; // Integer | uid

try {
    $result = $api_instance->findSearchInputDetailsUsingGET($ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->findSearchInputDetailsUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $uid = 56; # Integer | uid

eval { 
    my $result = $api_instance->findSearchInputDetailsUsingGET(ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->findSearchInputDetailsUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
uid = 56 # Integer | uid

try: 
    # Get Search Input details
    api_response = api_instance.find_search_input_details_using_get(ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->findSearchInputDetailsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
uid*
Integer (int32)
uid
Required

Responses

Status: 200 - Search Input data found for the given case type and jurisdiction

Status: 404 - No SearchInput found for the given case type and jurisdiction


findWorkbasketInputDetailsUsingGET

Get Workbasket Input details


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/work-basket-inputs

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/work-basket-inputs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        Integer uid = 56; // Integer | uid
        try {
            array[WorkbasketInput] result = apiInstance.findWorkbasketInputDetailsUsingGET(ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findWorkbasketInputDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        Integer uid = 56; // Integer | uid
        try {
            array[WorkbasketInput] result = apiInstance.findWorkbasketInputDetailsUsingGET(ctid, jid, uid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#findWorkbasketInputDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
Integer *uid = 56; // uid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Get Workbasket Input details
[apiInstance findWorkbasketInputDetailsUsingGETWith:ctid
    jid:jid
    uid:uid
              completionHandler: ^(array[WorkbasketInput] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var uid = 56; // {Integer} uid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findWorkbasketInputDetailsUsingGET(ctid, jid, uid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findWorkbasketInputDetailsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var uid = 56;  // Integer | uid

            try
            {
                // Get Workbasket Input details
                array[WorkbasketInput] result = apiInstance.findWorkbasketInputDetailsUsingGET(ctid, jid, uid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.findWorkbasketInputDetailsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$uid = 56; // Integer | uid

try {
    $result = $api_instance->findWorkbasketInputDetailsUsingGET($ctid, $jid, $uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->findWorkbasketInputDetailsUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $uid = 56; # Integer | uid

eval { 
    my $result = $api_instance->findWorkbasketInputDetailsUsingGET(ctid => $ctid, jid => $jid, uid => $uid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->findWorkbasketInputDetailsUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
uid = 56 # Integer | uid

try: 
    # Get Workbasket Input details
    api_response = api_instance.find_workbasket_input_details_using_get(ctid, jid, uid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->findWorkbasketInputDetailsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
uid*
Integer (int32)
uid
Required

Responses

Status: 200 - Workbasket Input data found for the given case type and jurisdiction

Status: 404 - No Workbasket Input found for the given case type and jurisdiction


getCaseHistoryForEventUsingGET

Fetch case history for the event


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events/{eventId}/case-history

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events/{eventId}/case-history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        Long eventId = 789; // Long | eventId
        String jid = jid_example; // String | jid
        try {
            CaseHistoryView result = apiInstance.getCaseHistoryForEventUsingGET(cid, ctid, eventId, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getCaseHistoryForEventUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        Long eventId = 789; // Long | eventId
        String jid = jid_example; // String | jid
        try {
            CaseHistoryView result = apiInstance.getCaseHistoryForEventUsingGET(cid, ctid, eventId, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getCaseHistoryForEventUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // cid
String *ctid = ctid_example; // ctid
Long *eventId = 789; // eventId
String *jid = jid_example; // jid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Fetch case history for the event
[apiInstance getCaseHistoryForEventUsingGETWith:cid
    ctid:ctid
    eventId:eventId
    jid:jid
              completionHandler: ^(CaseHistoryView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var cid = cid_example; // {String} cid

var ctid = ctid_example; // {String} ctid

var eventId = 789; // {Long} eventId

var jid = jid_example; // {String} jid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseHistoryForEventUsingGET(cid, ctid, eventId, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseHistoryForEventUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var cid = cid_example;  // String | cid
            var ctid = ctid_example;  // String | ctid
            var eventId = 789;  // Long | eventId
            var jid = jid_example;  // String | jid

            try
            {
                // Fetch case history for the event
                CaseHistoryView result = apiInstance.getCaseHistoryForEventUsingGET(cid, ctid, eventId, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.getCaseHistoryForEventUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$cid = cid_example; // String | cid
$ctid = ctid_example; // String | ctid
$eventId = 789; // Long | eventId
$jid = jid_example; // String | jid

try {
    $result = $api_instance->getCaseHistoryForEventUsingGET($cid, $ctid, $eventId, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->getCaseHistoryForEventUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $cid = cid_example; # String | cid
my $ctid = ctid_example; # String | ctid
my $eventId = 789; # Long | eventId
my $jid = jid_example; # String | jid

eval { 
    my $result = $api_instance->getCaseHistoryForEventUsingGET(cid => $cid, ctid => $ctid, eventId => $eventId, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->getCaseHistoryForEventUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
cid = cid_example # String | cid
ctid = ctid_example # String | ctid
eventId = 789 # Long | eventId
jid = jid_example # String | jid

try: 
    # Fetch case history for the event
    api_response = api_instance.get_case_history_for_event_using_get(cid, ctid, eventId, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->getCaseHistoryForEventUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
cid
Required
ctid*
String
ctid
Required
eventId*
Long (int64)
eventId
Required
jid*
String
jid
Required

Responses

Status: 200 - Displayable case data

Status: 404 - Invalid jurisdiction/case type/case reference or event id


getCaseTypesUsingGET

Get case types


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types?access="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String access = access_example; // String | access
        String jid = jid_example; // String | jid
        try {
            array[CaseType] result = apiInstance.getCaseTypesUsingGET(access, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getCaseTypesUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String access = access_example; // String | access
        String jid = jid_example; // String | jid
        try {
            array[CaseType] result = apiInstance.getCaseTypesUsingGET(access, jid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getCaseTypesUsingGET");
            e.printStackTrace();
        }
    }
}
String *access = access_example; // access
String *jid = jid_example; // jid

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Get case types
[apiInstance getCaseTypesUsingGETWith:access
    jid:jid
              completionHandler: ^(array[CaseType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var access = access_example; // {String} access

var jid = jid_example; // {String} jid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaseTypesUsingGET(access, jid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCaseTypesUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var access = access_example;  // String | access
            var jid = jid_example;  // String | jid

            try
            {
                // Get case types
                array[CaseType] result = apiInstance.getCaseTypesUsingGET(access, jid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.getCaseTypesUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$access = access_example; // String | access
$jid = jid_example; // String | jid

try {
    $result = $api_instance->getCaseTypesUsingGET($access, $jid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->getCaseTypesUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $access = access_example; # String | access
my $jid = jid_example; # String | jid

eval { 
    my $result = $api_instance->getCaseTypesUsingGET(access => $access, jid => $jid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->getCaseTypesUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
access = access_example # String | access
jid = jid_example # String | jid

try: 
    # Get case types
    api_response = api_instance.get_case_types_using_get(access, jid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->getCaseTypesUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
jid*
String
jid
Required
Query parameters
Name Description
access*
String
access
Required

Responses

Status: 200 - List of case types for the given access criteria

Status: 404 - No case types found for given access criteria


getEventTriggerForCaseTypeUsingGET

Fetch an event trigger in the context of a case type


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String etid = etid_example; // String | etid
        String jid = jid_example; // String | jid
        String uid = uid_example; // String | uid
        Boolean ignoreWarning = true; // Boolean | ignore-warning
        try {
            CaseEventTrigger result = apiInstance.getEventTriggerForCaseTypeUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getEventTriggerForCaseTypeUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String etid = etid_example; // String | etid
        String jid = jid_example; // String | jid
        String uid = uid_example; // String | uid
        Boolean ignoreWarning = true; // Boolean | ignore-warning
        try {
            CaseEventTrigger result = apiInstance.getEventTriggerForCaseTypeUsingGET(ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getEventTriggerForCaseTypeUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *etid = etid_example; // etid
String *jid = jid_example; // jid
String *uid = uid_example; // uid
Boolean *ignoreWarning = true; // ignore-warning (optional)

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Fetch an event trigger in the context of a case type
[apiInstance getEventTriggerForCaseTypeUsingGETWith:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(CaseEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var ctid = ctid_example; // {String} ctid

var etid = etid_example; // {String} etid

var jid = jid_example; // {String} jid

var uid = uid_example; // {String} uid

var opts = { 
  'ignoreWarning': true // {Boolean} ignore-warning
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventTriggerForCaseTypeUsingGET(ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventTriggerForCaseTypeUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var etid = etid_example;  // String | etid
            var jid = jid_example;  // String | jid
            var uid = uid_example;  // String | uid
            var ignoreWarning = true;  // Boolean | ignore-warning (optional) 

            try
            {
                // Fetch an event trigger in the context of a case type
                CaseEventTrigger result = apiInstance.getEventTriggerForCaseTypeUsingGET(ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.getEventTriggerForCaseTypeUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$ctid = ctid_example; // String | ctid
$etid = etid_example; // String | etid
$jid = jid_example; // String | jid
$uid = uid_example; // String | uid
$ignoreWarning = true; // Boolean | ignore-warning

try {
    $result = $api_instance->getEventTriggerForCaseTypeUsingGET($ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->getEventTriggerForCaseTypeUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $etid = etid_example; # String | etid
my $jid = jid_example; # String | jid
my $uid = uid_example; # String | uid
my $ignoreWarning = true; # Boolean | ignore-warning

eval { 
    my $result = $api_instance->getEventTriggerForCaseTypeUsingGET(ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->getEventTriggerForCaseTypeUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
ctid = ctid_example # String | ctid
etid = etid_example # String | etid
jid = jid_example # String | jid
uid = uid_example # String | uid
ignoreWarning = true # Boolean | ignore-warning (optional)

try: 
    # Fetch an event trigger in the context of a case type
    api_response = api_instance.get_event_trigger_for_case_type_using_get(ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->getEventTriggerForCaseTypeUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
etid*
String
etid
Required
jid*
String
jid
Required
uid*
String
uid
Required
Query parameters
Name Description
ignore-warning
Boolean
ignore-warning

Responses

Status: 200 - Empty pre-state conditions

Status: 422 - The case status did not qualify for the event


getEventTriggerForCaseUsingGET

Fetch an event trigger in the context of a case


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}?ignore-warning="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String etid = etid_example; // String | etid
        String jid = jid_example; // String | jid
        String uid = uid_example; // String | uid
        Boolean ignoreWarning = true; // Boolean | ignore-warning
        try {
            CaseEventTrigger result = apiInstance.getEventTriggerForCaseUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getEventTriggerForCaseUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String cid = cid_example; // String | cid
        String ctid = ctid_example; // String | ctid
        String etid = etid_example; // String | etid
        String jid = jid_example; // String | jid
        String uid = uid_example; // String | uid
        Boolean ignoreWarning = true; // Boolean | ignore-warning
        try {
            CaseEventTrigger result = apiInstance.getEventTriggerForCaseUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#getEventTriggerForCaseUsingGET");
            e.printStackTrace();
        }
    }
}
String *cid = cid_example; // cid
String *ctid = ctid_example; // ctid
String *etid = etid_example; // etid
String *jid = jid_example; // jid
String *uid = uid_example; // uid
Boolean *ignoreWarning = true; // ignore-warning (optional)

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Fetch an event trigger in the context of a case
[apiInstance getEventTriggerForCaseUsingGETWith:cid
    ctid:ctid
    etid:etid
    jid:jid
    uid:uid
    ignoreWarning:ignoreWarning
              completionHandler: ^(CaseEventTrigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var cid = cid_example; // {String} cid

var ctid = ctid_example; // {String} ctid

var etid = etid_example; // {String} etid

var jid = jid_example; // {String} jid

var uid = uid_example; // {String} uid

var opts = { 
  'ignoreWarning': true // {Boolean} ignore-warning
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventTriggerForCaseUsingGET(cid, ctid, etid, jid, uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventTriggerForCaseUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var cid = cid_example;  // String | cid
            var ctid = ctid_example;  // String | ctid
            var etid = etid_example;  // String | etid
            var jid = jid_example;  // String | jid
            var uid = uid_example;  // String | uid
            var ignoreWarning = true;  // Boolean | ignore-warning (optional) 

            try
            {
                // Fetch an event trigger in the context of a case
                CaseEventTrigger result = apiInstance.getEventTriggerForCaseUsingGET(cid, ctid, etid, jid, uid, ignoreWarning);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.getEventTriggerForCaseUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$cid = cid_example; // String | cid
$ctid = ctid_example; // String | ctid
$etid = etid_example; // String | etid
$jid = jid_example; // String | jid
$uid = uid_example; // String | uid
$ignoreWarning = true; // Boolean | ignore-warning

try {
    $result = $api_instance->getEventTriggerForCaseUsingGET($cid, $ctid, $etid, $jid, $uid, $ignoreWarning);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->getEventTriggerForCaseUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $cid = cid_example; # String | cid
my $ctid = ctid_example; # String | ctid
my $etid = etid_example; # String | etid
my $jid = jid_example; # String | jid
my $uid = uid_example; # String | uid
my $ignoreWarning = true; # Boolean | ignore-warning

eval { 
    my $result = $api_instance->getEventTriggerForCaseUsingGET(cid => $cid, ctid => $ctid, etid => $etid, jid => $jid, uid => $uid, ignoreWarning => $ignoreWarning);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->getEventTriggerForCaseUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
cid = cid_example # String | cid
ctid = ctid_example # String | ctid
etid = etid_example # String | etid
jid = jid_example # String | jid
uid = uid_example # String | uid
ignoreWarning = true # Boolean | ignore-warning (optional)

try: 
    # Fetch an event trigger in the context of a case
    api_response = api_instance.get_event_trigger_for_case_using_get(cid, ctid, etid, jid, uid, ignoreWarning=ignoreWarning)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->getEventTriggerForCaseUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
cid*
String
cid
Required
ctid*
String
ctid
Required
etid*
String
etid
Required
jid*
String
jid
Required
uid*
String
uid
Required
Query parameters
Name Description
ignore-warning
Boolean
ignore-warning

Responses

Status: 200 - Valid pre-state conditions


searchNewUsingGET

Get case data with UI layout


/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases?params="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryEndpointApi;

import java.io.File;
import java.util.*;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String params = params_example; // String | params
        try {
            SearchResultView result = apiInstance.searchNewUsingGET(ctid, jid, params);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#searchNewUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryEndpointApi;

public class QueryEndpointApiExample {

    public static void main(String[] args) {
        QueryEndpointApi apiInstance = new QueryEndpointApi();
        String ctid = ctid_example; // String | ctid
        String jid = jid_example; // String | jid
        String params = params_example; // String | params
        try {
            SearchResultView result = apiInstance.searchNewUsingGET(ctid, jid, params);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryEndpointApi#searchNewUsingGET");
            e.printStackTrace();
        }
    }
}
String *ctid = ctid_example; // ctid
String *jid = jid_example; // jid
String *params = params_example; // params

QueryEndpointApi *apiInstance = [[QueryEndpointApi alloc] init];

// Get case data with UI layout
[apiInstance searchNewUsingGETWith:ctid
    jid:jid
    params:params
              completionHandler: ^(SearchResultView output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.QueryEndpointApi()

var ctid = ctid_example; // {String} ctid

var jid = jid_example; // {String} jid

var params = params_example; // {String} params


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchNewUsingGET(ctid, jid, params, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchNewUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new QueryEndpointApi();
            var ctid = ctid_example;  // String | ctid
            var jid = jid_example;  // String | jid
            var params = params_example;  // String | params

            try
            {
                // Get case data with UI layout
                SearchResultView result = apiInstance.searchNewUsingGET(ctid, jid, params);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryEndpointApi.searchNewUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryEndpointApi();
$ctid = ctid_example; // String | ctid
$jid = jid_example; // String | jid
$params = params_example; // String | params

try {
    $result = $api_instance->searchNewUsingGET($ctid, $jid, $params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryEndpointApi->searchNewUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueryEndpointApi;

my $api_instance = WWW::SwaggerClient::QueryEndpointApi->new();
my $ctid = ctid_example; # String | ctid
my $jid = jid_example; # String | jid
my $params = params_example; # String | params

eval { 
    my $result = $api_instance->searchNewUsingGET(ctid => $ctid, jid => $jid, params => $params);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueryEndpointApi->searchNewUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QueryEndpointApi()
ctid = ctid_example # String | ctid
jid = jid_example # String | jid
params = params_example # String | params

try: 
    # Get case data with UI layout
    api_response = api_instance.search_new_using_get(ctid, jid, params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueryEndpointApi->searchNewUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
ctid*
String
ctid
Required
jid*
String
jid
Required
Query parameters
Name Description
params*
String
params
Required

Responses

Status: 200 - List of case data for the given search criteria

Status: 412 - Mismatch between case type and workbasket definitions


UserProfileEndpoint

getUserProfileUsingGET

Get default setting for user


/caseworkers/{uid}/profile

Usage and SDK Samples

curl -X GET "https://case-data-app.dev.ccd.reform.hmcts.net:4451/caseworkers/{uid}/profile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserProfileEndpointApi;

import java.io.File;
import java.util.*;

public class UserProfileEndpointApiExample {

    public static void main(String[] args) {
        
        UserProfileEndpointApi apiInstance = new UserProfileEndpointApi();
        String authorization = authorization_example; // String | Authorization
        try {
            UserProfile result = apiInstance.getUserProfileUsingGET(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserProfileEndpointApi#getUserProfileUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserProfileEndpointApi;

public class UserProfileEndpointApiExample {

    public static void main(String[] args) {
        UserProfileEndpointApi apiInstance = new UserProfileEndpointApi();
        String authorization = authorization_example; // String | Authorization
        try {
            UserProfile result = apiInstance.getUserProfileUsingGET(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserProfileEndpointApi#getUserProfileUsingGET");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Authorization

UserProfileEndpointApi *apiInstance = [[UserProfileEndpointApi alloc] init];

// Get default setting for user
[apiInstance getUserProfileUsingGETWith:authorization
              completionHandler: ^(UserProfile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CoreCaseDataDataStoreApi = require('core_case_data___data_store_api');

var api = new CoreCaseDataDataStoreApi.UserProfileEndpointApi()

var authorization = authorization_example; // {String} Authorization


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProfileUsingGET(authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserProfileUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new UserProfileEndpointApi();
            var authorization = authorization_example;  // String | Authorization

            try
            {
                // Get default setting for user
                UserProfile result = apiInstance.getUserProfileUsingGET(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserProfileEndpointApi.getUserProfileUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserProfileEndpointApi();
$authorization = authorization_example; // String | Authorization

try {
    $result = $api_instance->getUserProfileUsingGET($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserProfileEndpointApi->getUserProfileUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserProfileEndpointApi;

my $api_instance = WWW::SwaggerClient::UserProfileEndpointApi->new();
my $authorization = authorization_example; # String | Authorization

eval { 
    my $result = $api_instance->getUserProfileUsingGET(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserProfileEndpointApi->getUserProfileUsingGET: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserProfileEndpointApi()
authorization = authorization_example # String | Authorization

try: 
    # Get default setting for user
    api_response = api_instance.get_user_profile_using_get(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserProfileEndpointApi->getUserProfileUsingGET: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Authorization
Required

Responses

Status: 200 - OK


Generated 2018-07-16T10:00:49.010+01:00