POST api/ExecutableSettings/Startup
Request Information
URI Parameters
None.
Body Parameters
ExecutableSettingsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| InstalledLicenseKey | string |
None. |
|
| LogicDeviceCode | string |
None. |
|
| OSBitness | byte |
None. |
|
| OSDeviceName | string |
None. |
|
| OSFullName | string |
None. |
|
| OSLocaleID | integer |
None. |
|
| PhoneNumber | string |
None. |
|
| OSVersion | string |
None. |
|
| ScreenHeight | integer |
None. |
|
| ScreenWidth | integer |
None. |
|
| SoftwareVersion | string |
None. |
|
| TimeZoneDescription | string |
None. |
|
| TimeZoneUtcOffset | integer |
None. |
|
| TotalPhysicalMemory | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"InstalledLicenseKey": "sample string 1",
"LogicDeviceCode": "sample string 2",
"OSBitness": 64,
"OSDeviceName": "sample string 4",
"OSFullName": "sample string 5",
"OSLocaleID": 6,
"PhoneNumber": "sample string 7",
"OSVersion": "sample string 8",
"ScreenHeight": 9,
"ScreenWidth": 10,
"SoftwareVersion": "sample string 11",
"TimeZoneDescription": "sample string 12",
"TimeZoneUtcOffset": 1,
"TotalPhysicalMemory": 13
}
application/xml, text/xml
Sample:
<ExecutableSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <InstalledLicenseKey>sample string 1</InstalledLicenseKey> <LogicDeviceCode>sample string 2</LogicDeviceCode> <OSBitness>64</OSBitness> <OSDeviceName>sample string 4</OSDeviceName> <OSFullName>sample string 5</OSFullName> <OSLocaleID>6</OSLocaleID> <OSVersion>sample string 8</OSVersion> <PhoneNumber>sample string 7</PhoneNumber> <ScreenHeight>9</ScreenHeight> <ScreenWidth>10</ScreenWidth> <SoftwareVersion>sample string 11</SoftwareVersion> <TimeZoneDescription>sample string 12</TimeZoneDescription> <TimeZoneUtcOffset>1</TimeZoneUtcOffset> <TotalPhysicalMemory>13</TotalPhysicalMemory> </ExecutableSettingsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ExecutableSettingsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IntroUrl | string |
None. |
|
| IntroStartDate | date |
None. |
|
| License | License |
None. |
|
| MerchantID | integer |
None. |
|
| SendTicketAfterBillInsurance | boolean |
None. |
|
| SendTicketAfterChargeToAccount | boolean |
None. |
|
| SendTicketAfterComplete | boolean |
None. |
|
| SendTicketAfterPayment | boolean |
None. |
|
| SendTicketAfterSaveWip | boolean |
None. |
|
| SiteID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"IntroUrl": "sample string 1",
"IntroStartDate": "2026-03-21T22:17:07.031668+00:00",
"License": {
"MerchantID": 1,
"SiteID": 2,
"LicenseKey": "sample string 3",
"ExpirationDate": "2026-03-21T22:17:07.031668+00:00",
"LockMethod": true
},
"MerchantID": 3,
"SendTicketAfterBillInsurance": true,
"SendTicketAfterChargeToAccount": true,
"SendTicketAfterComplete": true,
"SendTicketAfterPayment": true,
"SendTicketAfterSaveWip": true,
"SiteID": 9
}
application/xml, text/xml
Sample:
<ExecutableSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InvoMax.Internal.WebAPI.Contracts">
<IntroStartDate>2026-03-21T22:17:07.031668+00:00</IntroStartDate>
<IntroUrl>sample string 1</IntroUrl>
<License>
<ExpirationDate xmlns="">2026-03-21T22:17:07.031668+00:00</ExpirationDate>
<LicenseKey xmlns="">sample string 3</LicenseKey>
<LockMethod xmlns="">true</LockMethod>
<MerchantID xmlns="">1</MerchantID>
<SiteID xmlns="">2</SiteID>
</License>
<MerchantID>3</MerchantID>
<SendTicketAfterBillInsurance>true</SendTicketAfterBillInsurance>
<SendTicketAfterChargeToAccount>true</SendTicketAfterChargeToAccount>
<SendTicketAfterComplete>true</SendTicketAfterComplete>
<SendTicketAfterPayment>true</SendTicketAfterPayment>
<SendTicketAfterSaveWip>true</SendTicketAfterSaveWip>
<SiteID>9</SiteID>
</ExecutableSettingsResponse>