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 JsonServerInformationRequest extends JsonRequestDto
{
public ClientHostName: string;
public UserName: string;
public IsPro: boolean;
public ClientId: string;
public constructor(init?: Partial<JsonServerInformationRequest>) { super(init); (Object as any).assign(this, init); }
}
export class JsonServerInformationResponse extends JsonDto
{
public ClientIpAddress: string;
public ClientGuid: string;
public ClientName: string;
public ClientId: string;
public UserHomeFolder: string;
public UserEmail: string;
public ServerVersion: string;
public AllowUpdate: boolean;
public FtpUsername: string;
public FtpPassword: string;
public AdminUsername: string;
public AdminPassword: string;
public FtpPort: number;
public SupportedDocumentFormats: string[];
public HpnVersion: string;
public constructor(init?: Partial<JsonServerInformationResponse>) { super(init); (Object as any).assign(this, init); }
}
TypeScript JsonServerInformationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/JsonServerInformationRequest HTTP/1.1
Host: buildmax.org
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ClientHostName: String,
UserName: String,
IsPro: False,
ClientId: String,
ClientCode: String,
ClientRegistrationCode: String,
Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ClientIpAddress: String,
ClientGuid: String,
ClientName: String,
ClientId: String,
UserHomeFolder: String,
UserEmail: String,
ServerVersion: String,
AllowUpdate: False,
FtpUsername: String,
FtpPassword: String,
AdminUsername: String,
AdminPassword: String,
FtpPort: 0,
SupportedDocumentFormats:
[
String
],
HpnVersion: String
}