GET_USER_PROC

Aprašymas

Paleidžia papildomą vartotojo procedūrą.

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header
  • ApiKey : Privalomas. Unikalus API raktas išduodamas užsakant paslaugą
  • Content-Type : Privalomas. Kokiu formatu paduodami parametrai ir duomenys (request):
    • application/xml
    • application/json
  • Accept: Neprivalomas. Gražinamo rezultato (response) formatas
    • application/xml(default)
    • application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)
Body
  • method : GET_USER_PROC

  • params :

    • procedureName : Iškviečiamos SQL procedūros pavadinimas
  • data: perduodami duomenys:

    • procedureParams - procedūros parametrai

SQL procedūra turi būti įkelta per Manorivile sistemą. Dėl poreikio kontaktuoti UAB Rivilė

pvz application/xml:

<body>
    <method>GET_USER_PROC</method>
    <params>
        <procedureName>USER_STORED_PROCEDURE</procedureName>
    </params>
    <data>
       <procedureParams>
            <Param1>A</Param1>
            <Param2>2019-01-01</Param2>
            <Param3>99.99</Param3>
       </procedureParams>
    </data>
</body>

pvz application/json:

  {
    "method": "GET_USER_PROC",
    "params": { 
        "procedureName": "USER_STORED_PROCEDURE" 
    },
    "data": {
      "procedureParams": {
        "Param1": "A",
        "Param2": "2019-01-01",
        "Param3": "99.99"
      }
    }
  }

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
curl_close($ch);

SQL procedūros pvz

CREATE PROC dbo.USER_STORED_PROCEDURE 
  @Param1 char(1) = null
 ,@Param2 datetime = null
 ,@Param3 numeric(12,2)
as
SELECT * FROM (
    SELECT @Param1 as [Col1], @Param2 as [Col2], @Param3 as [Col3]
    ) as REZ 
FOR XML AUTO, ELEMENTS
Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<?xml version="1.0" encoding="UTF-8" ?>
<RET_DOK>
    <REZ>
      <Col1>A</Col1>
      <Col2>2019-01-01T00:00:00</Col2>
      <Col3>99.99</Col3>
    </REZ>
</RET_DOK>
Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>14433105830.9def1bf4.1584217427751</id>
    <durationMs>45</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
</RET_DOK>
Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas, pvz

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Api key is not valid</errorMessage>
</RET_DOK>
Response (status 500)

Bendrinė sistemos klaida, pvz

<?xml version='1.0' encoding='UTF-8'?>
<Map>
    <timestamp>2020-02-05T12:34:26.890+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>