Skip to content

VisitsApi.md

Latest commit

 

History

History
132 lines (89 loc) · 3.5 KB

VisitsApi.md

File metadata and controls

132 lines (89 loc) · 3.5 KB

LORISClient\VisitsApi

All URIs are relative to https://demo.loris.ca/api/v0.0.4-dev, except if the operation defines another base path.

Method HTTP request Description
createVisit() PUT /candidates/{candid}/{visit} Create a new visit
getVisit() GET /candidates/{candid}/{visit} Get visit details

createVisit()

createVisit($candid, $visit, $visit_create_request)

Create a new visit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = LORISClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new LORISClient\Api\VisitsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$candid = 'candid_example'; // string
$visit = 'visit_example'; // string
$visit_create_request = new \LORISClient\LORISClient\Model\VisitCreateRequest(); // \LORISClient\LORISClient\Model\VisitCreateRequest

try {
    $apiInstance->createVisit($candid, $visit, $visit_create_request);
} catch (Exception $e) {
    echo 'Exception when calling VisitsApi->createVisit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
candid string
visit string
visit_create_request \LORISClient\LORISClient\Model\VisitCreateRequest

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVisit()

getVisit($candid, $visit): \LORISClient\LORISClient\Model\VisitObject

Get visit details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = LORISClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new LORISClient\Api\VisitsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$candid = 'candid_example'; // string
$visit = 'visit_example'; // string

try {
    $result = $apiInstance->getVisit($candid, $visit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VisitsApi->getVisit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
candid string
visit string

Return type

\LORISClient\LORISClient\Model\VisitObject

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]