POST Client/RequestExpress

Request a new service in product view

Request Information

URI Parameters

None.

Body Parameters

The service request object

Name	Type	Additional information
ToLanguageId	integer	None.
GenderOptionCodeId	integer	None.
RelatedVersionCode	string	None.
ApplicationCompanyCode	string	None.
DeviceTypeCodeId	integer	None.
ApplicationTypeCodeId	integer	None.
BJCVRIEntityNumber	string	None.
BJCVRIDepartmentPinNumber	string	None.
RequestLocation	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ToLanguageId": 1,
  "GenderOptionCodeId": 1,
  "RelatedVersionCode": "sample string 1",
  "ApplicationCompanyCode": "sample string 2",
  "DeviceTypeCodeId": 1,
  "ApplicationTypeCodeId": 1,
  "BJCVRIEntityNumber": "sample string 3",
  "BJCVRIDepartmentPinNumber": "sample string 4",
  "RequestLocation": "sample string 5"
}

application/xml, text/xml

Sample:

<ParaExpressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <ApplicationCompanyCode>sample string 2</ApplicationCompanyCode>
  <ApplicationTypeCodeId>1</ApplicationTypeCodeId>
  <BJCVRIDepartmentPinNumber>sample string 4</BJCVRIDepartmentPinNumber>
  <BJCVRIEntityNumber>sample string 3</BJCVRIEntityNumber>
  <DeviceTypeCodeId>1</DeviceTypeCodeId>
  <GenderOptionCodeId>1</GenderOptionCodeId>
  <RelatedVersionCode>sample string 1</RelatedVersionCode>
  <RequestLocation>sample string 5</RequestLocation>
  <ToLanguageId>1</ToLanguageId>
</ParaExpressRequest>

Response Information

Resource Description

Returns the transaction server API URL. If null, the transaction server API URL will remain the same

ResultWebServer

Name	Type	Additional information
URL	string	None.
Priority	integer	None.
ErrorMessage	string	None.
isSchedule	ParaSchedule	None.
AnyMeetingExist	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "URL": "sample string 1",
  "Priority": 1,
  "ErrorMessage": "sample string 2",
  "isSchedule": {
    "ScheduledRequestId": 1,
    "ScheduledBlockId": 1,
    "startUtcDate": "2025-04-25T15:01:13.8318945Z",
    "startUtcDateStr": "sample string 1",
    "ScheduleDuration": 1,
    "PersonId": 1,
    "ClientName": "sample string 2",
    "PIN": "sample string 3",
    "ForceId": "sample string 4",
    "PersonName": "sample string 5",
    "PersonEmail": "sample string 6",
    "PersonPhoneNumber": "sample string 7",
    "ClientUserId": 1,
    "FromLanguageId": 1,
    "FromLanguage": "sample string 8",
    "ToLanguageId": 1,
    "ToLanguage": "sample string 9",
    "ProductName": "sample string 10",
    "ProductDescription": "sample string 11",
    "ProviderId": 1,
    "ProviderEmail": "sample string 12",
    "ProviderPhoneNumber": "sample string 13",
    "ProviderName": "sample string 14",
    "ScheduleStatusDescription": "sample string 15",
    "ScheduleStatusId": 1,
    "BillPersonPrechargeProductId": 1,
    "ScheduledRequestRoutingStatusCodeId": 1,
    "ScheduledRequestRoutingStatus": "sample string 16",
    "JoinAvailable": true,
    "callPurpose": "sample string 17",
    "ConfirmationNumber": "sample string 18",
    "GenderOptionCode": "sample string 19",
    "VideoOptionCode": "sample string 20",
    "IsOffered": true,
    "ScheduledRequestProviderId": 1
  },
  "AnyMeetingExist": true
}

application/xml, text/xml

Sample:

<ResultWebServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AnyMeetingExist>true</AnyMeetingExist>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Priority>1</Priority>
  <URL>sample string 1</URL>
  <isSchedule>
    <BillPersonPrechargeProductId>1</BillPersonPrechargeProductId>
    <ClientName>sample string 2</ClientName>
    <ClientUserId>1</ClientUserId>
    <ConfirmationNumber>sample string 18</ConfirmationNumber>
    <ForceId>sample string 4</ForceId>
    <FromLanguage>sample string 8</FromLanguage>
    <FromLanguageId>1</FromLanguageId>
    <GenderOptionCode>sample string 19</GenderOptionCode>
    <IsOffered>true</IsOffered>
    <JoinAvailable>true</JoinAvailable>
    <PIN>sample string 3</PIN>
    <PersonEmail>sample string 6</PersonEmail>
    <PersonId>1</PersonId>
    <PersonName>sample string 5</PersonName>
    <PersonPhoneNumber>sample string 7</PersonPhoneNumber>
    <ProductDescription>sample string 11</ProductDescription>
    <ProductName>sample string 10</ProductName>
    <ProviderEmail>sample string 12</ProviderEmail>
    <ProviderId>1</ProviderId>
    <ProviderName>sample string 14</ProviderName>
    <ProviderPhoneNumber>sample string 13</ProviderPhoneNumber>
    <ScheduleDuration>1</ScheduleDuration>
    <ScheduleStatusDescription>sample string 15</ScheduleStatusDescription>
    <ScheduleStatusId>1</ScheduleStatusId>
    <ScheduledBlockId>1</ScheduledBlockId>
    <ScheduledRequestId>1</ScheduledRequestId>
    <ScheduledRequestProviderId>1</ScheduledRequestProviderId>
    <ScheduledRequestRoutingStatus>sample string 16</ScheduledRequestRoutingStatus>
    <ScheduledRequestRoutingStatusCodeId>1</ScheduledRequestRoutingStatusCodeId>
    <ToLanguage>sample string 9</ToLanguage>
    <ToLanguageId>1</ToLanguageId>
    <VideoOptionCode>sample string 20</VideoOptionCode>
    <callPurpose>sample string 17</callPurpose>
    <startUtcDate>2025-04-25T15:01:13.8318945Z</startUtcDate>
    <startUtcDateStr>sample string 1</startUtcDateStr>
  </isSchedule>
</ResultWebServer>