REST Service Classes

WebConnection Class

The WebConnection class enables you to customize request properties. You can use it to set the endpoint URI, message format, and client credential.

WebMessageFormat enum

The WebMessageFormat enum allows three formats for the message body:

• XML – well-formed XML.

  String Example:

  <string>You have entered (Xml, Bare): 12345</string>

  Int Array Example:

  <ArrayOfint>
    <int>0</int>
    <int>1</int>
    <int>2</int>
  </ArrayOfint> 

  Structure Example:

  <myStruct>
    <i1>10</i1>
    <str1>Xml, Bare</str1>
  </myStruct>

• DataContract – DataContract data is an XML format defined in a WCF data contract. By default, data contracts are assigned a namespace that comes from the common language runtime (CLR) namespace of the datatype.

  String Example:

  <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
    You have entered (Xml, Bare): 12345
  </string>

  Int Array Example:

  <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <int>0</int>
    <int>1</int>
    <int>2</int>
  </ArrayOfint> 

  Structure Example:

  <myStruct xmlns="http://schemas.datacontract.org/2004/07/None"
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <i1>10</i1>
    <str1>Xml, Bare</str1>
  </myStruct>      

• JSON – data in the JavaScript Object Notation format. Examples of string, array, and structure messages:

  String Example:

  "You have entered (Json, Bare): 12345"

  Int Array Example:

  [0,1,2] 

  Structure Example:

  {"i1":30,"str1":"Json, Bare"}     

WebClientCredential Class

This class specifies properties for REST service client credentials. When called, the PowerBuilder REST client uses credentials to communicate to the service. It supports all transport-level authentications, including Windows authentication, Basic, Digest, and certificate authentication.

WebClientCertificate Class

This class specifies a certificate from a certificate store or a certificate file. When called, the REST client exchanges the certificate with the server for authentication.

WebProxyServer

This class specifies properties for a client firewall. When called, the REST client communicates with the server through the firewall.

WebProxyCredential

This class specifies the credential of the proxy server. When called, the REST client uses the credential to communicate with the server.