Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET customer_field_groups

Ostatnia modyfikacja 2024-11-20 13:20:36
Zwraca listę grup pól specjalnych klienta

URL

https://your-system-name.thulium.com/api/customer_field_groups

Parametry

limit

opcjonalny

Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 1000. Przykładowa wartość: 100
offset

opcjonalny

Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: 10

Przykładowy request

GET https://your-system-name.thulium.com/api/customer_field_groups

Przykładowy response

{
   "count": 1,
   "result": [
      {
         "group_id": 2,
         "name": "Orders",
         "fields": [
            {
               "field_id": 12,
               "name": "Product"
            },
            {
               "field_id": 8,
               "name": "Count"
            },
            {
               "field_id": 9,
               "name": "Confirmed"
            },
            {
               "field_id": 10,
               "name": "Comment"
            }
         ]
      }
   ]
}

Przykładowe wywołanie


PHP

<?php
$request 
curl_init('https://your-system-name.thulium.com/api/customer_field_groups');
curl_setopt($requestCURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($requestCURLOPT_USERPWD"api_user:api_pass");
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_HTTP_CODE);
    if (
$httpCode == 200){
        
print_r(json_decode($response));
    } else {
        echo 
$response;
    }
} else {
    
trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.get("https://your-system-name.thulium.com/api/customer_field_groups");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/customer_field_groups"

HTTPie

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/customer_field_groups Accept:application/json