GET api/OnTheGo/Auth/GetSettings?language={language}

Request Information

URI Parameters

Name	Description	Type	Additional information
language		string	Default value is

Body Parameters

None.

Response Information

Resource Description

ValidationInfo

Name	Type	Additional information
AuthKeyAmbiguousInfo	AuthenticationKeyAmbiguous	None.
AutoFillJobTime	boolean	None.
AutoAlignJobTimes	boolean	None.
PromptJobStatusChangeOnTicketTimesEntry	boolean	None.
AutoSyncJobTicket	boolean	None.
ClientID	string	None.
ClockIncrementIntervalMinutes	integer	None.
ClockInTimeBuffer	integer	None.
ClockInTimeBufferTarget	string	None.
EmpID	integer	None.
EmployeeName	string	None.
EnforceSingleJobWorkflow	boolean	None.
EnforceTicketSubmission	boolean	None.
ShowLineItemPrices	boolean	None.
ErrorMessage	string	None.
GPSReportFrequency	integer	None.
GPSTrackFrequency	integer	None.
GPSTrackingMethod	string	None.
HomeLocationID	integer	None.
DispatchLocationID	integer	None.
IsClockInEnforced	boolean	None.
IsPreJobSignatureRequired	boolean	None.
IsPostJobSignatureRequired	boolean	None.
IsValidated	boolean	None.
IsDVIRClockInEnforced	boolean	None.
ClockInRequired	string	None.
LicensedTo	string	None.
Lineitems	Collection of InvoiceItem	None.
CustomerLineItems	Dictionary of integer [key] and Collection of InvoiceItem [value]	None.
Locations	Collection of Location	None.
MaxClockInTimeSpan	integer	None.
MessageCheckFrequency	integer	None.
MinUserRefreshTimeout	integer	None.
PreJobDisclaimer	string	None.
PostJobDisclaimer	string	None.
RoleGroup	string	None.
SupportPhone	string	None.
SupportEmail	string	None.
SyncFrequency	integer	None.
UISettings	Collection of UIElement	None.
UTCOffsetHours	decimal number	None.
EnforceDVIROffsetHours	decimal number	None.
AllowJobTimesOverlap	boolean	None.
AllowTimeSheetsOverlap	boolean	None.
JobTimesRounding	string	None.
JobTimeOrder	string	None.
JobTicketAcknowledgeRequired	boolean	None.
TimeZone	string	None.
PayPeriodStart	date	None.
PayPeriodEnd	date	None.
Photo	string	None.
EmployeeJobVolume	integer	None.
EmployeeJobCount	integer	None.
Security	Collection of SecurityPermissions	None.
APICredentials	APICredentials	None.

Response Formats

application/json, text/json

Sample:

{
  "AuthKeyAmbiguousInfo": {
    "KeyGUID": "3a4402b5-5016-42e8-a744-1bda730e9f25",
    "UTCKeyIssuedTime": "2025-11-04T20:48:06.275Z",
    "UTCKeyExpireTime": "2025-11-04T20:48:06.275Z",
    "MinutesToExpire": 4,
    "IsExpiredOrNotFound": true,
    "IsPendingJobChange": true,
    "IsTicketingJobChange": true,
    "IsCompletedJobChange": true,
    "IsClockingChange": true,
    "IsMessageChange": true,
    "IsSettingsChange": true,
    "IsKeepAlive": true,
    "IsPasswordChange": true,
    "Version": "sample string 14",
    "ForceUpdate": true
  },
  "AutoFillJobTime": true,
  "AutoAlignJobTimes": true,
  "PromptJobStatusChangeOnTicketTimesEntry": true,
  "AutoSyncJobTicket": true,
  "ClientID": "sample string 5",
  "ClockIncrementIntervalMinutes": 6,
  "ClockInTimeBuffer": 7,
  "ClockInTimeBufferTarget": "sample string 8",
  "EmpID": 9,
  "EmployeeName": "sample string 10",
  "EnforceSingleJobWorkflow": true,
  "EnforceTicketSubmission": true,
  "ShowLineItemPrices": true,
  "ErrorMessage": "sample string 14",
  "GPSReportFrequency": 15,
  "GPSTrackFrequency": 16,
  "GPSTrackingMethod": "sample string 17",
  "HomeLocationID": 18,
  "DispatchLocationID": 19,
  "IsClockInEnforced": true,
  "IsPreJobSignatureRequired": true,
  "IsPostJobSignatureRequired": true,
  "IsValidated": true,
  "IsDVIRClockInEnforced": true,
  "ClockInRequired": "sample string 25",
  "LicensedTo": "sample string 26",
  "Lineitems": [
    {
      "ItemID": 1,
      "ItemName": "sample string 2",
      "ItemQuantity": 3.0,
      "ItemPrice": 4.0,
      "ItemTaxed": true,
      "ItemXSys": true
    },
    {
      "ItemID": 1,
      "ItemName": "sample string 2",
      "ItemQuantity": 3.0,
      "ItemPrice": 4.0,
      "ItemTaxed": true,
      "ItemXSys": true
    }
  ],
  "CustomerLineItems": {
    "1": [
      {
        "ItemID": 1,
        "ItemName": "sample string 2",
        "ItemQuantity": 3.0,
        "ItemPrice": 4.0,
        "ItemTaxed": true,
        "ItemXSys": true
      },
      {
        "ItemID": 1,
        "ItemName": "sample string 2",
        "ItemQuantity": 3.0,
        "ItemPrice": 4.0,
        "ItemTaxed": true,
        "ItemXSys": true
      }
    ],
    "2": [
      {
        "ItemID": 1,
        "ItemName": "sample string 2",
        "ItemQuantity": 3.0,
        "ItemPrice": 4.0,
        "ItemTaxed": true,
        "ItemXSys": true
      },
      {
        "ItemID": 1,
        "ItemName": "sample string 2",
        "ItemQuantity": 3.0,
        "ItemPrice": 4.0,
        "ItemTaxed": true,
        "ItemXSys": true
      }
    ]
  },
  "Locations": [
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "Address": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "PostalCode": "sample string 6",
      "Phone": "sample string 7",
      "Fax": "sample string 8",
      "GPSLat": 1.0,
      "GPSLong": 1.0
    },
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "Address": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "PostalCode": "sample string 6",
      "Phone": "sample string 7",
      "Fax": "sample string 8",
      "GPSLat": 1.0,
      "GPSLong": 1.0
    }
  ],
  "MaxClockInTimeSpan": 27,
  "MessageCheckFrequency": 28,
  "MinUserRefreshTimeout": 29,
  "PreJobDisclaimer": "sample string 30",
  "PostJobDisclaimer": "sample string 31",
  "RoleGroup": "sample string 32",
  "SupportPhone": "(303) 500-3050",
  "SupportEmail": "support@rapidworks.com",
  "SyncFrequency": 33,
  "UISettings": [
    {
      "id": 1,
      "AppID": 2,
      "Name": "sample string 3",
      "APIMapping": "sample string 4",
      "Label": "sample string 5",
      "DefaultValue": "sample string 6",
      "Category": "sample string 7",
      "Type": "sample string 8",
      "DisplayParams": "sample string 9",
      "SortOrder": 10,
      "IsRequired": true,
      "IsReadOnly": true,
      "IsHidden": true,
      "IsEditable": true,
      "IsLockable": true,
      "Validation": "sample string 16",
      "ValidationParams": "sample string 17",
      "ValidationMessage": "sample string 18",
      "TipText": "sample string 19",
      "Actions": "sample string 20",
      "ValueSourceURL": "sample string 21",
      "ValueSourceURLParams": "sample string 22"
    },
    {
      "id": 1,
      "AppID": 2,
      "Name": "sample string 3",
      "APIMapping": "sample string 4",
      "Label": "sample string 5",
      "DefaultValue": "sample string 6",
      "Category": "sample string 7",
      "Type": "sample string 8",
      "DisplayParams": "sample string 9",
      "SortOrder": 10,
      "IsRequired": true,
      "IsReadOnly": true,
      "IsHidden": true,
      "IsEditable": true,
      "IsLockable": true,
      "Validation": "sample string 16",
      "ValidationParams": "sample string 17",
      "ValidationMessage": "sample string 18",
      "TipText": "sample string 19",
      "Actions": "sample string 20",
      "ValueSourceURL": "sample string 21",
      "ValueSourceURLParams": "sample string 22"
    }
  ],
  "UTCOffsetHours": 34.0,
  "EnforceDVIROffsetHours": 35.0,
  "AllowJobTimesOverlap": true,
  "AllowTimeSheetsOverlap": true,
  "JobTimesRounding": "sample string 38",
  "JobTimeOrder": "sample string 39",
  "JobTicketAcknowledgeRequired": true,
  "TimeZone": "sample string 41",
  "PayPeriodStart": "2025-11-04T20:48:06.291Z",
  "PayPeriodEnd": "2025-11-04T20:48:06.291Z",
  "Photo": "sample string 44",
  "EmployeeJobVolume": 45,
  "EmployeeJobCount": 46,
  "Security": [
    {
      "Permission": 1,
      "Visible": true,
      "Read": true,
      "Write": true,
      "Delete": true
    },
    {
      "Permission": 1,
      "Visible": true,
      "Read": true,
      "Write": true,
      "Delete": true
    }
  ],
  "APICredentials": {
    "ServiceClient": {
      "UserID": 1,
      "Authorization": "sample string 2",
      "ClientID": 3
    }
  }
}

application/xml, text/xml

Sample:

<AuthenticationModel.ValidationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/appsvc.rapidappsinc.com.Areas.OnTheGo.Models">
  <APICredentials>
    <ServiceClient>
      <Authorization>sample string 2</Authorization>
      <ClientID>3</ClientID>
      <UserID>1</UserID>
    </ServiceClient>
  </APICredentials>
  <AllowJobTimesOverlap>true</AllowJobTimesOverlap>
  <AllowTimeSheetsOverlap>true</AllowTimeSheetsOverlap>
  <AuthKeyAmbiguousInfo>
    <ForceUpdate>true</ForceUpdate>
    <IsClockingChange>true</IsClockingChange>
    <IsCompletedJobChange>true</IsCompletedJobChange>
    <IsExpiredOrNotFound>true</IsExpiredOrNotFound>
    <IsKeepAlive>true</IsKeepAlive>
    <IsMessageChange>true</IsMessageChange>
    <IsPasswordChange>true</IsPasswordChange>
    <IsPendingJobChange>true</IsPendingJobChange>
    <IsSettingsChange>true</IsSettingsChange>
    <IsTicketingJobChange>true</IsTicketingJobChange>
    <KeyGUID>3a4402b5-5016-42e8-a744-1bda730e9f25</KeyGUID>
    <MinutesToExpire>4</MinutesToExpire>
    <UTCKeyExpireTime>2025-11-04T20:48:06.2759228+00:00</UTCKeyExpireTime>
    <UTCKeyIssuedTime>2025-11-04T20:48:06.2759228+00:00</UTCKeyIssuedTime>
    <Version>sample string 14</Version>
  </AuthKeyAmbiguousInfo>
  <AutoAlignJobTimes>true</AutoAlignJobTimes>
  <AutoFillJobTime>true</AutoFillJobTime>
  <AutoSyncJobTicket>true</AutoSyncJobTicket>
  <ClientID>sample string 5</ClientID>
  <ClockInRequired>sample string 25</ClockInRequired>
  <ClockInTimeBuffer>7</ClockInTimeBuffer>
  <ClockInTimeBufferTarget>sample string 8</ClockInTimeBufferTarget>
  <ClockIncrementIntervalMinutes>6</ClockIncrementIntervalMinutes>
  <CustomerLineItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfJobsModel.InvoiceItems9kTaJNY>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>
        <JobsModel.InvoiceItem>
          <ItemID>1</ItemID>
          <ItemName>sample string 2</ItemName>
          <ItemPrice>4</ItemPrice>
          <ItemQuantity>3</ItemQuantity>
          <ItemTaxed>true</ItemTaxed>
          <ItemXSys>true</ItemXSys>
        </JobsModel.InvoiceItem>
        <JobsModel.InvoiceItem>
          <ItemID>1</ItemID>
          <ItemName>sample string 2</ItemName>
          <ItemPrice>4</ItemPrice>
          <ItemQuantity>3</ItemQuantity>
          <ItemTaxed>true</ItemTaxed>
          <ItemXSys>true</ItemXSys>
        </JobsModel.InvoiceItem>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfJobsModel.InvoiceItems9kTaJNY>
    <d2p1:KeyValueOfintArrayOfJobsModel.InvoiceItems9kTaJNY>
      <d2p1:Key>2</d2p1:Key>
      <d2p1:Value>
        <JobsModel.InvoiceItem>
          <ItemID>1</ItemID>
          <ItemName>sample string 2</ItemName>
          <ItemPrice>4</ItemPrice>
          <ItemQuantity>3</ItemQuantity>
          <ItemTaxed>true</ItemTaxed>
          <ItemXSys>true</ItemXSys>
        </JobsModel.InvoiceItem>
        <JobsModel.InvoiceItem>
          <ItemID>1</ItemID>
          <ItemName>sample string 2</ItemName>
          <ItemPrice>4</ItemPrice>
          <ItemQuantity>3</ItemQuantity>
          <ItemTaxed>true</ItemTaxed>
          <ItemXSys>true</ItemXSys>
        </JobsModel.InvoiceItem>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfJobsModel.InvoiceItems9kTaJNY>
  </CustomerLineItems>
  <DispatchLocationID>19</DispatchLocationID>
  <EmpID>9</EmpID>
  <EmployeeJobCount>46</EmployeeJobCount>
  <EmployeeJobVolume>45</EmployeeJobVolume>
  <EmployeeName>sample string 10</EmployeeName>
  <EnforceDVIROffsetHours>35</EnforceDVIROffsetHours>
  <EnforceSingleJobWorkflow>true</EnforceSingleJobWorkflow>
  <EnforceTicketSubmission>true</EnforceTicketSubmission>
  <ErrorMessage>sample string 14</ErrorMessage>
  <GPSReportFrequency>15</GPSReportFrequency>
  <GPSTrackFrequency>16</GPSTrackFrequency>
  <GPSTrackingMethod>sample string 17</GPSTrackingMethod>
  <HomeLocationID>18</HomeLocationID>
  <IsClockInEnforced>true</IsClockInEnforced>
  <IsDVIRClockInEnforced>true</IsDVIRClockInEnforced>
  <IsPostJobSignatureRequired>true</IsPostJobSignatureRequired>
  <IsPreJobSignatureRequired>true</IsPreJobSignatureRequired>
  <IsValidated>true</IsValidated>
  <JobTicketAcknowledgeRequired>true</JobTicketAcknowledgeRequired>
  <JobTimeOrder>sample string 39</JobTimeOrder>
  <JobTimesRounding>sample string 38</JobTimesRounding>
  <LicensedTo>sample string 26</LicensedTo>
  <Lineitems>
    <JobsModel.InvoiceItem>
      <ItemID>1</ItemID>
      <ItemName>sample string 2</ItemName>
      <ItemPrice>4</ItemPrice>
      <ItemQuantity>3</ItemQuantity>
      <ItemTaxed>true</ItemTaxed>
      <ItemXSys>true</ItemXSys>
    </JobsModel.InvoiceItem>
    <JobsModel.InvoiceItem>
      <ItemID>1</ItemID>
      <ItemName>sample string 2</ItemName>
      <ItemPrice>4</ItemPrice>
      <ItemQuantity>3</ItemQuantity>
      <ItemTaxed>true</ItemTaxed>
      <ItemXSys>true</ItemXSys>
    </JobsModel.InvoiceItem>
  </Lineitems>
  <Locations>
    <AuthenticationModel.Location>
      <Address>sample string 3</Address>
      <City>sample string 4</City>
      <Fax>sample string 8</Fax>
      <GPSLat>1</GPSLat>
      <GPSLong>1</GPSLong>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <Phone>sample string 7</Phone>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 5</State>
    </AuthenticationModel.Location>
    <AuthenticationModel.Location>
      <Address>sample string 3</Address>
      <City>sample string 4</City>
      <Fax>sample string 8</Fax>
      <GPSLat>1</GPSLat>
      <GPSLong>1</GPSLong>
      <LocationID>1</LocationID>
      <LocationName>sample string 2</LocationName>
      <Phone>sample string 7</Phone>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 5</State>
    </AuthenticationModel.Location>
  </Locations>
  <MaxClockInTimeSpan>27</MaxClockInTimeSpan>
  <MessageCheckFrequency>28</MessageCheckFrequency>
  <MinUserRefreshTimeout>29</MinUserRefreshTimeout>
  <PayPeriodEnd>2025-11-04T20:48:06.2915447+00:00</PayPeriodEnd>
  <PayPeriodStart>2025-11-04T20:48:06.2915447+00:00</PayPeriodStart>
  <Photo>sample string 44</Photo>
  <PostJobDisclaimer>sample string 31</PostJobDisclaimer>
  <PreJobDisclaimer>sample string 30</PreJobDisclaimer>
  <PromptJobStatusChangeOnTicketTimesEntry>true</PromptJobStatusChangeOnTicketTimesEntry>
  <RoleGroup>sample string 32</RoleGroup>
  <Security>
    <AuthenticationModel.SecurityPermissions>
      <Delete>true</Delete>
      <Permission>1</Permission>
      <Read>true</Read>
      <Visible>true</Visible>
      <Write>true</Write>
    </AuthenticationModel.SecurityPermissions>
    <AuthenticationModel.SecurityPermissions>
      <Delete>true</Delete>
      <Permission>1</Permission>
      <Read>true</Read>
      <Visible>true</Visible>
      <Write>true</Write>
    </AuthenticationModel.SecurityPermissions>
  </Security>
  <ShowLineItemPrices>true</ShowLineItemPrices>
  <SyncFrequency>33</SyncFrequency>
  <TimeZone>sample string 41</TimeZone>
  <UISettings>
    <AuthenticationModel.UIElement>
      <APIMapping>sample string 4</APIMapping>
      <Actions>sample string 20</Actions>
      <AppID>2</AppID>
      <Category>sample string 7</Category>
      <DefaultValue>sample string 6</DefaultValue>
      <DisplayParams>sample string 9</DisplayParams>
      <IsEditable>true</IsEditable>
      <IsHidden>true</IsHidden>
      <IsLockable>true</IsLockable>
      <IsReadOnly>true</IsReadOnly>
      <IsRequired>true</IsRequired>
      <Label>sample string 5</Label>
      <Name>sample string 3</Name>
      <SortOrder>10</SortOrder>
      <TipText>sample string 19</TipText>
      <Type>sample string 8</Type>
      <Validation>sample string 16</Validation>
      <ValidationMessage>sample string 18</ValidationMessage>
      <ValidationParams>sample string 17</ValidationParams>
      <ValueSourceURL>sample string 21</ValueSourceURL>
      <ValueSourceURLParams>sample string 22</ValueSourceURLParams>
      <id>1</id>
    </AuthenticationModel.UIElement>
    <AuthenticationModel.UIElement>
      <APIMapping>sample string 4</APIMapping>
      <Actions>sample string 20</Actions>
      <AppID>2</AppID>
      <Category>sample string 7</Category>
      <DefaultValue>sample string 6</DefaultValue>
      <DisplayParams>sample string 9</DisplayParams>
      <IsEditable>true</IsEditable>
      <IsHidden>true</IsHidden>
      <IsLockable>true</IsLockable>
      <IsReadOnly>true</IsReadOnly>
      <IsRequired>true</IsRequired>
      <Label>sample string 5</Label>
      <Name>sample string 3</Name>
      <SortOrder>10</SortOrder>
      <TipText>sample string 19</TipText>
      <Type>sample string 8</Type>
      <Validation>sample string 16</Validation>
      <ValidationMessage>sample string 18</ValidationMessage>
      <ValidationParams>sample string 17</ValidationParams>
      <ValueSourceURL>sample string 21</ValueSourceURL>
      <ValueSourceURLParams>sample string 22</ValueSourceURLParams>
      <id>1</id>
    </AuthenticationModel.UIElement>
  </UISettings>
  <UTCOffsetHours>34</UTCOffsetHours>
</AuthenticationModel.ValidationInfo>