Organization API V1

ChaingunOrganizationAPI WSDL letöltése

Create organization

Új szervezet létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
organization	OrganizationV1	A létrehozandó szervezet.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
organization	OrganizationV1	A létrehozott szervezet.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ws="http://ws.service.organization.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:createOrganization>
            <request>
                <organization>
                    <name>Moby Kft.</name>
                    <uuid>dbx-2020-0403</uuid>
                </organization>
                <requestMeta>
                    <clientHashKey>?</clientHashKey>
                </requestMeta>
            </request>
        </ws:createOrganization>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/organization/v1/organizations

body: JOrganization1

Válasz

Típus	Leírás
JOrganization1	A létrehozott szervezet.

Minta

KérésVálasz

POST hammy/json/organization/v1/organizations
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
    "type" : "organizations",
    "id" : "lovas-org01",
    "attributes" : {
      "name" : "Lovas 01"
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "organizations",
        "id": "lovas-org01",
        "attributes": {
            "name": "Lovas 01"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Modify organization

Meglévő szervezet módosítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
organization	OrganizationV1	A módosítandó szervezet.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
organization	OrganizationV1	A módosított szervezet.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ws="http://ws.service.organization.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:modifyOrganization>
            <request>
                <organization>
                    <name>Organization Demo 2</name>
                    <uuid>demo-2020-0002</uuid>
                </organization>
                <requestMeta>
                    <clientHashKey>?</clientHashKey>
                    <userName>?</userName>
                </requestMeta>
            </request>
        </ws:modifyOrganization>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/organization/v1/organizations/{{uuid}}

body: JOrganization1

Név	Típus	Leírás
uuid	String	A módosítandó szervezet UUID-ja.

Válasz

Típus	Leírás
JOrganization1	A módosított szervezet.

Minta

KérésVálasz

PUT hammy/json/organization/v1/organizations/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "organizations",
        "id" : "lovas-org01",
        "attributes" : {
        "name" : "Lovas 01"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "organizations",
        "id": "lovas-org01",
        "attributes": {
            "name": "Lovas 01"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find organizations

Szervezetek listázása. Alapból a védett szervezeteket nem fogja visszaadni. Alapból védett a default szervezet.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

GET hammy/json/organization/v1/organizations

Paraméter	Típus	Leírás
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.
name	String	Szervezet neve.
showAllOrg	Boolean	Listázza a védett szervezeteket is.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JOrganization1 [ ]	A megtalált szervezetek.

Minta

KérésVálasz

GET /hammy/json/organization/v1/organizations?showAllOrg=true
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "organizations",
      "id": "default",
      "attributes": {
        "name": "Default Org"
      }
    },
    {
      "type": "organizations",
      "id": "lovas-org01",
      "attributes": {
        "name": "Lovas 01b"
      }
    }
  ],
  "meta": {
    "total": 2,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}