BackofficeApi

<back to all web services

PlaceExcludeAddUploadRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
POST/place_exclude/add
PlaceExcludeAddUploadRequest Parameters:
NameParameterData TypeRequiredDescription
PlacesToExcludebodyList<PlaceExcludeDto>Yes
PlaceExcludeDto Parameters:
NameParameterData TypeRequiredDescription
CountryformstringYes
OrganizationNumberformstringYes
NoteformstringYes
PlaceExcludeAddUploadResponse Parameters:
NameParameterData TypeRequiredDescription
PlacesAddedToExcludeformintNo

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.

POST /place_exclude/add HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PlaceExcludeAddUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <PlacesToExclude>
    <PlaceExcludeDto>
      <Country>String</Country>
      <Note>String</Note>
      <OrganizationNumber>String</OrganizationNumber>
    </PlaceExcludeDto>
  </PlacesToExclude>
</PlaceExcludeAddUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PlaceExcludeAddUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <PlacesAddedToExclude>0</PlacesAddedToExclude>
</PlaceExcludeAddUploadResponse>