GET api/Locations?Projectid={Projectid}&Activerecordsonly={Activerecordsonly}

Token sahibi kullanıcının yetkili olduğu lokasyonlar arasından belirtilen Proje ID ve aktiflik durumuna göre sistemdeki lokasyonları listeler.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Projectid

Lokasyonların bağlı olduğu proje benzersiz kimlik (ID) numarası.

integer

Required

Activerecordsonly

Sadece aktif durumda olan kayıtların getirilip getirilmeyeceğini belirler. True gönderilirse sadece aktif kayıtlar, False gönderilirse tüm kayıtlar listelenir. Varsayılan değer True'dur.

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Belirtilen kriterlere uyan lokasyon listesini döner.

Collection of Location
NameDescriptionTypeAdditional information
Id

Lokasyonun sistemdeki benzersiz kimlik (ID) numarası.

integer

None.

Integrationcode

Lokasyonun entegrasyon kodudur 3.parti yazılımlar veya sistemlerle entegrasyon için kullanılan alandır.

string

String length: inclusive between 0 and 50

Name

Lokasyonun adı veya tanımı. Bu alan, lokasyonun ne olduğunu veya ne amaçla kullanıldığını açıklamak için kullanılır.

string

String length: inclusive between 0 and 150

Zone

Lokasyonun bulunduğu bölge adı veya tanımı. Bu alan, Lokasyonun hangi bölgede olduğunu belirtmek için kullanılır.

string

None.

Active

Lokasyonun aktiflik durumu. 1 ise aktif, 0 ise pasiftir.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Integrationcode": "sample string 2",
    "Name": "sample string 3",
    "Zone": "sample string 4",
    "Active": 5
  },
  {
    "Id": 1,
    "Integrationcode": "sample string 2",
    "Name": "sample string 3",
    "Zone": "sample string 4",
    "Active": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IntegroV6API">
  <Location>
    <Active>5</Active>
    <Id>1</Id>
    <Integrationcode>sample string 2</Integrationcode>
    <Name>sample string 3</Name>
    <Zone>sample string 4</Zone>
  </Location>
  <Location>
    <Active>5</Active>
    <Id>1</Id>
    <Integrationcode>sample string 2</Integrationcode>
    <Name>sample string 3</Name>
    <Zone>sample string 4</Zone>
  </Location>
</ArrayOfLocation>