GET visitor/getFirmByTitle?Title={Title}&Token={Token}&UseDiacritics={UseDiacritics}

Retrieve list of all visitor firms in the system. Agenda "Visits" has to be licensed. Privilege "View" of licensed agenda "Visitor - Persons" required. Data may also be restricted by record permission "View" of agenda "Visitors - Persons".

Request Information

Authorization

Authorization by token required

Availability

Method disabled by configuration

URI Parameters

Name	Description	Type	Additional information
Title	Visitor firm	string	Required
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required
UseDiacritics	Optional parameter may be omitted. Search data by using case sensitivity and diacritical signs or not. The meaning is: 1 - with diacritical signs and case sensitivity; 0 - without diacritical signs and case insensitivity. Default value is 0	integer	Range: inclusive between 0 and 1

Body Parameters

None.

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1526	Privilege View of agenda Visitors violated for [Visitor {0}]
403 server refuses fo fulfill the request	8	Not licensed
404 required resource does not exist on the server	1528	No visitor firm found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

VisitorGetFirmResp

Name	Description	Type	Additional information
Firms		Collection of Firm	None.

Response Formats

application/json

Sample:

{"Firms":[{"Title":"The Big Company ltd."},{"Title":"ABBC CZ as."},{"Title":"Dunkel Wald GmbH"}]}

application/xml

Sample:


<Response>
  <Firms>
    <Firm>
      <Title>The Big Company ltd.</Title>
    </Firm>
    <Firm>
      <Title>ABBC CZ as.</Title>
    </Firm>
    <Firm>
      <Title>Dunkel Wald GmbH</Title>
    </Firm>
  </Firms>
</Response>

text/json

Sample:

{
  "Firms": [
    {
      "Title": "sample string 1"
    },
    {
      "Title": "sample string 1"
    }
  ]
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Firms>
    <Firm>
      <Title>sample string 1</Title>
    </Firm>
    <Firm>
      <Title>sample string 1</Title>
    </Firm>
  </Firms>
</Response>