1. REST API Guide
  2. Accessing a Siebel Business Service with the matchrequestformat Parameter

Accessing a Siebel Business Service with the matchrequestformat Parameter

You can access a Siebel CRM business service by sending the matchrequestformat parameter in your request. The matchrequestformat parameter request and response has a SOAP-like structure that uses ListOf wrappers, where additional attributes such as pagination, and so on, can be present. The following changes occur in the input and output formats:

  • The input request body wrapper is removed.

  • The output response ListOf wrapper is added to the integration object name, and to all child integration component names.

The following request calls the QueryByExample method of the Siebel Account Business Service. The matchrequestformat parameter value is set to Y, and the business service method arguments are in the request body. This request queries for accounts matching the account-related criteria entered by the user:

  • URI: http://ServerName:port/siebel/v1.0/service/Siebel Account/QueryByExample?matchrequestformat=y

  • HTTP Method: POST

  • Content-Type: application/json

  • Authorization: Basic

  • Request body:
    {
    "SiebelMessage": {
        "IntObjectFormat": "Siebel Hierarchical",
        "MessageId": "",
        "IntObjectName": "Account Interface",
        "MessageType": "Integration Object",
        "ListOfAccount Interface": {
            "Account": [
                {
                    "Account Id": "1-1075",
                    "Partner Flag": "Y",
                     ..........................
                    "ListOfBusiness Address": {
                        "Business Address": [
                            {
                                ............................
                                "Province": "",
                                "IsPrimaryMVG": "Y"
                            }
                        ]
                    },
                    "ListOfRelated Sales Rep": {
                        .............................
                    }
                },
                {
                    "Account Id": "1-106W",
                    "Account Status": "Active",
                    ............................
                    "ListOfBusiness Address": {
                        "Business Address": [
                            {
                               .................
                            }
                        ]
                    }
                }
            ]
        }
    }
}

  • Response body:

    The following is the response of the QueryByExample method of the Siebel Account Business Service:

    {
    "SiebelMessage": {
        "IntObjectFormat": "Siebel Hierarchical",
        "MessageId": "",
        "IntObjectName": "Account Interface",
        "MessageType": "Integration Object",
        "ListOfAccount Interface": {
            "Account": [
                {
                    "Account Id": "1-1075",
                    "Partner Flag": "Y",
                     ..........................
                    "ListOfBusiness Address": {
                        "Business Address": [
                            {
                                ............................
                                "Province": "",
                                "IsPrimaryMVG": "Y"
                            }
                        ]
                    },
                    "ListOfRelated Sales Rep": {
                        .............................
                    }
                },
                {
                    "Account Id": "1-106W",
                    "Account Status": "Active",
                    ............................
                    "ListOfBusiness Address": {
                        "Business Address": [
                            {
                               .................
                            }
                        ]
                    }
                }
            ]
        }
    }
}
Note: Swagger specification for the same business service can be verified using the matchrequestformat parameter mentioned in Swagger specification URL. For example http://ServerName:port/siebel/v1.0/service/Siebel Account/QueryByExample/describe?matchrequestformat=y