Customer

GET/api/app/customer

Query parameters

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of Snam.Platform.Customers.Dtos.CustomerDto (object)

totalCountinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/customer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2024-11-27T19:32:17.908Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2024-11-27T19:32:17.908Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": false,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2024-11-27T19:32:17.908Z",
      "name": "text",
      "mobileNumber": "text",
      "subscriptionStatus": 1,
      "statusString": "text",
      "branchId": "123e4567-e89b-12d3-a456-426614174000",
      "branchName": "text",
      "customerType": 1,
      "customerTypeString": "text",
      "address": "text",
      "crNumber": "text",
      "vatNumber": "text"
    }
  ]
}

POST/api/app/customer

Body

application/jsontext/jsonapplication/*+json

namenullable string

mobileNumbernullable string

addressnullable string

customerTypeSnam.Platform.Customers.CustomerType (enum)

12

crNumbernullable string

vatNumbernullable string

branchIdnullable string (uuid)

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/customer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404500501

123e4567-e89b-12d3-a456-426614174000

GET/api/app/customer/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

creationTimestring (date-time)

creatorIdnullable string (uuid)

lastModificationTimenullable string (date-time)

lastModifierIdnullable string (uuid)

isDeletedboolean

deleterIdnullable string (uuid)

deletionTimenullable string (date-time)

namenullable string

mobileNumbernullable string

subscriptionStatusSnam.Platform.Subscriptions.SubscriptionStatus (enum)

123456

statusStringnullable string

branchIdnullable string (uuid)

branchNamenullable string

customerTypeSnam.Platform.Customers.CustomerType (enum)

12

customerTypeStringnullable string

addressnullable string

crNumbernullable string

vatNumbernullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/app/customer/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2024-11-27T19:32:17.908Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2024-11-27T19:32:17.908Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": false,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2024-11-27T19:32:17.908Z",
  "name": "text",
  "mobileNumber": "text",
  "subscriptionStatus": 1,
  "statusString": "text",
  "branchId": "123e4567-e89b-12d3-a456-426614174000",
  "branchName": "text",
  "customerType": 1,
  "customerTypeString": "text",
  "address": "text",
  "crNumber": "text",
  "vatNumber": "text"
}

PUT/api/app/customer/{id}

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

namenullable string

mobileNumbernullable string

addressnullable string

customerTypeSnam.Platform.Customers.CustomerType (enum)

12

crNumbernullable string

vatNumbernullable string

branchIdnullable string (uuid)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/customer/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}