BusinessApi

<back to all web services

GetBusinessRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/business/get
GetBusinessRequest Parameters:
NameParameterData TypeRequiredDescription
BusinessIdquerylongNo
GetBusinessResponse Parameters:
NameParameterData TypeRequiredDescription
BusinessformBusinessDtoYes
BusinessDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
OrganizationNumberformstringNo
StreetAddressformstringYes
PostalCodeformstringYes
CityformstringYes
CountryformstringYes
ContactformBusinessContactNo
BusinessContact Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
PositionformstringYes
PhoneformstringNo
EmailformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /business/get HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetBusinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Business>
    <City>String</City>
    <Contact xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Email>String</d3p1:Email>
      <d3p1:FirstName>String</d3p1:FirstName>
      <d3p1:LastName>String</d3p1:LastName>
      <d3p1:Phone>String</d3p1:Phone>
      <d3p1:Position>String</d3p1:Position>
    </Contact>
    <Country>String</Country>
    <Id>0</Id>
    <Name>String</Name>
    <OrganizationNumber>String</OrganizationNumber>
    <PostalCode>String</PostalCode>
    <StreetAddress>String</StreetAddress>
  </Business>
</GetBusinessResponse>