Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PUT→ /LogoCRMRest/api/v1.0/users

Bootstrap Callout

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

{

"Oid":"C5AB0C26-6199-4379-8CF-F2A8A10430A4"
"FirstName": "Logo1",
"LastName": "CRM1",
"UserName": "LOGOCRM1",
"IsActiveRecord": false,
"IsActive": false,
}

Response

Code

Description

200

Info
titleBilgilendirme

PUT işleminde yani güncelleme yaparken, Oid bilgisini değiştirmemeniz gerekmektedir. Kayıtlı kullanıcı bilgisini bulabileceğimiz değişmeyecek alandır. Diğer alanları güncelleyebilirsiniz.

Bootstrap Callout
Stylewarning
Expand
titleKullanıcı Ekleme

Kullanıcı ekleme işlemi rest üzerinden POST metodu ile yapılmaktadır. Login olduktan sonra, aşağıdaki örnek gibi bir POST işlemi ile kullanıcı ekleme işlemi yapabilirsiniz.

POST→ /LogoCRMRest/api/v1.0/users

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

{
"FirstName": "Test",
"LastName": "1",
"Birthday": "1978-01-25T00:00:00",
"UserName": "Test1",
"ChangePasswordOnFirstLogon": false,
"EMailAddress": "test1@gmail.com",
"ERPUserName": "LOGO",
"Caption": "TEST 1",
"IsActiveRecord": true,
"IsActive": true,
"UserLanguage": "2"
}

Response

Code

Description

200

Info
titleBilgilendirme

IsActiveRecord ve IsActive dikkat edilmesi gerekmektedir. IsActive false olduğu durumda Sisteme girişi engelle otomatik olarak web arayüzde ekrana gelmektedir. Eğer Sisteme giriş false ise IsActive durumuna bakmayacaktır.

Info
titleÖnemli Not

Postman den POST olarak içeriye verileri aldığımızda Logo CRM kullanıcılar menüsüne tıkladığımızda IIS hatasına düşmekteydi. Çözüm için database açıldı ve web arayüzden bir kullanıcıda eksik olan tanımlama nelerdir diye bakıldı ve POST sırasında "USER Language" verilmediğinden IIS hatasına düşüldüğü görüldü. Post işlemi yaparken "UserLanguage" değerini vermeniz gerekmektedir. User Language :1 Türkçe, User Language: 2 İngilizcedir.

Bootstrap Callout Expand
titleKullanıcı Güncelleme

Kullanıcı Güncelleme işleminde PUT metodu ile ilgili alanlarda güncelleme yapılmaktadır. Örnek olarak aşağıdaki çıktıda FirstName, LastName, UserName gibi alanlarda değişiklik yapılmıştır. Ayrıca kullanıcının durumunu pasife çekmek için IsActive ve IsActiveRecord işlemini false çekebilirsiniz. Bu alanların dışında rest ucu ile ilgili diğer alanları da pasif yapabilir veya değiştirebilirsiniz.

Stylesuccess
Expand
titleKullanıcı Girişi

POST→ /LogoCRMRest/api/v1.0/login

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

Authorization

Parametreler base64Encoded olarak "authorization" query name ile POST edilir: 

Example Authorization (Base64 encode için : https://www.base64decode.org/)

  •  Basic BASE64Encode(LOGO:Logo)
  •  Basic BASE64Encode(LOGO:Logo:true)
  •  Basic BASE64Encode(LOGO:Logo:true:tr)
  •  Basic BASE64Encode(LOGO:Logo:true:tr:false) 

Body

#Yok

Response

Code

Description

200

{
    "Meta": null,
    "Result": 1,
    "Message": "",
    "SessionId": "4882666c-c8bb-4998-b3fa-ab6d8a4ffa6a",
    "User": "0fe8cbb3-78eb-4ea5-a81b-4809210c71e8",
    "Integration_Connected": false,
    "Integration_SetOid": "61e1ce89-bc7e-42af-bbe0-4d889fd2c2aa",
    "Integration_ApplicationType": 2,
    "Integration_ApplicationName": "Tiger Enterprise",
    "Integration_FirmNumber": "",
    "Integration_Description": "Tiger3",
    "Integration_BranchCode": "",
    "Integration_BranchName": "",
    "IsUserAdmin": true,
    "RESTApiVersion": "1.59",
    "ClearDescribe": false,
    "AccessRights": [],
    "SalesRepRights": [],
    "NavigationMenuNames": {
        "MT_Firm": "",
        "MT_Contact": "",
        "MT_Task": "",
        "MT_Ticket": "",
        "MT_Event": "",
        "MT_Document": "",
        "MT_Activity": "",
        "MT_Opportunity": "",
        "MT_Proposals": "",
        "MT_Product": "",
        "MT_Campaign": "",
        "MT_Mail": "",
        "MT_Notes": "",
        "MT_Notifications": "",
        "MT_Shares": ""
    },
    "XMLSettings": {
        "flag_DontUseDistanceWhenCheckIn": "0"
    },
    "MaxRequestLength": 4096
}
Bootstrap Callout
Styleinfo
Expand
titleKullanıcı Listesi

GET→ /LogoCrmRest/api/v1.0/users

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

#Yok

Response

Code

Description

200

{
    "Meta": {
        "href": "localhost/LogoCrmRest/api",
        "mediaType": "application/json; charset=UTF-8",
        "fullPath": "/LogoCrmRest/api/v1.0/users",
        "apiVersion": "1"
    },
    "Result": 1,
    "Message": "",
    "Items": [
        {
            "Oid": "406c9b3d-262d-44ab-bc05-0cd6540d376c",
            "InternalPersonType": 1,
            "FirstName": "Ahmet",
            "LastName": "Yılmaz",
            "MiddleName": null,
            "Birthday": "1999-01-01T00:00:00",
            "Email": null,
            "UserName": "Ahmet",
            "IsActive": true,
            "StoredPassword": null,
            "ChangePasswordOnFirstLogon": false,
            "UserLanguage": 1,
            "Gender": 0,
            "EMailAddress": null,
            "ERPUserName": null,
            "Caption": "Ahmet Yılmaz",
            "ProposalSync": 0,
            "PhotoBase64": null,
            "IsActiveRecord": true
        },
        {
            "Oid": "0fe8cbb3-78eb-4ea5-a81b-4809210c71e8",
            "InternalPersonType": 1,
            "FirstName": "System",
            "LastName": "Administrator",
            "MiddleName": null,
            "Birthday": "1900-01-01T00:00:00",
            "Email": null,
            "UserName": "LOGO",
            "IsActive": true,
            "StoredPassword": null,
            "ChangePasswordOnFirstLogon": false,
            "UserLanguage": 1,
            "Gender": 0,
            "EMailAddress": null,
            "ERPUserName": null,
            "Caption": "System Administrator",
            "ProposalSync": 0,
            "PhotoBase64": null,
            "IsActiveRecord": true
        }
    ]
}
Bootstrap Callout
Stylewarning
Expand
titleKullanıcı Ekleme

Kullanıcı ekleme işlemi rest üzerinden POST metodu ile yapılmaktadır. Login olduktan sonra, aşağıdaki örnek gibi bir POST işlemi ile kullanıcı ekleme işlemi yapabilirsiniz.


POST→ /LogoCRMRest/api/v1.0/users

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

{
"FirstName": "Test",
"LastName": "1",
"Birthday": "1978-01-25T00:00:00",
"UserName": "Test1",
"ChangePasswordOnFirstLogon": false,
"EMailAddress": "test1@gmail.com",
"ERPUserName": "LOGO",
"Caption": "TEST 1",
"IsActiveRecord": true,
"IsActive": true,
"UserLanguage": "2"
}

Response

Code

Description

200


Info
titleBilgilendirme

IsActiveRecord ve IsActive dikkat edilmesi gerekmektedir. IsActive false olduğu durumda Sisteme girişi engelle otomatik olarak web arayüzde ekrana gelmektedir. Eğer Sisteme giriş false ise IsActive durumuna bakmayacaktır.

Info
titleÖnemli Not

Postman den POST olarak içeriye verileri aldığımızda Logo CRM kullanıcılar menüsüne tıkladığımızda IIS hatasına düşmekteydi. Çözüm için database açıldı ve web arayüzden bir kullanıcıda eksik olan tanımlama nelerdir diye bakıldı ve POST sırasında "USER Language" verilmediğinden IIS hatasına düşüldüğü görüldü. Post işlemi yaparken "UserLanguage" değerini vermeniz gerekmektedir. User Language :1 Türkçe, User Language: 2 İngilizcedir.

Bootstrap Callout
Expand
titleKullanıcı Güncelleme

Kullanıcı Güncelleme işleminde PUT metodu ile ilgili alanlarda güncelleme yapılmaktadır. Örnek olarak aşağıdaki çıktıda FirstName, LastName, UserName gibi alanlarda değişiklik yapılmıştır. Ayrıca kullanıcının durumunu pasife çekmek için IsActive ve IsActiveRecord işlemini false çekebilirsiniz. Bu alanların dışında rest ucu ile ilgili diğer alanları da pasif yapabilir veya değiştirebilirsiniz.


PUT→ /LogoCRMRest/api/v1.0/users

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

{

"Oid":"C5AB0C26-6199-4379-8CF-F2A8A10430A4"
"FirstName": "Logo1",
"LastName": "CRM1",
"UserName": "LOGOCRM1",
"IsActiveRecord": false,
"IsActive": false,
}

Response

Code

Description

200


Info
titleBilgilendirme

PUT işleminde yani güncelleme yaparken, Oid bilgisini değiştirmemeniz gerekmektedir. Kayıtlı kullanıcı bilgisini bulabileceğimiz değişmeyecek alandır. Diğer alanları güncelleyebilirsiniz.

Bootstrap Callout
Styledanger
Expand
titleKullanıcı Silme

DELETE → /LogoCrmRest/api/v1.0/users/{userOid}

Headers

Name

Value

Content-Type

application/json

Parameters

Name

Value

SessionId

Login işlemi başarılı bir şekilde POST edildiğinde üretilen SessionId kullanılmaktadır.

Body

#Yok

Response

Code

Description

200

{
    "Meta": {
        "href": "localhost/LogoCrmRest/api",
        "mediaType": "application/json; charset=UTF-8",
        "fullPath": "/LogoCrmRest/api/v1.0/users/a051f136-56d1-4e75-bbe1-4b224f4910be",
        "apiVersion": "1"
    },
    "Result": 1,
    "Message": "",
    "Items": []
}

...