POST Application/GetAvailableBackups

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	globally unique identifier	None.
ContactID	globally unique identifier	Required
Name	string	None.
SecurityGroupID	globally unique identifier	Required
UserName	string	Required
CanLogIn	boolean	Required
Password	Collection of byte	None.
ChangePassword	boolean	Required
BlockSynch	boolean	Required
Domain	string	None.
Locked	boolean	Required
ClearData	boolean	Required
MobileVersion	string	None.
DateInstalled	date	None.
RememberMe	boolean	Required
RefreshData	boolean	Required
PinCode	string	None.
APIToken	string	None.
RoleID	globally unique identifier	None.
CompanyRoleID	globally unique identifier	None.
TokenCacheBits	Collection of byte	None.
TokenLastWrite	date	None.
ExpiresIn	integer	None.
MonthlyHours	integer	None.
HasTwoFactorAuthentication	boolean	Required
IsActive	boolean	Required
DatePasswordExpires	date	None.
CanSignDocuments	boolean	Required
DocuSignUserID	string	None.
IsVerified	boolean	Required
DateVerified	date	None.
Token	string	None.
MobileOnlyUser	boolean	Required
RefreshTokenCache	Collection of byte	None.
LastSyncDate	date	None.
IsUpgradeAvailable	boolean	Required
DateUpgraded	date	None.
LastSuccessfulSyncDate	date	None.
PreviousMobileVersion	string	None.
Contact	Contact	None.
Role	Role	None.
SecurityGroup	SecurityGroup	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "565949c2-3db7-45ea-8e58-bb4d90a5538b",
  "ContactID": "c7682615-8422-4f90-9cb9-4e99ad44431d",
  "Name": "sample string 3",
  "SecurityGroupID": "fef43454-56b7-4b13-ae99-76eb96d891e7",
  "UserName": "sample string 5",
  "CanLogIn": true,
  "Password": "QEA=",
  "ChangePassword": true,
  "BlockSynch": true,
  "Domain": "sample string 9",
  "Locked": true,
  "ClearData": true,
  "MobileVersion": "sample string 12",
  "DateInstalled": "2025-09-05T18:36:56.2787557+00:00",
  "RememberMe": true,
  "RefreshData": true,
  "PinCode": "sample string 15",
  "APIToken": "sample string 16",
  "RoleID": "3df45b12-f503-4275-902b-eaafb542e990",
  "CompanyRoleID": "8256f861-aaf1-4ac2-94e2-1d582f753d75",
  "TokenCacheBits": "QEA=",
  "TokenLastWrite": "2025-09-05T18:36:56.2787557+00:00",
  "ExpiresIn": 1,
  "MonthlyHours": 1,
  "HasTwoFactorAuthentication": true,
  "IsActive": true,
  "DatePasswordExpires": "2025-09-05T18:36:56.2787557+00:00",
  "CanSignDocuments": true,
  "DocuSignUserID": "sample string 20",
  "IsVerified": true,
  "DateVerified": "2025-09-05T18:36:56.2787557+00:00",
  "Token": "sample string 22",
  "MobileOnlyUser": true,
  "RefreshTokenCache": "QEA=",
  "LastSyncDate": "2025-09-05T18:36:56.2787557+00:00",
  "IsUpgradeAvailable": true,
  "DateUpgraded": "2025-09-05T18:36:56.2787557+00:00",
  "LastSuccessfulSyncDate": "2025-09-05T18:36:56.2787557+00:00",
  "PreviousMobileVersion": "sample string 25",
  "Contact": {
    "$id": "2",
    "ID": "a2c4361c-6a08-49d4-b2d2-c9c66ae8eb8d",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Name": "sample string 4",
    "CellNumber": "sample string 5",
    "WorkNumber": "sample string 6",
    "HomeNumber": "sample string 7",
    "Email": "sample string 8",
    "PhysicalAddress": "sample string 9",
    "PostalAddress": "sample string 10",
    "Birthday": "2025-09-05T18:36:56.2787557+00:00",
    "GenderID": 1,
    "ContactStatusID": 1,
    "PhotoID": "38d25cc9-cd08-4da8-85c7-1ecfa8689301",
    "ExternalCode": "sample string 11",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "IDNumber": "sample string 12",
    "PassportNumber": "sample string 13",
    "DisplayName": "sample string 14",
    "UseDisplayName": true,
    "OptOutNotification": true,
    "CreatedByContactID": "3bc4eb1e-0110-442c-8c4f-a006059fef68",
    "ModifiedByContactID": "90541c83-d073-4a9d-a6b7-7ef078b90d54",
    "CreatedDate": "2025-09-05T18:36:56.2787557+00:00",
    "ModifiedDate": "2025-09-05T18:36:56.2787557+00:00"
  },
  "Role": {
    "$id": "3",
    "ID": "2c025d70-9047-4e67-be24-ff431ece0d6e",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsSystemAdministrator": true,
    "WorkflowID": "27ea8270-b7ac-4fce-b1e0-2fa3ba820689",
    "IsGroupAdmin": true,
    "Workflow": {
      "$id": "4",
      "ID": "59aa84d4-3861-4467-a337-92fb3b9f71d0",
      "ParentID": "42b6a0fa-2661-4f0b-8777-9389aa2e5192",
      "TypeID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Sequence": 5,
      "Active": true,
      "Caption": "sample string 7",
      "IconName": "sample string 8",
      "IsMobile": true,
      "Alias": "sample string 10",
      "NotificationBadgeValueViewModel": "sample string 11",
      "NotificationBadgeBackgroundColour": "sample string 12",
      "NotificationBadgeTextColour": "sample string 13",
      "IsPercentageNotificationBadge": true,
      "IsVisible": true
    }
  },
  "SecurityGroup": {
    "$id": "5",
    "ID": "9f1be139-355c-4042-ba1e-650c99e981f6",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "LogVerbosityID": 4,
    "BlockSyncMessage": "sample string 5",
    "SyncPollingMin": 6,
    "IsBlocked": true,
    "IsCommercialWorkflow": true,
    "IsDefault": true,
    "PhotoID": "d35bd0da-6566-4855-af96-8e063c17ca73"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResponse

Name	Type	Additional information
IsSuccess	boolean	None.
ErrorMessage	string	None.
Code	string	None.
StackTrace	string	None.
Response	ServiceItem	None.

Response Formats

application/json, text/json

Sample:

Sample not available.