Tegoed controleren

Grid Statistics 1.0

Gebruik onderstaand URL-sjabloon om uw huidig tegoed op te vragen.

Ondersteunde HTTP-methoden

GET

URL-sjabloon

Tegoed opvragen.

http://api.gisblox.com/REST/v1/gridstatistics/manage/credit?format=format&key=PersoonlijkeGISBloxSleutel

Sjabloonparameters

Opmerking

Kijk op de Algemene types en parameters-pagina voor informatie over de algemene respons-types en parameters die deze URL gebruikt.

Credit-type: bevat informatie over uw tegoed.
Output-parameters: bevat informatie over het output-formaat van de respons.

Parameternamen en -waarden zijn niet hoofdlettergevoelig.

Parameter	Omschrijving	Waarde
format	Optioneel Het output-formaat van de respons.	Eén van de volgende opties: xml [standaardwaarde] json Voorbeeld: format=json
key	Vereist Specificeert de GISBlox API-sleutel die voor dit verzoek gebruikt moet worden.	Een geldige GISBlox API-sleutel. Voorbeeld: key=abc1234def56789

Respons

Als antwoord op een HTTP-verzoek wordt een respons-object geretourneerd. Afhankelijk van de waarde van input-parameter format, heeft het respons-object het volgende output-formaat:

XML (application/xml)
JSON (application/json)

Resultaat

Het resultaat van onderstaand voorbeeld wordt geretourneerd als een Credit-resource binnen het generieke Response-type. Kijk voor meer informatie over de Credit-resource op de pagina over het Credit-type. Voor informatie over de overige algemene types en parameters kijkt u op de Algemene types en parameters-pagina.

Voorbeeld

Huidig tegoed opvragen

In onderstaand voorbeeld wordt het actuele tegoed opgevraagd dat behoort bij de opgegeven GISBlox-sleutel.

http://api.gisblox.com/REST/v1/gridstatistics/manage/credit?key=PersoonlijkeGISBloxSleutel

XML Response

                    
<Response xmlns="http://schemas.gisblox.com/rest/v1/gridstatistics" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Copyright>Copyright © 2011-2017 Bartels Online. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Bartels Online.</Copyright>
  <StatusCode>200</StatusCode>
  <StatusDescription>OK</StatusDescription>
  <ErrorDetails />
  <TraceId>8FF19DAE-A073-40B8-BEF0-51070CAB9E86/0503cc86-e48b-4d4a-a01a-b8c953badf0d/-718458138</TraceId>
  <Resource i:type="Credit">
    <ItemId>1</ItemId>
    <RMPsUsed>7909</RMPsUsed>
    <RMPCredit>92091</RMPCredit>
    <RMPMax>100000</RMPMax>
    <RMPLimitReached>false</RMPLimitReached>
    <Expired>false</Expired>
  </Resource>
</Response>

JSON Response

                    
{
    "Copyright": "Copyright © 2011-2017 Bartels Online. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Bartels Online.",
    "StatusCode": 200,
    "StatusDescription": "OK",
    "ErrorDetails": "",
    "TraceId": "8FF19DAE-A073-40B8-BEF0-51070CAB9E86\/7d16b81d-9c6a-4e3e-bbf8-9d7e8e743f0d\/-1567006195",
    "Resource": {
        "__type": "Credit:http:\/\/schemas.gisblox.com\/rest\/v1\/gridstatistics",
        "ItemId": 1,
        "RMPsUsed": 7909,
        "RMPCredit": 92091,
        "RMPMax": 100000,
        "RMPLimitReached": false,
        "Expired": false
    }
}

HTTP-statuscodes

Opmerking

Meer details over deze HTTP-statuscode zijn te vinden in artikel Statuscodes en foutafhandeling.

Na een succesvol verzoek wordt de volgende HTTP-statuscode geretourneerd.

Na een niet-succesvol verzoek wordt een van de volgende foutcodes geretourneerd.

Verwante onderwerpen

Beheer-API

Laatst gewijzigd: 2018-10-18