ScannerVision Web Server

<back to all web services

JsonBrowseRequest

Requires Authentication

export class JsonDto
{

    public constructor(init?: Partial<JsonDto>) { (Object as any).assign(this, init); }
}

export class JsonRequestDto extends JsonDto
{
    public ClientCode: string;
    public ClientRegistrationCode: string;
    public Token: string;

    public constructor(init?: Partial<JsonRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export class JsonBrowseRequest extends JsonRequestDto
{
    public Path: string;

    public constructor(init?: Partial<JsonBrowseRequest>) { super(init); (Object as any).assign(this, init); }
}

export class JsonBrowseResponse
{
    public Path: string;
    public Folders: string[];

    public constructor(init?: Partial<JsonBrowseResponse>) { (Object as any).assign(this, init); }
}

TypeScript JsonBrowseRequest DTOs

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 /xml/reply/JsonBrowseRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JsonBrowseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientCode>String</ClientCode>
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <Token>String</Token>
  <Path>String</Path>
</JsonBrowseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonBrowseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <Folders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Folders>
  <Path>String</Path>
</JsonBrowseResponse>