İçeriğe geç
Store API

User

Serverhttps://magaza-adiniz.myideasoft.com

User LIST

GET
https://magaza-adiniz.myideasoft.com
/api/users
Bearer

User LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Users adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

firstname
​string

Firstname.

surname
​string

Surname.

email
​string

Email.

username
​string

Username.

phoneNumber
​string

Phone Number.

isOwner
​string · enum

Is Owner.

Enum values:
0
1
status
​string · enum

Status Can be 0 for passive, 1 for active or 2 for queue

Enum values:
0
1
2
startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

User LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

email
​string · email · maxLength: 255 · required

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
username
​string · maxLength: 255 · required

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum · required

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
phoneNumber
​string · maxLength: 255
createdAt
​string · date-time · writeOnly

Kullanıcı hesabının oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time · writeOnly

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isOwner
​integer · enum
Enum values:
0
1
mfaSecret
​string · maxLength: 1024 · writeOnly
mfaResetKey
​string · maxLength: 256 · writeOnly
mfaMethod
​string · maxLength: 50 · writeOnly
mfaOtpCode
​string · maxLength: 50 · writeOnly
mfaOtpCodeSentAt
​string · date-time · writeOnly
​object · writeOnly
userRole
​object · writeOnly

User GET

GET
https://magaza-adiniz.myideasoft.com
/api/users/{id}
Bearer

User GET › path Parameters

id
​string · pattern: \d+ · required

User GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

email
​string · email · maxLength: 255 · required

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
username
​string · maxLength: 255 · required

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum · required

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
phoneNumber
​string · maxLength: 255
createdAt
​string · date-time · writeOnly

Kullanıcı hesabının oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time · writeOnly

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isOwner
​integer · enum
Enum values:
0
1
mfaSecret
​string · maxLength: 1024 · writeOnly
mfaResetKey
​string · maxLength: 256 · writeOnly
mfaMethod
​string · maxLength: 50 · writeOnly
mfaOtpCode
​string · maxLength: 50 · writeOnly
mfaOtpCodeSentAt
​string · date-time · writeOnly
​object · writeOnly
userRole
​object · writeOnly