BNN Api

<back to all web services

GetBox

Get Box

The following routes are available for this service:
POST/GetBoxGet Box

To override the Content-type in your clients 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 /xml/reply/GetBox HTTP/1.1 
Host: api.dev.bnn.us 
Content-Type: application/xml
Content-Length: length

<GetBox xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Requests">
  <Box>String</Box>
</GetBox>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FdBoxesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bnn.Api.Entities.Dto">
    <d2p1:FdBoxDto>
      <d2p1:Boro>String</d2p1:Boro>
      <d2p1:BoxNumber>String</d2p1:BoxNumber>
      <d2p1:Intersection>String</d2p1:Intersection>
      <d2p1:Lat>0</d2p1:Lat>
      <d2p1:Lon>0</d2p1:Lon>
    </d2p1:FdBoxDto>
  </Data>
</FdBoxesResponse>