{
"swagger": "2.0",
"info": {
"version": "V4",
"title": "Trov API 4.0",
"description": "The API for interacting with Trov.",
"x-swagger-net-version": "8.3.13.002",
"x-enumNames": [
{
"Name": "ValidationStatus",
"IsString": false,
"Items": {
"None": "0",
"Valid": "1",
"Invalid": "2",
"InvalidRequest": "4",
"InvalidResponse": "8"
}
},
{
"Name": "PolicyType",
"IsString": false,
"Items": {
"Unknown": "0",
"Contents": "1",
"Property": "2",
"Vehicle": "3"
}
},
{
"Name": "FeedMessageAction",
"IsString": true,
"Items": {
"Sell": "Sell",
"Insure": "Insure",
"Share": "Share"
}
},
{
"Name": "ClickActionType",
"IsString": false,
"Items": {
"Unknown": "0",
"AssetDetail": "1",
"Dashboard": "2"
}
},
{
"Name": "FeedMessageType",
"IsString": false,
"Items": {
"Unknown": "0",
"AssetNew": "1",
"AssetNewReceipt": "2",
"AssetNewEmail": "3",
"AssetUpdate": "4",
"AssetValue": "5",
"AssetDelete": "6",
"AssetTransfer": "7",
"AssetTransferCancelled": "8",
"TrovAddVehicle": "100",
"TrovAddProperty": "101",
"TrovAddEmailAccount": "102",
"TrovAddBroker": "103",
"TrovAddPhone": "104",
"Announcement": "200",
"ReValueExperiment": "901"
}
},
{
"Name": "NotificationType",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"AssetDisplay": "AssetDisplay",
"AssetRevalued": "AssetRevalued",
"AssetGifted": "AssetGifted",
"AssetSold": "AssetSold",
"AssetAutoDetect": "AssetAutoDetect",
"AssetsImported": "AssetsImported",
"ClaimCompanyMessageSent": "ClaimCompanyMessageSent",
"ClaimDenied": "ClaimDenied",
"ClaimAccepted": "ClaimAccepted",
"ClaimCancelled": "ClaimCancelled",
"ClaimSettled": "ClaimSettled"
}
},
{
"Name": "NotificationStatus",
"IsString": false,
"Items": {
"Deferred": "1",
"Sending": "2",
"Retrying": "3",
"Sent": "4",
"Error": "5"
}
},
{
"Name": "UserState",
"IsString": false,
"Items": {
"Active": "0"
}
},
{
"Name": "OperationTypes",
"IsString": false,
"Items": {
"None": "0",
"Login": "1",
"Autodetect": "2"
}
},
{
"Name": "OfficialPremiumInterval",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Monthly": "Monthly",
"Daily": "Daily"
}
},
{
"Name": "PromotionEndReason",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Cancelled": "Cancelled",
"Consumed": "Consumed",
"Expired": "Expired"
}
},
{
"Name": "PromotionType",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Cash": "Cash",
"Duration": "Duration"
}
},
{
"Name": "TaxCalculation",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"BeforeTax": "BeforeTax",
"AfterTax": "AfterTax"
}
},
{
"Name": "UnderwritingWarning",
"IsString": true,
"Items": {
"None": "None",
"InsuranceSoldOut": "InsuranceSoldOut",
"InsuranceCategorySoldOut": "InsuranceCategorySoldOut",
"CustomerLimitReached": "CustomerLimitReached",
"ItemLimitReached": "ItemLimitReached"
}
},
{
"Name": "PremiumCalculationStatus",
"IsString": true,
"Items": {
"Success": "Success",
"FailedToPrice": "FailedToPrice",
"Declined": "Declined",
"ItemCategoryNotSupported": "ItemCategoryNotSupported",
"CustomerAgeNotSupported": "CustomerAgeNotSupported",
"CustomerAddressNotSupported": "CustomerAddressNotSupported",
"PremiumNotAffordable": "PremiumNotAffordable",
"UnderwritingDenied": "UnderwritingDenied"
}
},
{
"Name": "PriceOfferType",
"IsString": true,
"Items": {
"Quote": "Quote",
"ProfileChange": "ProfileChange",
"PricingModelChange": "PricingModelChange",
"PdsUpdate": "PdsUpdate"
}
},
{
"Name": "StopInsureReason",
"IsString": true,
"Items": {
"User": "User",
"PaymentFail": "PaymentFail",
"StaffCancel": "StaffCancel",
"Claim": "Claim",
"ProfileCoverageChange": "ProfileCoverageChange",
"PricingModelCoverageChange": "PricingModelCoverageChange"
}
},
{
"Name": "PriceOfferRequestFailure",
"IsString": true,
"Items": {
"ItemValueTooLow": "ItemValueTooLow",
"ItemValueTooHigh": "ItemValueTooHigh",
"ItemCategoryNotSupported": "ItemCategoryNotSupported",
"BeValuedInvalidArticleId": "BeValuedInvalidArticleId",
"BeValuedNoValueEstimate": "BeValuedNoValueEstimate",
"BeValuedLookupFailure": "BeValuedLookupFailure",
"PricingFailed": "PricingFailed",
"UserProfileIncomplete": "UserProfileIncomplete",
"UserProfileNotSupported": "UserProfileNotSupported",
"PaymentPastDue": "PaymentPastDue"
}
},
{
"Name": "PaymentCardBrand",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Visa": "Visa",
"AmericanExpress": "AmericanExpress",
"MasterCard": "MasterCard",
"Discover": "Discover",
"JCB": "JCB",
"DinersClub": "DinersClub"
}
},
{
"Name": "PhotoType",
"IsString": true,
"Items": {
"Background": "Background",
"Profile": "Profile"
}
},
{
"Name": "ClaimPaymentRequestType",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"CreditCard": "CreditCard"
}
},
{
"Name": "ClaimSettlementItemIssue",
"IsString": true,
"Items": {
"NotCovered": "NotCovered",
"CoverageStartedLessThanThirtyDaysAgo": "CoverageStartedLessThanThirtyDaysAgo",
"NoRefundDueToNotTotalLoss": "NoRefundDueToNotTotalLoss",
"NoRefundDueToWaivedPayment": "NoRefundDueToWaivedPayment",
"LostItemNotTotalLoss": "LostItemNotTotalLoss",
"StolenItemNotTotalLoss": "StolenItemNotTotalLoss",
"NoRefundDueToPromotionalPayment": "NoRefundDueToPromotionalPayment",
"NoRefundDueToDeferredPayment": "NoRefundDueToDeferredPayment"
}
},
{
"Name": "ClaimSettlementMethod",
"IsString": true,
"Items": {
"Payout": "Payout",
"Repair": "Repair",
"RepairByCustomer": "RepairByCustomer",
"Replace": "Replace"
}
},
{
"Name": "ClaimSettlementIssue",
"IsString": true,
"Items": {
"NoActiveCoveragePeriods": "NoActiveCoveragePeriods",
"NonPositivePayableAmount": "NonPositivePayableAmount",
"LostWithItemsNotTotalLoss": "LostWithItemsNotTotalLoss",
"StolenWithItemsNotTotalLoss": "StolenWithItemsNotTotalLoss",
"PayoutNotSupportedForSelectedSettlementMethod": "PayoutNotSupportedForSelectedSettlementMethod",
"BankAccountNotSetForPayout": "BankAccountNotSetForPayout",
"NetPaymentDueNotPaid": "NetPaymentDueNotPaid"
}
},
{
"Name": "ClaimAssetAction",
"IsString": true,
"Items": {
"Add": "Add",
"Remove": "Remove"
}
},
{
"Name": "ConversationState",
"IsString": true,
"Items": {
"LossType": "LossType",
"LossDate": "LossDate",
"LossLocation": "LossLocation",
"Description": "Description",
"Description2": "Description2",
"Photos": "Photos",
"Photos2": "Photos2",
"PhoneNumber": "PhoneNumber",
"ConfirmationCode": "ConfirmationCode",
"Banking": "Banking",
"Done": "Done"
}
},
{
"Name": "ClaimMessageResponseType",
"IsString": true,
"Items": {
"Any": "Any",
"LossType": "LossType",
"LossDate": "LossDate",
"LossLocation": "LossLocation",
"NoReply": "NoReply",
"BankAccount": "BankAccount",
"Text": "Text",
"Photo": "Photo",
"PhoneNumber": "PhoneNumber",
"ConfirmationCode": "ConfirmationCode",
"PaymentCard": "PaymentCard"
}
},
{
"Name": "ClaimEventType",
"IsString": true,
"Items": {
"StatusUpdate": "StatusUpdate",
"TypeOfLossUpdate": "TypeOfLossUpdate",
"LossDateUpdate": "LossDateUpdate",
"LossLocationUpdate": "LossLocationUpdate",
"PhoneNumberUpdate": "PhoneNumberUpdate",
"BankAccountUpdate": "BankAccountUpdate",
"AssignmentUpdate": "AssignmentUpdate",
"CompanyMessage": "CompanyMessage",
"CustomerMessage": "CustomerMessage",
"Note": "Note",
"Photo": "Photo",
"Payout": "Payout",
"AssetUpdate": "AssetUpdate",
"AssetAmountUpdate": "AssetAmountUpdate",
"CustomerMessageDismissalUpdate": "CustomerMessageDismissalUpdate",
"ClaimPaymentCardUpdate": "ClaimPaymentCardUpdate",
"ExcessPayment": "ExcessPayment",
"Payable": "Payable",
"SettlementMethodUpdate": "SettlementMethodUpdate"
}
},
{
"Name": "ClaimTypeOfLoss",
"IsString": true,
"Items": {
"Lost": "Lost",
"Stolen": "Stolen",
"Damaged": "Damaged"
}
},
{
"Name": "ClaimStatus",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Draft": "Draft",
"Submitted": "Submitted",
"Cancelled": "Cancelled",
"Accepted": "Accepted",
"Denied": "Denied",
"Settled": "Settled"
}
},
{
"Name": "PaymentType",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Charged": "Charged",
"Waived": "Waived",
"Refunded": "Refunded",
"RefundedExGratia": "RefundedExGratia",
"SettledIntoClaim": "SettledIntoClaim",
"AlreadyRefunded": "AlreadyRefunded",
"RetroactiveCancellation": "RetroactiveCancellation",
"WaivedRefund": "WaivedRefund",
"InsuranceNotStarted": "InsuranceNotStarted",
"Promotion": "Promotion",
"PromotionRefund": "PromotionRefund",
"Deferred": "Deferred",
"DeferredRefund": "DeferredRefund"
}
},
{
"Name": "PaymentHistoryFilter",
"IsString": false,
"Items": {
"All": "0",
"MostRecent": "1",
"AllSuccessful": "2"
}
},
{
"Name": "TransactionEventType",
"IsString": true,
"Items": {
"NotStarted": "NotStarted",
"Started": "Started",
"Succeeded": "Succeeded",
"Abandoned": "Abandoned",
"Failed": "Failed",
"Rejected": "Rejected"
}
},
{
"Name": "AuditAction",
"IsString": true,
"Items": {
"Create": "Create",
"Update": "Update",
"Delete": "Delete",
"Restore": "Restore"
}
},
{
"Name": "TwoFactorProviderType",
"IsString": false,
"Items": {
"Unknown": "0",
"Email": "1",
"Text": "3",
"Voice": "4"
}
},
{
"Name": "ClientApplicationType",
"IsString": false,
"Items": {
"Native": "0",
"Javascript": "1"
}
},
{
"Name": "PhoneNumberConfirmationType",
"IsString": false,
"Items": {
"Voice": "0",
"Sms": "1"
}
},
{
"Name": "SecurityAuditType",
"IsString": true,
"Items": {
"InvalidPassword": "InvalidPassword",
"InvalidUser": "InvalidUser",
"InvalidRoleAccess": "InvalidRoleAccess",
"PasswordResetRequest": "PasswordResetRequest",
"PasswordResetCompleteFailure": "PasswordResetCompleteFailure",
"PasswordResetCompleteSuccess": "PasswordResetCompleteSuccess",
"UserChangeEmail": "UserChangeEmail",
"UserCreate": "UserCreate",
"UserDelete": "UserDelete",
"UserDoesNotExist": "UserDoesNotExist",
"UserIsActiveStateUpdate": "UserIsActiveStateUpdate",
"UserLockedOut": "UserLockedOut",
"UserRoleChangeAdd": "UserRoleChangeAdd",
"UserRoleChangeRemove": "UserRoleChangeRemove",
"UserRoleChangeUpdate": "UserRoleChangeUpdate"
}
},
{
"Name": "SupportedImage",
"IsString": true,
"Items": {
"Bmp": "Bmp",
"Gif": "Gif",
"Jpeg": "Jpeg",
"Png": "Png",
"Tiff": "Tiff"
}
},
{
"Name": "MetadataKey",
"IsString": false,
"Items": {
"Unknown": "0",
"StartVersion": "1",
"EndVersion": "2",
"Width": "3",
"Height": "4",
"OriginalFilename": "5",
"S3Key": "6",
"GridFsKey": "7",
"FitMode": "8",
"MaxWidth": "9",
"MaxHeight": "10",
"PertainsTo": "11"
}
},
{
"Name": "BankAccountDetailType",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"BeneficiaryId": "BeneficiaryId",
"SortCodeLast4Digits": "SortCodeLast4Digits"
}
},
{
"Name": "BankAccountProvider",
"IsString": true,
"Items": {
"Unknown": "Unknown",
"Pin": "Pin",
"CurrencyCloud": "CurrencyCloud"
}
},
{
"Name": "StorageBlobType",
"IsString": false,
"Items": {
"TrovData": "0",
"MigrationSource": "1",
"Insurance": "2",
"Claims": "3",
"GeneralLedger": "4",
"Bordereau": "5",
"RawProviderData": "6",
"BeValued": "7"
}
},
{
"Name": "CurrencyType",
"IsString": false,
"Items": {
"USD": "0",
"CAD": "1",
"GBP": "2",
"AUD": "3",
"EUR": "4",
"CHF": "5",
"NZD": "6",
"NOK": "7",
"SEK": "8"
}
},
{
"Name": "SchemaType",
"IsString": false,
"Items": {
"Asset": "0",
"Audio": "1",
"Building": "2",
"Collection": "3",
"Document": "4",
"File": "5",
"Floor": "6",
"Image": "7",
"Property": "8",
"Room": "9",
"Trov": "10",
"UserInvite": "11",
"User": "12",
"Video": "13",
"Sitemap": "14",
"TrovInvite": "15",
"Index": "16",
"FloorPlan": "17",
"BulkTrovInvite": "18"
}
},
{
"Name": "RevisionReason",
"IsString": false,
"Items": {
"Metadata": "0",
"Audio": "1",
"Image": "2",
"Document": "3",
"Video": "4",
"Eula": "5",
"System": "6",
"Creation": "7",
"Sitemap": "8",
"ClientServiceUpdate": "9",
"FloorPlan": "10",
"Deletion": "11",
"UserToken": "12",
"Archival": "13",
"Sold": "14",
"Given": "15",
"Lost": "16",
"Destroyed": "17",
"TrovSetting": "18",
"TrovToken": "19",
"TrovEmailAccount": "20",
"TrovMilestone": "21",
"TrovPolicy": "22",
"Categorization": "23",
"FairMarketValuation": "24",
"ReplacementValuation": "25",
"PurchaseAmount": "26",
"Trashed": "27",
"Ownership": "28",
"Damaged": "29",
"Stolen": "30"
}
},
{
"Name": "PublishableKeyProvider",
"IsString": true,
"Items": {
"Pin": "Pin",
"Stripe": "Stripe"
}
},
{
"Name": "TemplatedEmailMergeLanguage",
"IsString": false,
"Items": {
"Mailchimp": "0",
"Handlebars": "1"
}
},
{
"Name": "AssetStatus",
"IsString": true,
"Items": {
"Owned": "Owned",
"Loaned": "Loaned",
"RentedOut": "RentedOut",
"Borrowed": "Borrowed",
"Renting": "Renting",
"Sold": "Sold",
"Gifted": "Gifted",
"Donated": "Donated"
}
},
{
"Name": "AssetFlag",
"IsString": false,
"Items": {
"WoozAttention": "0"
}
},
{
"Name": "PreferredContactMethod",
"IsString": false,
"Items": {
"Unspecified": "0",
"Email": "1",
"Callback": "2",
"WillCall": "3"
}
},
{
"Name": "PreferredContactTime",
"IsString": false,
"Items": {
"Unspecified": "0",
"Morning": "1",
"Afternoon": "2",
"Evening": "3"
}
},
{
"Name": "VehicleCondition",
"IsString": true,
"Items": {
"Excellent": "Excellent",
"VeryGood": "VeryGood",
"Good": "Good",
"Fair": "Fair"
}
}
]
},
"host": "api-us.macronlabs.com",
"basePath": "/Trov.Service",
"schemes": [
"https"
],
"paths": {
"/api/v4.0/account/email": {
"put": {
"tags": [
"Account"
],
"summary": "Changes the email address for the current user.",
"operationId": "PUT_api_account_email",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "changeEmailRequest",
"in": "body",
"description": "The model that represents the change email request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityChangeEmailRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 InvalidPasswordException": {
"description": "The password was incorrect.",
"schema": {
"$ref": "#/definitions/InvalidPasswordException",
"default": {
"Message": "The password provided was invalid.",
"ExceptionMessage": "The password provided was invalid.",
"ExceptionType": "InvalidPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The new email address was null or empty.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"409 EmailAlreadyInUseException": {
"description": "The new email address is already in use by another user account.",
"schema": {
"$ref": "#/definitions/EmailAlreadyInUseException",
"default": {
"Message": "The email address is in use by an existing user.",
"ExceptionMessage": "The email address is in use by an existing user.",
"ExceptionType": "EmailAlreadyInUseException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/password": {
"put": {
"tags": [
"Account"
],
"summary": "Changes the password for the current user.\r\n \r\nAny active long term access tokens (`refresh_token`) will be invalidated.",
"operationId": "PUT_api_account_password",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "changePasswordRequestModel",
"in": "body",
"description": "The model that represents the change password request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityChangePasswordRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 InvalidPasswordException": {
"description": "The old password was incorrect.",
"schema": {
"$ref": "#/definitions/InvalidPasswordException",
"default": {
"Message": "The password provided was invalid.",
"ExceptionMessage": "The password provided was invalid.",
"ExceptionType": "InvalidPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The new password did not meet the complexity requirements.
\r\n The `NewPassword` and `ConfirmNewPassword` properties did not match.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Account"
],
"summary": "Sets the password for the current user.\r\n \r\nCan only be used when the user does not have a current password.",
"operationId": "POST_api_account_password",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "setPasswordRequest",
"in": "body",
"description": "The model that represents the set password request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecuritySetPasswordRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 UserHasPasswordException": {
"description": "The user has a current password set.",
"schema": {
"$ref": "#/definitions/UserHasPasswordException",
"default": {
"Message": "Setting the password this way is prohibited on accounts with existing passwords, please use the dedicated endpoints update password endpoint.",
"ExceptionMessage": "Setting the password this way is prohibited on accounts with existing passwords, please use the dedicated endpoints update password endpoint.",
"ExceptionType": "UserHasPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The new password did not meet the complexity requirements.
\r\n The `NewPassword` and `ConfirmNewPassword` properties did not match.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/twoFactorAuthentication": {
"put": {
"tags": [
"Account"
],
"summary": "Toggles two factor authentication for the current user.",
"operationId": "PUT_api_account_twoFactorAuthentication",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "toggleTwoFactorAuthenticationRequest",
"in": "body",
"description": "The model that represents the two factor authentication toggle request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityToggleTwoFactorAuthenticationRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 InvalidPasswordException": {
"description": "The password was incorrect.",
"schema": {
"$ref": "#/definitions/InvalidPasswordException",
"default": {
"Message": "The password provided was invalid.",
"ExceptionMessage": "The password provided was invalid.",
"ExceptionType": "InvalidPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 UserRequiresConfirmationException": {
"description": "Enabling two-factor authentication requires a confirmed phone number.",
"schema": {
"$ref": "#/definitions/UserRequiresConfirmationException",
"default": {
"Message": "The user account () requires phone contact information in a confirmed state.",
"ExceptionMessage": "The user account () requires phone contact information in a confirmed state.",
"ExceptionType": "UserRequiresConfirmationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/phoneNumber": {
"put": {
"tags": [
"Account"
],
"summary": "Changes the phone number for the current user and optionally requests a confirmation code to be sent to the phone number.",
"operationId": "PUT_api_account_phoneNumber",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "changePhoneNumberRequest",
"in": "body",
"description": "The model that represents the change phone number request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityChangePhoneNumberRequest"
}
},
{
"name": "confirmationType",
"in": "query",
"description": "Optional phone number confirmation type to use. A confirmation code is not sent if this parameter is not supplied. (0 = Voice , 1 = Sms )",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1
],
"x-enumName": "PhoneNumberConfirmationType"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 InvalidPhoneNumberException": {
"description": "The specified phone number cannot be used for confirmation (e.g. invalid format, missing country code, etc.).",
"schema": {
"$ref": "#/definitions/InvalidPhoneNumberException",
"default": {
"Message": "The phone number provided is invalid.",
"ExceptionMessage": "The phone number provided is invalid.",
"ExceptionType": "InvalidPhoneNumberException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 InvalidPasswordException": {
"description": "The password was incorrect.",
"schema": {
"$ref": "#/definitions/InvalidPasswordException",
"default": {
"Message": "The password provided was invalid.",
"ExceptionMessage": "The password provided was invalid.",
"ExceptionType": "InvalidPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 UserDoesNotHavePasswordException": {
"description": "The user account does not have a password set.",
"schema": {
"$ref": "#/definitions/UserDoesNotHavePasswordException",
"default": {
"Message": "The user account does not have a password set.",
"ExceptionMessage": "The user account does not have a password set.",
"ExceptionType": "UserDoesNotHavePasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The new phone number was null or empty.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/logoff": {
"post": {
"tags": [
"Account"
],
"summary": "Logs the current user out of the system.",
"operationId": "POST_api_account_logoff",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/resetPassword": {
"post": {
"tags": [
"Account"
],
"summary": "Issues a request to start the reset password process for a specified email address.",
"operationId": "POST_api_account_resetPassword",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The model that represents the reset password request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityResetPasswordRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/phoneNumber/confirm": {
"post": {
"tags": [
"Account"
],
"summary": "Confirms the phone number for the current user.",
"operationId": "POST_api_account_phoneNumber_confirm",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "confirmPhoneNumberRequest",
"in": "body",
"description": "The model that represents the phone number confirmation request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityConfirmPhoneNumberRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 InvalidPinException": {
"description": "The PIN failed validation.",
"schema": {
"$ref": "#/definitions/InvalidPinException",
"default": {
"Message": "The PIN provided was invalid.",
"ExceptionMessage": "The PIN provided was invalid.",
"ExceptionType": "InvalidPinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/email/requestConfirm": {
"post": {
"tags": [
"Account"
],
"summary": "Requests a confirmation email to be sent for the current user.",
"operationId": "POST_api_account_email_requestConfirm",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"409 EmailAlreadyConfirmedException": {
"description": "The email address associated with the current user has already been confirmed.",
"schema": {
"$ref": "#/definitions/EmailAlreadyConfirmedException",
"default": {
"Message": "The string has already been confirmed.",
"ExceptionMessage": "The string has already been confirmed.",
"ExceptionType": "EmailAlreadyConfirmedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account/phoneNumber/requestConfirm": {
"post": {
"tags": [
"Account"
],
"summary": "Requests a confirmation code to be sent to the phone number for the current user.",
"operationId": "POST_api_account_phoneNumber_requestConfirm",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "confirmationType",
"in": "query",
"description": "The type of confirmation to use. (0 = Voice , 1 = Sms )",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
],
"x-enumName": "PhoneNumberConfirmationType"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 PhoneNumberNotSetException": {
"description": "The user account does not have a phone number set.",
"schema": {
"$ref": "#/definitions/PhoneNumberNotSetException",
"default": {
"Message": "The user account does not contain a phone number.",
"ExceptionMessage": "The user account does not contain a phone number.",
"ExceptionType": "PhoneNumberNotSetException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"409 PhoneNumberAlreadyConfirmedException": {
"description": "The phone number associated with the current user has already been confirmed.",
"schema": {
"$ref": "#/definitions/PhoneNumberAlreadyConfirmedException",
"default": {
"Message": "The phone number 'string' has already been confirmed.",
"ExceptionMessage": "The phone number 'string' has already been confirmed.",
"ExceptionType": "PhoneNumberAlreadyConfirmedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account-status/summary": {
"get": {
"tags": [
"AccountStatus"
],
"summary": "Gets a minimal summary of the logged in user's, current billing cycle's account status for use with the On Demand Refund endpoint.\r\nIncludes protection statuses for assets in the current billing cycle, and the available true up refund amount if it exists.",
"operationId": "GET_api_account_status_summary",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedAccountStatusAccountStatusSummaryResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account-status/detailed": {
"get": {
"tags": [
"AccountStatus"
],
"summary": "Returns the detailed account status as HTML, for the logged in user, for the current billing cycle.",
"operationId": "GET_api_account_status_detailed",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/account-status/on-demand-refund": {
"post": {
"tags": [
"AccountStatus"
],
"summary": "Executes an On Demand Refund (True Up) for all outstanding refundable amounts within the current billing cycle for the logged in user.\r\nIf the current status of the account does not have a refund available, then no operation occurs and the result is no content.",
"operationId": "POST_api_account_status_on_demand_refund",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedAccountStatusOnDemandRefundResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/analytics/generate": {
"post": {
"tags": [
"Analytics"
],
"summary": "Request the scheduling of analytics data generation.",
"operationId": "POST_api_analytics_generate",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The parameters for the data generation.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedAnalyticsGenerateAnalyticsDataRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedAnalyticsGenerateAnalyticsDataResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets/{assetId}/asset-status": {
"get": {
"tags": [
"Assets"
],
"summary": "Get details pertaining to an asset's claim and protection status.",
"operationId": "GET_api_trovs_trovId_assets_assetId_asset_status",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset to retrieve status for.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedAssetAssetStatusResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets/{assetId}": {
"get": {
"tags": [
"Assets"
],
"summary": "Gets an asset.\r\n \r\n- The `If-Modified-Since` request header is optionally supported.\r\n- The `Last-Modified` response header will be populated with the last modified date of the asset.\r\n- HTTP documentation for date/time formats available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3)\r\n- HTTP documentation for `If-Modified-Since` request header available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25)\r\n- HTTP documentation for `Last-Modified` response header available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29)",
"operationId": "GET_api_trovs_trovId_assets_assetId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "assetId",
"in": "path",
"description": "The asset id.",
"required": true,
"type": "string"
},
{
"name": "trovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "includeRevision",
"in": "query",
"description": "Value indicating if the revisions should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "includeFileInfos",
"in": "query",
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"403 ValidationException": {
"description": "The trov id does not match the asset's root id.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"put": {
"tags": [
"Assets"
],
"summary": "Updates an asset.",
"operationId": "PUT_api_trovs_trovId_assets_assetId",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "assetId",
"in": "path",
"description": "The asset id.",
"required": true,
"type": "string"
},
{
"name": "trovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "assetUpdateRequest",
"in": "body",
"description": "The asset update request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetUpdateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"400 AssetCurrentlyInsuredException": {
"description": "The asset cannot be trashed because it has at least one active coverage period.",
"schema": {
"$ref": "#/definitions/AssetCurrentlyInsuredException",
"default": {
"Message": "The asset string is currently insured.",
"ExceptionMessage": "The asset string is currently insured.",
"ExceptionType": "AssetCurrentlyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The trov id does not match the asset's root id.
\r\n The specified containment hierarchy is not allowed.
\r\n The asset thumbnail is invalid.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specific revision of the asset does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 AssetStaleRevisionException": {
"description": "The asset cannot be updated because the supplied revision is not current.",
"schema": {
"$ref": "#/definitions/AssetStaleRevisionException",
"default": {
"Message": "Cannot update asset string: stale revision=0: storage revision=0",
"ExceptionMessage": "Cannot update asset string: stale revision=0: storage revision=0",
"ExceptionType": "AssetStaleRevisionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"delete": {
"tags": [
"Assets"
],
"summary": "Deletes an asset.",
"operationId": "DELETE_api_trovs_trovId_assets_assetId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov that the asset is being deleted from.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The asset id. Can be a comma-delimited list of ids.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 AssetPreviouslyInsuredException": {
"description": "The asset was insured in the past and cannot be permanently deleted.",
"schema": {
"$ref": "#/definitions/AssetPreviouslyInsuredException",
"default": {
"Message": "The asset string was previously insured.",
"ExceptionMessage": "The asset string was previously insured.",
"ExceptionType": "AssetPreviouslyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The trov id does not match the asset's root id.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets": {
"get": {
"tags": [
"Assets"
],
"summary": "Gets a trov's assets if modified since the date specified in the `If-Modified-Since` request header.\r\n \r\n- The `Last-Modified` response header will be populated with the last modified date of the most recently modified asset.\r\n- HTTP documentation for date/time formats available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3)\r\n- HTTP documentation for `If-Modified-Since` request header available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25)\r\n- HTTP documentation for `Last-Modified` response header available [here](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29)",
"operationId": "GET_api_trovs_trovId_assets",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The trov ID.",
"required": true,
"type": "string"
},
{
"name": "includeRevision",
"in": "query",
"description": "Value indicating if the revisions should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "includeFileInfos",
"in": "query",
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "isInitialSync",
"in": "query",
"description": "Value indicating if the request is the initial sync for all active assets.",
"required": false,
"type": "boolean"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"304": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetsResponse"
}
},
"400 MissingHeaderException": {
"description": "The `If-Modified-Since` request header is missing.",
"schema": {
"$ref": "#/definitions/MissingHeaderException",
"default": {
"Message": "The following required header(s) were missing from the request: ",
"ExceptionMessage": "The following required header(s) were missing from the request: ",
"ExceptionType": "MissingHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the trov.
\r\n The trov does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Assets"
],
"summary": "Adds an asset and associated files.\r\n \r\nThe endpoint requires a MimeMultipart request body:\r\n- Part 1:\r\n - Must contain the JSON representation of the asset to create;\r\n - The `Content-Type` header must be set to `application/json`;\r\n- Part 2...n (optional):\r\n - Each part must contain a single byte array (binary blob) of a files data.\r\n - Each part must have the `Content-Type` header set to the corresponding type of the blob (e.g. a jpg photo may have it set as `image/jpeg`);\r\n - Each part must have the `Trov-SchemaType` header set to the corresponding schema type the file is to be classed under;\r\n - Each part can indicate a filename using the `ContentDisposition FileName` header;\r\n - The order of parts matters;\r\n - The first part with the `Trov-SchemaType` header set to `SchemaType.Image` will automatically be set as the thumbnail of the asset;",
"operationId": "POST_api_trovs_trovId_assets",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov that the asset is being added to.",
"required": true,
"type": "string"
},
{
"name": "pssId",
"in": "query",
"description": "The unique id associated with the search session request.",
"required": false,
"type": "string"
},
{
"name": "sessionId",
"in": "query",
"description": "The id of the ThreatMetrix session on the client device.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"400 AssetMimeMultipartInvalidHeaderException": {
"description": "One or more of the multipart content sections that were not `application/json` type did not contain a `Trov-SchemaType` header value.",
"schema": {
"$ref": "#/definitions/AssetMimeMultipartInvalidHeaderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AssetMimeMultipartInvalidHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 AssetMimeMultipartMissingHeaderException": {
"description": "One or more of the multipart content sections did not contain a `Content-Type` header value.",
"schema": {
"$ref": "#/definitions/AssetMimeMultipartMissingHeaderException",
"default": {
"Message": "One or more sections of the Mime Multipart request is missing the 'string' header.",
"ExceptionMessage": "One or more sections of the Mime Multipart request is missing the 'string' header.",
"ExceptionType": "AssetMimeMultipartMissingHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 AssetMimeMultipartMissingPartException": {
"description": "The multipart content sections did not contain exactly one part with the `Content-Type` header value set as `application/json`.",
"schema": {
"$ref": "#/definitions/AssetMimeMultipartMissingPartException",
"default": {
"Message": "The Mime Multipart request does not contain a valid part.",
"ExceptionMessage": "The Mime Multipart request does not contain a valid part.",
"ExceptionType": "AssetMimeMultipartMissingPartException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 AssetNotCreatedException": {
"description": "The asset could not be created because a fingerprint could not be retrieved from ThreatMetrix.",
"schema": {
"$ref": "#/definitions/AssetNotCreatedException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AssetNotCreatedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 HttpResponseException": {
"description": "The request was not a valid MultiPart-FormData request.",
"schema": {
"$ref": "#/definitions/HttpResponseException",
"default": {
"Message": "Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details.",
"ExceptionMessage": "Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details.",
"ExceptionType": "HttpResponseException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The trov id does not match the asset's root id.
\r\n The specified containment hierarchy is not allowed.
\r\n The asset thumbnail is invalid.
\r\n The asset is requesting asset flag 'WoozAttention' but the trov has AutoId disabled.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the trov.
\r\n The trov does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"409 DocumentExistsException": {
"description": "The asset already exists.",
"schema": {
"$ref": "#/definitions/DocumentExistsException",
"default": {
"Message": "The key used for the document, already exists.",
"ExceptionMessage": "The key used for the document, already exists.",
"ExceptionType": "DocumentExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets/trash": {
"get": {
"tags": [
"Assets"
],
"summary": "Gets a trov's trashed assets.",
"operationId": "GET_api_trovs_trovId_assets_trash",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The trov ID.",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "count",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "includeRevision",
"in": "query",
"description": "Value indicating if the revisions should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "includeFileInfos",
"in": "query",
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"required": false,
"type": "boolean"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
},
"xml": {
"name": "AssetResponse",
"wrapped": true
},
"type": "array"
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the trov.
\r\n The trov does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets/{assetId}/requestWoz": {
"post": {
"tags": [
"Assets"
],
"summary": "Marks an asset as pending Wooz updates.",
"operationId": "POST_api_trovs_trovId_assets_assetId_requestWoz",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 BBEExperienceNotEnabledException": {
"description": "Wooz access has not been enabled for the trov.",
"schema": {
"$ref": "#/definitions/BBEExperienceNotEnabledException",
"default": {
"Message": "The BBE Experience is not enabled for this trov.",
"ExceptionMessage": "The BBE Experience is not enabled for this trov.",
"ExceptionType": "BBEExperienceNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"deprecated": true
}
},
"/api/v4.0/autosuggest": {
"get": {
"tags": [
"AutoSuggest"
],
"summary": "Retrieves the autosuggest URL for the market.",
"operationId": "GET_api_autosuggest",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400 CapabilityNotSupportedException": {
"description": "The requested capability is not supported in the market.",
"schema": {
"$ref": "#/definitions/CapabilityNotSupportedException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "CapabilityNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/chatbot/api/messages": {
"post": {
"tags": [
"Chatbot"
],
"summary": "This is the endpoint that the Microsoft Bot Connector uses to send messages from the client to the server to be processed\r\n(for new and on going chats). The API for this endpoint is mandated by Microsoft.",
"operationId": "POST_chatbot_api_messages",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "activity",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MicrosoftBotConnectorActivity"
}
},
{
"name": "cancellationToken",
"in": "header",
"required": true
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}": {
"get": {
"tags": [
"Claims"
],
"summary": "Gets a claim by claim id.",
"operationId": "GET_api_sic_claim_claimId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/asset/{assetId}/claims": {
"get": {
"tags": [
"Claims"
],
"summary": "Gets a summary of the claims for the specified asset id.",
"operationId": "GET_api_sic_asset_assetId_claims",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "assetId",
"in": "path",
"description": "The id of the asset to get the claims for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimsForAssetResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/events": {
"get": {
"tags": [
"Claims"
],
"summary": "Gets the claim events for a given claim.",
"operationId": "GET_api_sic_claim_claimId_events",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimEventsResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/photo": {
"post": {
"tags": [
"Claims"
],
"summary": "Adds a photo to a claim.\r\n \r\nThe endpoint requires a MimeMultipart request body with a single part:\r\n- The part must contain a single byte array (binary blob) of image data.\r\n- The part must have the `Content-Type` header set to a supported image.",
"operationId": "POST_api_sic_claim_claimId_photo",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to add a photo to.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/cancel": {
"post": {
"tags": [
"Claims"
],
"summary": "Cancels a claim.",
"operationId": "POST_api_sic_claim_claimId_cancel",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to cancel.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimCancelClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given claimId.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/submit": {
"post": {
"tags": [
"Claims"
],
"summary": "Submits a claim.",
"operationId": "POST_api_sic_claim_claimId_submit",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to submit.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimSubmitClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given claimId.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/message": {
"post": {
"tags": [
"Claims"
],
"summary": "Adds a customer message to the claim.",
"operationId": "POST_api_sic_claim_claimId_message",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the chat message.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimAddClaimMessageRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/description": {
"post": {
"tags": [
"Claims"
],
"summary": "Adds a description to the claim.",
"operationId": "POST_api_sic_claim_claimId_description",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the description.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimAddClaimDescriptionRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/bank-account": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's bank account.",
"operationId": "POST_api_sic_claim_claimId_bank_account",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "updateClaimBankAccountRequest",
"in": "body",
"description": "The model containing the bank account.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimBankAccountRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/payment-card": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's payment card.",
"operationId": "POST_api_sic_claim_claimId_payment_card",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "updateClaimPaymentCardRequest",
"in": "body",
"description": "The model containing the payment card.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimPaymentCardRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/phone-number": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's phone number.",
"operationId": "POST_api_sic_claim_claimId_phone_number",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the phone number.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimPhoneNumberRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claims": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets a list of claims, filtered by the provided parameters.",
"operationId": "GET_api_sic_claims",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "displayId",
"in": "query",
"description": "The claim display id to filter on. Optional.",
"required": false,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 500,
"maximum": 500,
"minimum": 1
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 1,
"maximum": 2147483647,
"minimum": 1
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimsResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Claims"
],
"summary": "Creates a new claim.",
"operationId": "POST_api_sic_claims",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The model containing the create request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimCreateClaimRequest"
}
},
{
"name": "sessionId",
"in": "query",
"description": "The id of the ThreatMetrix session on the client device.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimCreateClaimResponse"
}
},
"400 AssetsNotClaimableException": {
"description": "One or more assets are not claimable.",
"schema": {
"$ref": "#/definitions/AssetsNotClaimableException",
"default": {
"Message": "The specified assets are not claimable. This could be because they have already been associated as a non-repair item of an accepted claim.",
"ExceptionMessage": "The specified assets are not claimable. This could be because they have already been associated as a non-repair item of an accepted claim.",
"ExceptionType": "AssetsNotClaimableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ExactlyOneAssetRequiredException": {
"description": "Exactly one asset id is required to create a claim.",
"schema": {
"$ref": "#/definitions/ExactlyOneAssetRequiredException",
"default": {
"Message": "Exactly one asset is required.",
"ExceptionMessage": "Exactly one asset is required.",
"ExceptionType": "ExactlyOneAssetRequiredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/incident-date": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's incident date.",
"operationId": "POST_api_sic_claim_claimId_incident_date",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the incident date.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimIncidentDateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/incident-time": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's incident time.",
"operationId": "POST_api_sic_claim_claimId_incident_time",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the incident time.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimIncidentTimeRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/incident-type": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's incident type.",
"operationId": "POST_api_sic_claim_claimId_incident_type",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the incident type.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimIncidentTypeRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/claim/{claimId}/incident-location": {
"post": {
"tags": [
"Claims"
],
"summary": "Updates the claim's incident location.",
"operationId": "POST_api_sic_claim_claimId_incident_location",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the incident location.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimIncidentLocationRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnexpectedClaimActionException": {
"description": "The requested update was not expected due to the state of the claim.",
"schema": {
"$ref": "#/definitions/UnexpectedClaimActionException",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets claim details by claim id.",
"operationId": "GET_api_sic_customer_customerId_claim_claimId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to get a claim details for.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim details to get.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetailsResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/events": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets the claim events for a given claim.",
"operationId": "GET_api_sic_customer_customerId_claim_claimId_events",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer the claim belongs to.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get the events for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimEventDetailsResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/status": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets the claim status for a given claim.",
"operationId": "GET_api_sic_customer_customerId_claim_claimId_status",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer the claim belongs to.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get the claim status for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetClaimStatusResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/protection-summary": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets the protection summary for the specified customer and claim.",
"operationId": "GET_api_sic_customer_customerId_claim_claimId_protection_summary",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get the protection summary for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedProtectionGetProtectionSummaryResponse"
}
},
"400 ClaimCannotCalculateLossDateException": {
"description": "Claim requires a valid loss date, time and location with a time zone id.",
"schema": {
"$ref": "#/definitions/ClaimCannotCalculateLossDateException",
"default": {
"Message": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionMessage": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionType": "ClaimCannotCalculateLossDateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/settlement-summary": {
"get": {
"tags": [
"ClaimsEmployee"
],
"summary": "Gets the settlement summary for the specified customer and claim.",
"operationId": "GET_api_sic_customer_customerId_claim_claimId_settlement_summary",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to get the settlement summary for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimGetSettlementSummaryResponse"
}
},
"400 AssetsNotCoveredException": {
"description": "One or more assets are not covered at the loss date.",
"schema": {
"$ref": "#/definitions/AssetsNotCoveredException",
"default": {
"Message": "The assets are not covered on the specified date.",
"ExceptionMessage": "The assets are not covered on the specified date.",
"ExceptionType": "AssetsNotCoveredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ClaimCannotCalculateLossDateException": {
"description": "Claim requires a valid loss date, time and location with a time zone id.",
"schema": {
"$ref": "#/definitions/ClaimCannotCalculateLossDateException",
"default": {
"Message": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionMessage": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionType": "ClaimCannotCalculateLossDateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/deny": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Attempts to deny a claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_deny",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to deny.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimDenyClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/close": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Attempts to close a claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_close",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to close.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimCloseClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/accept": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Attempts to accept a claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_accept",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to accept.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimAcceptClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/reopen": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Attempts to reopen a claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_reopen",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to reopen.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimReopenClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/settle": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Attempts to settle a claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_settle",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to settle.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimSettleClaimResponse"
}
},
"400 ClaimRulesNotSatisfiedException": {
"description": "The requested transition cannot be performed because some claim rules remain unsatisfied.",
"schema": {
"$ref": "#/definitions/ClaimRulesNotSatisfiedException",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidClaimStateTransitionException": {
"description": "The requested claim transition does not exist.",
"schema": {
"$ref": "#/definitions/InvalidClaimStateTransitionException",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/message": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Adds a message to the claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_message",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer the claim belongs to.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to add a message to.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the chat message.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimAddClaimMessageRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 InvalidClaimUpdateException": {
"description": "The requested update to the claim is not allowed in the claim's current state.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/asset/{customerAssetId}/claim-amount": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Updates the claim amount for an asset on an associated claim.",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_asset_customerAssetId_claim_amount",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "customerAssetId",
"in": "path",
"description": "The id of the asset associated with the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the updated claim amount.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateAssetClaimAmountRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimUpdateAssetClaimAmountResponse"
}
},
"400 InvalidClaimUpdateException": {
"description": "The claim is in a state where it cannot be modified.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/claim/{claimId}/asset/{customerAssetId}/settlement-method": {
"post": {
"tags": [
"ClaimsEmployee"
],
"summary": "Updates the claim settlement method for an asset for an associated claim .",
"operationId": "POST_api_sic_customer_customerId_claim_claimId_asset_customerAssetId_settlement_method",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer who owns the claim.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The id of the claim to update.",
"required": true,
"type": "string"
},
{
"name": "customerAssetId",
"in": "path",
"description": "The id of the asset associated with the claim to update.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "The model containing the updated claim settlement method.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimSetSettlementMethodRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimSetSettlementMethodResponse"
}
},
"400 InvalidClaimUpdateException": {
"description": "The claim is in a state where it cannot be modified.",
"schema": {
"$ref": "#/definitions/InvalidClaimUpdateException",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "There is no claim with the given `claimId`.
\r\n The requesting user does not have access to the specified claim.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/client": {
"get": {
"tags": [
"ClientAdmin"
],
"summary": "Gets all available clients.",
"operationId": "GET_api_admin_client",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClientClientResponse"
},
"xml": {
"name": "ClientResponse",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"ClientAdmin"
],
"summary": "Creates a new client.",
"operationId": "POST_api_admin_client",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClientCreateClientRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedClientClientResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/client/{clientId}/isActive/{isActive}": {
"put": {
"tags": [
"ClientAdmin"
],
"summary": "Updates the `IsActive` state for the client specified by the id.",
"operationId": "PUT_api_admin_client_clientId_isActive_isActive",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "The id of the client to update.",
"required": true,
"type": "string"
},
{
"name": "isActive",
"in": "path",
"description": "The value to update to.",
"required": true,
"type": "boolean"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/definitions": {
"get": {
"tags": [
"Configuration"
],
"summary": "Gets the definitions.",
"operationId": "GET_api_definitions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelCoreIDefinitions"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/publishableKeys": {
"get": {
"tags": [
"Configuration"
],
"summary": "Gets the publishable keys (e.g. Stripe) for clients.",
"operationId": "GET_api_publishableKeys",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelConfigurationPublishableKeysResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/asset/{customerAssetId}": {
"get": {
"tags": [
"CoveredAssetsEmployee"
],
"summary": "Gets a specific history revision of an asset that has been covered by the customer.",
"operationId": "GET_api_sic_customer_customerId_asset_customerAssetId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer id.",
"required": true,
"type": "string"
},
{
"name": "customerAssetId",
"in": "path",
"description": "The asset id.",
"required": true,
"type": "string"
},
{
"name": "revision",
"in": "query",
"description": "The asset revision.",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The revision of the asset has never been covered by the customer.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the asset.
\r\n The asset does not exist.
\r\n The specific revision of the asset does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/asset/{customerAssetId}/files": {
"get": {
"tags": [
"CoveredAssetsEmployee"
],
"summary": "Gets a dictionary containing the file info associated with an asset that has been covered by the customer.\r\n \r\n- The key of the returned dictionary is the schema type.\r\n- The value of the returned dictionary is a list of associated file info for that schema type.",
"operationId": "GET_api_sic_customer_customerId_asset_customerAssetId_files",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer id.",
"required": true,
"type": "string"
},
{
"name": "customerAssetId",
"in": "path",
"description": "The asset id.",
"required": true,
"type": "string"
},
{
"name": "revision",
"in": "query",
"description": "The asset revision.",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"properties": {
"asset": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"audio": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"building": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"collection": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"document": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"file": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"floor": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"image": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"property": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"room": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"trov": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"userInvite": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"user": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"video": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"sitemap": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"trovInvite": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"index": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"floorPlan": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedFileFileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
}
},
"type": "object"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The revision of the asset has never been covered by the customer.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the asset.
\r\n The asset does not exist.
\r\n The specific revision of the asset does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/notes": {
"get": {
"tags": [
"CustomerNotesEmployee"
],
"summary": "Gets the customer notes for the specified customer id.",
"operationId": "GET_api_sic_customer_customerId_notes",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer identifier.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerNote"
},
"xml": {
"name": "CustomerNote",
"wrapped": true
},
"type": "array",
"default": [
{
"Text": "Bob's law blog: http://arresteddevelopment.wikia.com/wiki/Bob_Loblaw",
"CustomerId": "customerId",
"Id": "customerNoteId",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
]
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"CustomerNotesEmployee"
],
"summary": "Creates a new customer note.",
"operationId": "POST_api_sic_customer_customerId_notes",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer identifier.",
"required": true,
"type": "string"
},
{
"name": "note",
"in": "body",
"description": "The info about the customer note to create.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCreateCustomerNoteRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerNote"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "The provided customer note failed to validate.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}": {
"get": {
"tags": [
"CustomersEmployee"
],
"summary": "Gets a customer if they have insured at least one asset.",
"operationId": "GET_api_sic_customer_customerId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerCustomerResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerAccessException": {
"description": "The customer does not exist.
\r\n The customer has not insured at least one asset.",
"schema": {
"$ref": "#/definitions/CustomerAccessException",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requesting user does not have access to view the customer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"patch": {
"tags": [
"CustomersEmployee"
],
"summary": "Updates an existing customer.",
"operationId": "PATCH_api_sic_customer_customerId",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to update.",
"required": true,
"type": "string"
},
{
"name": "customerUpdateRequest",
"in": "body",
"description": "The model that represents the update information.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerUpdateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerCustomerResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The customer does not exist.
\r\n The requesting user does not have access to view the customer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/audits": {
"get": {
"tags": [
"CustomersEmployee"
],
"summary": "Gets the audit entries for a specific customer that has insured at least one asset.",
"operationId": "GET_api_sic_customer_customerId_audits",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer id.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerCustomerAuditResponse"
},
"xml": {
"name": "CustomerAuditResponse",
"wrapped": true
},
"type": "array"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerAccessException": {
"description": "The customer does not exist.
\r\n The customer has not insured at least one asset.",
"schema": {
"$ref": "#/definitions/CustomerAccessException",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requesting user does not have access to view the customer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/fraud/{claimId}": {
"get": {
"tags": [
"CustomersEmployee"
],
"summary": "Gets the fraud information for a customer.",
"operationId": "GET_api_sic_customer_customerId_fraud_claimId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer id.",
"required": true,
"type": "string"
},
{
"name": "claimId",
"in": "path",
"description": "The claim id.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerFraudSignals"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customers": {
"get": {
"tags": [
"CustomersEmployee"
],
"summary": "Gets all customers with optional filters for role \"sicadmin\"\r\nGets all customers that have insured at least one asset with optional filters for other roles",
"operationId": "GET_api_sic_customers",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of customers to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "The position to offset the customers.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "emailFilter",
"in": "query",
"description": "The email address or name filter.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerCustomerResponse"
},
"xml": {
"name": "CustomerResponse",
"wrapped": true
},
"type": "array"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/profileResults": {
"get": {
"tags": [
"CustomersEmployee"
],
"summary": "Gets the fraud profile results for a customer.",
"operationId": "GET_api_sic_customer_customerId_profileResults",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The customer id.",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "The offset in the result.",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
{
"name": "count",
"in": "query",
"description": "The number of records to get.",
"required": false,
"type": "integer",
"format": "int32",
"default": 100
},
{
"name": "fromEventTime",
"in": "query",
"description": "The start time to include in unix format.",
"required": false,
"type": "string"
},
{
"name": "toEventTime",
"in": "query",
"description": "The end time to include in unix format.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerFraudProfilingResult"
},
"xml": {
"name": "CustomerFraudProfilingResult",
"wrapped": true
},
"type": "array"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customers/notify": {
"post": {
"tags": [
"CustomersEmployee"
],
"summary": "Sends customer notifications",
"operationId": "POST_api_sic_customers_notify",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The model that represents the notification request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerCustomerNotifyRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/quotes/stop/{customerId}": {
"post": {
"tags": [
"CustomersEmployee"
],
"summary": "Stops all coverage for an existing customer effective immediately.",
"operationId": "POST_api_sic_customer_quotes_stop_customerId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to stop coverage for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 UnsupportedMarketException": {
"description": "The operation requested is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerAccessException": {
"description": "The customer does not exist.
\r\n The customer has not insured at least one asset.",
"schema": {
"$ref": "#/definitions/CustomerAccessException",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requesting user does not have access to view the customer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/{customerId}/ofac-screen": {
"post": {
"tags": [
"CustomersEmployee"
],
"summary": "Performs a screen of the customer against the OFAC watch lists.",
"operationId": "POST_api_sic_customer_customerId_ofac_screen",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to screen.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerOfacScreeningResponse"
}
},
"400 UnsupportedMarketException": {
"description": "The operation requested is only supported in the US market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerAccessException": {
"description": "The customer does not exist.",
"schema": {
"$ref": "#/definitions/CustomerAccessException",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 ExternalServiceException": {
"description": "The external service used to screen the customer failed.",
"schema": {
"$ref": "#/definitions/ExternalServiceException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ExternalServiceException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/customer/quotes/stop/{customerId}/endOfBillingCycle": {
"post": {
"tags": [
"CustomersEmployee"
],
"summary": "Stops all coverage for an existing customer effective the end of the customer's current billing cycle.",
"operationId": "POST_api_sic_customer_quotes_stop_customerId_endOfBillingCycle",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to stop coverage for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 UnsupportedMarketException": {
"description": "The operation requested is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerAccessException": {
"description": "The customer does not exist.
\r\n The customer has not insured at least one asset.",
"schema": {
"$ref": "#/definitions/CustomerAccessException",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requesting user does not have access to view the customer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/disclosure/fraud": {
"get": {
"tags": [
"Disclosure"
],
"summary": "Returns the fraud disclosure text that needs to be displayed for the specified customer event.",
"operationId": "GET_api_disclosure_fraud",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "event",
"in": "query",
"description": "The action the customer is about to take that we potentially need to show a fraud disclosure for",
"required": true,
"type": "string",
"enum": [
"Unknown",
"StartProtect",
"Claim"
],
"x-enumName": "CustomerEvent"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDisclosureFraudDisclosureResponse"
}
},
"204": {
"description": "There is no disclosure to display."
},
"400 InvalidAddressException": {
"description": "The customer's address could not be resolved to a valid address.",
"schema": {
"$ref": "#/definitions/InvalidAddressException",
"default": {
"Message": "The address was unable to be resolved to a valid address.",
"ExceptionMessage": "The address was unable to be resolved to a valid address.",
"ExceptionType": "InvalidAddressException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnknownCustomerEventException": {
"description": "The specified customer event is not recognized.",
"schema": {
"$ref": "#/definitions/UnknownCustomerEventException",
"default": {
"Message": "The specified customer event doesn't exist.",
"ExceptionMessage": "The specified customer event doesn't exist.",
"ExceptionType": "UnknownCustomerEventException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/consent/{documentType}": {
"get": {
"tags": [
"DocumentConsent"
],
"summary": "Gets user's consent status for a required document consent.",
"operationId": "GET_api_consent_documentType",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentType",
"in": "path",
"description": "",
"required": true,
"type": "string",
"enum": [
"ReceiveElectronicDocument",
"ProductDisclosureSummary",
"AmendatoryEndorsement"
],
"x-enumName": "DisclosureDocumentType"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentDocumentConsentStatusResponse"
}
},
"400 CustomerProfileInformationMissingException": {
"description": "The customer profile is missing required information.",
"schema": {
"$ref": "#/definitions/CustomerProfileInformationMissingException",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/consent": {
"post": {
"tags": [
"DocumentConsent"
],
"summary": "Saves user's consent to a required document consent.",
"operationId": "POST_api_consent",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentCreateDocumentConsentRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 CustomerProfileInformationMissingException": {
"description": "The customer profile is missing required information.",
"schema": {
"$ref": "#/definitions/CustomerProfileInformationMissingException",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 DocumentConsentVersionNotSupportedException": {
"description": "Attempted to accept version different than required version.",
"schema": {
"$ref": "#/definitions/DocumentConsentVersionNotSupportedException",
"default": {
"Message": "Attempted to accept version different than required version.",
"ExceptionMessage": "Attempted to accept version different than required version.",
"ExceptionType": "DocumentConsentVersionNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/consent-content/{documentType}": {
"get": {
"tags": [
"DocumentConsentContentEmployee"
],
"summary": "Gets list of document consent versions.",
"operationId": "GET_api_consent_content_documentType",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentType",
"in": "path",
"description": "",
"required": true,
"type": "string",
"enum": [
"ReceiveElectronicDocument",
"ProductDisclosureSummary",
"AmendatoryEndorsement"
],
"x-enumName": "DisclosureDocumentType"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentDocumentConsentContentResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/consent-content": {
"post": {
"tags": [
"DocumentConsentContentEmployee"
],
"summary": "Creates a new document consent content.",
"operationId": "POST_api_consent_content",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentCreateDocumentConsentContentRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/consent-content/assign": {
"post": {
"tags": [
"DocumentConsentContentEmployee"
],
"summary": "Makes a document required for the given states.",
"operationId": "POST_api_consent_content_assign",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentAssignDocumentConsentContentToStateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/employee/audits": {
"get": {
"tags": [
"EmployeesEmployee"
],
"summary": "Gets the audit entries for all employees.",
"operationId": "GET_api_sic_employee_audits",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicAuditEmployeeAudit"
},
"xml": {
"name": "EmployeeAudit",
"wrapped": true
},
"type": "array",
"default": [
{
"AuditId": 1,
"Timestamp": "2016-01-26T10:11:12Z",
"UserId": "123456",
"UserEmail": "jon.jones@trov.com",
"Action": "Create",
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
},
{
"AuditId": 2,
"Timestamp": "2016-01-26T10:11:12Z",
"UserId": "123456",
"UserEmail": "jon.jones@trov.com",
"Action": "Update",
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin2@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
]
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/employee/{employeeId}": {
"get": {
"tags": [
"EmployeesEmployee"
],
"summary": "Gets a employee.",
"operationId": "GET_api_sic_employee_employeeId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The id of the employee.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeIEmployee"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requested user does not exist, or the requesting user does not have access to view",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"put": {
"tags": [
"EmployeesEmployee"
],
"summary": "Updates an existing employee.",
"operationId": "PUT_api_sic_employee_employeeId",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The id of the employee to update.",
"required": true,
"type": "string"
},
{
"name": "updateEmployeeRequest",
"in": "body",
"description": "The model containing the update request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeUpdateEmployeeRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeIEmployee"
}
},
"400 TwoFactorAuthenticationNotEnabledException": {
"description": "The requested user account does not have two-factor authentication enabled.",
"schema": {
"$ref": "#/definitions/TwoFactorAuthenticationNotEnabledException",
"default": {
"Message": "The user account does not have two-factor authentication enabled.",
"ExceptionMessage": "The user account does not have two-factor authentication enabled.",
"ExceptionType": "TwoFactorAuthenticationNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requested user does not exist, or the requesting user does not have access to view.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"delete": {
"tags": [
"EmployeesEmployee"
],
"summary": "Delete an existing employee and assigns their claims to a specified employee.",
"operationId": "DELETE_api_sic_employee_employeeId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The id of the employee to delete.",
"required": true,
"type": "string"
},
{
"name": "transfereeId",
"in": "query",
"description": "The id of the employee that will take ownership of the former employee's claims.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requested user does not exist, or the requesting user does not have access to view.
\r\n The requested transfer employee does not exist, or the requesting user does not have access to view.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/employee/{employeeId}/audits": {
"get": {
"tags": [
"EmployeesEmployee"
],
"summary": "Gets the audit entries for a specific employee.",
"operationId": "GET_api_sic_employee_employeeId_audits",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee id.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicAuditEmployeeAudit"
},
"xml": {
"name": "EmployeeAudit",
"wrapped": true
},
"type": "array",
"default": [
{
"AuditId": 1,
"Timestamp": "2016-01-26T10:11:12Z",
"UserId": "123456",
"UserEmail": "jon.jones@trov.com",
"Action": "Create",
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
},
{
"AuditId": 2,
"Timestamp": "2016-01-26T10:11:12Z",
"UserId": "123456",
"UserEmail": "jon.jones@trov.com",
"Action": "Update",
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin2@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
]
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/employees": {
"get": {
"tags": [
"EmployeesEmployee"
],
"summary": "Gets the employees.",
"operationId": "GET_api_sic_employees",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "count",
"in": "query",
"description": "The number of employees to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "The offset position.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeIEmployee"
},
"xml": {
"name": "IEmployee",
"wrapped": true
},
"type": "array",
"default": [
{
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
},
{
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "sue@trov.com",
"Id": "6ffaaf7a06754d11975705334203",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "2",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "2"
}
]
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"EmployeesEmployee"
],
"summary": "Creates a new employee.",
"operationId": "POST_api_sic_employees",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "createEmployeeRequest",
"in": "body",
"description": "The info about the employee to create.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeCreateEmployeeRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicEmployeeIEmployee"
}
},
"400 TwoFactorAuthenticationNotEnabledException": {
"description": "The requested user account does not have two-factor authentication enabled.",
"schema": {
"$ref": "#/definitions/TwoFactorAuthenticationNotEnabledException",
"default": {
"Message": "The user account does not have two-factor authentication enabled.",
"ExceptionMessage": "The user account does not have two-factor authentication enabled.",
"ExceptionType": "TwoFactorAuthenticationNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The requested user does not exist, or the requesting user does not have access to view.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/experiments/pricing-files": {
"get": {
"tags": [
"ExperimentEmployee"
],
"summary": "Get list of available pricing file experiments.",
"operationId": "GET_api_experiments_pricing_files",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "statusFilter",
"in": "query",
"description": "",
"required": true,
"items": {
"type": "string",
"enum": [
"New",
"Running",
"Stopped",
"Archived"
]
},
"collectionFormat": "multi",
"type": "array",
"uniqueItems": true,
"x-enumName": "ExperimentStatus"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 500,
"maximum": 500,
"minimum": 1
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 1,
"maximum": 2147483647,
"minimum": 1
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedExperimentGetAllPricingFileExperimentsResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"ExperimentEmployee"
],
"summary": "Creates a new experiment in Optimizely.",
"operationId": "POST_api_experiments_pricing_files",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedExperimentCreatePricingFileExperimentRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedExperimentCreatePricingFileExperimentResponse"
}
},
"400 InvalidPricingFileException": {
"description": "Invalid pricing file id in the request.",
"schema": {
"$ref": "#/definitions/InvalidPricingFileException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidPricingFileException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/experiments/pricing-files/{experimentId}/status": {
"post": {
"tags": [
"ExperimentEmployee"
],
"summary": "Makes an experiment active.",
"operationId": "POST_api_experiments_pricing_files_experimentId_status",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "experimentId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedExperimentUpdatePricingFileExperimentRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 ExperimentActionNotSupportedException": {
"description": "Attempted action not supported.",
"schema": {
"$ref": "#/definitions/ExperimentActionNotSupportedException",
"default": {
"Message": "Attempted an action not supported.",
"ExceptionMessage": "Attempted an action not supported.",
"ExceptionType": "ExperimentActionNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "Experiment does not exist",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/token/currencyCloud": {
"get": {
"tags": [
"ExternalToken"
],
"summary": "Get a short term access token for requests to the Currency Cloud API.",
"operationId": "GET_api_sic_token_currencyCloud",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelCoreAuthTokenResult"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/files/{fileId}/info": {
"get": {
"tags": [
"Files"
],
"summary": "Gets a file's info.",
"operationId": "GET_api_files_fileId_info",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "fileId",
"in": "path",
"description": "The file id.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/files/{fileId}": {
"get": {
"tags": [
"Files"
],
"summary": "Gets a file as binary content.",
"operationId": "GET_api_files_fileId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "fileId",
"in": "path",
"description": "The file id.",
"required": true,
"type": "string"
},
{
"name": "download",
"in": "query",
"description": "Web browser clients should request 'true' to force a download (Content-Type and ContentDisposition headers are modified).\r\nOther clients should request 'false' for unmodified response headers.",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/items/{itemId}/files": {
"get": {
"tags": [
"Files"
],
"summary": "Gets a dictionary containing the file ids associated with an item.\r\n \r\n- The key of the returned dictionary is the schema type.\r\n- The value of the returned dictionary is a list of associated file ids for that schema type.\r\n- If schema type is specified the dictionary contents will be limited to files of that type, otherwise data for all schema types will be returned.",
"operationId": "GET_api_items_itemId_files",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "itemId",
"in": "path",
"description": "The item id.",
"required": true,
"type": "string"
},
{
"name": "schemaType",
"in": "query",
"description": "The type of file. (0 = Asset , 1 = Audio , 2 = Building , 3 = Collection , 4 = Document , 5 = File , 6 = Floor , 7 = Image , 8 = Property , 9 = Room , 10 = Trov , 11 = UserInvite , 12 = User , 13 = Video , 14 = Sitemap , 15 = TrovInvite , 16 = Index , 17 = FloorPlan , 18 = BulkTrovInvite )",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"x-enumName": "SchemaType"
},
{
"name": "revision",
"in": "query",
"description": "The revision of the item id to fetch files for.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"properties": {
"asset": {
"items": {
"type": "string"
},
"type": "array"
},
"audio": {
"items": {
"type": "string"
},
"type": "array"
},
"building": {
"items": {
"type": "string"
},
"type": "array"
},
"collection": {
"items": {
"type": "string"
},
"type": "array"
},
"document": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"items": {
"type": "string"
},
"type": "array"
},
"floor": {
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"items": {
"type": "string"
},
"type": "array"
},
"property": {
"items": {
"type": "string"
},
"type": "array"
},
"room": {
"items": {
"type": "string"
},
"type": "array"
},
"trov": {
"items": {
"type": "string"
},
"type": "array"
},
"userInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"user": {
"items": {
"type": "string"
},
"type": "array"
},
"video": {
"items": {
"type": "string"
},
"type": "array"
},
"sitemap": {
"items": {
"type": "string"
},
"type": "array"
},
"trovInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"index": {
"items": {
"type": "string"
},
"type": "array"
},
"floorPlan": {
"items": {
"type": "string"
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"default": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Files"
],
"summary": "Adds a file to an item.\r\n \r\nThe endpoint requires a MimeMultipart request body, with a single part:\r\n- Must contain a single byte array (binary blob) of a files data.\r\n- The 'Content-Type' header set to the corresponding type of the blob (e.g. a jpg photo may have it set as 'image/jpeg').",
"operationId": "POST_api_items_itemId_files",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "itemId",
"in": "path",
"description": "The item id.",
"required": true,
"type": "string"
},
{
"name": "schemaType",
"in": "query",
"description": "The type of the file. (0 = Asset , 1 = Audio , 2 = Building , 3 = Collection , 4 = Document , 5 = File , 6 = Floor , 7 = Image , 8 = Property , 9 = Room , 10 = Trov , 11 = UserInvite , 12 = User , 13 = Video , 14 = Sitemap , 15 = TrovInvite , 16 = Index , 17 = FloorPlan , 18 = BulkTrovInvite )",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"x-enumName": "SchemaType"
},
{
"name": "name",
"in": "query",
"description": "The name.",
"required": false,
"type": "string"
},
{
"name": "desc",
"in": "query",
"description": "The description.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfoResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"409 DocumentExistsException": {
"description": "The specified file already exists.",
"schema": {
"$ref": "#/definitions/DocumentExistsException",
"default": {
"Message": "The key used for the document, already exists.",
"ExceptionMessage": "The key used for the document, already exists.",
"ExceptionType": "DocumentExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/items/{itemId}/files/info": {
"get": {
"tags": [
"Files"
],
"summary": "Gets a dictionary containing the file info associated with an item.\r\n \r\n- The key of the returned dictionary is the schema type.\r\n- The value of the returned dictionary is a list of associated file info for that schema type.\r\n- If schema type is specified the dictionary contents will be limited to files of that type, otherwise data for all schema types will be returned.",
"operationId": "GET_api_items_itemId_files_info",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "itemId",
"in": "path",
"description": "The item id.",
"required": true,
"type": "string"
},
{
"name": "schemaType",
"in": "query",
"description": "The type of file. (0 = Asset , 1 = Audio , 2 = Building , 3 = Collection , 4 = Document , 5 = File , 6 = Floor , 7 = Image , 8 = Property , 9 = Room , 10 = Trov , 11 = UserInvite , 12 = User , 13 = Video , 14 = Sitemap , 15 = TrovInvite , 16 = Index , 17 = FloorPlan , 18 = BulkTrovInvite )",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"x-enumName": "SchemaType"
},
{
"name": "revision",
"in": "query",
"description": "The revision of the item id to fetch files for.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"properties": {
"asset": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"audio": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"building": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"collection": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"document": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"file": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"floor": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"image": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"property": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"room": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"trov": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"userInvite": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"user": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"video": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"sitemap": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"trovInvite": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"index": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"floorPlan": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
}
},
"type": "object",
"default": {
"Document": [
{
"Id": "507f1f77bcf86cd799439011",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "hud1.docx",
"Description": "HUD1 Statement",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Length": 2359,
"UploadDate": 130982766720000000,
"SchemaType": 7
},
{
"Id": "507f191e810c19729de860ea",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "deed.pdf",
"Description": "Property Deed",
"ContentType": "application/pdf",
"Length": 2539,
"UploadDate": 130982766720000000,
"SchemaType": 7
}
],
"Image": [
{
"Id": "507f1f77bcf86cd799439012",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "aerialview.jpg",
"Description": "An aerial view of the property.",
"ContentType": "image/jpeg",
"Length": 23599,
"UploadDate": 130982766720000000,
"SchemaType": 7
},
{
"Id": "507f191e810c19729de860eb",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "streetview.png",
"Description": "A street view of the property.",
"ContentType": "image/png",
"Length": 25399,
"UploadDate": 130982766720000000,
"SchemaType": 7
}
],
"Video": [
{
"Id": "507f1f77bcf86cd799439013",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "groundstour.mpeg",
"Description": "A tour of the grounds.",
"ContentType": "video/mpeg",
"Length": 235990,
"UploadDate": 130982766720000000,
"SchemaType": 7
},
{
"Id": "507f191e810c19729de860ec",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "housetour.wmv",
"Description": "A tour of the house.",
"ContentType": "video/x-ms-wmv",
"Length": 253990,
"UploadDate": 130982766720000000,
"SchemaType": 7
}
]
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/items/{itemId}/files/{fileIdList}": {
"delete": {
"tags": [
"Files"
],
"summary": "Deletes a file.",
"operationId": "DELETE_api_items_itemId_files_fileIdList",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "itemId",
"in": "path",
"description": "The item id the file(s) are associated with.",
"required": true,
"type": "string"
},
{
"name": "fileIdList",
"in": "path",
"description": "The file id list (comma separated).",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/fraud/{sessionId}": {
"get": {
"tags": [
"Fraud"
],
"summary": "Gets the success or failure of a device profiling.",
"operationId": "GET_api_fraud_sessionId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "sessionId",
"in": "path",
"description": "The sessionId uniquely identifying the profilnig session.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedFraudFraudProfilingSuccessResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/guests/suggestion-groups": {
"get": {
"tags": [
"Guest"
],
"summary": "Retrieves the suggestion groups.",
"operationId": "GET_api_guests_suggestion_groups",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionsResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/guests/quote": {
"post": {
"tags": [
"Guest"
],
"summary": "Gets a quote response for guest quote request.\r\n \r\n---\r\nThe required properties to be populated for the request are different per market:\r\n \r\n| Market | Properties |\r\n| -- | -- |\r\n| US | PrimaryExternalIdentifier,BirthDate,StateOfResidence,SessionId |",
"operationId": "POST_api_guests_quote",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestQuoteRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestQuoteResponse"
}
},
"400 UnsupportedMarketException": {
"description": "The specified market is not supported.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/guests/textToDownload": {
"post": {
"tags": [
"Guest"
],
"summary": "Sends a text with links to download the apps from the app store.",
"operationId": "POST_api_guests_textToDownload",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "phoneNumber",
"in": "query",
"description": "The phone number to text to.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400 InvalidPhoneNumberException": {
"description": "The phone number failed validation.",
"schema": {
"$ref": "#/definitions/InvalidPhoneNumberException",
"default": {
"Message": "The phone number provided is invalid.",
"ExceptionMessage": "The phone number provided is invalid.",
"ExceptionType": "InvalidPhoneNumberException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/guests/search-id": {
"post": {
"tags": [
"Guest"
],
"summary": "Issues a search for a id query.",
"operationId": "POST_api_guests_search_id",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestSearchIdRequest"
}
},
{
"name": "searchSessionId",
"in": "query",
"description": "Unique id to associate with the search request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestSearchIdResponse"
}
},
"400 UnsupportedMarketException": {
"description": "The specified market is not supported.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/guests/search-product": {
"post": {
"tags": [
"Guest"
],
"summary": "Issues a search for a product query.",
"operationId": "POST_api_guests_search_product",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestSearchProductRequest"
}
},
{
"name": "searchSessionId",
"in": "query",
"description": "Unique id to associate with the search request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestSearchProductResponse"
}
},
"400 UnsupportedMarketException": {
"description": "The specified market is not supported.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/images/{fileId}": {
"get": {
"tags": [
"Images"
],
"summary": "Gets an image.",
"operationId": "GET_api_images_fileId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "fileId",
"in": "path",
"description": "The file ID.",
"required": true,
"type": "string"
},
{
"name": "width",
"in": "query",
"description": "The width of image.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "height",
"in": "query",
"description": "The height of image.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxWidth",
"in": "query",
"description": "The maximum width.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxHeight",
"in": "query",
"description": "The maximum height.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "fitMode",
"in": "query",
"description": "The mode used to resolve the aspect ratio differences between the requested and original image sizes. (0 = None , 1 = Max , 2 = Pad , 3 = Crop , 4 = Carve , 5 = Stretch )",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5
],
"x-enumName": "FitMode"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specified asset does not file.
\r\n The requesting user does not have access to the specified file.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/assets/{assetId}/thumbnail": {
"get": {
"tags": [
"Images"
],
"summary": "Gets the thumbnail for an asset.",
"operationId": "GET_api_trovs_trovId_assets_assetId_thumbnail",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "width",
"in": "query",
"description": "The width of image.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "height",
"in": "query",
"description": "The height of image.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxWidth",
"in": "query",
"description": "The maximum width.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxHeight",
"in": "query",
"description": "The maximum height.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "fitMode",
"in": "query",
"description": "The mode used to resolve the aspect ratio differences between the requested and original image sizes. (0 = None , 1 = Max , 2 = Pad , 3 = Crop , 4 = Carve , 5 = Stretch )",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5
],
"x-enumName": "FitMode"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/categories": {
"get": {
"tags": [
"Metadata"
],
"summary": "Gets a list of categories and subcategories for which customers can value assets.",
"operationId": "GET_api_metadata_categories",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataAssetCategoriesResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/category/{categoryId}": {
"get": {
"tags": [
"Metadata"
],
"summary": "Gets a category for which customers can value assets.",
"operationId": "GET_api_metadata_category_categoryId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "The category ID to request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataAssetCategoryResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/user-added-asset": {
"post": {
"tags": [
"Metadata"
],
"summary": "Enriches a user added asset.",
"operationId": "POST_api_metadata_enrich_user_added_asset",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataEnrichUserAddedAssetRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataEnrichUserAddedAssetResponse"
}
},
"400 ArgumentException": {
"description": "The request body is missing at least one required field.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ArgumentNullException": {
"description": "The request body did not contain an asset.",
"schema": {
"$ref": "#/definitions/ArgumentNullException",
"default": {
"Message": "Value cannot be null.",
"ExceptionMessage": "Value cannot be null.",
"ExceptionType": "ArgumentNullException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 EnrichFailedException": {
"description": "The enrichment request does not have valid properties.",
"schema": {
"$ref": "#/definitions/EnrichFailedException",
"default": {
"Message": "Asset enrichment failed for this request.",
"ExceptionMessage": "Asset enrichment failed for this request.",
"ExceptionType": "EnrichFailedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/phone": {
"post": {
"tags": [
"Metadata"
],
"summary": "Enriches the provided phone information with additional data. Creates or saves the asset.",
"operationId": "POST_api_metadata_enrich_phone",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "phoneEnrichmentRequest",
"in": "body",
"description": "The asset to enrich.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsPhoneEnrichmentRequest"
}
},
{
"name": "sessionId",
"in": "query",
"description": "Optional ThreatMetrix session id associated with the request.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"201": {
"description": "Request succeeded but the auto-detected asset did not match the one provided. The auto-detected asset was created and the provided asset deleted."
},
"204": {
"description": "Request succeeded, but no additional data was found, so no result was returned."
},
"400 UnsupportedMarketException": {
"description": "Phone enrichment is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/search-id": {
"post": {
"tags": [
"Metadata"
],
"summary": "Issues a search for a type and id.",
"operationId": "POST_api_metadata_enrich_search_id",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchIdRequest"
}
},
{
"name": "searchSessionId",
"in": "query",
"description": "Unique id to associate with the search request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchIdResponse"
}
},
"403 ValidationException": {
"description": "The request was missing required parameters.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/other-phone": {
"post": {
"tags": [
"Metadata"
],
"summary": "Enriches the provided phone information with additional data.",
"operationId": "POST_api_metadata_enrich_other_phone",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "phoneEnrichmentRequest",
"in": "body",
"description": "The asset to enrich.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsPhoneEnrichmentRequest"
}
},
{
"name": "token",
"in": "query",
"description": "The one time token for the enrichment request.",
"required": false,
"type": "string"
},
{
"name": "sessionId",
"in": "query",
"description": "Optional ThreatMetrix session id associated with the request.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"400": {
"description": "The token is invalid."
},
"400 UnsupportedMarketException": {
"description": "Phone enrichment is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/search-product": {
"post": {
"tags": [
"Metadata"
],
"summary": "Issues a search for a product query.",
"operationId": "POST_api_metadata_enrich_search_product",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchProductRequest"
}
},
{
"name": "searchSessionId",
"in": "query",
"description": "Unique id to associate with the search request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchProductResponse"
}
},
"403 ValidationException": {
"description": "The request was missing required parameters.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/search-property": {
"post": {
"tags": [
"Metadata"
],
"summary": "Issues a search for a property query.",
"operationId": "POST_api_metadata_enrich_search_property",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchPropertyRequest"
}
},
{
"name": "searchSessionId",
"in": "query",
"description": "Unique id to associate with the search request.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSearchPropertyResponse"
}
},
"403 ValidationException": {
"description": "The request was missing required parameters.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/metadata/enrich/assets": {
"post": {
"tags": [
"Metadata"
],
"summary": "Enriches the provided asset with additional data.",
"operationId": "POST_api_metadata_enrich_assets",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "asset",
"in": "body",
"description": "The asset to enrich.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsIAsset"
}
},
{
"name": "maxResultCount",
"in": "query",
"description": "The maximum number of results to return when there are multiple options.",
"required": false,
"type": "integer",
"format": "int32",
"default": 40
},
{
"name": "pssId",
"in": "query",
"description": "The unique id associated with the search session request.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsIAsset"
},
"xml": {
"name": "IAsset",
"wrapped": true
},
"type": "array",
"default": [
{
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Zillow",
"CategoryId": "ABC",
"CategoryName": "Mansions",
"Level": 2
}
],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
},
{
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
}
]
}
},
"204": {
"description": "Request succeeded, but no additional data was found, so no result was returned."
},
"300": {
"description": "Request succeeded, and multiple results were returned.
\r\n Once one is selected, it may need to be re-enriched if some of the expected data is missing."
},
"400 ArgumentException": {
"description": "The request body is missing at least one required field.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ArgumentNullException": {
"description": "The request body did not contain an asset.",
"schema": {
"$ref": "#/definitions/ArgumentNullException",
"default": {
"Message": "Value cannot be null.",
"ExceptionMessage": "Value cannot be null.",
"ExceptionType": "ArgumentNullException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidAssetException": {
"description": "The asset did not contain properties to indicate a type of enrichment.",
"schema": {
"$ref": "#/definitions/InvalidAssetException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidAssetException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/paymentCards": {
"get": {
"tags": [
"PaymentCards"
],
"summary": "Get the payment cards for the current customer.",
"operationId": "GET_api_sic_paymentCards",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIV31PaymentCardPaymentCardResponse"
},
"xml": {
"name": "PaymentCardResponse",
"wrapped": true
},
"type": "array"
}
},
"500 PaymentProviderException": {
"description": "An unexpected problem occurred with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"PaymentCards"
],
"summary": "Create a payment card for the current customer.\r\nThe newly created card will be set as the default card.",
"operationId": "POST_api_sic_paymentCards",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "paymentCardRequest",
"in": "body",
"description": "The model containing the payment card request information.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIV31PaymentCardAddPaymentCardRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIV31PaymentCardPaymentCardResponse"
}
},
"500 PaymentProviderException": {
"description": "An unexpected problem occurred with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/paymentCard": {
"put": {
"tags": [
"PaymentCards"
],
"summary": "Update the payment card for the current customer.",
"operationId": "PUT_api_sic_paymentCard",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicPaymentCardsPaymentCardUpdateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 PaymentProviderException": {
"description": "An unexpected problem occurred with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/paymentCard/{defaultCardId}": {
"put": {
"tags": [
"PaymentCards"
],
"summary": "Set the default payment card for the current customer.",
"operationId": "PUT_api_sic_paymentCard_defaultCardId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "defaultCardId",
"in": "path",
"description": "The Stripe id of a customer's payment card.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 PaymentProviderException": {
"description": "An unexpected problem occurred with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/paymentCard/{cardId}": {
"delete": {
"tags": [
"PaymentCards"
],
"summary": "Delete a payment card from the current customer.",
"operationId": "DELETE_api_sic_paymentCard_cardId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "cardId",
"in": "path",
"description": "The card id to delete.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 PaymentProviderException": {
"description": "An unexpected problem occurred with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/pds": {
"get": {
"tags": [
"Pds"
],
"summary": "Gets a response containing the effective Product Disclosure Summary URI and\r\nthe Amendatory Endorsement URI (if configured) for the user",
"operationId": "GET_api_pds",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsProductDisclosureResponse"
}
},
"401 UserNotFoundException": {
"description": "The user does not exist, or the password associated with the login is incorrect.",
"schema": {
"$ref": "#/definitions/UserNotFoundException",
"default": {
"Message": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionMessage": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionType": "UserNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"PdsEmployee"
],
"summary": "Creates a new PDS.",
"operationId": "POST_api_pds",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request object containing the PDS version of the new PDS.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsCreateProductDisclosureSummaryRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsProductDisclosureSummaryResponse"
}
},
"400 PdsSummaryVersionExistsException": {
"description": "The PDS version cannot be created because one already exists.",
"schema": {
"$ref": "#/definitions/PdsSummaryVersionExistsException",
"default": {
"Message": "The PDS version cannot be created because one already exists.",
"ExceptionMessage": "The PDS version cannot be created because one already exists.",
"ExceptionType": "PdsSummaryVersionExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PdsSummaryVersionNotProvidedException": {
"description": "The PDS version is was not provided.",
"schema": {
"$ref": "#/definitions/PdsSummaryVersionNotProvidedException",
"default": {
"Message": "The PDS version is was not provided.",
"ExceptionMessage": "The PDS version is was not provided.",
"ExceptionType": "PdsSummaryVersionNotProvidedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/pds/history": {
"get": {
"tags": [
"PdsEmployee"
],
"summary": "Gets the history of all PDSes for the current market, ordered chronologically, descending.",
"operationId": "GET_api_pds_history",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsProductDisclosureSummaryResponse"
},
"xml": {
"name": "ProductDisclosureSummaryResponse",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/pds/regional": {
"get": {
"tags": [
"PdsEmployee"
],
"summary": "Gets the effective regional PDS.",
"operationId": "GET_api_pds_regional",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsProductDisclosureSummaryResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/pds/uri/{pdsVersion}": {
"get": {
"tags": [
"PdsEmployee"
],
"summary": "Gets the proposed URI for a PDS given the proposed version, used when the clients wants the URI for a version that has not yet been created.",
"operationId": "GET_api_pds_uri_pdsVersion",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "pdsVersion",
"in": "path",
"description": "The proposed version.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsProductDisclosureSummaryResponse"
}
},
"400 PdsSummaryVersionNotProvidedException": {
"description": "The PDS version is was not provided.",
"schema": {
"$ref": "#/definitions/PdsSummaryVersionNotProvidedException",
"default": {
"Message": "The PDS version is was not provided.",
"ExceptionMessage": "The PDS version is was not provided.",
"ExceptionType": "PdsSummaryVersionNotProvidedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/amendatoryEndorsement/{stateOfResidence}/history": {
"get": {
"tags": [
"PdsEmployee"
],
"summary": "Gets the history of all PDSes for the current market, ordered chronologically, descending.",
"operationId": "GET_api_amendatoryEndorsement_stateOfResidence_history",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "stateOfResidence",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsAmendatoryEndorsementResponse"
},
"xml": {
"name": "AmendatoryEndorsementResponse",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/amendatoryEndorsement": {
"post": {
"tags": [
"PdsEmployee"
],
"summary": "Creates a new Amendatory Endorsement for a state.",
"operationId": "POST_api_amendatoryEndorsement",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request object containing the PDS version of the new PDS.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsCreateAmendatoryEndorsementRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedPdsAmendatoryEndorsementResponse"
}
},
"400 AmendatoryEndorsementVersionExistsException": {
"description": "The Amendatory Endorsement version already exists.",
"schema": {
"$ref": "#/definitions/AmendatoryEndorsementVersionExistsException",
"default": {
"Message": "The Amendatory Endorsement version already exists.",
"ExceptionMessage": "The Amendatory Endorsement version already exists.",
"ExceptionType": "AmendatoryEndorsementVersionExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/premium/test": {
"post": {
"tags": [
"PremiumCalculationEmployee"
],
"summary": "Calculate a premium given a premium calculation request instance.\r\n \r\nThis endpoint is intended to be used by insurance providers to test their pricing models.",
"operationId": "POST_api_sic_premium_test",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "premiumCalculationRequest",
"in": "body",
"description": "The request to be used in the calculation.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicPriceOfferPremiumCalculationRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelSicPriceOfferPremiumCalculationResultsResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/premium/test/bulk": {
"post": {
"tags": [
"PremiumCalculationEmployee"
],
"summary": "Accepts a CSV file containing individual premium calculation test cases.\r\n \r\nThe endpoint requires a MimeMultipart request body, with a single part:\r\n- Must contain the CSV of test cases to execute;",
"description": "This endpoint is intended to be used by insurance providers to test their pricing models.",
"operationId": "POST_api_sic_premium_test_bulk",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "The file containing the test cases for premium calculation.",
"required": true,
"type": "file"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/quote/categories": {
"get": {
"tags": [
"PricingFileEmployee"
],
"summary": "Gets a list of supported quoting categories.",
"operationId": "GET_api_trov_quote_categories",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteSupportedQuoteCategoriesResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/profile": {
"get": {
"tags": [
"Profile"
],
"summary": "Gets the profile for the current user.",
"operationId": "GET_api_profile",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileProfile"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/profile/customer": {
"put": {
"tags": [
"Profile"
],
"summary": "Updates the profile customer for the current user.",
"operationId": "PUT_api_profile_customer",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerProfile",
"in": "body",
"description": "The updated info about the profile customer to edit.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileCustomerProfile"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileProfile"
}
},
"400 CustomerAddressNotSupportedException": {
"description": "The customer address is valid, but the address is not supported.",
"schema": {
"$ref": "#/definitions/CustomerAddressNotSupportedException",
"default": {
"Message": "Insurance is not available due to the customer's address.",
"ExceptionMessage": "Insurance is not available due to the customer's address.",
"ExceptionType": "CustomerAddressNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerAgeNotSupportedException": {
"description": "The customer has an age that is not supported.",
"schema": {
"$ref": "#/definitions/CustomerAgeNotSupportedException",
"default": {
"Message": "Insurance is not available due to the customer's age.",
"ExceptionMessage": "Insurance is not available due to the customer's age.",
"ExceptionType": "CustomerAgeNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerProfileInformationMissingException": {
"description": "The customer profile is missing information.",
"schema": {
"$ref": "#/definitions/CustomerProfileInformationMissingException",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 StateOfResidenceNotSupportedException": {
"description": "Customer does not reside in an active US state.",
"schema": {
"$ref": "#/definitions/StateOfResidenceNotSupportedException",
"default": {
"Message": "Customer does not reside in an active US state",
"ExceptionMessage": "Customer does not reside in an active US state",
"ExceptionType": "StateOfResidenceNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/profile/photos/profile": {
"post": {
"tags": [
"Profile"
],
"summary": "Updates the current user's profile photo.
\r\n \r\nThe endpoint requires a MimeMultipart request body, with a single part:\r\n- Must contain a single byte array (binary blob) of the images data.\r\n- The 'Content-Type' header set to the corresponding type of the blob (e.g. a jpg photo may have it set as 'image/jpeg');",
"operationId": "POST_api_profile_photos_profile",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileProfile"
}
},
"400 ArgumentException": {
"description": "The user id is an invalid format.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnsupportedImageException": {
"description": "The file was not a supported image.",
"schema": {
"$ref": "#/definitions/UnsupportedImageException",
"default": {
"Message": "The file is not a valid image or not a supported type.",
"ExceptionMessage": "The file is not a valid image or not a supported type.",
"ExceptionType": "UnsupportedImageException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to update the profile photo.
\r\n The customer does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/profile/photos/background": {
"post": {
"tags": [
"Profile"
],
"summary": "Updates the current user's background photo.\r\n \r\nThe endpoint requires a MimeMultipart request body, with a single part:\r\n- Must contain a single byte array (binary blob) of the images data.\r\n- The 'Content-Type' header set to the corresponding type of the blob (e.g. a jpg photo may have it set as 'image/jpeg');",
"operationId": "POST_api_profile_photos_background",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileProfile"
}
},
"400 ArgumentException": {
"description": "The user id is an invalid format.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnsupportedImageException": {
"description": "The file was not a supported image.",
"schema": {
"$ref": "#/definitions/UnsupportedImageException",
"default": {
"Message": "The file is not a valid image or not a supported type.",
"ExceptionMessage": "The file is not a valid image or not a supported type.",
"ExceptionType": "UnsupportedImageException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to update the background photo.
\r\n The customer does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/profile/{userId}": {
"get": {
"tags": [
"ProfileEmployee"
],
"summary": "Gets a profile for a specified user id.",
"operationId": "GET_api_profile_userId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The user id of the profile to get.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelProfileProfile"
}
},
"400 ArgumentException": {
"description": "The user id is an invalid format.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 MarketAuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user in this region.",
"schema": {
"$ref": "#/definitions/MarketAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The user does not exist.
\r\n The user does not have access.
\r\n The user has not set a profile.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/promotions": {
"get": {
"tags": [
"PromotionsEmployee"
],
"summary": "Retrieves the list of promotion objects that exist (within the date range given, if one is passed in).",
"operationId": "GET_api_promotions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Start of the date range for promotions to retrieve (optional).",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "toDate",
"in": "query",
"description": "End of the date range for promotions to retrieve (optional).",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicPromotionsPromotion"
},
"xml": {
"name": "Promotion",
"wrapped": true
},
"type": "array"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/promotion/{promoCode}": {
"get": {
"tags": [
"PromotionsEmployee"
],
"summary": "Retrieves the promotion object for a particular promotion code.",
"operationId": "GET_api_promotion_promoCode",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "promoCode",
"in": "path",
"description": "The promotion code to retrieve.",
"required": true,
"type": "string"
},
{
"name": "startedBeforeUtc",
"in": "query",
"description": "The promotion to be retrieved starts before this date (optional).",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicPromotionsPromotion"
},
"xml": {
"name": "Promotion",
"wrapped": true
},
"type": "array"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 PromotionNotFoundException": {
"description": "The specified promotion does not exist.",
"schema": {
"$ref": "#/definitions/PromotionNotFoundException",
"default": {
"Message": "A promotion with PromoCode string was not found.",
"ExceptionMessage": "A promotion with PromoCode string was not found.",
"ExceptionType": "PromotionNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/promotion": {
"post": {
"tags": [
"PromotionsEmployee"
],
"summary": "Stores a new entry in the Promotion table (and associated `PromotionCategory` entries).",
"operationId": "POST_api_promotion",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "promotion",
"in": "body",
"description": "The promotion to be created.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicPromotionsPromotion"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 InvalidDateException": {
"description": "The end date for a promotion must follow the start date.",
"schema": {
"$ref": "#/definitions/InvalidDateException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidDateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidPromotionException": {
"description": "A given property is not valid for the promotion.",
"schema": {
"$ref": "#/definitions/InvalidPromotionException",
"default": {
"Message": "'' is an invalid string for this operation.",
"ExceptionMessage": "'' is an invalid string for this operation.",
"ExceptionType": "InvalidPromotionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidPromotionTypeException": {
"description": "The given PromotionType is not valid.",
"schema": {
"$ref": "#/definitions/InvalidPromotionTypeException",
"default": {
"Message": "'Unknown' is not a valid PromotionType for this operation.",
"ExceptionMessage": "'Unknown' is not a valid PromotionType for this operation.",
"ExceptionType": "InvalidPromotionTypeException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"patch": {
"tags": [
"PromotionsEmployee"
],
"summary": "Updates details about the specified promotion.",
"operationId": "PATCH_api_promotion",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "promotionUpdate",
"in": "body",
"description": "Promotion Request object that describes the promotion to be updated (Promotion ID) and the updatable settings to be changed.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicPromotionsPromotionUpdateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 PromotionNotFoundException": {
"description": "The specified promotion does not exist.",
"schema": {
"$ref": "#/definitions/PromotionNotFoundException",
"default": {
"Message": "A promotion with PromoCode string was not found.",
"ExceptionMessage": "A promotion with PromoCode string was not found.",
"ExceptionType": "PromotionNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/promotion/{promotionId}": {
"delete": {
"tags": [
"PromotionsEmployee"
],
"summary": "Deletes the specified promotion.",
"operationId": "DELETE_api_promotion_promotionId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "promotionId",
"in": "path",
"description": "ID of the promotion to be deleted.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 PromotionNotFoundException": {
"description": "The specified promotion does not exist.",
"schema": {
"$ref": "#/definitions/PromotionNotFoundException",
"default": {
"Message": "A promotion with PromoCode string was not found.",
"ExceptionMessage": "A promotion with PromoCode string was not found.",
"ExceptionType": "PromotionNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 PromotionAlreadyRedeemedException": {
"description": "The specified promotion has already been redeemed.",
"schema": {
"$ref": "#/definitions/PromotionAlreadyRedeemedException",
"default": {
"Message": "The promotion string cannot be deleted, as it has already been redeemed.",
"ExceptionMessage": "The promotion string cannot be deleted, as it has already been redeemed.",
"ExceptionType": "PromotionAlreadyRedeemedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/asset/{assetId}/display-quote": {
"get": {
"tags": [
"Quotes"
],
"summary": "Gets a display quote for a specific asset id.",
"operationId": "GET_api_trov_trovId_asset_assetId_display_quote",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset to retrieve display quote for.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteDisplayQuoteResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/quote/{priceOfferId}/start-requirements": {
"get": {
"tags": [
"Quotes"
],
"summary": "Retrieves any requirements to start protection for a specified price offer.",
"operationId": "GET_api_trov_trovId_quote_priceOfferId_start_requirements",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset that the price offer is covering.",
"required": true,
"type": "string"
},
{
"name": "priceOfferId",
"in": "path",
"description": "The id of the price offer to retrieve requirements for.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteStartProtectionRequirementsResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified price offer does not exist.
\r\n The requesting user does not have access to the specified price offer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/asset/{assetId}/protection-billing-summary/{billingCycleCount}": {
"get": {
"tags": [
"Quotes"
],
"summary": "Gets billing summary for a specified asset id for the following billing cycles.",
"operationId": "GET_api_trov_trovId_asset_assetId_protection_billing_summary_billingCycleCount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset to billing summary for.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset to retrieve quote for.",
"required": true,
"type": "string"
},
{
"name": "billingCycleCount",
"in": "path",
"description": "The number of requested billing cycles. 1 - this month, 2 - current and next month etc.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteProtectionBillSummaryResponse"
}
},
"400 AssetNotCoveredException": {
"description": "The asset has no active coverage.",
"schema": {
"$ref": "#/definitions/AssetNotCoveredException",
"default": {
"Message": "There are no active coverage periods for this asset.",
"ExceptionMessage": "There are no active coverage periods for this asset.",
"ExceptionType": "AssetNotCoveredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnsupportedMarketException": {
"description": "The specified market is not supported.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset id does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/price-offer/{priceOfferId}/checkout-billing-summary/{billingCycleCount}": {
"get": {
"tags": [
"Quotes"
],
"summary": "Gets billing summary for a specified price offer id for the following billing cycles.",
"operationId": "GET_api_trov_trovId_price_offer_priceOfferId_checkout_billing_summary_billingCycleCount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset to retrieve quote for.",
"required": true,
"type": "string"
},
{
"name": "priceOfferId",
"in": "path",
"description": "The id of the price offer to retrieve billing summary for.",
"required": true,
"type": "string"
},
{
"name": "billingCycleCount",
"in": "path",
"description": "The number of requested billing cycles. 1 - this month, 2 - current and next month etc.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteCheckoutBillSummaryResponse"
}
},
"400 AssetAlreadyInsuredException": {
"description": "The asset is already insured.",
"schema": {
"$ref": "#/definitions/AssetAlreadyInsuredException",
"default": {
"Message": "The asset is already insured.",
"ExceptionMessage": "The asset is already insured.",
"ExceptionType": "AssetAlreadyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnsupportedMarketException": {
"description": "The specified market is not supported.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified price offer does not exist.
\r\n The requesting user does not have access to the specified price offer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/quotes/stop": {
"post": {
"tags": [
"Quotes"
],
"summary": "Stops all coverage for the current user.",
"operationId": "POST_api_trov_trovId_quotes_stop",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 UnsupportedMarketException": {
"description": "The operation requested is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/asset/{assetId}/stop-insurance": {
"post": {
"tags": [
"Quotes"
],
"summary": "Stops coverage for an asset.",
"operationId": "POST_api_trov_trovId_asset_assetId_stop_insurance",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset to stop.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "No Content"
},
"400 AssetNotCoveredException": {
"description": "The asset has no active coverage.",
"schema": {
"$ref": "#/definitions/AssetNotCoveredException",
"default": {
"Message": "There are no active coverage periods for this asset.",
"ExceptionMessage": "There are no active coverage periods for this asset.",
"ExceptionType": "AssetNotCoveredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 UnsupportedMarketException": {
"description": "The operation requested is not supported in the requested market.",
"schema": {
"$ref": "#/definitions/UnsupportedMarketException",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified asset coverage does not exist.
\r\n The requesting user does not have access to the specified asset coverage.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/quote/{assetId}": {
"post": {
"tags": [
"Quotes"
],
"summary": "Creates a quote response for insurance coverage on a customer's asset.\r\n \r\n---\r\nTo retrieve a quote, there are required properties necessary on the requesting customers profile.\r\n \r\n| Market | Properties |\r\n| -- | -- |\r\n| US | Customer.BirthDate,Customer.Address.State |",
"operationId": "POST_api_trov_trovId_quote_assetId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id asset to get the quote for.",
"required": true,
"type": "string"
},
{
"name": "sessionId",
"in": "query",
"description": "Optional ThreatMetrix session id associated with the quote request.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteCreateQuoteResponse"
}
},
"400 CategoryNotSupportedException": {
"description": "The specified asset has a category that is not supported for quotes.",
"schema": {
"$ref": "#/definitions/CategoryNotSupportedException",
"default": {
"Message": "The given asset has a category that is not supported for quotes.",
"ExceptionMessage": "The given asset has a category that is not supported for quotes.",
"ExceptionType": "CategoryNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerAgeNotSupportedException": {
"description": "The customer has an age that is not supported.",
"schema": {
"$ref": "#/definitions/CustomerAgeNotSupportedException",
"default": {
"Message": "Insurance is not available due to the customer's age.",
"ExceptionMessage": "Insurance is not available due to the customer's age.",
"ExceptionType": "CustomerAgeNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerLimitReachedException": {
"description": "The customer has exceeded their insurance coverage limit.",
"schema": {
"$ref": "#/definitions/CustomerLimitReachedException",
"default": {
"Message": "The customer has reached their insurance limit.",
"ExceptionMessage": "The customer has reached their insurance limit.",
"ExceptionType": "CustomerLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerProfileInformationMissingException": {
"description": "The customer is missing required profile information for insurance.",
"schema": {
"$ref": "#/definitions/CustomerProfileInformationMissingException",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 DeviceNotAutoDetectedException": {
"description": "The specified mobile device was not auto-detected and cannot be insured.",
"schema": {
"$ref": "#/definitions/DeviceNotAutoDetectedException",
"default": {
"Message": "The device cannot be insured",
"ExceptionMessage": "The device cannot be insured",
"ExceptionType": "DeviceNotAutoDetectedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 FraudValidationException": {
"description": "The request violates one or more ThreatMetrix categories.",
"schema": {
"$ref": "#/definitions/FraudValidationException",
"default": {
"Message": "Fraud validation failed.",
"ExceptionMessage": "Fraud validation failed.",
"ExceptionType": "FraudValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 InvalidAddressException": {
"description": "The customer's address could not be resolved to a valid address.",
"schema": {
"$ref": "#/definitions/InvalidAddressException",
"default": {
"Message": "The address was unable to be resolved to a valid address.",
"ExceptionMessage": "The address was unable to be resolved to a valid address.",
"ExceptionType": "InvalidAddressException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ItemLimitReachedException": {
"description": "The item exceeds the insurance limit.",
"schema": {
"$ref": "#/definitions/ItemLimitReachedException",
"default": {
"Message": "The item exceeds the insurance limit.",
"ExceptionMessage": "The item exceeds the insurance limit.",
"ExceptionType": "ItemLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ItemValueBelowMinException": {
"description": "Item value is below the minimum.",
"schema": {
"$ref": "#/definitions/ItemValueBelowMinException",
"default": {
"Message": "Item value is below the minimum.",
"ExceptionMessage": "Item value is below the minimum.",
"ExceptionType": "ItemValueBelowMinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 NoValueEstimateException": {
"description": "The BeValued response didn't supply a price for the asset.",
"schema": {
"$ref": "#/definitions/NoValueEstimateException",
"default": {
"Message": "Failed to generate price offer. (BeValuedNoValueEstimate)",
"ExceptionMessage": "Failed to generate price offer. (BeValuedNoValueEstimate)",
"ExceptionType": "NoValueEstimateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 OfacScreeningFailedException": {
"description": "The customer failed OFAC screening.",
"schema": {
"$ref": "#/definitions/OfacScreeningFailedException",
"default": {
"Message": "OFAC screening failed.",
"ExceptionMessage": "OFAC screening failed.",
"ExceptionType": "OfacScreeningFailedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PremiumValueBelowMinException": {
"description": "The premium value is below the minimum.",
"schema": {
"$ref": "#/definitions/PremiumValueBelowMinException",
"default": {
"Message": "The premium value is below the minimum.",
"ExceptionMessage": "The premium value is below the minimum.",
"ExceptionType": "PremiumValueBelowMinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerBlockedException": {
"description": "The customer is blocked from getting quotes.",
"schema": {
"$ref": "#/definitions/CustomerBlockedException",
"default": {
"Message": "The customer is blocked from performing this operation",
"ExceptionMessage": "The customer is blocked from performing this operation",
"ExceptionType": "CustomerBlockedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 ProductIsNotQuotableException": {
"description": "The product is not quotable.",
"schema": {
"$ref": "#/definitions/ProductIsNotQuotableException",
"default": {
"Message": "Product is not quotable. string",
"ExceptionMessage": "Product is not quotable. string",
"ExceptionType": "ProductIsNotQuotableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 StateOfResidenceNotSupportedException": {
"description": "Customer does not reside in an active US state.",
"schema": {
"$ref": "#/definitions/StateOfResidenceNotSupportedException",
"default": {
"Message": "Customer does not reside in an active US state",
"ExceptionMessage": "Customer does not reside in an active US state",
"ExceptionType": "StateOfResidenceNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trov/{trovId}/quote/{priceOfferId}/start-protection": {
"post": {
"tags": [
"Quotes"
],
"summary": "Accepts a price offer by processing the payment and marking the price offer as accepted.",
"operationId": "POST_api_trov_trovId_quote_priceOfferId_start_protection",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov containing the asset that the price offer is covering.",
"required": true,
"type": "string"
},
{
"name": "priceOfferId",
"in": "path",
"description": "The id of the price offer to accept.",
"required": true,
"type": "string"
},
{
"name": "sessionId",
"in": "query",
"description": "The id of the ThreatMetrix session on the client device.",
"required": false,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 AssetAlreadyInsuredException": {
"description": "The asset is already insured.",
"schema": {
"$ref": "#/definitions/AssetAlreadyInsuredException",
"default": {
"Message": "The asset is already insured.",
"ExceptionMessage": "The asset is already insured.",
"ExceptionType": "AssetAlreadyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerAddressNotSupportedException": {
"description": "The customer address is not supported for insurance.",
"schema": {
"$ref": "#/definitions/CustomerAddressNotSupportedException",
"default": {
"Message": "Insurance is not available due to the customer's address.",
"ExceptionMessage": "Insurance is not available due to the customer's address.",
"ExceptionType": "CustomerAddressNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerAgeNotSupportedException": {
"description": "The customer age is not supported for insurance.",
"schema": {
"$ref": "#/definitions/CustomerAgeNotSupportedException",
"default": {
"Message": "Insurance is not available due to the customer's age.",
"ExceptionMessage": "Insurance is not available due to the customer's age.",
"ExceptionType": "CustomerAgeNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerLimitReachedException": {
"description": "The customer has exceeded their insurance coverage limit.",
"schema": {
"$ref": "#/definitions/CustomerLimitReachedException",
"default": {
"Message": "The customer has reached their insurance limit.",
"ExceptionMessage": "The customer has reached their insurance limit.",
"ExceptionType": "CustomerLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 CustomerProfileInformationMissingException": {
"description": "The customer is missing required profile information for insurance.",
"schema": {
"$ref": "#/definitions/CustomerProfileInformationMissingException",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 DeviceNotAutoDetectedException": {
"description": "The specified mobile device was not auto-detected and cannot be insured.",
"schema": {
"$ref": "#/definitions/DeviceNotAutoDetectedException",
"default": {
"Message": "The device cannot be insured",
"ExceptionMessage": "The device cannot be insured",
"ExceptionType": "DeviceNotAutoDetectedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 DocumentConsentNotAcceptedException": {
"description": "To start protection for the asset current state document consent acceptance is required.",
"schema": {
"$ref": "#/definitions/DocumentConsentNotAcceptedException",
"default": {
"Message": "To start protection for the asset current state document consent acceptance is required.",
"ExceptionMessage": "To start protection for the asset current state document consent acceptance is required.",
"ExceptionType": "DocumentConsentNotAcceptedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 ItemLimitReachedException": {
"description": "The item exceeds the insurance limit.",
"schema": {
"$ref": "#/definitions/ItemLimitReachedException",
"default": {
"Message": "The item exceeds the insurance limit.",
"ExceptionMessage": "The item exceeds the insurance limit.",
"ExceptionType": "ItemLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PremiumNotAffordableException": {
"description": "Insuring the specified asset would have an unaffordable premium.",
"schema": {
"$ref": "#/definitions/PremiumNotAffordableException",
"default": {
"Message": "Insuring the specified asset would have an unaffordable premium.",
"ExceptionMessage": "Insuring the specified asset would have an unaffordable premium.",
"ExceptionType": "PremiumNotAffordableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PriceOfferAlreadyAcceptedException": {
"description": "The price offer has already been accepted.",
"schema": {
"$ref": "#/definitions/PriceOfferAlreadyAcceptedException",
"default": {
"Message": "The price offer has already been accepted.",
"ExceptionMessage": "The price offer has already been accepted.",
"ExceptionType": "PriceOfferAlreadyAcceptedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PriceOfferExpiredException": {
"description": "The price offer is expired.",
"schema": {
"$ref": "#/definitions/PriceOfferExpiredException",
"default": {
"Message": "The price offer is expired.",
"ExceptionMessage": "The price offer is expired.",
"ExceptionType": "PriceOfferExpiredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"400 PriceOfferProtectionRequiresAssetPhotosException": {
"description": "The price offer requires item photo(s).",
"schema": {
"$ref": "#/definitions/PriceOfferProtectionRequiresAssetPhotosException",
"default": {
"Message": "The price offer requires 0 photo(s).",
"ExceptionMessage": "The price offer requires 0 photo(s).",
"ExceptionType": "PriceOfferProtectionRequiresAssetPhotosException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 CustomerBlockedException": {
"description": "The customer is blocked from accepting quotes.",
"schema": {
"$ref": "#/definitions/CustomerBlockedException",
"default": {
"Message": "The customer is blocked from performing this operation",
"ExceptionMessage": "The customer is blocked from performing this operation",
"ExceptionType": "CustomerBlockedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified price offer does not exist.
\r\n The requesting user does not have access to the specified price offer.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 PaymentProviderChargeException": {
"description": "The charge failed.",
"schema": {
"$ref": "#/definitions/PaymentProviderChargeException",
"default": {
"Message": "Payment provider charge failed: string",
"ExceptionMessage": "Payment provider charge failed: string",
"ExceptionType": "PaymentProviderChargeException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 PaymentProviderNoPaymentCardConfiguredForCustomerException": {
"description": "The customer has no payment card configured with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderNoPaymentCardConfiguredForCustomerException",
"default": {
"Message": "There is no payment card configured in the payment provider for the customer.",
"ExceptionMessage": "There is no payment card configured in the payment provider for the customer.",
"ExceptionType": "PaymentProviderNoPaymentCardConfiguredForCustomerException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 PaymentProviderNotConfiguredForCustomerException": {
"description": "The customer has is configured with the payment provider.",
"schema": {
"$ref": "#/definitions/PaymentProviderNotConfiguredForCustomerException",
"default": {
"Message": "The customer has not been configured with the payment provider.",
"ExceptionMessage": "The customer has not been configured with the payment provider.",
"ExceptionType": "PaymentProviderNotConfiguredForCustomerException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/refreshToken/{refreshToken}": {
"delete": {
"tags": [
"RefreshToken"
],
"summary": "Deletes the specified refresh token.",
"operationId": "DELETE_api_refreshToken_refreshToken",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "refreshToken",
"in": "path",
"description": "The refresh token to delete.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/token/requestRemoteAutoDetect": {
"post": {
"tags": [
"RemoteOperations"
],
"summary": "Sends an email to the given user email account with a link to the app that allows auto-detection.",
"operationId": "POST_api_sic_token_requestRemoteAutoDetect",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "remoteAutodetectRequest",
"in": "body",
"description": "The model containing the remote request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicRemoteOperationsRemoteAutodetectRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"202": {
"description": "No Content"
},
"400": {
"description": "The email address is not valid.
The password does not meet minimum requirements."
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/sic/token/requestRemoteLoginAndAutodetect": {
"post": {
"tags": [
"RemoteOperations"
],
"summary": "Sends an email to the calling user email account with the app login.",
"operationId": "POST_api_sic_token_requestRemoteLoginAndAutodetect",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "remoteOperationRequest",
"in": "body",
"description": "The model containing the remote request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSicRemoteOperationsRemoteOperationRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"202": {
"description": "No Content"
},
"400": {
"description": "Magic link can only be requested for mobile phones."
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/risk/score/{customerId}": {
"get": {
"tags": [
"RiskScoringEmployee"
],
"summary": "Gets the risk score for the customer.",
"operationId": "GET_api_risk_score_customerId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The id of the customer to score",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedRiskScoringRiskScoringResponse"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The customer does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/risk/whitelist/{CustomerId}": {
"post": {
"tags": [
"RiskScoringEmployee"
],
"summary": "Adds the customer to the risk scoring validation whitelist.",
"operationId": "POST_api_risk_whitelist_customerId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "customerId",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "customerId",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The customer does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"delete": {
"tags": [
"RiskScoringEmployee"
],
"summary": "Removes the customer from the risk scoring validation whitelist.",
"operationId": "DELETE_api_risk_whitelist_customerId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "customerId",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "customerId",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 AuthenticationException": {
"description": "The current user is not a SIC support admin or SIC support user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The customer does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/role": {
"get": {
"tags": [
"RoleAdmin"
],
"summary": "Gets all available roles in the trov system.",
"operationId": "GET_api_admin_role",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelSecurityApplicationRoleResult"
},
"xml": {
"name": "ApplicationRoleResult",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"RoleAdmin"
],
"summary": "Updates a specified users roles.",
"operationId": "POST_api_admin_role",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "updateUserRolesRequest",
"in": "body",
"description": "The model that represents the update user roles request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityUpdateUserRolesRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"401 RoleRequiresTwoFactorAuthenticationException": {
"description": "The requested user account does not have two-factor authentication enabled and has requested a role that required it.",
"schema": {
"$ref": "#/definitions/RoleRequiresTwoFactorAuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "RoleRequiresTwoFactorAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/statements": {
"get": {
"tags": [
"Statements"
],
"summary": "Gets a list of available statement summaries for the logged in user.",
"operationId": "GET_api_statements",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedStatementsStatementsResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/statement/{statementId}": {
"get": {
"tags": [
"Statements"
],
"summary": "Returns the requested statement as HTML.",
"operationId": "GET_api_statement_statementId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "statementId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"404 DocumentAccessException": {
"description": "The user does not have access to the statement.
\r\n The statement does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/status": {
"get": {
"tags": [
"Status"
],
"summary": "Validates connectivity to internal dependencies of the system.",
"operationId": "GET_api_status",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedStatusStatusResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/status/internal": {
"get": {
"tags": [
"Status"
],
"summary": "Validates connectivity to internal dependencies of the system.",
"operationId": "GET_api_status_internal",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedStatusStatusResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/suggestionGroups": {
"get": {
"tags": [
"Suggestions"
],
"summary": "Retrieves the suggestion groups.",
"operationId": "GET_api_suggestionGroups",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionGroup"
},
"xml": {
"name": "SuggestionGroup",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"put": {
"tags": [
"Suggestions"
],
"summary": "Replaces the existing suggestion groups.",
"operationId": "PUT_api_suggestionGroups",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The suggestion groups. Suggestion groups cannot be empty.",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionGroup"
},
"xml": {
"name": "SuggestionGroup",
"wrapped": true
},
"type": "array"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionGroup"
},
"xml": {
"name": "SuggestionGroup",
"wrapped": true
},
"type": "array"
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/suggestionGroups/{trovId}": {
"get": {
"tags": [
"Suggestions"
],
"summary": "Retrieves the suggestion groups for a specified trov.",
"operationId": "GET_api_suggestionGroups_trovId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The trov identifier.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionGroup"
},
"xml": {
"name": "SuggestionGroup",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/suggestions/{suggestionId}/addedAssets/{trovId}": {
"get": {
"tags": [
"Suggestions"
],
"summary": "Gets the assets that have the given suggestion id in the external identifiers for `ExternalIdentifierType.TrovSuggestionId`.",
"operationId": "GET_api_suggestions_suggestionId_addedAssets_trovId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "suggestionId",
"in": "path",
"description": "The suggestion identifier.",
"required": true,
"type": "string"
},
{
"name": "trovId",
"in": "path",
"description": "The trov identifier.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsIAsset"
},
"xml": {
"name": "IAsset",
"wrapped": true
},
"type": "array",
"default": [
{
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Zillow",
"CategoryId": "ABC",
"CategoryName": "Mansions",
"Level": 2
}
],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
},
{
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
}
]
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/test/sentEmails": {
"post": {
"tags": [
"TestHook"
],
"summary": "Retrieves the email templates that were sent to a the given recipient.",
"operationId": "POST_api_test_sentEmails",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "recipient",
"in": "body",
"description": "The recipient email address to filter the sent emails with.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Unexpected server error."
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/test/publish-to-platform-hangfire": {
"post": {
"tags": [
"TestHook"
],
"summary": "Publishes a background job based on the specified interface name, method name, and method parameters.",
"operationId": "POST_api_test_publish_to_platform_hangfire",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedTestHookPublishToHangfirePlatformRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"403 ValidationException": {
"description": "Invalid request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/test/execute-scheduled-platform-jobs": {
"post": {
"tags": [
"TestHook"
],
"summary": "Executes all scheduled job that have been scheduled before the given time.\r\nThis can only be used when the Synchronous_Jobs environment capability is configured.",
"operationId": "POST_api_test_execute_scheduled_platform_jobs",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request model.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedTestHookExecuteScheduledPlatformJobsRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"403 ValidationException": {
"description": "Invalid request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/test/notification/queue": {
"post": {
"tags": [
"TestHook"
],
"summary": "Queues a notification to be sent to the current user's devices.\r\n \r\nFor development and testing purposes only.",
"operationId": "POST_api_test_notification_queue",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "query",
"description": "The trov id of the notification.",
"required": true,
"type": "string"
},
{
"name": "notificationText",
"in": "query",
"description": "The notification text that will be displayed to the user.",
"required": true,
"type": "string"
},
{
"name": "notificationType",
"in": "query",
"description": "The type of notification being sent.",
"required": true,
"type": "string",
"enum": [
"Unknown",
"AssetDisplay",
"AssetRevalued",
"AssetGifted",
"AssetSold",
"AssetAutoDetect",
"AssetsImported",
"ClaimCompanyMessageSent",
"ClaimDenied",
"ClaimAccepted",
"ClaimCancelled",
"ClaimSettled"
],
"x-enumName": "NotificationType"
},
{
"name": "customItems",
"in": "body",
"description": "The custom items that will be included in the notification payload.",
"required": true,
"schema": {
"additionalProperties": {
"type": "object"
},
"type": "object"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "integer",
"format": "int32"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/token/twoFactor": {
"post": {
"tags": [
"Token"
],
"summary": "Requests a two-factor code to be sent for the provided credentials.",
"operationId": "POST_api_token_twoFactor",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "twoFactorSendRequest",
"in": "body",
"description": "The model that represents the request to send a two-factor code.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelSecurityTwoFactorSendRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 TwoFactorAuthenticationNotEnabledException": {
"description": "The user account does not have two-factor authentication enabled.
\r\n The user account does not have two-factor authentication enabled for the requested TwoFactorProviderType.",
"schema": {
"$ref": "#/definitions/TwoFactorAuthenticationNotEnabledException",
"default": {
"Message": "The user account does not have two-factor authentication enabled.",
"ExceptionMessage": "The user account does not have two-factor authentication enabled.",
"ExceptionType": "TwoFactorAuthenticationNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"401 UserNotFoundException": {
"description": "The user does not exist, or the password associated with the login is incorrect.",
"schema": {
"$ref": "#/definitions/UserNotFoundException",
"default": {
"Message": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionMessage": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionType": "UserNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/trovs": {
"get": {
"tags": [
"TrovAdmin"
],
"summary": "Finds a trov by a specified email address.",
"operationId": "GET_api_admin_trovs",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "email",
"in": "query",
"description": "The email address to filter the trovs by owner.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedTrovTrovResponse"
},
"xml": {
"name": "TrovResponse",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs": {
"get": {
"tags": [
"Trovs"
],
"summary": "Gets all trovs to which a user has access.",
"operationId": "GET_api_trovs",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedTrovTrovResponse"
},
"xml": {
"name": "TrovResponse",
"wrapped": true
},
"type": "array"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Trovs"
],
"summary": "Creates a new trov for the current user.",
"operationId": "POST_api_trovs",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedTrovTrovResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}": {
"get": {
"tags": [
"Trovs"
],
"summary": "Gets a trov.",
"operationId": "GET_api_trovs_trovId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The trov id.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedTrovTrovResponse"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/trovs/{trovId}/settings": {
"get": {
"tags": [
"Trovs"
],
"summary": "Gets the settings associated with a trov.",
"operationId": "GET_api_trovs_trovId_settings",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"properties": {
"unknown": {
"type": "object"
},
"ebayMinimumImportThreshold": {
"type": "object"
},
"brokerEmail": {
"type": "object"
},
"wealthManagerEmail": {
"type": "object"
},
"adminAccess": {
"type": "object"
},
"insuranceContact": {
"type": "object"
},
"experimentParticipation": {
"type": "object"
},
"defaultCulture": {
"type": "object"
},
"defaultMarket": {
"type": "object"
},
"emailMinimumImportThreshold": {
"type": "object"
},
"emergencyLogout20150410": {
"type": "object"
}
},
"type": "object"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"post": {
"tags": [
"Trovs"
],
"summary": "Adds or updates the settings associated with a trov.",
"operationId": "POST_api_trovs_trovId_settings",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "path",
"description": "The id of the trov.",
"required": true,
"type": "string"
},
{
"name": "settings",
"in": "body",
"description": "Allows for extracting the TrovSettings dictionary from the body (NOTE: query parameters are preferred).",
"required": true,
"schema": {
"properties": {
"unknown": {
"type": "object"
},
"ebayMinimumImportThreshold": {
"type": "object"
},
"brokerEmail": {
"type": "object"
},
"wealthManagerEmail": {
"type": "object"
},
"adminAccess": {
"type": "object"
},
"insuranceContact": {
"type": "object"
},
"experimentParticipation": {
"type": "object"
},
"defaultCulture": {
"type": "object"
},
"defaultMarket": {
"type": "object"
},
"emailMinimumImportThreshold": {
"type": "object"
},
"emergencyLogout20150410": {
"type": "object"
}
},
"type": "object"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/user/{userId}": {
"get": {
"tags": [
"UserAdmin"
],
"summary": "Gets the roles for a specified user id.",
"operationId": "GET_api_admin_user_userId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The id of the user to retrieve.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserUserResponse"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/user": {
"get": {
"tags": [
"UserAdmin"
],
"summary": "Searches users using specified filters.",
"operationId": "GET_api_admin_user",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "roleName",
"in": "query",
"description": "Optional role name to filter with.",
"required": false,
"type": "string"
},
{
"name": "email",
"in": "query",
"description": "Optional email to filter with.",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserUserResponse"
},
"xml": {
"name": "UserResponse",
"wrapped": true
},
"type": "array"
}
},
"400 ValidationException": {
"description": "Request must contain a 'RoleName' or 'Email' parameter.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users/conversion": {
"post": {
"tags": [
"Users"
],
"summary": "Stores the guest user conversion data.",
"operationId": "POST_api_users_conversion",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The guest user data.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestUserConversionRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users/deactivate": {
"post": {
"tags": [
"Users"
],
"summary": "Deactivates the current user account.\r\n \r\n- Removes any associated user tokens (e.g. Apple Push token), and any linked email accounts.\r\n- NOTE: any future request to the API after this call, will reactivate the account.",
"operationId": "POST_api_users_deactivate",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"400 CustomerHasActiveCoveragePeriodsException": {
"description": "Customer cannot be deactivated because it has active coverage periods.",
"schema": {
"$ref": "#/definitions/CustomerHasActiveCoveragePeriodsException",
"default": {
"Message": "Customer cannot be deactivated because it has active coverage periods.",
"ExceptionMessage": "Customer cannot be deactivated because it has active coverage periods.",
"ExceptionType": "CustomerHasActiveCoveragePeriodsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users": {
"post": {
"tags": [
"Users"
],
"summary": "Registers a new user in the global Trov system.",
"operationId": "POST_api_users",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The user registration request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserUserRegistrationRequest"
}
},
{
"name": "sessionId",
"in": "query",
"description": "Optional ThreatMetrix session id associated with the user account creation.",
"required": false,
"type": "string"
},
{
"name": "guestSessionId",
"in": "query",
"description": "Optional guest session id associated with the user account creation.",
"required": false,
"type": "string",
"format": "uuid"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserUserRegisterResponse"
}
},
"401 AuthenticationException": {
"description": "The username and/or password does not match for an existing user.",
"schema": {
"$ref": "#/definitions/AuthenticationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"403 ValidationException": {
"description": "Invalid/missing request properties.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users/tokens": {
"put": {
"tags": [
"UserToken"
],
"summary": "Adds a token to the current user.",
"operationId": "PUT_api_users_tokens",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The request containing the token to add.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserTokenAddDeviceTokenRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"403 ValidationException": {
"description": "The token is not supported.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users/tokens/delete": {
"post": {
"tags": [
"UserToken"
],
"summary": "Removes a token from the current user.",
"operationId": "POST_api_users_tokens_delete",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "The token to be deleted.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserTokenRemoveDeviceTokenRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"403 ValidationException": {
"description": "The token is not supported.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/users/tokens/{tokenType}/{tokenValue}": {
"delete": {
"tags": [
"UserToken"
],
"summary": "Removes a token from the current user.",
"operationId": "DELETE_api_users_tokens_tokenType_tokenValue",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "tokenType",
"in": "path",
"description": "The type of the token to delete. (0 = Unknown , 1 = Apple , 2 = Android )",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
],
"x-enumName": "DeviceTokenType"
},
{
"name": "tokenValue",
"in": "path",
"description": "The value of the token to delete.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"403 ValidationException": {
"description": "The token is not supported.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"deprecated": true
}
},
"/api/version/minimumApiVersion": {
"get": {
"tags": [
"Version"
],
"summary": "Gets the current minimum version of the API that is supported.",
"operationId": "GET_api_version_minimumApiVersion",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "number",
"format": "double"
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/woz": {
"get": {
"tags": [
"Wooz"
],
"summary": "Gets all current actionable wooz assets.",
"operationId": "GET_api_woz",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsWoozAssetResult"
},
"xml": {
"name": "WoozAssetResult",
"wrapped": true
},
"type": "array",
"default": [
{
"Id": "4d3ed089fb60ab534684b7fb",
"Created": 130982766720000000,
"HasPendingAccessor": false
}
]
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/trovs/{woozTrovId}/assets/{assetId}": {
"put": {
"tags": [
"Wooz"
],
"summary": "Updates an asset for a wooz user.",
"operationId": "PUT_api_admin_trovs_woozTrovId_assets_assetId",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "woozTrovId",
"in": "path",
"description": "The id of the trov the asset belongs to.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset to update.",
"required": true,
"type": "string"
},
{
"name": "assetUpdateRequest",
"in": "body",
"description": "The asset update request.",
"required": true,
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetUpdateRequest"
}
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
}
},
"403 ValidationException": {
"description": "The trov id does not match the asset's root id.
\r\n The specified containment hierarchy is not allowed.
\r\n The asset thumbnail is invalid.",
"schema": {
"$ref": "#/definitions/ValidationException",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
},
"delete": {
"tags": [
"Wooz"
],
"summary": "Deletes an asset on the trov.",
"operationId": "DELETE_api_admin_trovs_woozTrovId_assets_assetId",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "woozTrovId",
"in": "path",
"description": "The id of the trov containing the asset to delete.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the asset to delete.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/trovs/{woozTrovId}/assets": {
"post": {
"tags": [
"Wooz"
],
"summary": "Adds an asset to an existing trov for a wooz user.",
"operationId": "POST_api_admin_trovs_woozTrovId_assets",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "woozTrovId",
"in": "path",
"description": "The id of the trov to create the asset on.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelCoreWoozAccessResult"
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/woz/claim": {
"post": {
"tags": [
"Wooz"
],
"summary": "Marks the wooz asset as claimed and returns an access result for a specified asset.",
"operationId": "POST_api_woz_claim",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "trovId",
"in": "query",
"description": "The id of the trov the asset is associated with.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "query",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TrovCommonModelCoreWoozAccessResult"
}
},
"403 WozAccessNotEnabledException": {
"description": "The asset does not have admin access enabled.
\r\n The asset does not have a pending WOZ update flag.",
"schema": {
"$ref": "#/definitions/WozAccessNotEnabledException",
"default": {
"Message": "Woz access is not enabled for this trov.",
"ExceptionMessage": "Woz access is not enabled for this trov.",
"ExceptionType": "WozAccessNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/woz/remove": {
"post": {
"tags": [
"Wooz"
],
"summary": "Removes wooz access from a specified asset.",
"operationId": "POST_api_woz_remove",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "query",
"description": "The id of the trov the asset is associated with.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "query",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"403 WozAccessNotEnabledException": {
"description": "The asset does not have admin access enabled.
\r\n The asset does not have a pending WOZ update flag.",
"schema": {
"$ref": "#/definitions/WozAccessNotEnabledException",
"default": {
"Message": "Woz access is not enabled for this trov.",
"ExceptionMessage": "Woz access is not enabled for this trov.",
"ExceptionType": "WozAccessNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/woz/unclaim": {
"post": {
"tags": [
"Wooz"
],
"summary": "Removes the claimed status of a specified asset.",
"operationId": "POST_api_woz_unclaim",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "trovId",
"in": "query",
"description": "The id of the trov the asset is associated with.",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "query",
"description": "The id of the asset.",
"required": true,
"type": "string"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"403 WozAccessNotEnabledException": {
"description": "The asset does not have admin access enabled.
\r\n The asset does not have a pending WOZ update flag.",
"schema": {
"$ref": "#/definitions/WozAccessNotEnabledException",
"default": {
"Message": "Woz access is not enabled for this trov.",
"ExceptionMessage": "Woz access is not enabled for this trov.",
"ExceptionType": "WozAccessNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/v4.0/admin/trovs/{woozTrovId}/assets/{assetId}/duplicate": {
"post": {
"tags": [
"Wooz"
],
"summary": "Duplicates an existing asset on the trov.",
"operationId": "POST_api_admin_trovs_woozTrovId_assets_assetId_duplicate",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "woozTrovId",
"in": "path",
"description": "The id of the trov containing the original asset and the destination for the duplicated asset(s).",
"required": true,
"type": "string"
},
{
"name": "assetId",
"in": "path",
"description": "The id of the source asset to duplicate.",
"required": true,
"type": "string"
},
{
"name": "numberOfDuplicates",
"in": "query",
"description": "The number duplicated source asset to create.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Trov-Tenant",
"in": "header",
"description": "The tenant to use for the requests.",
"required": true,
"type": "string",
"default": "USSic"
},
{
"name": "Trov-Market",
"in": "header",
"description": "The market to use for the requests.",
"required": true,
"type": "string",
"default": "US"
},
{
"name": "Trov-Client",
"in": "header",
"description": "The identifier of the client making the request.",
"required": true,
"type": "string",
"default": "kahunaTestApi"
},
{
"name": "Accept-Language",
"in": "header",
"description": "The language to use for localization of responses (where applicable).",
"required": true,
"type": "string",
"default": "en-US"
},
{
"name": "Authorization",
"in": "header",
"description": "The bearer access token to authorize the request (e.g. `bearer TOKEN`)",
"required": true,
"type": "string",
"default": ""
}
],
"responses": {
"204": {
"description": "No Content"
},
"400 ArgumentException": {
"description": "The `numberOfDuplicates` parameter must be greater than 0.",
"schema": {
"$ref": "#/definitions/ArgumentException",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"404 DocumentAccessException": {
"description": "The specified trov does not exist.
\r\n The requesting user does not have access to the specified trov.
\r\n The specified asset does not exist.
\r\n The requesting user does not have access to the specified asset.
\r\n The specific revision of the asset does not exist.",
"schema": {
"$ref": "#/definitions/DocumentAccessException",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"500 UnexpectedErrorException": {
"description": "An unexpected error has occurred.",
"schema": {
"$ref": "#/definitions/UnexpectedErrorException",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
},
"/api/token": {
"post": {
"tags": [
"Token"
],
"summary": "\r\nAllows for generating access tokens to use with the API.\r\n\r\nThe endpoint requires the request properties to be sent via `x-www-form-urlencoded` format.\r\n\r\n---\r\n\r\nThere are two types of tokens available:\r\n\r\n| Type | Description |\r\n| -- | -- |\r\n| short term access token (`access_token`) | Necessary for use with any other Authorized Trov API endpoint -- a long term access token cannot be used in its place. |\r\n| long term access token (`refresh_token`) | Used to request new short term access tokens. Automatically revoked when a user changes their password. |\r\n\r\n---\r\n\r\nThere are four request types available, these types are controlled by the request `grant_type` property.\r\n\r\n# `grant_type: password`:\r\nAllows for initial access to the Trov system;\r\n\r\nAuthenticates the username and password and returns both a short term access token (`access_token`) and long term access token (`refresh_token`);\r\n\r\n| Request Property |\r\n| -- |\r\n| `username` |\r\n| `username` |\r\n| `password` |\r\n| `grant_type` |\r\n| `client_id` |\r\n| `client_secret` (optional if client type is `Javascript`) |\r\n| `client_instance` (unique identifier of the client instance to associate the `refresh_token` with) |\r\n\r\n# `grant_type: facebook_token`:\r\nAuthenticates the Facebook access token and returns both a Trov short term access token (`access_token`) and Trov long term access token (`refresh_token`);\r\n\r\nThe response may contain a `is_new_user` property, indicating if it was the first time a user logged into the Trov system;\r\n\r\n| Request Property |\r\n| -- |\r\n| `facebook_token` |\r\n| `grant_type` |\r\n| `client_id` |\r\n| `client_secret` (optional if client type is `Javascript`) |\r\n| `client_instance` (unique identifier of the client instance to associate the `refresh_token` with) |\r\n\r\n# `grant_type: one_time_use_token`:\r\nAuthenticates the one-time use token and returns both a Trov short term access token (`access_token`) and Trov long term access token (`refresh_token`);\r\n\r\n| Request Property |\r\n| -- |\r\n| `one_time_use_token` |\r\n| `grant_type` |\r\n| `client_id` |\r\n| `client_secret` (optional if client type is `Javascript`) |\r\n| `client_instance` (unique identifier of the client instance to associate the `refresh_token` with) |\r\n\r\n# `grant_type: refresh_token`:\r\nExchanges a long term access token (`refresh_token`) for a short term access token (`access_token`);\r\n\r\nInvalidates the request `refresh_token` and returns a new `refresh_token` with an extended expiry;\r\n\r\n| Request Property |\r\n| -- |\r\n| `refresh_token` |\r\n| `grant_type` |\r\n| `client_id` |\r\n| `client_secret` (optional if client type is `Javascript`) |\r\n| `client_instance` (unique identifier of the client instance to associate the extended `refresh_token` with) |\r\n\r\n---\r\n\r\n# Known Error Responses:\r\n\r\n| Response | Reason |\r\n| -- | -- |\r\n| `{\"error\": \"unsupported_grant_type\"}` | `grant_type` is missing or invalid |\r\n| `{\"error\": \"invalid_grant\"}` | `refresh_token` is invalid or expired |\r\n| `{\"error\": \"invalid_client\", \"error_description\": \"'client_id' can not be null or empty.\"}` | `client_id` is missing |\r\n| `{\"error\": \"invalid_client\", \"error_description\": \"'client_id' 'XXXX' is not registered in the system.\"}` | `client_id` is invalid |\r\n| `{\"error\": \"invalid_client\", \"error_description\": \"'client_secret' can not be null or empty.\" }` | `client_secret` is missing |\r\n| `{\"error\": \"invalid_client\", \"error_description\": \"'client_secret' 'XXXX' is invalid\" }` | `client_secret` is invalid |\r\n| `{\"error\": \"invalid_client\", \"error_description\": \"'client_instance' can not be null or empty.\" }` | `client_instance` is missing |\r\n| `{\"invalid_grant\": \"The username or password is incorrect.\"}` | the `username` or `password` fields are missing or invalid |\r\n| `{\"invalid_grant\": \"'facebook_token' can not be null or empty.\" }` | `facebook_token` is missing |\r\n| `{\"invalid_grant\": \"Invalid Facebook OAuth access token.\"}` | `facebook_token` is invalid or expired |\r\n| `{\"invalid_grant\": \"The Facebook account does not have an associated/verified email address.\"}` | `facebook_token` does not have an associated/verified email address |\r\n| `{\"invalid_grant\": \"'one_time_use_token' can not be null or empty.\" }` | `one_time_use_token` is missing |\r\n| `{\"invalid_grant\": \"Invalid one-time use token.\"}` | `one_time_use_token` is invalid or expired |",
"operationId": "Token_Token",
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "grant_type",
"in": "formData",
"required": true,
"schema": {
"type": "string"
},
"type": "string",
"default": "password"
},
{
"name": "username",
"in": "formData",
"required": true,
"schema": {
"type": "string"
},
"type": "string",
"default": "test"
},
{
"name": "password",
"in": "formData",
"required": true,
"schema": {
"type": "string"
},
"type": "string",
"default": "test"
},
{
"name": "client_id",
"in": "formData",
"required": true,
"schema": {
"type": "string"
},
"type": "string",
"default": "test-client"
},
{
"name": "client_instance",
"in": "formData",
"required": true,
"schema": {
"type": "string"
},
"type": "string",
"default": "my_instance"
},
{
"name": "client_secret",
"in": "formData",
"required": false,
"schema": {
"type": "string"
},
"type": "string",
"default": "my_secret"
}
],
"responses": {
"200": {
"schema": {
"type": "string"
}
},
"400": {
"schema": {
"type": "string"
}
}
}
}
}
},
"definitions": {
"TrovCommonModelSecurityChangeEmailRequest": {
"description": "Represents a change email request.",
"required": [
"password",
"newEmail"
],
"properties": {
"password": {
"description": "Gets or sets the password of the user account.",
"type": "string"
},
"newEmail": {
"description": "Gets or sets the new email of the user account.",
"type": "string"
}
},
"xml": {
"name": "ChangeEmailRequest"
},
"type": "object",
"default": {
"Password": "password",
"NewEmail": "john.smith@trov.com"
}
},
"UnexpectedErrorException": {
"description": "UnexpectedErrorException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "An unexpected error has occurred.",
"ExceptionMessage": "An unexpected error has occurred.",
"ExceptionType": "UnexpectedErrorException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"InvalidPasswordException": {
"description": "InvalidPasswordException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The password provided was invalid.",
"ExceptionMessage": "The password provided was invalid.",
"ExceptionType": "InvalidPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"EmailAlreadyInUseException": {
"description": "EmailAlreadyInUseException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The email address is in use by an existing user.",
"ExceptionMessage": "The email address is in use by an existing user.",
"ExceptionType": "EmailAlreadyInUseException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ValidationException": {
"description": "ValidationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSecurityChangePasswordRequest": {
"description": "Represents a change password request.",
"required": [
"oldPassword",
"newPassword",
"confirmPassword"
],
"properties": {
"oldPassword": {
"description": "Gets or sets the old password of the user account.",
"type": "string"
},
"newPassword": {
"description": "Gets or sets the new password of the user account.",
"type": "string",
"maxLength": 100,
"minLength": 8
},
"confirmPassword": {
"description": "Gets or sets the confirmation of the new password of the user account.",
"type": "string"
}
},
"xml": {
"name": "ChangePasswordRequest"
},
"type": "object",
"default": {
"OldPassword": "oldPassword1!",
"NewPassword": "password",
"ConfirmPassword": "password"
}
},
"TrovCommonModelSecuritySetPasswordRequest": {
"description": "Represents a password set request.",
"required": [
"newPassword",
"confirmPassword"
],
"properties": {
"newPassword": {
"description": "Gets or sets the new password for the request.",
"type": "string",
"maxLength": 100,
"minLength": 6
},
"confirmPassword": {
"description": "Gets or sets the confirmation of the new password for the request.",
"type": "string"
}
},
"xml": {
"name": "SetPasswordRequest"
},
"type": "object",
"default": {
"NewPassword": "password",
"ConfirmPassword": "password"
}
},
"UserHasPasswordException": {
"description": "UserHasPasswordException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Setting the password this way is prohibited on accounts with existing passwords, please use the dedicated endpoints update password endpoint.",
"ExceptionMessage": "Setting the password this way is prohibited on accounts with existing passwords, please use the dedicated endpoints update password endpoint.",
"ExceptionType": "UserHasPasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSecurityToggleTwoFactorAuthenticationRequest": {
"description": "Represents a request to toggle two-factor authentication on a user's account.",
"required": [
"password",
"enabled"
],
"properties": {
"password": {
"description": "Gets or sets the password of the user account.",
"type": "string"
},
"enabled": {
"description": "Gets or sets a value indicating whether two factor authentication should be enabled or disabled.",
"type": "boolean"
}
},
"xml": {
"name": "ToggleTwoFactorAuthenticationRequest"
},
"type": "object",
"default": {
"Password": "password",
"Enabled": true
}
},
"UserRequiresConfirmationException": {
"description": "UserRequiresConfirmationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The user account () requires phone contact information in a confirmed state.",
"ExceptionMessage": "The user account () requires phone contact information in a confirmed state.",
"ExceptionType": "UserRequiresConfirmationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSecurityChangePhoneNumberRequest": {
"description": "Represents a change phone number request.",
"required": [
"password",
"newPhoneNumber"
],
"properties": {
"password": {
"description": "Gets or sets the password of the user account.",
"type": "string"
},
"newPhoneNumber": {
"description": "Gets or sets the new phone number of the user account.\r\n\r\nMust include the country code associated with the phone number.\r\n\r\n+1 123 234 1234 (US)\r\n+61 123 123 123 (AU)\r\n",
"type": "string"
}
},
"xml": {
"name": "ChangePhoneNumberRequest"
},
"type": "object",
"default": {
"Password": "password",
"NewPhoneNumber": "(123) 456 7890"
}
},
"InvalidPhoneNumberException": {
"description": "InvalidPhoneNumberException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The phone number provided is invalid.",
"ExceptionMessage": "The phone number provided is invalid.",
"ExceptionType": "InvalidPhoneNumberException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"UserDoesNotHavePasswordException": {
"description": "UserDoesNotHavePasswordException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The user account does not have a password set.",
"ExceptionMessage": "The user account does not have a password set.",
"ExceptionType": "UserDoesNotHavePasswordException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSecurityResetPasswordRequest": {
"description": "Represents a reset password request.",
"required": [
"email"
],
"properties": {
"email": {
"description": "Gets or sets the email of the user account to reset the password for.",
"type": "string"
}
},
"xml": {
"name": "ResetPasswordRequest"
},
"type": "object",
"default": {
"Email": "john.smith@trov.com"
}
},
"TrovCommonModelSecurityConfirmPhoneNumberRequest": {
"description": "Represents a confirm phone number request.",
"required": [
"pin"
],
"properties": {
"pin": {
"description": "Gets or sets the pin associated with the phone number confirmation.",
"type": "string"
},
"retryPhoneNumberConfirmationType": {
"description": "Gets or sets the type of confirmation to use when a retry is required.\r\n\r\nDefaults to PhoneNumberConfirmationType.Sms\".\r\n",
"type": "integer",
"format": "int32",
"enum": [
0,
1
],
"x-enumName": "PhoneNumberConfirmationType"
}
},
"xml": {
"name": "ConfirmPhoneNumberRequest"
},
"type": "object",
"default": {
"Pin": "1234",
"RetryPhoneNumberConfirmationType": 1
}
},
"InvalidPinException": {
"description": "InvalidPinException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The PIN provided was invalid.",
"ExceptionMessage": "The PIN provided was invalid.",
"ExceptionType": "InvalidPinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"EmailAlreadyConfirmedException": {
"description": "EmailAlreadyConfirmedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The string has already been confirmed.",
"ExceptionMessage": "The string has already been confirmed.",
"ExceptionType": "EmailAlreadyConfirmedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PhoneNumberAlreadyConfirmedException": {
"description": "PhoneNumberAlreadyConfirmedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The phone number 'string' has already been confirmed.",
"ExceptionMessage": "The phone number 'string' has already been confirmed.",
"ExceptionType": "PhoneNumberAlreadyConfirmedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PhoneNumberNotSetException": {
"description": "PhoneNumberNotSetException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The user account does not contain a phone number.",
"ExceptionMessage": "The user account does not contain a phone number.",
"ExceptionType": "PhoneNumberNotSetException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedAccountStatusAccountStatusSummaryResponse": {
"required": [
"isRefundable",
"refundAmount",
"timestampUtc",
"assetProtectionSummaries"
],
"properties": {
"isRefundable": {
"description": "A flag indicating that an On Demand Refund can be requested for the account.",
"type": "boolean"
},
"refundAmount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse",
"description": "The potential amount available to be refunded."
},
"timestampUtc": {
"description": "The date and time that the account summary was calculated on in UTC.",
"type": "string",
"format": "date-time"
},
"assetProtectionSummaries": {
"description": "A list of assets that have been protected and whether they are currently protected or not.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedAccountStatusAccountStatusAssetProtectionSummary"
},
"xml": {
"name": "AccountStatusAssetProtectionSummary",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "AccountStatusSummaryResponse"
},
"type": "object"
},
"TrovContractAPILegacyCurrencyResponse": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"x-enumName": "LegacyCurrencyType"
},
"value": {
"type": "number",
"format": "double"
}
},
"xml": {
"name": "LegacyCurrencyResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedAccountStatusAccountStatusAssetProtectionSummary": {
"required": [
"assetId",
"assetName",
"isProtected"
],
"properties": {
"assetId": {
"type": "string"
},
"assetName": {
"type": "string"
},
"isProtected": {
"description": "A flag indicating if the asset is currently protected.",
"type": "boolean"
}
},
"xml": {
"name": "AccountStatusAssetProtectionSummary"
},
"type": "object"
},
"TrovContractAPIUnversionedAccountStatusOnDemandRefundResponse": {
"required": [
"refundedAmount"
],
"properties": {
"refundedAmount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse",
"description": "The amount value refunded to the customer's credit card."
}
},
"xml": {
"name": "OnDemandRefundResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedAnalyticsGenerateAnalyticsDataRequest": {
"required": [
"entities",
"dateRange"
],
"properties": {
"entities": {
"items": {
"type": "string",
"enum": [
"Unknown",
"Assets",
"Users",
"Trovs",
"AssetDeletions",
"CustomerRiskKnowledge",
"CustomerRiskFactors",
"SicPriceOffers",
"Customers",
"GuestUserConversions",
"Categories",
"ProductDisclosureSummaries",
"PricingFileExperiments"
],
"x-enumName": "AnalyticsEntityType"
},
"xml": {
"name": "AnalyticsEntityType",
"wrapped": true
},
"type": "array",
"x-enumName": "AnalyticsEntityType"
},
"dateRange": {
"$ref": "#/definitions/TrovContractAPIUnversionedAnalyticsAnalyticsRequestInterval"
}
},
"xml": {
"name": "GenerateAnalyticsDataRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedAnalyticsAnalyticsRequestInterval": {
"required": [
"start",
"end"
],
"properties": {
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "AnalyticsRequestInterval"
},
"type": "object"
},
"TrovContractAPIUnversionedAnalyticsGenerateAnalyticsDataResponse": {
"required": [
"id"
],
"properties": {
"id": {
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "GenerateAnalyticsDataResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedAssetAssetStatusResponse": {
"required": [
"isClaimable",
"totalClaimCount"
],
"properties": {
"isClaimable": {
"type": "boolean"
},
"currentClaimStatus": {
"$ref": "#/definitions/TrovContractAPIUnversionedAssetCurrentClaimStatus"
},
"totalClaimCount": {
"type": "integer",
"format": "int32"
},
"activePriceOffer": {
"$ref": "#/definitions/TrovContractAPIUnversionedAssetAssetStatusPriceOfferResponse"
}
},
"xml": {
"name": "AssetStatusResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedAssetCurrentClaimStatus": {
"required": [
"claimId",
"claimStatus"
],
"properties": {
"claimId": {
"type": "string"
},
"claimStatus": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
}
},
"xml": {
"name": "CurrentClaimStatus"
},
"type": "object"
},
"TrovContractAPIUnversionedAssetAssetStatusPriceOfferResponse": {
"required": [
"id",
"excess",
"officialPremium"
],
"properties": {
"id": {
"type": "string"
},
"excess": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"officialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"unofficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"excessPercentage": {
"type": "number",
"format": "double"
},
"insuredValue": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"pdsSummary": {
"type": "string"
},
"amendatoryEndorsement": {
"type": "string"
},
"protectionStartDate": {
"type": "string",
"format": "date-time"
},
"policyNumber": {
"type": "string"
}
},
"xml": {
"name": "AssetStatusPriceOfferResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuotePremium": {
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"interval": {
"type": "string",
"enum": [
"Unknown",
"Daily",
"Monthly",
"Biannually",
"Annually",
"OneTimePayment"
],
"x-enumName": "PremiumInterval"
}
},
"xml": {
"name": "Premium"
},
"type": "object"
},
"DocumentAccessException": {
"description": "DocumentAccessException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Document does not exist, or user does not have access to the document.",
"ExceptionMessage": "Document does not exist, or user does not have access to the document.",
"ExceptionType": "DocumentAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedAssetGetAssetQueryRequest": {
"properties": {
"includeRevision": {
"description": "Value indicating if the revisions should be included in the response.",
"type": "boolean"
},
"includeFileInfos": {
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"type": "boolean"
}
},
"xml": {
"name": "GetAssetQueryRequest"
},
"type": "object"
},
"TrovCommonModelAssetsAssetResponse": {
"description": "Defines a model that represents an asset response.",
"required": [
"asset",
"lastModified"
],
"properties": {
"asset": {
"$ref": "#/definitions/TrovCommonModelAssetsIAsset",
"description": "Gets or sets the asset being returned."
},
"revisionInfo": {
"$ref": "#/definitions/TrovCommonModelAssetsRevisionInfo",
"description": "Gets or sets the asset revision information."
},
"fileIdListDictionary": {
"description": "Gets or sets a dictionary of the asset's file ids, mapped to their respective schema types.",
"properties": {
"asset": {
"items": {
"type": "string"
},
"type": "array"
},
"audio": {
"items": {
"type": "string"
},
"type": "array"
},
"building": {
"items": {
"type": "string"
},
"type": "array"
},
"collection": {
"items": {
"type": "string"
},
"type": "array"
},
"document": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"items": {
"type": "string"
},
"type": "array"
},
"floor": {
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"items": {
"type": "string"
},
"type": "array"
},
"property": {
"items": {
"type": "string"
},
"type": "array"
},
"room": {
"items": {
"type": "string"
},
"type": "array"
},
"trov": {
"items": {
"type": "string"
},
"type": "array"
},
"userInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"user": {
"items": {
"type": "string"
},
"type": "array"
},
"video": {
"items": {
"type": "string"
},
"type": "array"
},
"sitemap": {
"items": {
"type": "string"
},
"type": "array"
},
"trovInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"index": {
"items": {
"type": "string"
},
"type": "array"
},
"floorPlan": {
"items": {
"type": "string"
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"default": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
}
},
"fileInfos": {
"description": "Gets or sets the list of files associated with the asset.",
"items": {
"$ref": "#/definitions/TrovCommonModelFileIFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"lastModified": {
"description": "Gets or sets the date that the asset was last modified.",
"type": "integer",
"format": "int64"
}
},
"xml": {
"name": "AssetResponse"
},
"type": "object",
"default": {
"Asset": {
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Zillow",
"CategoryId": "ABC",
"CategoryName": "Mansions",
"Level": 2
}
],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
},
"RevisionInfo": {
"PrimaryId": "4d3ed089fb60ab534684b7ff",
"Timestamp": 130982766720000000,
"Reason": "Metadata",
"Revision": 2,
"UserId": "1",
"UsersName": "Pall Mall",
"IsWozRevision": false
},
"FileIdListDictionary": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
},
"FileInfos": [
{
"Id": "507f1f77bcf86cd799439011",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "hud1.docx",
"Description": "HUD1 Statement",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Length": 2359,
"UploadDate": 130982766720000000,
"SchemaType": 7
},
{
"Id": "507f1f77bcf86cd799439012",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "aerialview.jpg",
"Description": "An aerial view of the property.",
"ContentType": "image/jpeg",
"Length": 23599,
"UploadDate": 130982766720000000,
"SchemaType": 7
}
],
"LastModified": 130982766720000000
}
},
"TrovCommonModelAssetsIAsset": {
"description": "Defines an interface for a model that represents an asset.",
"required": [
"isRegion",
"quantity",
"status",
"isQuotable",
"isOwned",
"isPossessed",
"isTrashed",
"isCertified"
],
"properties": {
"thumbnail": {
"description": "Gets or sets the id of the asset thumbnail image.",
"type": "string"
},
"type": {
"description": "Gets or sets the asset type.",
"type": "string"
},
"isRegion": {
"description": "Gets or sets a value indicating whether the asset is a region.",
"type": "boolean"
},
"notes": {
"description": "Gets or sets additional notes about the asset.",
"type": "string"
},
"categoryId": {
"description": "Gets or sets the asset category id.",
"type": "string"
},
"quantity": {
"description": "Gets or sets the quantity.",
"type": "integer",
"format": "int32"
},
"commonAttributes": {
"$ref": "#/definitions/TrovCommonModelAssetsCommonAttributes",
"description": "Gets or sets the asset's common attributes, mostly related to value information."
},
"categoryAttributes": {
"$ref": "#/definitions/TrovCommonModelAssetsCategoryAttributes",
"description": "Gets or sets the asset's category attributes."
},
"externalIdentifiers": {
"description": "Gets or sets the identifiers that map the asset to external systems.",
"items": {
"$ref": "#/definitions/TrovContractCommonExternalIdentifier"
},
"xml": {
"name": "ExternalIdentifier",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"primaryExternalIdentifier": {
"$ref": "#/definitions/TrovContractCommonExternalIdentifier",
"description": "The primary external identifier for the market the asset is associated with."
},
"externalCategories": {
"description": "Gets or sets the categories the asset was assigned by external systems.",
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsExternalCategory"
},
"xml": {
"name": "ExternalCategory",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"flags": {
"description": "Gets or sets a set of user defined flags for the asset.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"status": {
"description": "Gets or sets the asset status (e.g. owned, loaned, donated, etc).",
"type": "string",
"enum": [
"Owned",
"Loaned",
"RentedOut",
"Borrowed",
"Renting",
"Sold",
"Gifted",
"Donated"
],
"x-enumName": "AssetStatus"
},
"isQuotable": {
"description": "Gets a value indicating whether the asset is quotable. A quotable asset is insurable assuming the underwriting and\r\npricing conditions are met for the customer.",
"readOnly": true,
"type": "boolean"
},
"isOwned": {
"description": "Gets a value indicating whether the asset is owned.",
"readOnly": true,
"type": "boolean"
},
"isPossessed": {
"description": "Gets a value indicating whether the asset is possessed.",
"readOnly": true,
"type": "boolean"
},
"isTrashed": {
"description": "Gets or sets a value indicating whether the asset is trashed. Trashed is also referred to as archived.",
"type": "boolean"
},
"isCertified": {
"description": "Gets a value indicating whether the asset is certified.",
"readOnly": true,
"type": "boolean"
},
"clientId": {
"description": "Gets or sets the client id of the item.",
"type": "string"
},
"parentId": {
"description": "Gets or sets the parent id of the item.",
"type": "string"
},
"rootId": {
"description": "Gets or sets the root id of the item.",
"type": "string"
},
"name": {
"description": "Gets or sets the item name.",
"type": "string"
},
"description": {
"description": "Gets or sets the item description.",
"type": "string"
},
"id": {
"description": "Gets or sets the unique id of the type.",
"type": "string"
}
},
"xml": {
"name": "IAsset"
},
"type": "object",
"default": {
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Zillow",
"CategoryId": "ABC",
"CategoryName": "Mansions",
"Level": 2
}
],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
}
},
"TrovCommonModelAssetsRevisionInfo": {
"required": [
"revision"
],
"properties": {
"primaryId": {
"description": "Gets or sets the id of the corresponding item.",
"type": "string"
},
"timestamp": {
"description": "Gets or sets the revision timestamp.",
"type": "integer",
"format": "int64"
},
"reason": {
"description": "Gets or sets the revision reason.",
"type": "string"
},
"revision": {
"description": "Gets or sets the revision number.",
"type": "integer",
"format": "int32"
},
"userId": {
"description": "Gets or sets the id of the user who made the revision.",
"type": "string"
},
"usersName": {
"description": "Gets or sets the name of the user who made the revision.",
"type": "string"
},
"isWozRevision": {
"description": "Gets a value indicating whether the revision was made by a Woz user.",
"readOnly": true,
"type": "boolean"
}
},
"xml": {
"name": "RevisionInfo"
},
"type": "object",
"default": {
"PrimaryId": "4d3ed089fb60ab534684b7ff",
"Timestamp": 130982766720000000,
"Reason": "Metadata",
"Revision": 2,
"UserId": "1",
"UsersName": "Pall Mall",
"IsWozRevision": false
}
},
"TrovCommonModelFileIFileInfo": {
"description": "Defines an interface for a model that represents a file.",
"properties": {
"contentType": {
"description": "Gets or sets the file content type.",
"type": "string"
},
"length": {
"description": "Gets or sets the file length (i.e. the number of bytes in the file).",
"type": "integer",
"format": "int64"
},
"uploadDate": {
"description": "Gets or sets the date the file was uploaded.",
"type": "integer",
"format": "int64"
},
"schemaType": {
"description": "Gets or sets the file schema type.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"x-enumName": "SchemaType"
},
"uri": {
"description": "Gets or sets a {Trov.Common.Model.File.IFileInfo.Uri} associated with a file.",
"type": "string"
},
"clientId": {
"description": "Gets or sets the client id of the item.",
"type": "string"
},
"parentId": {
"description": "Gets or sets the parent id of the item.",
"type": "string"
},
"rootId": {
"description": "Gets or sets the root id of the item.",
"type": "string"
},
"name": {
"description": "Gets or sets the item name.",
"type": "string"
},
"description": {
"description": "Gets or sets the item description.",
"type": "string"
},
"id": {
"description": "Gets or sets the unique id of the type.",
"type": "string"
}
},
"xml": {
"name": "IFileInfo"
},
"type": "object",
"default": {
"Id": "507f1f77bcf86cd799439011",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "hud1.docx",
"Description": "HUD1 Statement",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Length": 2359,
"UploadDate": 130982766720000000,
"SchemaType": 7
}
},
"TrovCommonModelAssetsCommonAttributes": {
"description": "Represents the common attributes of an asset.",
"properties": {
"insurance": {
"$ref": "#/definitions/TrovCommonModelAssetsInsurance",
"description": "Gets or sets the insurance attribute."
},
"purchase": {
"$ref": "#/definitions/TrovCommonModelAssetsPurchase",
"description": "Gets or sets the purchase attribute."
},
"replacementValue": {
"$ref": "#/definitions/TrovCommonModelAssetsValueInformation",
"description": "Gets or sets the replacement value attribute."
},
"fairMarketValue": {
"$ref": "#/definitions/TrovCommonModelAssetsValueInformation",
"description": "Gets or sets the fair market value attribute."
},
"acquisitionInformation": {
"$ref": "#/definitions/TrovCommonModelAssetsAcquisitionInformation",
"description": "Gets or sets the information associated with the acquisition of an asset."
},
"transferInformation": {
"$ref": "#/definitions/TrovCommonModelAssetsTransferInformation",
"description": "Gets or sets the information associated with the transfer of an asset."
}
},
"xml": {
"name": "CommonAttributes"
},
"type": "object",
"default": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
}
},
"TrovCommonModelAssetsCategoryAttributes": {
"properties": {
"wine": {
"$ref": "#/definitions/TrovCommonModelAssetsWine",
"description": "Gets or sets the wine attribute."
},
"product": {
"$ref": "#/definitions/TrovCommonModelAssetsProduct",
"description": "Gets or sets the product attribute."
},
"vehicle": {
"$ref": "#/definitions/TrovCommonModelAssetsVehicle",
"description": "Gets or sets the vehicle attribute."
},
"art": {
"$ref": "#/definitions/TrovCommonModelAssetsArt",
"description": "Gets or sets the art attribute."
},
"property": {
"$ref": "#/definitions/TrovCommonModelAssetsProperty",
"description": "Gets or sets the property attribute."
}
},
"xml": {
"name": "CategoryAttributes"
},
"type": "object",
"default": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
}
},
"TrovContractCommonExternalIdentifier": {
"required": [
"type",
"id"
],
"properties": {
"type": {
"description": "Gets or sets the type of external identifier.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"x-enumName": "ExternalIdentifierType"
},
"id": {
"description": "Gets or sets the identifier.",
"type": "string"
}
},
"xml": {
"name": "ExternalIdentifier"
},
"type": "object",
"default": {
"Type": 4,
"Id": "68890082"
}
},
"TrovCommonModelAssetsExternalCategory": {
"description": "Represents an external category.",
"required": [
"categoryId",
"categoryName"
],
"properties": {
"provider": {
"description": "Gets or sets the provider of the external category.",
"type": "string"
},
"categoryId": {
"description": "Gets or sets the id of the external category.",
"type": "string"
},
"categoryName": {
"description": "Gets or sets the name of the external category.",
"type": "string"
},
"level": {
"description": "Gets or sets the level of the external category within a hierarchy.",
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "ExternalCategory"
},
"type": "object",
"default": {
"Provider": "BeValued",
"CategoryId": "12345",
"CategoryName": "Widgets",
"Level": 1
}
},
"TrovCommonModelFileBlobAttributes": {
"properties": {
"blobType": {
"description": "The type of data in the blob.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"x-enumName": "StorageBlobType"
}
},
"xml": {
"name": "BlobAttributes"
},
"type": "object"
},
"TrovCommonModelAssetsInsurance": {
"description": "Defines a model that represents the insurance attributes of an asset.",
"properties": {
"policyId": {
"description": "Gets or sets the id of the insurance policy under which the asset is covered.",
"type": "string"
},
"policyNumber": {
"description": "Gets or sets the insurance policy number.",
"type": "string"
},
"contact": {
"description": "Gets or sets the contact at the insurance provider.",
"type": "string"
},
"amount": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the insured amount."
}
},
"xml": {
"name": "Insurance"
},
"type": "object",
"default": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
}
},
"TrovCommonModelAssetsPurchase": {
"description": "Defines a model that represents the purchase attributes of an asset.",
"properties": {
"date": {
"description": "Gets or sets the date of purchase.",
"type": "string"
},
"amount": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the purchase amount."
},
"vendor": {
"description": "Gets or sets the vendor that facilitated the purchase.",
"type": "string"
}
},
"xml": {
"name": "Purchase"
},
"type": "object",
"default": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
}
},
"TrovCommonModelAssetsValueInformation": {
"description": "Defines a model that represents value information associated with an asset.",
"properties": {
"date": {
"description": "Gets or sets the date of the valuation.",
"type": "string",
"format": "date-time"
},
"value": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the value of the asset."
},
"highValue": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the high value of the asset when a range exists."
},
"lowValue": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the low value of the asset when a range exists."
},
"valuedBy": {
"description": "Gets or sets the name of the entity that performed the valuation.",
"type": "string"
}
},
"xml": {
"name": "ValueInformation"
},
"type": "object",
"default": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
}
},
"TrovCommonModelAssetsAcquisitionInformation": {
"description": "Defines a model that represents information associated with the acquisition of an asset.",
"properties": {
"acquiredFromName": {
"description": "Gets or sets the name of the person that the asset was acquired from.",
"type": "string"
},
"acquiredFromEmail": {
"description": "Gets or sets the email address of the person the asset was acquired from.",
"type": "string"
},
"timestamp": {
"description": "Gets or sets the timestamp of acquisition.",
"type": "string",
"format": "date-time"
},
"reason": {
"description": "Gets or sets the reason of the acquisition.",
"type": "string"
}
},
"xml": {
"name": "AcquisitionInformation"
},
"type": "object",
"default": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"TrovCommonModelAssetsTransferInformation": {
"description": "Defines an interface for a model that represents information associated with the transfer of an asset.",
"properties": {
"recipientEmail": {
"description": "Gets or sets the email address of the person the asset was transferred to.",
"type": "string"
},
"startDate": {
"description": "Gets or sets the date and time that the transfer was started.",
"type": "string",
"format": "date-time"
},
"completionDate": {
"description": "Gets or sets the date and time that the transfer was completed.",
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "TransferInformation"
},
"type": "object",
"default": {
"RecipientEmail": "joe@blow.com",
"StartDate": "2016-01-26T10:11:12Z",
"CompletionDate": "2016-01-28T10:11:12Z"
}
},
"TrovCommonModelAssetsWine": {
"description": "Defines a model that represents the wine attributes of an asset.",
"properties": {
"type": {
"description": "Gets or sets the wine type.",
"type": "string"
},
"vintage": {
"description": "Gets or sets the wine vintage (i.e. the year the grapes were grown and harvested).",
"type": "string"
},
"manufacturer": {
"description": "Gets or sets the wine manufacturer.",
"type": "string"
},
"varietal": {
"description": "Gets or sets the wine varietal (e.g. Cabernet Sauvignon, Chardonnay, Merlot).",
"type": "string"
},
"designation": {
"description": "Gets or sets the wine designation.",
"type": "string"
},
"vineyard": {
"description": "Gets or sets the vineyard that produced the wine (e.g. Wente Vineyards).",
"type": "string"
},
"region": {
"description": "Gets or sets the region where the wine was produced.",
"type": "string"
},
"subRegion": {
"description": "Gets or sets the subregion where the wine was produced.",
"type": "string"
},
"appellation": {
"description": "Gets or sets the geographically delineated wine region.",
"type": "string"
},
"bottleSize": {
"description": "Gets or sets the wine bottle size.",
"type": "string"
}
},
"xml": {
"name": "Wine"
},
"type": "object",
"default": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
}
},
"TrovCommonModelAssetsProduct": {
"description": "Defines a model that represents the product attributes of an asset.",
"properties": {
"make": {
"description": "Gets or sets the product maker.",
"type": "string"
},
"model": {
"description": "Gets or sets the product model.",
"type": "string"
},
"series": {
"description": "Gets or sets the product series.",
"type": "string"
},
"serialNumber": {
"description": "Gets or sets the product serial number.",
"type": "string"
}
},
"xml": {
"name": "Product"
},
"type": "object",
"default": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
}
},
"TrovCommonModelAssetsVehicle": {
"description": "Defines a model that represents the vehicle attributes of an asset.",
"properties": {
"year": {
"description": "Gets or sets the model year (not necessarily the year it was manufactured).",
"type": "integer",
"format": "int32"
},
"make": {
"description": "Gets or sets the make (name of manufacturer) of the vehicle (e.g. Honda, Infiniti, BMW).",
"type": "string"
},
"model": {
"description": "Gets or sets the modelthe vehicle (e.g. Odyssey, G37, X5).",
"type": "string"
},
"series": {
"description": "Gets or sets the series of the vehicle (e.g. Limited, X, ES), if applicable.",
"type": "string"
},
"style": {
"description": "Gets or sets the style of the vehicle (e.g. 4D Wagon, 2D Coupe, 2D Convertible).",
"type": "string"
},
"vin": {
"description": "Gets or sets the VIN.",
"type": "string"
},
"exterior": {
"description": "Gets or sets a description of the exterior of the vehicle.",
"type": "string"
},
"interior": {
"description": "Gets or sets a description of the interior of the vehicle.",
"type": "string"
},
"engine": {
"description": "Gets or sets engine type of the vehicle (e.g. \"4-Cyl, 2.0 Liter\", \"4-Cyl, Turbo, 1.8 Liter\").",
"type": "string"
},
"transmission": {
"description": "Gets or sets transmission type of the vehicle (e.g. \"Automatic\", \"Automatic w/Tiptronic\", \"Manual, 5-Spd\").",
"type": "string"
},
"driveTrain": {
"description": "Gets or sets the drive train of the vehicle (e.g. FWD).",
"type": "string"
},
"licenceNumber": {
"description": "Gets or sets the licence number.",
"type": "string"
},
"mileage": {
"description": "Gets or sets the mileage.",
"type": "integer",
"format": "int32"
},
"condition": {
"description": "Gets or sets the condition of the vehicle.",
"type": "string",
"enum": [
"Excellent",
"VeryGood",
"Good",
"Fair"
],
"x-enumName": "VehicleCondition"
}
},
"xml": {
"name": "Vehicle"
},
"type": "object",
"default": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
}
},
"TrovCommonModelAssetsArt": {
"description": "Defines a model that represents the art attributes of an asset.",
"properties": {
"artist": {
"description": "Gets or sets the artist of the art piece.",
"type": "string"
},
"title": {
"description": "Gets or sets the title of the art piece.",
"type": "string"
},
"creationDate": {
"description": "Gets or sets the creation date of the art piece.\r\nTODO: should this be a long value",
"type": "string"
},
"medium": {
"description": "Gets or sets the primary medium of the art piece.",
"type": "string"
},
"edition": {
"description": "Gets or sets the edition of the art piece.",
"type": "string"
},
"signature": {
"description": "Gets or sets the signature of the art piece.",
"type": "string"
},
"frame": {
"description": "Gets or sets the frame of the art piece.",
"type": "string"
}
},
"xml": {
"name": "Art"
},
"type": "object",
"default": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
}
},
"TrovCommonModelAssetsProperty": {
"description": "Defines a model that represents the property attributes of a structural asset.",
"properties": {
"address": {
"$ref": "#/definitions/TrovCommonModelAssetsLegacyAddress",
"description": "Gets or sets the property address."
},
"lotSize": {
"description": "Gets or sets the lot size.",
"type": "string"
},
"livingAreaSize": {
"$ref": "#/definitions/TrovCommonModelCoreMeasurement",
"description": "Gets or sets the living area size."
},
"stories": {
"description": "Gets or sets the number of stories.",
"type": "integer",
"format": "int32"
},
"bedrooms": {
"description": "Gets or sets the number of bedrooms.",
"type": "integer",
"format": "int32"
},
"bathrooms": {
"description": "Gets or sets the number of bathrooms.",
"type": "number",
"format": "double"
},
"yearBuilt": {
"description": "Gets or sets the year the property was built.",
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "Property"
},
"type": "object",
"default": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"TrovCommonModelCoreCurrency": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "Gets or sets the currency type.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"x-enumName": "CurrencyType"
},
"value": {
"description": "Gets or sets the currency value.",
"type": "number",
"format": "double"
}
},
"xml": {
"name": "Currency"
},
"type": "object"
},
"TrovCommonModelAssetsLegacyAddress": {
"description": "Defines a model that represents an address.",
"properties": {
"fullAddress": {
"description": "Gets or sets a single string representation of a complete address.",
"type": "string"
},
"street": {
"description": "Gets or sets the street of the address.",
"type": "string"
},
"street2": {
"description": "Gets or sets the secondary street of the address (e.g. \"Apt 56\").",
"type": "string"
},
"city": {
"description": "Gets or sets the city of the address.",
"type": "string"
},
"state": {
"description": "Gets or sets the state of the address.",
"type": "string"
},
"zip": {
"description": "Gets or sets the zip code of the address.",
"type": "string"
},
"country": {
"description": "Gets or sets the country of the address.",
"type": "string"
},
"timezoneId": {
"description": "Gets or sets the IANA timezone id associated with the address.\r\n.",
"type": "string"
},
"isEmpty": {
"description": "Gets a value indicating whether any properties have been changed from the defaults",
"readOnly": true,
"type": "boolean"
}
},
"xml": {
"name": "LegacyAddress"
},
"type": "object",
"default": {
"FullAddress": "2682 Bishop Drive, Suite 101, San Ramon, CA, 94583, USA",
"Street": "2682 Bishop Drive",
"Street2": "Suite 101",
"City": "San Ramon",
"State": "CA",
"Zip": "94583",
"Country": "USA",
"IsEmpty": false,
"Hash": "A03EE61E794D776A92F90F5A27008402"
}
},
"TrovCommonModelCoreMeasurement": {
"description": "Defines a model that represents a numeric measurement.",
"required": [
"unit",
"value"
],
"properties": {
"unit": {
"description": "Gets or sets the unit of measurement.",
"type": "string"
},
"value": {
"description": "Gets or sets the measured value.",
"type": "number",
"format": "double"
}
},
"xml": {
"name": "Measurement"
},
"type": "object"
},
"TrovCommonModelAssetsAssetUpdateRequest": {
"description": "Defines a model that represents an asset update request.",
"required": [
"asset",
"revision"
],
"properties": {
"asset": {
"$ref": "#/definitions/TrovCommonModelAssetsIAsset",
"description": "Gets or sets the asset being updated."
},
"fileIdListDictionary": {
"description": "Gets or sets a dictionary of new asset file ids, mapped to their respective schema types.",
"properties": {
"asset": {
"items": {
"type": "string"
},
"type": "array"
},
"audio": {
"items": {
"type": "string"
},
"type": "array"
},
"building": {
"items": {
"type": "string"
},
"type": "array"
},
"collection": {
"items": {
"type": "string"
},
"type": "array"
},
"document": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"items": {
"type": "string"
},
"type": "array"
},
"floor": {
"items": {
"type": "string"
},
"type": "array"
},
"image": {
"items": {
"type": "string"
},
"type": "array"
},
"property": {
"items": {
"type": "string"
},
"type": "array"
},
"room": {
"items": {
"type": "string"
},
"type": "array"
},
"trov": {
"items": {
"type": "string"
},
"type": "array"
},
"userInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"user": {
"items": {
"type": "string"
},
"type": "array"
},
"video": {
"items": {
"type": "string"
},
"type": "array"
},
"sitemap": {
"items": {
"type": "string"
},
"type": "array"
},
"trovInvite": {
"items": {
"type": "string"
},
"type": "array"
},
"index": {
"items": {
"type": "string"
},
"type": "array"
},
"floorPlan": {
"items": {
"type": "string"
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"default": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
}
},
"revision": {
"description": "Gets or sets the current asset revision number.",
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "AssetUpdateRequest"
},
"type": "object",
"default": {
"Asset": {
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
},
"Product": {
"Make": "Dell",
"Model": "XPS 8700",
"Series": "XPS",
"SerialNumber": "CN-0P7D0G-74261-33N-0KEL"
},
"Vehicle": {
"Year": 2012,
"Make": "Lamborghini",
"Model": "Aventador",
"Style": "LP700-4 Coupe",
"Vin": "19UYA31581L000000",
"Exterior": "Red",
"Interior": "Leather",
"Transmission": "7-speed automatic transmission with overdrive",
"LicenceNumber": "4FASTER",
"Mileage": 0
},
"Art": {
"Artist": "Auguste Rodin",
"Title": "The Thinker",
"CreationDate": "1904",
"Medium": "Bronze",
"Edition": "1",
"Signature": "Auguste Rodin",
"Frame": "N/A"
},
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Zillow",
"CategoryId": "ABC",
"CategoryName": "Mansions",
"Level": 2
}
],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
},
"FileIdListDictionary": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
},
"Revision": 5
}
},
"AssetCurrentlyInsuredException": {
"description": "AssetCurrentlyInsuredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The asset string is currently insured.",
"ExceptionMessage": "The asset string is currently insured.",
"ExceptionType": "AssetCurrentlyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetStaleRevisionException": {
"description": "AssetStaleRevisionException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Cannot update asset string: stale revision=0: storage revision=0",
"ExceptionMessage": "Cannot update asset string: stale revision=0: storage revision=0",
"ExceptionType": "AssetStaleRevisionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetPreviouslyInsuredException": {
"description": "AssetPreviouslyInsuredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The asset string was previously insured.",
"ExceptionMessage": "The asset string was previously insured.",
"ExceptionType": "AssetPreviouslyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedAssetGetModifiedTrovAssetsQueryRequest": {
"properties": {
"includeRevision": {
"description": "Value indicating if the revisions should be included in the response.",
"type": "boolean"
},
"includeFileInfos": {
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"type": "boolean"
},
"isInitialSync": {
"description": "Value indicating if the request is the initial sync for all active assets.",
"type": "boolean"
}
},
"xml": {
"name": "GetModifiedTrovAssetsQueryRequest"
},
"type": "object"
},
"TrovCommonModelAssetsAssetsResponse": {
"description": "Defines a model that represents a collection of asset responses.",
"required": [
"active",
"deleted",
"trashed"
],
"properties": {
"active": {
"description": "Gets or sets the active assets.",
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
},
"xml": {
"name": "AssetResponse",
"wrapped": true
},
"type": "array"
},
"deleted": {
"description": "Gets or sets the deleted assets.",
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
},
"xml": {
"name": "AssetResponse",
"wrapped": true
},
"type": "array"
},
"trashed": {
"description": "Gets or sets the trashed assets.",
"items": {
"$ref": "#/definitions/TrovCommonModelAssetsAssetResponse"
},
"xml": {
"name": "AssetResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "AssetsResponse"
},
"type": "object",
"default": {
"Active": [
{
"Asset": {
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "15",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 167944810.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810.00
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810.00
},
"HighValue": {
"Type": 0,
"Value": 177944810.00
},
"LowValue": {
"Type": 0,
"Value": 157944810.00
},
"ValuedBy": "Zestimate by Zillow"
},
"AcquisitionInformation": {
"AcquiredFromName": "John Smith",
"AcquiredFromEmail": "john.smith@trov.com",
"Timestamp": "2016-01-26T10:11:12Z",
"Reason": "Sold"
}
},
"CategoryAttributes": {
"Property": {
"Address": {
"Street": "1835 73rd Ave NE",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"IsEmpty": false,
"Hash": "16467FAFA748121C6ED97594AF6E5934"
},
"LotSize": "224334 SqFt",
"LivingAreaSize": {
"Unit": "SqFt",
"Value": 50050.0
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8.0,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "Xanadu 2.0",
"Description": "A large mansion in the side of a hill which overlooks Lake Washington in Medina, Washington, United States of America. The 66,000-square-foot (6,100 m2) mansion is noted for its design and the technology it incorporates. It is nicknamed Xanadu 2.0 after the title character's estate in Citizen Kane. It took 7 years to build and cost $63.2 million."
},
"RevisionInfo": {
"PrimaryId": "4d3ed089fb60ab534684b7ff",
"Timestamp": 130982766720000000,
"Reason": "Metadata",
"Revision": 2,
"UserId": "1",
"UsersName": "Pall Mall",
"IsWozRevision": false
},
"FileIdListDictionary": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
},
"LastModified": 130982766720000000
}
],
"Deleted": [
{
"Asset": {
"Thumbnail": "4d3ed089fb60ab534684b7e0",
"IsRegion": true,
"CategoryId": "22",
"Quantity": 1,
"CommonAttributes": {
"Insurance": {
"PolicyId": "4d3ed089fb60ab534684b7f9",
"PolicyNumber": "56206-78-42",
"Contact": "J.R. Smith",
"Amount": {
"Type": 0,
"Value": 12.00
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 12.00
},
"Vendor": "BevMo!"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 12.00
},
"ValuedBy": "Trov Estimate"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 12.00
},
"ValuedBy": "Trov Estimate"
}
},
"CategoryAttributes": {
"Wine": {
"Type": "Morning Fog",
"Vintage": "2012",
"Manufacturer": "Wente Vineyards",
"Varietal": "Chardonnay",
"Vineyard": "Estate Vineyards",
"Region": "United States",
"SubRegion": "California",
"Appellation": "Livermore Valley, San Francisco Bay",
"BottleSize": "750 ML"
}
},
"ExternalIdentifiers": [
{
"Type": 7,
"Id": "7Rq5fHUcroEG6U0cGguGks"
},
{
"Type": 8,
"Id": "6949639101631"
}
],
"ExternalCategories": [],
"Flags": [],
"Status": "Owned",
"IsQuotable": false,
"IsOwned": true,
"IsPossessed": true,
"IsTrashed": false,
"IsCertified": false,
"Id": "4d3ed089fb60ab534684b7ff",
"ParentId": "4d3ed089fb60ab534684b7e9",
"RootId": "4d3ed089fb60ab534684b7e9",
"Name": "2012 Morning Fog Chardonnay",
"Description": "Enjoy aromas and flavors of green apple and tropical fruits, balanced by subtle oak, cinnamon and vanilla from barrel aging. With a mouth-filling body and balanced acidity, this wine delivers a medium-long, refreshing finish."
},
"RevisionInfo": {
"PrimaryId": "4d3ed089fb60ab534684b7ff",
"Timestamp": 130982766720000000,
"Reason": "Metadata",
"Revision": 2,
"UserId": "1",
"UsersName": "Pall Mall",
"IsWozRevision": false
},
"FileIdListDictionary": {
"Document": [
"507f1f77bcf86cd799439011",
"507f191e810c19729de860ea"
],
"Image": [
"507f1f77bcf86cd799439012",
"507f191e810c19729de860eb"
],
"Video": [
"507f1f77bcf86cd799439013",
"507f191e810c19729de860ec"
]
},
"LastModified": 130982766720000000
}
]
}
},
"MissingHeaderException": {
"description": "MissingHeaderException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The following required header(s) were missing from the request: ",
"ExceptionMessage": "The following required header(s) were missing from the request: ",
"ExceptionType": "MissingHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetMimeMultipartMissingPartException": {
"description": "AssetMimeMultipartMissingPartException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The Mime Multipart request does not contain a valid part.",
"ExceptionMessage": "The Mime Multipart request does not contain a valid part.",
"ExceptionType": "AssetMimeMultipartMissingPartException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetMimeMultipartMissingHeaderException": {
"description": "AssetMimeMultipartMissingHeaderException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "One or more sections of the Mime Multipart request is missing the 'string' header.",
"ExceptionMessage": "One or more sections of the Mime Multipart request is missing the 'string' header.",
"ExceptionType": "AssetMimeMultipartMissingHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetMimeMultipartInvalidHeaderException": {
"description": "AssetMimeMultipartInvalidHeaderException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AssetMimeMultipartInvalidHeaderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"AssetNotCreatedException": {
"description": "AssetNotCreatedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AssetNotCreatedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"DocumentExistsException": {
"description": "DocumentExistsException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The key used for the document, already exists.",
"ExceptionMessage": "The key used for the document, already exists.",
"ExceptionType": "DocumentExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"HttpResponseException": {
"description": "HttpResponseException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details.",
"ExceptionMessage": "Processing of the HTTP request resulted in an exception. Please see the HTTP response returned by the 'Response' property of this exception for details.",
"ExceptionType": "HttpResponseException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedAssetGetTrashedAssetsQueryRequest": {
"properties": {
"offset": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
},
"includeRevision": {
"description": "Value indicating if the revisions should be included in the response.",
"type": "boolean"
},
"includeFileInfos": {
"description": "Value indicating if the file info list associated with the asset should be included in the response.",
"type": "boolean"
}
},
"xml": {
"name": "GetTrashedAssetsQueryRequest"
},
"type": "object"
},
"BBEExperienceNotEnabledException": {
"description": "BBEExperienceNotEnabledException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The BBE Experience is not enabled for this trov.",
"ExceptionMessage": "The BBE Experience is not enabled for this trov.",
"ExceptionType": "BBEExperienceNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"CapabilityNotSupportedException": {
"description": "CapabilityNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "CapabilityNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"MicrosoftBotConnectorActivity": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"localTimestamp": {
"type": "string",
"format": "date-time"
},
"serviceUrl": {
"type": "string"
},
"channelId": {
"type": "string"
},
"from": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"conversation": {
"$ref": "#/definitions/MicrosoftBotConnectorConversationAccount"
},
"recipient": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"textFormat": {
"type": "string"
},
"attachmentLayout": {
"type": "string"
},
"membersAdded": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"xml": {
"name": "ChannelAccount",
"wrapped": true
},
"type": "array"
},
"membersRemoved": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"xml": {
"name": "ChannelAccount",
"wrapped": true
},
"type": "array"
},
"reactionsAdded": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorMessageReaction"
},
"xml": {
"name": "MessageReaction",
"wrapped": true
},
"type": "array"
},
"reactionsRemoved": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorMessageReaction"
},
"xml": {
"name": "MessageReaction",
"wrapped": true
},
"type": "array"
},
"topicName": {
"type": "string"
},
"historyDisclosed": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"text": {
"type": "string"
},
"speak": {
"type": "string"
},
"inputHint": {
"type": "string"
},
"summary": {
"type": "string"
},
"suggestedActions": {
"$ref": "#/definitions/MicrosoftBotConnectorSuggestedActions"
},
"attachments": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorAttachment"
},
"xml": {
"name": "Attachment",
"wrapped": true
},
"type": "array"
},
"entities": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorEntity"
},
"xml": {
"name": "Entity",
"wrapped": true
},
"type": "array"
},
"channelData": {
"type": "object"
},
"action": {
"type": "string"
},
"replyToId": {
"type": "string"
},
"value": {
"type": "object"
},
"name": {
"type": "string"
},
"relatesTo": {
"$ref": "#/definitions/MicrosoftBotConnectorConversationReference"
},
"code": {
"type": "string"
}
},
"xml": {
"name": "Activity"
},
"type": "object"
},
"MicrosoftBotConnectorChannelAccount": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "ChannelAccount"
},
"type": "object"
},
"MicrosoftBotConnectorConversationAccount": {
"properties": {
"isGroup": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "ConversationAccount"
},
"type": "object"
},
"MicrosoftBotConnectorMessageReaction": {
"properties": {
"type": {
"type": "string"
}
},
"xml": {
"name": "MessageReaction"
},
"type": "object"
},
"MicrosoftBotConnectorSuggestedActions": {
"properties": {
"to": {
"items": {
"type": "string"
},
"type": "array"
},
"actions": {
"items": {
"$ref": "#/definitions/MicrosoftBotConnectorCardAction"
},
"xml": {
"name": "CardAction",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SuggestedActions"
},
"type": "object"
},
"MicrosoftBotConnectorAttachment": {
"properties": {
"contentType": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"content": {
"type": "object"
},
"name": {
"type": "string"
},
"thumbnailUrl": {
"type": "string"
}
},
"xml": {
"name": "Attachment"
},
"type": "object"
},
"MicrosoftBotConnectorEntity": {
"properties": {
"type": {
"type": "string"
}
},
"xml": {
"name": "Entity"
},
"type": "object"
},
"MicrosoftBotConnectorConversationReference": {
"properties": {
"activityId": {
"type": "string"
},
"user": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"bot": {
"$ref": "#/definitions/MicrosoftBotConnectorChannelAccount"
},
"conversation": {
"$ref": "#/definitions/MicrosoftBotConnectorConversationAccount"
},
"channelId": {
"type": "string"
},
"serviceUrl": {
"type": "string"
}
},
"xml": {
"name": "ConversationReference"
},
"type": "object"
},
"MicrosoftBotConnectorCardAction": {
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"image": {
"type": "string"
},
"text": {
"type": "string"
},
"displayText": {
"type": "string"
},
"value": {
"type": "object"
}
},
"xml": {
"name": "CardAction"
},
"type": "object"
},
"SystemThreadingCancellationToken": {
"properties": {
"isCancellationRequested": {
"readOnly": true,
"type": "boolean"
},
"canBeCanceled": {
"readOnly": true,
"type": "boolean"
},
"waitHandle": {
"$ref": "#/definitions/SystemThreadingWaitHandle",
"readOnly": true
}
},
"xml": {
"name": "CancellationToken"
},
"type": "object"
},
"SystemThreadingWaitHandle": {
"properties": {
"handle": {
"type": "object"
},
"safeWaitHandle": {
"$ref": "#/definitions/MicrosoftWin32SafeHandlesSafeWaitHandle"
}
},
"xml": {
"name": "WaitHandle"
},
"type": "object"
},
"MicrosoftWin32SafeHandlesSafeWaitHandle": {
"properties": {
"isInvalid": {
"readOnly": true,
"type": "boolean"
},
"isClosed": {
"readOnly": true,
"type": "boolean"
}
},
"xml": {
"name": "SafeWaitHandle"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimResponse": {
"required": [
"claim"
],
"properties": {
"claim": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaim"
}
},
"xml": {
"name": "GetClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaim": {
"required": [
"claimId",
"displayId",
"customerId",
"assetIds",
"status",
"creationUtc"
],
"properties": {
"claimId": {
"type": "string"
},
"displayId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"assetIds": {
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
},
"incidentDate": {
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
},
"incidentTime": {
"example": "12:53:00",
"type": "string",
"default": "12:53:00"
},
"incidentLocation": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimLocation"
},
"incidentDateUtc": {
"description": "The incident date in the UTC timezone. This will only have a value if IncidentDate, IncidentTime and\r\nIncidentLocation.TimezoneId are set.",
"type": "string",
"format": "date-time"
},
"incidentType": {
"type": "string",
"enum": [
"Unknown",
"Lost",
"Stolen",
"Damaged"
],
"x-enumName": "ClaimIncidentType"
},
"images": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimPhoto"
},
"xml": {
"name": "ClaimPhoto",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"descriptions": {
"items": {
"type": "string"
},
"type": "array"
},
"phoneNumber": {
"$ref": "#/definitions/TrovContractAPIUnversionedPhoneNumber"
},
"creationUtc": {
"type": "string",
"format": "date-time"
},
"submittedUtc": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "Claim"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimLocation": {
"properties": {
"timezoneId": {
"description": "The IANA timezone id associated with the location.\r\n.",
"type": "string"
},
"point": {
"$ref": "#/definitions/TrovContractAPIUnversionedGeoPoint",
"description": "Gets or sets the associated latitude and longitude of the location."
},
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress"
},
"originalAddress": {
"type": "string"
}
},
"xml": {
"name": "ClaimLocation"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimPhoto": {
"required": [
"imageUri"
],
"properties": {
"imageUri": {
"type": "string"
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "ClaimPhoto"
},
"type": "object"
},
"TrovContractAPIUnversionedPhoneNumber": {
"required": [
"number",
"isConfirmed"
],
"properties": {
"number": {
"type": "string"
},
"isConfirmed": {
"type": "boolean"
}
},
"xml": {
"name": "PhoneNumber"
},
"type": "object"
},
"TrovContractAPIUnversionedGeoPoint": {
"description": "Represents a geographical point.",
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"xml": {
"name": "GeoPoint"
},
"type": "object"
},
"TrovContractAPIUnversionedAddress": {
"properties": {
"street": {
"type": "string"
},
"street2": {
"description": "The secondary street of the address (e.g. \"Apt 56\").",
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"type": "string"
}
},
"xml": {
"name": "Address"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimsForAssetResponse": {
"required": [
"claimSummaries"
],
"properties": {
"claimSummaries": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimSummary"
},
"xml": {
"name": "ClaimSummary",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GetClaimsForAssetResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimSummary": {
"required": [
"claimId",
"claimStatus"
],
"properties": {
"claimId": {
"type": "string"
},
"claimStatus": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
},
"incidentDateUtc": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "ClaimSummary"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimEventsResponse": {
"required": [
"events",
"acceptableResponseTypes"
],
"properties": {
"events": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimEventSummary"
},
"xml": {
"name": "ClaimEventSummary",
"wrapped": true
},
"type": "array"
},
"acceptableResponseTypes": {
"items": {
"type": "string",
"enum": [
"Any",
"CustomerMessage",
"IncidentType",
"IncidentDate",
"IncidentTime",
"IncidentLocation",
"IncidentDescription",
"ClaimPhoto",
"ClaimPhoneNumber",
"Submit"
],
"x-enumName": "AcceptableResponseType"
},
"xml": {
"name": "AcceptableResponseType",
"wrapped": true
},
"type": "array",
"x-enumName": "AcceptableResponseType"
}
},
"xml": {
"name": "GetClaimEventsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimEventSummary": {
"description": "Represents Customer events only.",
"required": [
"isCustomerEvent",
"claimEvent",
"kind"
],
"properties": {
"isCustomerEvent": {
"description": "Whether or not this event represents a customer-generated action.",
"type": "boolean"
},
"claimEvent": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimEventsClaimEvent"
},
"kind": {
"type": "string",
"enum": [
"Unknown",
"Message",
"IncidentType",
"IncidentDate",
"IncidentTime",
"IncidentLocation",
"IncidentDescription",
"ClaimPhoto",
"ClaimPhoneNumber",
"Submit",
"Accept",
"Close",
"Delete",
"Deny",
"Open",
"Payout",
"Settle"
],
"x-enumName": "ClaimEventSummaryKind"
}
},
"xml": {
"name": "ClaimEventSummary"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimEventsClaimEvent": {
"required": [
"creationUtc"
],
"properties": {
"creationUtc": {
"type": "string",
"format": "date-time"
},
"displayText": {
"type": "string"
}
},
"xml": {
"name": "ClaimEvent"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimResponse": {
"required": [
"claim"
],
"properties": {
"claim": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaim"
}
},
"xml": {
"name": "UpdateClaimResponse"
},
"type": "object"
},
"ClaimRulesNotSatisfiedException": {
"description": "ClaimRulesNotSatisfiedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionMessage": "The requested transition cannot be performed because some claim rules remain unsatisfied.The unsatisfied rules are unspecified.",
"ExceptionType": "ClaimRulesNotSatisfiedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"InvalidClaimUpdateException": {
"description": "InvalidClaimUpdateException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionMessage": "The requested update to the claim is not allowed in the claim's current state.",
"ExceptionType": "InvalidClaimUpdateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"UnexpectedClaimActionException": {
"description": "UnexpectedClaimActionException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The requested update was not expected due to the state of the claim.",
"ExceptionMessage": "The requested update was not expected due to the state of the claim.",
"ExceptionType": "UnexpectedClaimActionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimCancelClaimResponse": {
"required": [
"claim"
],
"properties": {
"claim": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaim"
}
},
"xml": {
"name": "CancelClaimResponse"
},
"type": "object"
},
"InvalidClaimStateTransitionException": {
"description": "InvalidClaimStateTransitionException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The requested claim transition does not exist.",
"ExceptionMessage": "The requested claim transition does not exist.",
"ExceptionType": "InvalidClaimStateTransitionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimSubmitClaimResponse": {
"required": [
"claim"
],
"properties": {
"claim": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaim"
}
},
"xml": {
"name": "SubmitClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimAddClaimMessageRequest": {
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
},
"xml": {
"name": "AddClaimMessageRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimAddClaimDescriptionRequest": {
"required": [
"description"
],
"properties": {
"description": {
"type": "string"
}
},
"xml": {
"name": "AddClaimDescriptionRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimBankAccountRequest": {
"properties": {},
"xml": {
"name": "UpdateClaimBankAccountRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimPaymentCardRequest": {
"properties": {
"paymentCardId": {
"description": "Gets or sets the Id of an existing Payment Card already associated with this Customer.",
"type": "string"
},
"paymentCardToken": {
"$ref": "#/definitions/TrovContractAPIUnversionedPaymentCardToken",
"description": "Gets or sets the token of a Payment Card that is not necessarily associated with the Customer."
}
},
"xml": {
"name": "UpdateClaimPaymentCardRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedPaymentCardToken": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
4,
8,
16,
32,
64
],
"x-enumName": "TokenType"
},
"value": {
"type": "string"
}
},
"xml": {
"name": "PaymentCardToken"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimPhoneNumberRequest": {
"properties": {
"phoneNumber": {
"$ref": "#/definitions/TrovContractAPIUnversionedPhoneNumber"
}
},
"xml": {
"name": "UpdateClaimPhoneNumberRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimCreateClaimRequest": {
"required": [
"assetIds"
],
"properties": {
"assetIds": {
"description": "Gets or sets the ids of the assets of the Claim.",
"items": {
"type": "string"
},
"type": "array"
}
},
"xml": {
"name": "CreateClaimRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimCreateClaimResponse": {
"required": [
"claim"
],
"properties": {
"claim": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaim"
}
},
"xml": {
"name": "CreateClaimResponse"
},
"type": "object"
},
"AssetsNotClaimableException": {
"description": "AssetsNotClaimableException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The specified assets are not claimable. This could be because they have already been associated as a non-repair item of an accepted claim.",
"ExceptionMessage": "The specified assets are not claimable. This could be because they have already been associated as a non-repair item of an accepted claim.",
"ExceptionType": "AssetsNotClaimableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ExactlyOneAssetRequiredException": {
"description": "ExactlyOneAssetRequiredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Exactly one asset is required.",
"ExceptionMessage": "Exactly one asset is required.",
"ExceptionType": "ExactlyOneAssetRequiredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimGetClaimsQueryRequest": {
"properties": {
"displayId": {
"description": "The claim display id to filter on. Optional.",
"type": "string"
},
"pageSize": {
"type": "integer",
"format": "int32",
"default": 500,
"maximum": 500,
"minimum": 1
},
"page": {
"type": "integer",
"format": "int32",
"default": 1,
"maximum": 2147483647,
"minimum": 1
}
},
"xml": {
"name": "GetClaimsQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimsResponse": {
"required": [
"page",
"pageSize",
"totalRecords",
"items",
"isLastPage"
],
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"totalRecords": {
"type": "integer",
"format": "int64"
},
"items": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimListItem"
},
"xml": {
"name": "ClaimListItem",
"wrapped": true
},
"type": "array"
},
"isLastPage": {
"description": "True when the next page in sequence would be empty.",
"type": "boolean"
}
},
"xml": {
"name": "GetClaimsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimListItem": {
"required": [
"claimId",
"customerId",
"customerName",
"customerEmail",
"displayId",
"status",
"productType",
"lastUpdatedUtc"
],
"properties": {
"claimId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"customerName": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"displayId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
},
"productType": {
"type": "string",
"enum": [
"Unknown",
"SingleItem",
"AutoComprehensive",
"AutoBreakdownCover",
"AutoThirdParty",
"AutoWindshield",
"AutoTires",
"AutoRoadsideAssistance",
"AutoCarForHire"
],
"x-enumName": "ProductType"
},
"lastUpdatedUtc": {
"type": "string",
"format": "date-time"
},
"assignedId": {
"type": "string"
},
"assignedName": {
"type": "string"
},
"assignedEmail": {
"type": "string"
},
"incidentType": {
"type": "string",
"enum": [
"Unknown",
"Lost",
"Stolen",
"Damaged"
],
"x-enumName": "ClaimIncidentType"
},
"submittedUtc": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "ClaimListItem"
},
"type": "object"
},
"AuthenticationException": {
"description": "AuthenticationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "AuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"MarketAuthenticationException": {
"description": "MarketAuthenticationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "MarketAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimUpdateClaimIncidentDateRequest": {
"required": [
"localDate"
],
"properties": {
"localDate": {
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
}
},
"xml": {
"name": "UpdateClaimIncidentDateRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimIncidentTimeRequest": {
"required": [
"localTime"
],
"properties": {
"localTime": {
"example": "12:53:00",
"type": "string",
"default": "12:53:00"
}
},
"xml": {
"name": "UpdateClaimIncidentTimeRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimIncidentTypeRequest": {
"required": [
"incidentType"
],
"properties": {
"incidentType": {
"type": "string",
"enum": [
"Unknown",
"Lost",
"Stolen",
"Damaged"
],
"x-enumName": "ClaimIncidentType"
}
},
"xml": {
"name": "UpdateClaimIncidentTypeRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateClaimIncidentLocationRequest": {
"required": [
"incidentLocation"
],
"properties": {
"incidentLocation": {
"$ref": "#/definitions/TrovContractAPIUnversionedGeoLocation"
}
},
"xml": {
"name": "UpdateClaimIncidentLocationRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedGeoLocation": {
"description": "Represents a geographical location.",
"properties": {
"point": {
"$ref": "#/definitions/TrovContractAPIUnversionedGeoPoint",
"description": "Gets or sets the associated latitude and longitude of the location."
},
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress"
},
"originalAddress": {
"type": "string"
}
},
"xml": {
"name": "GeoLocation"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimDetailsResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "ClaimDetailsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimDetails": {
"required": [
"customerId",
"displayId",
"creationUtc",
"assets",
"lastUpdatedUtc",
"claimId",
"claimStatus"
],
"properties": {
"customerId": {
"type": "string"
},
"displayId": {
"type": "string"
},
"creationUtc": {
"type": "string",
"format": "date-time"
},
"assets": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimAssetDetails"
},
"xml": {
"name": "ClaimAssetDetails",
"wrapped": true
},
"type": "array"
},
"submittedUtc": {
"type": "string",
"format": "date-time"
},
"incidentType": {
"type": "string",
"enum": [
"Unknown",
"Lost",
"Stolen",
"Damaged"
],
"x-enumName": "ClaimIncidentType"
},
"incidentLocation": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimLocation"
},
"lastUpdatedUtc": {
"type": "string",
"format": "date-time"
},
"claimId": {
"type": "string"
},
"claimStatus": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
},
"incidentDateUtc": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "ClaimDetails"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimAssetDetails": {
"required": [
"assetId",
"assetName"
],
"properties": {
"assetId": {
"type": "string"
},
"assetName": {
"type": "string"
},
"settlementMethod": {
"type": "string",
"enum": [
"Unknown",
"Payout",
"Replacement",
"RepairByFulfillment",
"RepairByCustomer"
],
"x-enumName": "ClaimSettlementMethod"
},
"claimAmount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
}
},
"xml": {
"name": "ClaimAssetDetails"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimEventDetailsResponse": {
"required": [
"events",
"users"
],
"properties": {
"events": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimEventDetails"
},
"xml": {
"name": "ClaimEventDetails",
"wrapped": true
},
"type": "array"
},
"users": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimEventUser"
},
"xml": {
"name": "ClaimEventUser",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GetClaimEventDetailsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimEventDetails": {
"description": "Represents both Customer and Employee events.",
"required": [
"isCustomerEvent",
"userId",
"claimEvent",
"kind"
],
"properties": {
"isCustomerEvent": {
"type": "boolean"
},
"userId": {
"description": "Gets or sets the Id of the user that created this event when it's not a Customer Event.",
"type": "string"
},
"claimEvent": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimEventsClaimEvent"
},
"kind": {
"type": "string",
"enum": [
"Unknown",
"Message",
"IncidentType",
"IncidentDate",
"IncidentTime",
"IncidentLocation",
"IncidentDescription",
"ClaimPhoto",
"ClaimPhoneNumber",
"Submit",
"SettlementMethod",
"Accept",
"Assign",
"Close",
"Delete",
"Deny",
"Open",
"ClaimAmount",
"Settle"
],
"x-enumName": "ClaimEventDetailsKind"
}
},
"xml": {
"name": "ClaimEventDetails"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimClaimEventUser": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "ClaimEventUser"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimGetClaimStatusResponse": {
"required": [
"claimStatus",
"acceptableActions",
"requiredRulesToChangeState"
],
"properties": {
"claimStatus": {
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Closed",
"Accepted",
"Denied",
"Settled",
"Deleted"
],
"x-enumName": "ClaimStatus"
},
"acceptableActions": {
"items": {
"type": "string",
"enum": [
"Unknown",
"SetIncidentType",
"SetIncidentDate",
"SetIncidentTime",
"SetIncidentLocation",
"AddIncidentDescription",
"SetIncidentPhoto",
"SetIncidentPhoneNumber",
"AddMessage",
"AddPhoto",
"AddClaimNote",
"SetFraudFlag",
"SetDeductibleCreditCardId",
"SetEftBankAccountInfo",
"SetClaimAmount",
"SetAssignment",
"SetSettlementMethod",
"ProcessExcessCollection",
"ProcessExcessRefund",
"ProcessEftPayout",
"ConfirmIncidentPhoneNumber"
],
"x-enumName": "ClaimAction"
},
"xml": {
"name": "ClaimAction",
"wrapped": true
},
"type": "array",
"x-enumName": "ClaimAction"
},
"requiredRulesToChangeState": {
"properties": {
"Unknown": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Draft": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Submitted": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Closed": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Accepted": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Denied": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Settled": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"Deleted": {
"items": {
"type": "string",
"enum": [
"Unknown",
"IncidentTypeNotNullOrUnknown",
"IncidentDateNotNull",
"IncidentTimeNotNull",
"IncidentLocationIsValid",
"IncidentDescriptionNotEmpty",
"IncidentPhotosNotEmpty",
"IncidentPhoneNumberNotEmpty",
"IncidentPhoneNumberConfirmed",
"ClaimAmountValid",
"SettlementMethodSet",
"OfacScreeningPassed"
],
"x-enumName": ""
},
"xml": {
"name": "ClaimRule",
"wrapped": true
},
"type": "array",
"x-enumName": ""
}
},
"type": "object"
}
},
"xml": {
"name": "GetClaimStatusResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedProtectionGetProtectionSummaryResponse": {
"required": [
"protectedAssets"
],
"properties": {
"protectedAssets": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedProtectionProtectedAssetSummary"
},
"xml": {
"name": "ProtectedAssetSummary",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GetProtectionSummaryResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedProtectionProtectedAssetSummary": {
"required": [
"assetId",
"assetName",
"assetRevision",
"protectionStartedUtc",
"productDisclosureUri"
],
"properties": {
"assetId": {
"type": "string"
},
"assetName": {
"type": "string"
},
"assetRevision": {
"type": "integer",
"format": "int32"
},
"policyNumber": {
"description": "The policy number that was active at the time of the claim.",
"type": "string"
},
"protectionStartedUtc": {
"description": "The start date of the protection period that was active at the time of the claim.",
"type": "string",
"format": "date-time"
},
"protectionStoppedUtc": {
"description": "The stop date of the protection period that was active at the time of the claim.",
"type": "string",
"format": "date-time"
},
"productDisclosureUri": {
"description": "The Uri of the product disclosure that was active at the time of the claim.",
"type": "string"
},
"amendatoryEndorsementUri": {
"description": "The Uri of the amendatory endorsement that was active at the time of the claim.",
"type": "string"
}
},
"xml": {
"name": "ProtectedAssetSummary"
},
"type": "object"
},
"ClaimCannotCalculateLossDateException": {
"description": "ClaimCannotCalculateLossDateException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionMessage": "Claim requires a valid loss date, time and location with a time zone id.",
"ExceptionType": "ClaimCannotCalculateLossDateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimGetSettlementSummaryResponse": {
"required": [
"settlementSummaries"
],
"properties": {
"settlementSummaries": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimSettlementSummary"
},
"xml": {
"name": "SettlementSummary",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GetSettlementSummaryResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimSettlementSummary": {
"required": [
"assetId",
"assetName",
"assetRevision",
"allowableSettlementMethods",
"wasProtectedOnLossDate"
],
"properties": {
"assetId": {
"type": "string"
},
"assetName": {
"type": "string"
},
"assetRevision": {
"type": "integer",
"format": "int32"
},
"allowableSettlementMethods": {
"items": {
"type": "string",
"enum": [
"Unknown",
"Payout",
"Replacement",
"RepairByFulfillment",
"RepairByCustomer"
],
"x-enumName": "ClaimSettlementMethod"
},
"xml": {
"name": "ClaimSettlementMethod",
"wrapped": true
},
"type": "array",
"x-enumName": "ClaimSettlementMethod"
},
"wasProtectedOnLossDate": {
"type": "boolean"
},
"protectedValue": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"settlementMethod": {
"type": "string",
"enum": [
"Unknown",
"Payout",
"Replacement",
"RepairByFulfillment",
"RepairByCustomer"
],
"x-enumName": "ClaimSettlementMethod"
},
"claimedAmount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"excess": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"premiumRefund": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"payout": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
}
},
"xml": {
"name": "SettlementSummary"
},
"type": "object"
},
"AssetsNotCoveredException": {
"description": "AssetsNotCoveredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The assets are not covered on the specified date.",
"ExceptionMessage": "The assets are not covered on the specified date.",
"ExceptionType": "AssetsNotCoveredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedClaimDenyClaimResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "DenyClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimCloseClaimResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "CloseClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimAcceptClaimResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "AcceptClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimReopenClaimResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "ReopenClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimSettleClaimResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "SettleClaimResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateAssetClaimAmountRequest": {
"required": [
"claimedAmount"
],
"properties": {
"claimedAmount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyRequest"
}
},
"xml": {
"name": "UpdateAssetClaimAmountRequest"
},
"type": "object"
},
"TrovContractAPILegacyCurrencyRequest": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"x-enumName": "LegacyCurrencyType"
},
"value": {
"type": "number",
"format": "double"
}
},
"xml": {
"name": "LegacyCurrencyRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimUpdateAssetClaimAmountResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "UpdateAssetClaimAmountResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimSetSettlementMethodRequest": {
"required": [
"method"
],
"properties": {
"method": {
"description": "Gets or sets the method to settle the item in the claim.",
"type": "string",
"enum": [
"Unknown",
"Payout",
"Replacement",
"RepairByFulfillment",
"RepairByCustomer"
],
"x-enumName": "ClaimSettlementMethod"
}
},
"xml": {
"name": "SetSettlementMethodRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedClaimSetSettlementMethodResponse": {
"required": [
"claimDetails"
],
"properties": {
"claimDetails": {
"$ref": "#/definitions/TrovContractAPIUnversionedClaimClaimDetails"
}
},
"xml": {
"name": "SetSettlementMethodResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClientClientResponse": {
"required": [
"id",
"name",
"type",
"isActive",
"refreshTokenLifeTimeInMinutes",
"allowedOrigins",
"enforceTwoFactorForOAuth"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1
],
"x-enumName": "ClientApplicationType"
},
"isActive": {
"type": "boolean"
},
"refreshTokenLifeTimeInMinutes": {
"type": "integer",
"format": "int32"
},
"allowedOrigins": {
"type": "string"
},
"enforceTwoFactorForOAuth": {
"type": "boolean"
}
},
"xml": {
"name": "ClientResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedClientCreateClientRequest": {
"required": [
"id",
"name",
"clientApplicationType",
"refreshTokenLifeTimeInMinutes"
],
"properties": {
"id": {
"description": "Gets or sets the id of the client.",
"type": "string"
},
"secret": {
"description": "Gets or sets the secret of the client.",
"type": "string"
},
"name": {
"description": "Gets or sets the friendly name of the client.",
"type": "string"
},
"clientApplicationType": {
"type": "integer",
"format": "int32",
"enum": [
0,
1
],
"x-enumName": "ClientApplicationType"
},
"refreshTokenLifeTimeInMinutes": {
"description": "Gets or sets the length the associated refresh tokens are given before expired.",
"type": "integer",
"format": "int32"
},
"allowedOrigins": {
"description": "Gets or sets the origins allowed to utilize the client.",
"type": "string"
}
},
"xml": {
"name": "CreateClientRequest"
},
"type": "object"
},
"TrovCommonModelCoreIDefinitions": {
"description": "Defines an interface for a model that represents the definitions of allowable attributes/properties that can be used in conjunction with other models.",
"required": [
"baseApiUris",
"categoryList",
"supportedCurrencies",
"parentChildStructureMapping",
"capabilities",
"claimPaymentTypes"
],
"properties": {
"baseApiUris": {
"description": "Gets or sets the base {System.Uri}s to be used per market for the API.",
"properties": {
"Unknown": {
"type": "string"
},
"US": {
"type": "string"
},
"AU": {
"type": "string"
},
"GB": {
"type": "string"
}
},
"type": "object"
},
"categoryList": {
"description": "Gets or sets the supported categories.",
"items": {
"$ref": "#/definitions/TrovCommonModelCoreLegacyCategory"
},
"xml": {
"name": "LegacyCategory",
"wrapped": true
},
"type": "array"
},
"supportedCurrencies": {
"description": "Gets or sets the supported currencies.",
"items": {
"$ref": "#/definitions/TrovCommonModelCoreCurrencyTypeDetails"
},
"xml": {
"name": "CurrencyTypeDetails",
"wrapped": true
},
"type": "array"
},
"parentChildStructureMapping": {
"description": "Gets or sets the supported structure definitions.",
"items": {
"$ref": "#/definitions/TrovCommonModelCoreStructureDefinition"
},
"xml": {
"name": "StructureDefinition",
"wrapped": true
},
"type": "array"
},
"capabilities": {
"description": "Gets or sets a set of supported {Trov.Utility.Configuration.CapabilityType}s per market.",
"properties": {
"Unknown": {
"items": {
"type": "integer",
"format": "int32",
"enum": [
0,
100,
101,
200,
201,
202,
203,
204,
205,
206,
300,
400,
401,
402,
410,
411,
412,
420,
421,
500,
501,
600,
666,
667,
668,
669,
700,
9999
],
"x-enumName": ""
},
"xml": {
"name": "CapabilityType",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"US": {
"items": {
"type": "integer",
"format": "int32",
"enum": [
0,
100,
101,
200,
201,
202,
203,
204,
205,
206,
300,
400,
401,
402,
410,
411,
412,
420,
421,
500,
501,
600,
666,
667,
668,
669,
700,
9999
],
"x-enumName": ""
},
"xml": {
"name": "CapabilityType",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"AU": {
"items": {
"type": "integer",
"format": "int32",
"enum": [
0,
100,
101,
200,
201,
202,
203,
204,
205,
206,
300,
400,
401,
402,
410,
411,
412,
420,
421,
500,
501,
600,
666,
667,
668,
669,
700,
9999
],
"x-enumName": ""
},
"xml": {
"name": "CapabilityType",
"wrapped": true
},
"type": "array",
"x-enumName": ""
},
"GB": {
"items": {
"type": "integer",
"format": "int32",
"enum": [
0,
100,
101,
200,
201,
202,
203,
204,
205,
206,
300,
400,
401,
402,
410,
411,
412,
420,
421,
500,
501,
600,
666,
667,
668,
669,
700,
9999
],
"x-enumName": ""
},
"xml": {
"name": "CapabilityType",
"wrapped": true
},
"type": "array",
"x-enumName": ""
}
},
"type": "object"
},
"claimPaymentTypes": {
"description": "Gets or sets the supported claim payment types.",
"items": {
"type": "string",
"enum": [
"Unknown",
"CreditCard"
],
"x-enumName": "ClaimPaymentRequestType"
},
"xml": {
"name": "ClaimPaymentRequestType",
"wrapped": true
},
"type": "array",
"uniqueItems": true,
"x-enumName": "ClaimPaymentRequestType"
}
},
"xml": {
"name": "IDefinitions"
},
"type": "object",
"default": {
"BaseApiUris": {
"AU": "https://api-au.trov.com/Trov.Service/",
"US": "https://api-us.trov.com/Trov.Service/"
},
"CategoryList": [
{
"Id": "1",
"Name": "Animals",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "2",
"Name": "Art",
"CategorySpecificAttributes": [
"Art"
],
"IsRegion": false
},
{
"Id": "3",
"Name": "Fashion",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "4",
"Name": "Collectibles",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "5",
"Name": "Decor",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "6",
"Name": "Electronics",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "7",
"Name": "Entertainment",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "8",
"Name": "Furniture",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "9",
"Name": "Hardware & Equipment",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "10",
"Name": "Houseware & Appliances",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "11",
"Name": "Musical Instruments",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "12",
"Name": "Jewelry",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "15",
"Name": "Real Estate",
"CategorySpecificAttributes": [
"Property"
],
"IsRegion": true
},
{
"Id": "17",
"Name": "Lighting",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "19",
"Name": "Sporting Goods",
"CategorySpecificAttributes": [
"Product"
],
"IsRegion": false
},
{
"Id": "20",
"Name": "Memorabilia",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "21",
"Name": "Vehicles",
"CategorySpecificAttributes": [
"Vehicle"
],
"IsRegion": false
},
{
"Id": "22",
"Name": "Wine & Spirits",
"CategorySpecificAttributes": [
"Wine"
],
"IsRegion": false
},
{
"Id": "23",
"Name": "Building",
"CategorySpecificAttributes": [
"Building"
],
"IsRegion": true
},
{
"Id": "24",
"Name": "Floor",
"CategorySpecificAttributes": [
"Floor"
],
"IsRegion": true
},
{
"Id": "25",
"Name": "Room",
"CategorySpecificAttributes": [],
"IsRegion": true
},
{
"Id": "26",
"Name": "Area",
"CategorySpecificAttributes": [
"Area"
],
"IsRegion": true
},
{
"Id": "27",
"Name": "Books",
"CategorySpecificAttributes": [],
"IsRegion": false
},
{
"Id": "28",
"Name": "Militaria",
"CategorySpecificAttributes": [],
"IsRegion": false
}
],
"SupportedCurrencies": [
{
"CurrencyType": 0,
"CurrencySymbol": "$",
"CurrencyAcronym": "USD",
"CurrencyDescription": "U.S Dollars",
"ExchangeRateUsd": 1.0,
"InverseExchangeRateUsd": 1.0
},
{
"CurrencyType": 1,
"CurrencySymbol": "$",
"CurrencyAcronym": "CAD",
"CurrencyDescription": "Canadian Dollars",
"ExchangeRateUsd": 0.827157738095,
"InverseExchangeRateUsd": 1.2089592516
},
{
"CurrencyType": 2,
"CurrencySymbol": "£",
"CurrencyAcronym": "GBP",
"CurrencyDescription": "British Pounds",
"ExchangeRateUsd": 1.5125170068,
"InverseExchangeRateUsd": 0.661149590717
},
{
"CurrencyType": 3,
"CurrencySymbol": "$",
"CurrencyAcronym": "AUD",
"CurrencyDescription": "Australian Dollars",
"ExchangeRateUsd": 0.78737870954,
"InverseExchangeRateUsd": 1.27003688045
},
{
"CurrencyType": 4,
"CurrencySymbol": "€",
"CurrencyAcronym": "EUR",
"CurrencyDescription": "Euros",
"ExchangeRateUsd": 1.1117,
"InverseExchangeRateUsd": 0.899523252676
},
{
"CurrencyType": 5,
"CurrencySymbol": "",
"CurrencyAcronym": "CHF",
"CurrencyDescription": "Swiss Francs",
"ExchangeRateUsd": 1.07141480339,
"InverseExchangeRateUsd": 0.933345326977
},
{
"CurrencyType": 6,
"CurrencySymbol": "$",
"CurrencyAcronym": "NZD",
"CurrencyDescription": "New Zealand Dollars",
"ExchangeRateUsd": 0.750033733639,
"InverseExchangeRateUsd": 1.33327336512
},
{
"CurrencyType": 7,
"CurrencySymbol": "kr",
"CurrencyAcronym": "NOK",
"CurrencyDescription": "Norwegian Kroners",
"ExchangeRateUsd": 0.131601065404,
"InverseExchangeRateUsd": 7.59872267698
},
{
"CurrencyType": 8,
"CurrencySymbol": "kr",
"CurrencyAcronym": "SEK",
"CurrencyDescription": "Swedish Kronor",
"ExchangeRateUsd": 0.119173706102,
"InverseExchangeRateUsd": 8.39111271026
}
],
"ParentChildStructureMapping": [
{
"ParentId": "15",
"ChildId": "23"
},
{
"ParentId": "15",
"ChildId": "26"
},
{
"ParentId": "23",
"ChildId": "24"
},
{
"ParentId": "24",
"ChildId": "25"
}
],
"Capabilities": {
"AU": [
500,
100,
101,
201,
204,
667
]
},
"ClaimPaymentTypes": [
"CreditCard"
]
}
},
"TrovCommonModelCoreLegacyCategory": {
"description": "Defines a model that represents a category.",
"required": [
"name"
],
"properties": {
"id": {
"description": "Gets or sets the category id.",
"type": "string"
},
"name": {
"description": "Gets or sets the category name.",
"type": "string"
},
"categorySpecificAttributes": {
"description": "Gets or sets the category specific attributes.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"isRegion": {
"description": "Gets or sets a value indicating whether the category is a region.",
"type": "boolean"
}
},
"xml": {
"name": "LegacyCategory"
},
"type": "object"
},
"TrovCommonModelCoreCurrencyTypeDetails": {
"description": "Represents currency type details.",
"required": [
"currencyType",
"currencySymbol",
"currencyAcronym"
],
"properties": {
"currencyType": {
"description": "Gets or sets the currency type.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"x-enumName": "CurrencyType"
},
"currencySymbol": {
"description": "Gets or sets the currency symbol.",
"type": "string"
},
"currencyAcronym": {
"description": "Gets or sets the currency acronym.",
"type": "string"
},
"currencyDescription": {
"description": "Gets or sets the currency description.",
"type": "string"
},
"exchangeRateUsd": {
"description": "Gets or sets the exchange rate to USD.",
"type": "number",
"format": "double"
},
"inverseExchangeRateUsd": {
"description": "Gets or sets the inverse exchange rate from USD.",
"type": "number",
"format": "double"
}
},
"xml": {
"name": "CurrencyTypeDetails"
},
"type": "object"
},
"TrovCommonModelCoreStructureDefinition": {
"description": "Defines a model that represents a parent/child structure definition.",
"properties": {
"parentId": {
"description": "Gets or sets the parent id of the structure definition.",
"type": "string"
},
"childId": {
"description": "Gets or sets the child id of the structure definition.",
"type": "string"
}
},
"xml": {
"name": "StructureDefinition"
},
"type": "object"
},
"TrovCommonModelConfigurationPublishableKeysResponse": {
"required": [
"publishableKeys"
],
"properties": {
"publishableKeys": {
"items": {
"$ref": "#/definitions/TrovCommonModelConfigurationPublishableKey"
},
"xml": {
"name": "PublishableKey",
"wrapped": true
},
"type": "array",
"uniqueItems": true
}
},
"xml": {
"name": "PublishableKeysResponse"
},
"type": "object",
"default": {
"PublishableKeys": [
{
"Provider": "Pin",
"Key": "key"
}
]
}
},
"TrovCommonModelConfigurationPublishableKey": {
"required": [
"provider",
"key"
],
"properties": {
"provider": {
"type": "string",
"enum": [
"Pin",
"Stripe"
],
"x-enumName": "PublishableKeyProvider"
},
"key": {
"type": "string"
}
},
"xml": {
"name": "PublishableKey"
},
"type": "object",
"default": {
"Provider": "Pin",
"Key": "key"
}
},
"TrovContractAPIUnversionedFileFileInfoResponse": {
"properties": {
"clientId": {
"type": "string"
},
"parentId": {
"type": "string"
},
"rootId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"contentType": {
"type": "string"
},
"length": {
"description": "The number of bytes in the file.",
"type": "integer",
"format": "int64"
},
"uploadDate": {
"type": "integer",
"format": "int64"
},
"schemaType": {
"type": "integer",
"format": "int32",
"enum": [
1,
2
],
"x-enumName": "SchemaType"
},
"uri": {
"type": "string"
},
"pertainsTo": {
"description": "Indicates what part of the user's workflow the file pertains to.\r\nPossible values include \"Asset\", \"Claim\", \"Photo-to-Protect\".",
"type": "string"
}
},
"xml": {
"name": "FileInfoResponse"
},
"type": "object"
},
"TrovCommonModelSicCustomerCustomerNote": {
"description": "A customer note.",
"properties": {
"text": {
"description": "Gets or sets the text.",
"type": "string"
},
"customerId": {
"description": "Gets or sets the customer identifier.",
"type": "string"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "CustomerNote"
},
"type": "object",
"default": {
"Text": "Bob's law blog: http://arresteddevelopment.wikia.com/wiki/Bob_Loblaw",
"CustomerId": "customerId",
"Id": "customerNoteId",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
},
"TrovCommonModelSicCustomerCreateCustomerNoteRequest": {
"description": "Represents a customer note creation request.",
"required": [
"text"
],
"properties": {
"text": {
"description": "Gets or sets the text of the note.",
"type": "string"
}
},
"xml": {
"name": "CreateCustomerNoteRequest"
},
"type": "object",
"default": {
"Text": "Woo!"
}
},
"TrovContractAPIUnversionedCustomerCustomerResponse": {
"properties": {
"id": {
"type": "string"
},
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress",
"description": "Gets or sets the address of the customer."
},
"backgroundPhotoS3Key": {
"description": "Gets or sets the key of the background photo S3 object.",
"type": "string"
},
"birthDate": {
"description": "Gets or sets the birth date of the customer.",
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
},
"employmentStatus": {
"description": "Gets or sets the customer's employment status.",
"type": "string",
"enum": [
"UniversityStudent",
"CollegeStudent",
"Unemployed",
"Employed",
"SelfEmployed",
"Houseperson",
"Retired",
"Other",
"Unknown"
],
"x-enumName": "EmploymentStatus"
},
"gender": {
"description": "Gets or sets the customer's gender.",
"type": "string",
"enum": [
"F",
"M"
],
"x-enumName": "Gender"
},
"name": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerNameResponse",
"description": "Gets or sets the name of the customer."
},
"nationality": {
"description": "Gets or sets the nationality of the customer.",
"type": "string"
},
"profilePhotoS3Key": {
"description": "Gets or sets the key of the profile photo S3 object.",
"type": "string"
},
"tokens": {
"description": "Gets or sets the customer's tokens.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerTokenResponse"
},
"xml": {
"name": "TokenResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"sicCustomerSince": {
"description": "Gets or sets the date the customer first purchased SIC insurance.",
"type": "string",
"format": "date-time"
},
"secondaryEmails": {
"description": "Gets or sets the user's secondary email addresses.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerEmailAddressResponse"
},
"xml": {
"name": "EmailAddressResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"isBlocked": {
"description": "Indicates whether the customer has been blocked from using insurance features\r\n(e.g. requesting quotes, starting insurance, etc.).",
"type": "boolean"
},
"isSubscribed": {
"description": "Gets or sets a value indicating whether the customer is subscribed to marketing communications.\r\n\r\nDefaults to true.\r\n",
"type": "boolean"
},
"defaultPaymentCardFingerprint": {
"description": "Gets or sets the fingerprint value for the customer's default payment card.",
"type": "string"
},
"defaultPaymentCardLast4": {
"description": "Gets or sets the last four digits of the customer's default payment card.",
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"createdByEmail": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string"
},
"modifiedByEmail": {
"type": "string"
},
"deleted": {
"type": "string",
"format": "date-time"
},
"deletedBy": {
"type": "string"
},
"deletedByEmail": {
"type": "string"
},
"isDeleted": {
"readOnly": true,
"type": "boolean"
},
"email": {
"type": "string"
},
"currentOfacStatus": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerOfacScreeningResponse"
}
},
"xml": {
"name": "CustomerResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedCustomerNameResponse": {
"properties": {
"first": {
"description": "Gets or sets the first name of the person.",
"type": "string"
},
"middle": {
"description": "Gets or sets the middle name of the person.",
"type": "string"
},
"last": {
"description": "Gets or sets the last name of the person.",
"type": "string"
}
},
"xml": {
"name": "NameResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedCustomerTokenResponse": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
4,
8,
16,
32,
64
],
"x-enumName": "TokenType"
},
"value": {
"type": "string"
}
},
"xml": {
"name": "TokenResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedCustomerEmailAddressResponse": {
"required": [
"email"
],
"properties": {
"email": {
"description": "Gets or sets the email address.",
"type": "string"
},
"isConfirmed": {
"description": "Gets a value indicating whether the email address has been confirmed as being owned by the associated user.",
"type": "boolean"
}
},
"xml": {
"name": "EmailAddressResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedCustomerOfacScreeningResponse": {
"properties": {
"status": {
"type": "string",
"enum": [
"Unknown",
"Passed",
"Failed"
],
"x-enumName": "OfacScreenStatus"
},
"transactionId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"matchedListName": {
"type": "string"
},
"matchedListScore": {
"type": "integer",
"format": "int32"
},
"matchedListDateOfBirth": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "OfacScreeningResponse"
},
"type": "object"
},
"CustomerAccessException": {
"description": "CustomerAccessException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionMessage": "Customer cannot be accessed because they have never purchased protection or the id does not exist.",
"ExceptionType": "CustomerAccessException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSicCustomerCustomerUpdateRequest": {
"description": "Represents a request for a {Trov.Common.Model.Sic.Customer.ICustomer} update.",
"required": [
"isBlocked"
],
"properties": {
"isBlocked": {
"description": "Gets or sets a value indicating whether the {Trov.Common.Model.Sic.Customer.ICustomer} has been blocked from using insurance features\r\n(e.g. requesting quotes, starting insurance, etc.).",
"type": "boolean"
}
},
"xml": {
"name": "CustomerUpdateRequest"
},
"type": "object",
"default": {
"IsBlocked": false
}
},
"TrovContractAPIUnversionedCustomerCustomerAuditResponse": {
"required": [
"auditId",
"timestamp",
"userId",
"userEmail",
"action"
],
"properties": {
"auditId": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"description": "The timestamp of the event.",
"type": "string",
"format": "date-time"
},
"userId": {
"description": "The user identifier for the event.",
"type": "string"
},
"userEmail": {
"description": "The user email for the event.",
"type": "string"
},
"action": {
"description": "The type of action being logged.",
"type": "string"
},
"id": {
"type": "string"
},
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress",
"description": "Gets or sets the address of the customer."
},
"backgroundPhotoS3Key": {
"description": "Gets or sets the key of the background photo S3 object.",
"type": "string"
},
"birthDate": {
"description": "Gets or sets the birth date of the customer.",
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
},
"employmentStatus": {
"description": "Gets or sets the customer's employment status.",
"type": "string",
"enum": [
"UniversityStudent",
"CollegeStudent",
"Unemployed",
"Employed",
"SelfEmployed",
"Houseperson",
"Retired",
"Other",
"Unknown"
],
"x-enumName": "EmploymentStatus"
},
"gender": {
"description": "Gets or sets the customer's gender.",
"type": "string",
"enum": [
"F",
"M"
],
"x-enumName": "Gender"
},
"name": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerNameResponse",
"description": "Gets or sets the name of the customer."
},
"nationality": {
"description": "Gets or sets the nationality of the customer.",
"type": "string"
},
"profilePhotoS3Key": {
"description": "Gets or sets the key of the profile photo S3 object.",
"type": "string"
},
"tokens": {
"description": "Gets or sets the customer's tokens.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerTokenResponse"
},
"xml": {
"name": "TokenResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"sicCustomerSince": {
"description": "Gets or sets the date the customer first purchased SIC insurance.",
"type": "string",
"format": "date-time"
},
"secondaryEmails": {
"description": "Gets or sets the user's secondary email addresses.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerEmailAddressResponse"
},
"xml": {
"name": "EmailAddressResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"isBlocked": {
"description": "Indicates whether the customer has been blocked from using insurance features\r\n(e.g. requesting quotes, starting insurance, etc.).",
"type": "boolean"
},
"isSubscribed": {
"description": "Gets or sets a value indicating whether the customer is subscribed to marketing communications.\r\n\r\nDefaults to true.\r\n",
"type": "boolean"
},
"defaultPaymentCardFingerprint": {
"description": "Gets or sets the fingerprint value for the customer's default payment card.",
"type": "string"
},
"defaultPaymentCardLast4": {
"description": "Gets or sets the last four digits of the customer's default payment card.",
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"createdByEmail": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"modifiedBy": {
"type": "string"
},
"modifiedByEmail": {
"type": "string"
},
"deleted": {
"type": "string",
"format": "date-time"
},
"deletedBy": {
"type": "string"
},
"deletedByEmail": {
"type": "string"
},
"isDeleted": {
"readOnly": true,
"type": "boolean"
},
"email": {
"type": "string"
},
"currentOfacStatus": {
"$ref": "#/definitions/TrovContractAPIUnversionedCustomerOfacScreeningResponse"
}
},
"xml": {
"name": "CustomerAuditResponse"
},
"type": "object"
},
"TrovCommonModelSicCustomerCustomerFraudSignals": {
"description": "Represents customer fraud information that an employee should be aware of",
"required": [
"totalOfPremiumsPaid",
"numberOfClaimsPaid",
"numberOfClaimsDenied",
"numberOfFailedPayments",
"numberOfPaymentCardChanges",
"customerIsPastDue",
"creditCardFraudInfo",
"blockedCreditCards",
"customersWithSameAddress",
"customersWithSamePhone",
"claimsWithSameLossLocation",
"claimsWithSamePhoneNumber",
"customersWithSameDeviceFingerprint",
"deviceFingerprints",
"numberOfUninsuredCustomersWithAMatchingDeviceFingerprint",
"numberOfClaimsWithSameLossLocation",
"numberOfClaimsWithSamePhoneNumber",
"numberOfAccountsWithSameAddress",
"numberOfAccountsWithSamePhoneNumber"
],
"properties": {
"totalOfPremiumsPaid": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the total premiums paid to the customer"
},
"numberOfClaimsPaid": {
"description": "Gets or sets the number of claims paid out to the customer",
"type": "integer",
"format": "int32"
},
"numberOfClaimsDenied": {
"description": "Gets or sets the number of claims denied to the customer",
"type": "integer",
"format": "int32"
},
"numberOfFailedPayments": {
"description": "Gets or sets the number of failed payments by the customer",
"type": "integer",
"format": "int32"
},
"numberOfPaymentCardChanges": {
"description": "Gets or sets the number of payment card changes by the customer",
"type": "integer",
"format": "int32"
},
"customerIsPastDue": {
"description": "Gets or sets a value indicating whether the customer is past due in payment",
"type": "boolean"
},
"creditCardFraudInfo": {
"description": "Gets or sets the list of credit card fraud information",
"items": {
"$ref": "#/definitions/TrovCommonModelSicBillCreditCardFraudInfo"
},
"xml": {
"name": "CreditCardFraudInfo",
"wrapped": true
},
"type": "array"
},
"blockedCreditCards": {
"description": "Gets or sets the list of blocked credit cards",
"items": {
"$ref": "#/definitions/TrovCommonModelSicBillCreditCardFraudInfo"
},
"xml": {
"name": "CreditCardFraudInfo",
"wrapped": true
},
"type": "array"
},
"customersWithSameAddress": {
"description": "Gets or sets the list of customers with the same address",
"items": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerSummary"
},
"xml": {
"name": "CustomerSummary",
"wrapped": true
},
"type": "array"
},
"customersWithSamePhone": {
"description": "Gets or sets the list of customers with the same phone",
"items": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerSummary"
},
"xml": {
"name": "CustomerSummary",
"wrapped": true
},
"type": "array"
},
"claimsWithSameLossLocation": {
"description": "Gets or sets the list of claims with the same loss location",
"items": {
"$ref": "#/definitions/TrovCommonModelSicClaimLegacyClaimSummary"
},
"xml": {
"name": "LegacyClaimSummary",
"wrapped": true
},
"type": "array",
"default": [
{
"ClaimId": "claimId1",
"ClaimStatus": "Accepted",
"LossDate": {
"year": 2018,
"month": 6,
"day": 14,
"calendar": 0
}
},
{
"ClaimId": "claimId1",
"ClaimStatus": "Submitted"
}
]
},
"claimsWithSamePhoneNumber": {
"description": "Gets or sets the list of claims with the same phone",
"items": {
"$ref": "#/definitions/TrovCommonModelSicClaimLegacyClaimSummary"
},
"xml": {
"name": "LegacyClaimSummary",
"wrapped": true
},
"type": "array",
"default": [
{
"ClaimId": "claimId1",
"ClaimStatus": "Accepted",
"LossDate": {
"year": 2018,
"month": 6,
"day": 14,
"calendar": 0
}
},
{
"ClaimId": "claimId1",
"ClaimStatus": "Submitted"
}
]
},
"customersWithSameDeviceFingerprint": {
"description": "Gets or sets the list of insured customers with a matching device fingerprint",
"items": {
"$ref": "#/definitions/TrovCommonModelSicCustomerCustomerDeviceFingerprint"
},
"xml": {
"name": "CustomerDeviceFingerprint",
"wrapped": true
},
"type": "array"
},
"deviceFingerprints": {
"description": "Gets or sets the device fingerprints associated with the customer.",
"items": {
"type": "string"
},
"type": "array"
},
"numberOfUninsuredCustomersWithAMatchingDeviceFingerprint": {
"description": "Gets or sets the number of other customers, who have never had insurance, that have a matching device fingerprint.",
"type": "integer",
"format": "int32"
},
"numberOfClaimsWithSameLossLocation": {
"description": "Gets the number of claims with the same loss location",
"readOnly": true,
"type": "integer",
"format": "int32"
},
"numberOfClaimsWithSamePhoneNumber": {
"description": "Gets the number of claims with the same phone number",
"readOnly": true,
"type": "integer",
"format": "int32"
},
"numberOfAccountsWithSameAddress": {
"description": "Gets the number of accounts with the same address",
"readOnly": true,
"type": "integer",
"format": "int32"
},
"numberOfAccountsWithSamePhoneNumber": {
"description": "Gets the number of accounts with the same phone number",
"readOnly": true,
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "CustomerFraudSignals"
},
"type": "object",
"default": {
"TotalOfPremiumsPaid": {
"Type": 0,
"Value": 5.45
},
"NumberOfClaimsPaid": 1,
"NumberOfClaimsDenied": 0,
"NumberOfFailedPayments": 3,
"NumberOfPaymentCardChanges": 1,
"CustomerIsPastDue": false,
"CreditCardFraudInfo": [],
"BlockedCreditCards": [],
"CustomersWithSameAddress": [],
"CustomersWithSamePhone": [],
"ClaimsWithSameLossLocation": [],
"ClaimsWithSamePhoneNumber": [],
"NumberOfUninsuredCustomersWithAMatchingDeviceFingerprint": 0,
"NumberOfClaimsWithSameLossLocation": 0,
"NumberOfClaimsWithSamePhoneNumber": 0,
"NumberOfAccountsWithSameAddress": 0,
"NumberOfAccountsWithSamePhoneNumber": 0
}
},
"TrovCommonModelSicBillCreditCardFraudInfo": {
"description": "Designates the use of a payment card by a specified customer.",
"required": [
"paymentCardExpirationMonth",
"paymentCardExpirationYear",
"paymentCardLast4",
"customerId",
"email"
],
"properties": {
"paymentCardExpirationMonth": {
"description": "Gets or sets the expiration month.",
"type": "integer",
"format": "int32"
},
"paymentCardExpirationYear": {
"description": "Gets or sets the expiration year.",
"type": "integer",
"format": "int32"
},
"paymentCardLast4": {
"description": "Gets or sets the last 4 digits of the credit card number.",
"type": "string"
},
"customerId": {
"description": "Gets or sets the customer id",
"type": "string"
},
"email": {
"description": "Gets or sets the customer email",
"type": "string"
},
"phoneNumber": {
"description": "Gets or sets the customer phone number",
"type": "string"
},
"name": {
"$ref": "#/definitions/TrovCommonModelCoreIName",
"description": "Gets or sets the customer name"
},
"address": {
"$ref": "#/definitions/TrovCommonModelCoreNormalizedAddress",
"description": "Gets or sets the customer address"
},
"deviceFingerprint": {
"description": "Gets or sets the customer device fingerprint",
"type": "string"
}
},
"xml": {
"name": "CreditCardFraudInfo"
},
"type": "object"
},
"TrovCommonModelSicCustomerCustomerSummary": {
"description": "Represents a summary information of a customer",
"required": [
"customerId",
"email"
],
"properties": {
"customerId": {
"description": "Gets or sets the customer id",
"type": "string"
},
"email": {
"description": "Gets or sets the customer email",
"type": "string"
},
"phoneNumber": {
"description": "Gets or sets the customer phone number",
"type": "string"
},
"name": {
"$ref": "#/definitions/TrovCommonModelCoreIName",
"description": "Gets or sets the customer name"
},
"address": {
"$ref": "#/definitions/TrovCommonModelCoreNormalizedAddress",
"description": "Gets or sets the customer address"
},
"deviceFingerprint": {
"description": "Gets or sets the customer device fingerprint",
"type": "string"
}
},
"xml": {
"name": "CustomerSummary"
},
"type": "object"
},
"TrovCommonModelSicClaimLegacyClaimSummary": {
"description": "Represents a summary of a {Trov.Common.Model.Sic.Claim.Claim}.",
"required": [
"claimStatus"
],
"properties": {
"claimId": {
"description": "Gets or sets the parent claim id.",
"type": "string"
},
"claimStatus": {
"description": "Gets or sets the status for the {Trov.Common.Model.Sic.Claim.Claim}.",
"type": "string",
"enum": [
"Unknown",
"Draft",
"Submitted",
"Cancelled",
"Accepted",
"Denied",
"Settled"
],
"x-enumName": "ClaimStatus"
},
"lossDate": {
"description": "Gets or sets the date of loss for the {Trov.Common.Model.Sic.Claim.Claim}.",
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
}
},
"xml": {
"name": "LegacyClaimSummary"
},
"type": "object",
"default": {
"ClaimId": "claimId1",
"ClaimStatus": "Accepted",
"LossDate": {
"year": 2018,
"month": 6,
"day": 14,
"calendar": 0
}
}
},
"TrovCommonModelSicCustomerCustomerDeviceFingerprint": {
"description": "Represents information on a customer and associated Device Fingerprint.",
"required": [
"customerId",
"email",
"deviceFingerprint"
],
"properties": {
"customerId": {
"description": "Gets or sets the customer id.",
"type": "string"
},
"email": {
"description": "Gets or sets the customer email.",
"type": "string"
},
"name": {
"$ref": "#/definitions/TrovCommonModelCoreIName",
"description": "Gets or sets the customer name."
},
"deviceFingerprint": {
"description": "Gets or sets the customer device fingerprint.",
"type": "string"
}
},
"xml": {
"name": "CustomerDeviceFingerprint"
},
"type": "object",
"default": {
"CustomerId": "123456",
"Email": "customer@trov.com",
"Name": {
"First": "John",
"Middle": "K.",
"Last": "Smith"
},
"DeviceFingerprint": "9b28fa6aa3e64608b125f3ed6c31f623"
}
},
"TrovCommonModelCoreIName": {
"description": "Defines an interface for a model that represents a person's name.",
"properties": {
"first": {
"description": "Gets or sets the first name of the person.",
"type": "string"
},
"middle": {
"description": "Gets or sets the middle name of the person.",
"type": "string"
},
"last": {
"description": "Gets or sets the last name of the person.",
"type": "string"
}
},
"xml": {
"name": "IName"
},
"type": "object"
},
"TrovCommonModelCoreNormalizedAddress": {
"description": "Represents a normalized address.",
"properties": {
"street": {
"description": "Gets or sets the street of the address.",
"type": "string"
},
"street2": {
"description": "Gets or sets the secondary street of the address (e.g. \"Apt 56\").",
"type": "string"
},
"city": {
"description": "Gets or sets the city of the address.",
"type": "string"
},
"state": {
"description": "Gets or sets the state of the address.",
"type": "string"
},
"zip": {
"description": "Gets or sets the zip code of the address.",
"type": "string"
},
"country": {
"description": "Gets or sets the country of the address.",
"type": "string"
},
"timezoneId": {
"description": "Gets or sets the IANA timezone id associated with the address.\r\n.",
"type": "string"
},
"isEmpty": {
"description": "Gets a value indicating whether any properties have been changed from the defaults",
"readOnly": true,
"type": "boolean"
}
},
"xml": {
"name": "NormalizedAddress"
},
"type": "object",
"default": {
"Street": "1835 73rd Ave NE",
"Street2": "APT 84",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"TimezoneId": "US/Pacific",
"IsEmpty": false,
"Hash": "B1AB2DF660EB22F8EC4C6654C7AEC9EF"
}
},
"TrovContractAPIUnversionedCustomerSearchCustomerQueryRequest": {
"required": [
"emailFilter"
],
"properties": {
"count": {
"description": "The number of customers to return.",
"type": "integer",
"format": "int32"
},
"offset": {
"description": "The position to offset the customers.",
"type": "integer",
"format": "int32"
},
"emailFilter": {
"description": "The email address or name filter.",
"type": "string"
}
},
"xml": {
"name": "SearchCustomerQueryRequest"
},
"type": "object"
},
"TrovCommonModelSicCustomerCustomerFraudProfilingResult": {
"properties": {
"fingerprint": {
"description": "Gets or sets the device fingerprint. It is the hash of combining DeviceId and DeviceModel",
"type": "string"
},
"customerId": {
"description": "Gets or sets the customer identifier.",
"type": "string"
},
"assetId": {
"description": "Gets or sets the asset id associated with the device",
"type": "string"
},
"accountEmail": {
"description": "Gets or sets the customer account email.",
"type": "string"
},
"accountEmailDomain": {
"description": "Gets or sets the customer email domain.",
"type": "string"
},
"accountEmailFirstSeen": {
"description": "Gets or sets the account email first seen",
"type": "string"
},
"accountEmailLastEvent": {
"description": "Gets or sets the account email last event.",
"type": "string"
},
"accountEmailLastUpdate": {
"description": "Gets or sets the account email last update.",
"type": "string"
},
"accountEmailResult": {
"description": "Gets or sets the account email result.",
"type": "string"
},
"accountEmailScore": {
"description": "Gets or sets the account email score.",
"type": "string"
},
"accountEmailWorstScore": {
"description": "Gets or sets the account email worst score.",
"type": "string"
},
"agentType": {
"description": "Gets or sets the agent type.",
"type": "string"
},
"apiCallDatetime": {
"description": "Gets or sets the api call date time.",
"type": "string"
},
"apiVersion": {
"description": "Gets or sets the api version.",
"type": "string"
},
"browser": {
"description": "Gets or sets the browser.",
"type": "string"
},
"browserLanguage": {
"description": "Gets or sets the browser language",
"type": "string"
},
"browserString": {
"description": "Gets or sets the browser string",
"type": "string"
},
"browserStringHash": {
"description": "Gets or sets the browser string hash",
"type": "string"
},
"browserVersion": {
"description": "Gets or sets the browser version",
"type": "string"
},
"cssImageLoaded": {
"description": "Gets or sets the css image loaded",
"type": "string"
},
"detectedFl": {
"description": "Gets or sets the detected fl",
"type": "string"
},
"deviceFirstSeen": {
"description": "Gets or sets the device first seen",
"type": "string"
},
"deviceId": {
"description": "Gets or sets the device id obtained from ThreatMetrix which is used to calculate the fingerprint.",
"type": "string"
},
"deviceIdConfidence": {
"description": "Gets or sets the device id confidence",
"type": "string"
},
"deviceLastEvent": {
"description": "Gets or sets the device last event",
"type": "string"
},
"deviceLastUpdate": {
"description": "Gets or sets the device last update",
"type": "string"
},
"deviceMatchResult": {
"description": "Gets or sets the device match result",
"type": "string"
},
"deviceModel": {
"description": "Gets or sets the device model obtained from ThreatMetrix which is used to calculate the fingerprint.",
"type": "string"
},
"deviceResult": {
"description": "Gets or sets the device result",
"type": "string"
},
"deviceScore": {
"description": "Gets or sets the device score",
"type": "string"
},
"deviceWorstScore": {
"description": "Gets or sets the device worst score",
"type": "string"
},
"dnsIp": {
"description": "Gets or sets the dns ip",
"type": "string"
},
"dnsIpCity": {
"description": "Gets or sets the dns ip city",
"type": "string"
},
"dnsIpGeo": {
"description": "Gets or sets the dns ip geo",
"type": "string"
},
"dnsIpIsp": {
"description": "Gets or sets the dns ip isp",
"type": "string"
},
"dnsIpLatitude": {
"description": "Gets or sets the dns ip latitude",
"type": "string"
},
"dnsIpLongitude": {
"description": "Gets or sets the dns ip longitude",
"type": "string"
},
"dnsIpOrganization": {
"description": "Gets or sets the dns ip organization",
"type": "string"
},
"dnsIpRegion": {
"description": "Gets or sets the dns ip region",
"type": "string"
},
"dnsIpRegionIsoCode": {
"description": "Gets or sets the dns ip region iso code",
"type": "string"
},
"enabledCk": {
"description": "Gets or sets the enabled ck",
"type": "string"
},
"enabledFl": {
"description": "Gets or sets the enabled fl",
"type": "string"
},
"enabledIm": {
"description": "Gets or sets the enabled im",
"type": "string"
},
"enabledJs": {
"description": "Gets or sets the enabled js",
"type": "string"
},
"eventType": {
"description": "Gets or sets the event type when this fingerprint was obtained.",
"type": "string"
},
"eventTime": {
"description": "Gets or sets the date time of the profiling.",
"type": "string"
},
"flashAnomaly": {
"description": "Gets or sets the flash anomaly.",
"type": "string"
},
"fuzzyDeviceFirstSeen": {
"description": "Gets or sets the fuzzy device first seen",
"type": "string"
},
"fuzzyDeviceId": {
"description": "Gets or sets the fuzzy device id",
"type": "string"
},
"fuzzyDeviceIdConfidence": {
"description": "Gets or sets the fuzzy device id confidence",
"type": "string"
},
"fuzzyDeviceLastEvent": {
"description": "Gets or sets the fuzzy device last event",
"type": "string"
},
"fuzzyDeviceLastUpdate": {
"description": "Gets or sets the fuzzy device last update",
"type": "string"
},
"fuzzyDeviceMatchResult": {
"description": "Gets or sets the fuzzy device match result",
"type": "string"
},
"fuzzyDeviceResult": {
"description": "Gets or sets the fuzzy device result",
"type": "string"
},
"fuzzyDeviceScore": {
"description": "Gets or sets the fuzzy device score",
"type": "string"
},
"fuzzyDeviceWorstScore": {
"description": "Gets or sets the fuzzy device worst score",
"type": "string"
},
"headersNameValueHash": {
"description": "Gets or sets the headers name value hash",
"type": "string"
},
"headersOrderStringHash": {
"description": "Gets or sets the headers order string hash",
"type": "string"
},
"httpOsSignature": {
"description": "Gets or sets the http os signature",
"type": "string"
},
"httpReferer": {
"description": "Gets or sets the http referer",
"type": "string"
},
"httpRefererDomain": {
"description": "Gets or sets the http referer domain",
"type": "string"
},
"httpRefererUrl": {
"description": "Gets or sets the http referer url",
"type": "string"
},
"imageLoaded": {
"description": "Gets or sets the image loaded",
"type": "string"
},
"jsBrowser": {
"description": "Gets or sets the js browser",
"type": "string"
},
"jsBrowserString": {
"description": "Gets or sets the js browser string",
"type": "string"
},
"jsBrowserStringHash": {
"description": "Gets or sets the js browser string hash",
"type": "string"
},
"jsFontsHash": {
"description": "Gets or sets the js fonts hash",
"type": "string"
},
"jsFontsNumber": {
"description": "Gets or sets the js fonts number",
"type": "string"
},
"jsOs": {
"description": "Gets or sets the js os",
"type": "string"
},
"mimeTypeHash": {
"description": "Gets or sets the mime type hash",
"type": "string"
},
"mimeTypeNumber": {
"description": "Gets or sets the mime type number",
"type": "string"
},
"orgId": {
"description": "Gets or sets the org id",
"type": "string"
},
"os": {
"description": "Gets or sets the os",
"type": "string"
},
"osVersion": {
"description": "Gets or sets the os version",
"type": "string"
},
"pageTimeOn": {
"description": "Gets or sets the page time on",
"type": "string"
},
"pluginFlash": {
"description": "Gets or sets the plugin flash",
"type": "string"
},
"pluginHash": {
"description": "Gets or sets the plugin hash",
"type": "string"
},
"pluginNumber": {
"description": "Gets or sets the plugin number",
"type": "string"
},
"policy": {
"description": "Gets or sets the policy used for the profiling",
"type": "string"
},
"policyScore": {
"description": "Gets or sets the Policy Score of the profiling.",
"type": "string"
},
"profiledDomain": {
"description": "Gets or sets the profile domain",
"type": "string"
},
"profiledUrl": {
"description": "Gets or sets the profile url",
"type": "string"
},
"reasonCode": {
"description": "Gets or sets any reasons for unable to profile.",
"type": "string"
},
"requestDuration": {
"description": "Gets or sets the request duration",
"type": "string"
},
"requestId": {
"description": "Gets or sets the request id",
"type": "string"
},
"requestResult": {
"description": "Gets or sets the request result",
"type": "string"
},
"reviewStatus": {
"description": "Gets or sets the review status",
"type": "string"
},
"riskRating": {
"description": "Gets or sets the risk rating as determined by ThreatMetrix.",
"type": "string"
},
"screenColorDepth": {
"description": "Gets or sets the screen color depth",
"type": "string"
},
"serviceType": {
"description": "Gets or sets the service type",
"type": "string"
},
"sessionId": {
"description": "Gets or sets the associated sessionId passed by the client",
"type": "string"
},
"sessionIdQueryCount": {
"description": "Gets or sets the session id query count",
"type": "string"
},
"smartLearningVariables": {
"description": "Gets or sets the smart learning variables",
"type": "string"
},
"summaryRiskScore": {
"description": "Gets or sets the summary risk score",
"type": "string"
},
"timeZone": {
"description": "Gets or sets the time zone",
"type": "string"
},
"timeZoneDstOffset": {
"description": "Gets or sets the time zone dst offset",
"type": "string"
},
"tmxVariables": {
"description": "Gets or sets the tmx variables",
"type": "string"
},
"trueIp": {
"description": "Gets or sets the true ip",
"type": "string"
},
"trueIpAttributes": {
"description": "Gets or sets the true ip attributes",
"type": "string"
},
"trueIpCity": {
"description": "Gets or sets the true ip city",
"type": "string"
},
"trueIpFirstSeen": {
"description": "Gets or sets the true ip first seen",
"type": "string"
},
"trueIpGeo": {
"description": "Gets or sets the geo location determined by the ip address.",
"type": "string"
},
"trueIpIsp": {
"description": "Gets or sets the true ip isp",
"type": "string"
},
"trueIpLastEvent": {
"description": "Gets or sets the true ip last event",
"type": "string"
},
"trueIpLastUpdate": {
"description": "Gets or sets the true ip last update",
"type": "string"
},
"trueIpLatitude": {
"description": "Gets or sets the true ip latitude",
"type": "string"
},
"trueIpLongitude": {
"description": "Gets or sets the true ip longitude",
"type": "string"
},
"trueIpOrganization": {
"description": "Gets or sets the true ip organization",
"type": "string"
},
"trueIpRegion": {
"description": "Gets or sets the true ip region",
"type": "string"
},
"trueIpRegionIsoCode": {
"description": "Gets or sets the true ip region iso code",
"type": "string"
},
"trueIpResult": {
"description": "Gets or sets the true ip result",
"type": "string"
},
"trueIpScore": {
"description": "Gets or sets the true ip score",
"type": "string"
},
"trueIpWorstScore": {
"description": "Gets or sets the true ip worst score",
"type": "string"
},
"uaBrowser": {
"description": "Gets or sets the ua browser",
"type": "string"
},
"uaOs": {
"description": "Gets or sets the ua os",
"type": "string"
},
"uaPlatform": {
"description": "Gets or sets the ua platform",
"type": "string"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "CustomerFraudProfilingResult"
},
"type": "object"
},
"TrovContractAPIUnversionedCustomerCustomerNotifyRequest": {
"required": [
"templateName"
],
"properties": {
"templateName": {
"type": "string"
}
},
"xml": {
"name": "CustomerNotifyRequest"
},
"type": "object"
},
"UnsupportedMarketException": {
"description": "UnsupportedMarketException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The operation requested is not supported in the current market.",
"ExceptionMessage": "The operation requested is not supported in the current market.",
"ExceptionType": "UnsupportedMarketException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ExternalServiceException": {
"description": "ExternalServiceException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "ExternalServiceException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedDisclosureFraudDisclosureQueryRequest": {
"required": [
"event"
],
"properties": {
"event": {
"description": "The action the customer is about to take that we potentially need to show a fraud disclosure for",
"type": "string",
"enum": [
"Unknown",
"StartProtect",
"Claim"
],
"x-enumName": "CustomerEvent"
}
},
"xml": {
"name": "FraudDisclosureQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedDisclosureFraudDisclosureResponse": {
"required": [
"fraudDisclosureText"
],
"properties": {
"fraudDisclosureText": {
"type": "string"
}
},
"xml": {
"name": "FraudDisclosureResponse"
},
"type": "object"
},
"InvalidAddressException": {
"description": "InvalidAddressException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The address was unable to be resolved to a valid address.",
"ExceptionMessage": "The address was unable to be resolved to a valid address.",
"ExceptionType": "InvalidAddressException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"UnknownCustomerEventException": {
"description": "UnknownCustomerEventException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The specified customer event doesn't exist.",
"ExceptionMessage": "The specified customer event doesn't exist.",
"ExceptionType": "UnknownCustomerEventException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedDocumentConsentDocumentConsentStatusResponse": {
"required": [
"documentId",
"documentVersion",
"documentUri"
],
"properties": {
"documentId": {
"type": "string"
},
"documentVersion": {
"type": "integer",
"format": "int32"
},
"documentUri": {
"type": "string"
},
"acceptedOn": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "DocumentConsentStatusResponse"
},
"type": "object"
},
"CustomerProfileInformationMissingException": {
"description": "CustomerProfileInformationMissingException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The customer profile is missing required fields ().",
"ExceptionMessage": "The customer profile is missing required fields ().",
"ExceptionType": "CustomerProfileInformationMissingException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedDocumentConsentCreateDocumentConsentRequest": {
"required": [
"documentType",
"documentId",
"documentVersion"
],
"properties": {
"documentType": {
"type": "string",
"enum": [
"ReceiveElectronicDocument",
"ProductDisclosureSummary",
"AmendatoryEndorsement"
],
"x-enumName": "DisclosureDocumentType"
},
"documentId": {
"type": "string"
},
"documentVersion": {
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "CreateDocumentConsentRequest"
},
"type": "object"
},
"DocumentConsentVersionNotSupportedException": {
"description": "DocumentConsentVersionNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Attempted to accept version different than required version.",
"ExceptionMessage": "Attempted to accept version different than required version.",
"ExceptionType": "DocumentConsentVersionNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedDocumentConsentDocumentConsentContentResponse": {
"required": [
"documents"
],
"properties": {
"documents": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedDocumentConsentDocumentConsentContentVersion"
},
"xml": {
"name": "DocumentConsentContentVersion",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "DocumentConsentContentResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedDocumentConsentDocumentConsentContentVersion": {
"required": [
"documentId",
"documentUri",
"documentVersion"
],
"properties": {
"documentId": {
"type": "string"
},
"documentUri": {
"type": "string"
},
"documentVersion": {
"type": "integer",
"format": "int32"
},
"stateOfResidence": {
"description": "State where this document and version are required",
"type": "string"
}
},
"xml": {
"name": "DocumentConsentContentVersion"
},
"type": "object"
},
"TrovContractAPIUnversionedDocumentConsentCreateDocumentConsentContentRequest": {
"required": [
"documentType",
"documentId",
"documentUri"
],
"properties": {
"documentType": {
"type": "string",
"enum": [
"ReceiveElectronicDocument",
"ProductDisclosureSummary",
"AmendatoryEndorsement"
],
"x-enumName": "DisclosureDocumentType"
},
"documentId": {
"type": "string"
},
"documentUri": {
"type": "string"
}
},
"xml": {
"name": "CreateDocumentConsentContentRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedDocumentConsentAssignDocumentConsentContentToStateRequest": {
"required": [
"documentType",
"documentId"
],
"properties": {
"documentType": {
"type": "string",
"enum": [
"ReceiveElectronicDocument",
"ProductDisclosureSummary",
"AmendatoryEndorsement"
],
"x-enumName": "DisclosureDocumentType"
},
"documentId": {
"type": "string"
},
"stateOfResidence": {
"description": "State where this document and version are required. Empty as default.",
"type": "string"
}
},
"xml": {
"name": "AssignDocumentConsentContentToStateRequest"
},
"type": "object"
},
"TrovCommonModelSicAuditEmployeeAudit": {
"description": "Represents an employee audit entry.",
"required": [
"modified",
"modifiedBy",
"modifiedByEmail"
],
"properties": {
"auditId": {
"description": "Gets or sets id of the {Trov.Common.Model.Sic.Audit.IAuditEntry}.",
"type": "integer",
"format": "int64"
},
"timestamp": {
"description": "Gets or sets the timestamp of the event.",
"type": "string",
"format": "date-time"
},
"userId": {
"description": "Gets or sets the user identifier for the event.",
"type": "string"
},
"userEmail": {
"description": "Gets or sets the user email for the event.",
"type": "string"
},
"action": {
"description": "Gets or sets the type of action being logged.",
"type": "string",
"enum": [
"Create",
"Update",
"Delete",
"Restore"
],
"x-enumName": "AuditAction"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"twoFactorAuthenticationEnabled": {
"type": "boolean"
},
"emailConfirmed": {
"type": "boolean"
},
"email": {
"type": "string"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "EmployeeAudit"
},
"type": "object",
"default": {
"AuditId": 1,
"Timestamp": "2016-01-26T10:11:12Z",
"UserId": "123456",
"UserEmail": "jon.jones@trov.com",
"Action": "Create",
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
},
"TrovCommonModelSicEmployeeIEmployee": {
"description": "Represents an employee.",
"required": [
"roles",
"twoFactorAuthenticationEnabled",
"emailConfirmed",
"email"
],
"properties": {
"roles": {
"description": "Gets or sets the roles the employee has access to.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"twoFactorAuthenticationEnabled": {
"description": "Gets or sets a value indicating whether the employee has two factor authentication enabled.",
"type": "boolean"
},
"emailConfirmed": {
"description": "Gets or sets a value indicating whether the employee has a confirmed email.",
"type": "boolean"
},
"id": {
"description": "Gets or sets the unique id of the type.",
"type": "string"
},
"email": {
"description": "Gets or sets the email address.\r\n\r\nGenerally not persisted to SQL, ensure the implementation is checked for verification.\r\n",
"type": "string"
}
},
"xml": {
"name": "IEmployee"
},
"type": "object",
"default": {
"TwoFactorAuthenticationEnabled": false,
"EmailConfirmed": false,
"IsDeleted": false,
"Email": "admin@pallmallartadvisors.com",
"Id": "4f96309f762dd76ece5a9591",
"Modified": "2016-01-26T10:11:12Z",
"ModifiedBy": "1",
"Created": "2016-01-26T10:11:12Z",
"CreatedBy": "1"
}
},
"TrovCommonModelSicEmployeeUpdateEmployeeRequest": {
"description": "Represents an {Trov.Common.Model.Sic.Employee.IEmployee} update request.",
"properties": {
"isAdmin": {
"description": "Gets or sets a value indicating whether the user should be a SIC admin.",
"type": "boolean"
}
},
"xml": {
"name": "UpdateEmployeeRequest"
},
"type": "object",
"default": {
"IsAdmin": true
}
},
"TwoFactorAuthenticationNotEnabledException": {
"description": "TwoFactorAuthenticationNotEnabledException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The user account does not have two-factor authentication enabled.",
"ExceptionMessage": "The user account does not have two-factor authentication enabled.",
"ExceptionType": "TwoFactorAuthenticationNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSicEmployeeCreateEmployeeRequest": {
"description": "Represents an {Trov.Common.Model.Sic.Employee.IEmployee} creation request.",
"required": [
"email"
],
"properties": {
"email": {
"description": "Gets or sets the email of the user to create the {Trov.Common.Model.Sic.Employee.IEmployee} from.",
"type": "string"
},
"isAdmin": {
"description": "Gets or sets a value indicating whether the user should be a SIC admin.",
"type": "boolean"
}
},
"xml": {
"name": "CreateEmployeeRequest"
},
"type": "object",
"default": {
"Email": "joe.blogs@trov.com",
"IsAdmin": true
}
},
"TrovContractAPIUnversionedExperimentGetAllPricingFileExperimentsQueryRequest": {
"properties": {
"pageSize": {
"type": "integer",
"format": "int32",
"default": 500,
"maximum": 500,
"minimum": 1
},
"page": {
"type": "integer",
"format": "int32",
"default": 1,
"maximum": 2147483647,
"minimum": 1
}
},
"xml": {
"name": "GetAllPricingFileExperimentsQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedExperimentGetAllPricingFileExperimentsResponse": {
"required": [
"page",
"pageSize",
"totalRecords",
"items",
"isLastPage"
],
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"totalRecords": {
"type": "integer",
"format": "int64"
},
"items": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedExperimentPricingFileExperimentResponse"
},
"xml": {
"name": "PricingFileExperimentResponse",
"wrapped": true
},
"type": "array"
},
"isLastPage": {
"description": "True when the next page in sequence would be empty.",
"type": "boolean"
}
},
"xml": {
"name": "GetAllPricingFileExperimentsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedExperimentPricingFileExperimentResponse": {
"required": [
"id",
"description",
"controlPricingFileId",
"controlPricingFileVersion",
"controlPricingFilePercentage",
"testPricingFileId",
"testPricingFileVersion",
"status",
"createdUtc",
"createdBy"
],
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"controlPricingFileId": {
"type": "string"
},
"controlPricingFileVersion": {
"type": "integer",
"format": "int64"
},
"controlPricingFilePercentage": {
"type": "number",
"format": "double"
},
"testPricingFileId": {
"type": "string"
},
"testPricingFileVersion": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"enum": [
"New",
"Running",
"Stopped",
"Archived"
],
"x-enumName": "ExperimentStatus"
},
"createdUtc": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"startedUtc": {
"type": "string",
"format": "date-time"
},
"startedBy": {
"type": "string"
},
"endedUtc": {
"type": "string",
"format": "date-time"
},
"endedBy": {
"type": "string"
}
},
"xml": {
"name": "PricingFileExperimentResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedExperimentCreatePricingFileExperimentRequest": {
"required": [
"experimentDescription",
"controlPricingFileId",
"testPricingFileId"
],
"properties": {
"experimentDescription": {
"type": "string",
"maxLength": 100
},
"controlPricingFileId": {
"type": "string"
},
"testPricingFileId": {
"type": "string"
},
"controlPricingFilePercentage": {
"type": "number",
"format": "double",
"default": 0.5,
"maximum": 0.99,
"minimum": 0.01
}
},
"xml": {
"name": "CreatePricingFileExperimentRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedExperimentCreatePricingFileExperimentResponse": {
"required": [
"experimentId"
],
"properties": {
"experimentId": {
"type": "string"
}
},
"xml": {
"name": "CreatePricingFileExperimentResponse"
},
"type": "object"
},
"InvalidPricingFileException": {
"description": "InvalidPricingFileException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidPricingFileException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedExperimentUpdatePricingFileExperimentRequest": {
"required": [
"action"
],
"properties": {
"action": {
"type": "string",
"enum": [
"Start",
"Stop",
"Archive"
],
"x-enumName": "ExperimentStateAction"
}
},
"xml": {
"name": "UpdatePricingFileExperimentRequest"
},
"type": "object"
},
"ExperimentActionNotSupportedException": {
"description": "ExperimentActionNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Attempted an action not supported.",
"ExceptionMessage": "Attempted an action not supported.",
"ExceptionType": "ExperimentActionNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelCoreAuthTokenResult": {
"description": "Represents a security token.",
"required": [
"authToken"
],
"properties": {
"authToken": {
"description": "Gets or sets a short term access token..",
"type": "string"
}
},
"xml": {
"name": "AuthTokenResult"
},
"type": "object",
"default": {
"AuthToken": "qw1BajChKn6vkILYCmLzeh/H0GEaQJPuss1rpqby4rfd9fzanMNB2iGNVqNPI0CwGHaNSPz6bgNowkjPEbt/9Q=="
}
},
"TrovCommonModelFileIFileInfoResponse": {
"description": "Defines an interface for a model that represents a file response.",
"properties": {
"parentRevision": {
"description": "Gets or sets the parent revision number.",
"type": "integer",
"format": "int32"
},
"contentType": {
"description": "Gets or sets the file content type.",
"type": "string"
},
"length": {
"description": "Gets or sets the file length (i.e. the number of bytes in the file).",
"type": "integer",
"format": "int64"
},
"uploadDate": {
"description": "Gets or sets the date the file was uploaded.",
"type": "integer",
"format": "int64"
},
"schemaType": {
"description": "Gets or sets the file schema type.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"x-enumName": "SchemaType"
},
"uri": {
"description": "Gets or sets a {Trov.Common.Model.File.IFileInfo.Uri} associated with a file.",
"type": "string"
},
"clientId": {
"description": "Gets or sets the client id of the item.",
"type": "string"
},
"parentId": {
"description": "Gets or sets the parent id of the item.",
"type": "string"
},
"rootId": {
"description": "Gets or sets the root id of the item.",
"type": "string"
},
"name": {
"description": "Gets or sets the item name.",
"type": "string"
},
"description": {
"description": "Gets or sets the item description.",
"type": "string"
},
"id": {
"description": "Gets or sets the unique id of the type.",
"type": "string"
}
},
"xml": {
"name": "IFileInfoResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedFraudFraudProfilingSuccessResponse": {
"required": [
"profileSuccess"
],
"properties": {
"profileSuccess": {
"type": "boolean"
}
},
"xml": {
"name": "FraudProfilingSuccessResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedSuggestionsSuggestionsResponse": {
"required": [
"suggestionGroups"
],
"properties": {
"suggestionGroups": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestionGroup"
},
"xml": {
"name": "SuggestionGroup",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SuggestionsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedSuggestionsSuggestionGroup": {
"required": [
"suggestions",
"description",
"id",
"name",
"type",
"urlThumbnail"
],
"properties": {
"suggestions": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedSuggestionsSuggestion"
},
"xml": {
"name": "Suggestion",
"wrapped": true
},
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"urlThumbnail": {
"type": "string"
}
},
"xml": {
"name": "SuggestionGroup"
},
"type": "object"
},
"TrovContractAPIUnversionedSuggestionsSuggestion": {
"required": [
"id",
"name",
"type",
"urlThumbnail"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"urlThumbnail": {
"type": "string"
}
},
"xml": {
"name": "Suggestion"
},
"type": "object"
},
"TrovContractAPIV40GuestGuestQuoteRequest": {
"required": [
"primaryExternalIdentifier",
"birthDate",
"sessionId"
],
"properties": {
"primaryExternalIdentifier": {
"$ref": "#/definitions/TrovContractAPIExternalIdentifierResponse",
"description": "The identifier of the asset to request the quote for."
},
"stateOfResidence": {
"type": "string"
},
"zipOfResidence": {
"type": "string"
},
"birthDate": {
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
},
"gender": {
"type": "string",
"enum": [
"F",
"M"
],
"x-enumName": "Gender"
},
"sessionId": {
"description": "Unique identifier for the guest session.",
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "GuestQuoteRequest"
},
"type": "object"
},
"TrovContractAPIExternalIdentifierResponse": {
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"x-enumName": "ExternalIdentifierType"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "ExternalIdentifierResponse"
},
"type": "object"
},
"TrovContractAPIV40GuestGuestQuoteResponse": {
"required": [
"insuredValue",
"priceOffers",
"quoteId",
"showPdsToUser"
],
"properties": {
"insuredValue": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"priceOffers": {
"description": "A collection price offers applicable to this quote.",
"items": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestQuotePriceOfferResponse"
},
"xml": {
"name": "GuestQuotePriceOfferResponse",
"wrapped": true
},
"type": "array"
},
"quoteId": {
"type": "string"
},
"showPdsToUser": {
"description": "Value indicating whether the PDS must be shown to the user before accepting the quote.",
"type": "boolean"
}
},
"xml": {
"name": "GuestQuoteResponse"
},
"type": "object"
},
"TrovContractAPIV40GuestGuestQuotePriceOfferResponse": {
"required": [
"id",
"excess",
"officialPremium"
],
"properties": {
"id": {
"type": "string"
},
"excess": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"officialPremium": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestQuotePremium"
},
"unofficialPremium": {
"$ref": "#/definitions/TrovContractAPIV40GuestGuestQuotePremium"
},
"excessPercentage": {
"type": "number",
"format": "double"
},
"pdsSummary": {
"type": "string"
},
"amendatoryEndorsement": {
"type": "string"
}
},
"xml": {
"name": "GuestQuotePriceOfferResponse"
},
"type": "object"
},
"TrovContractAPIV40GuestGuestQuotePremium": {
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"interval": {
"type": "string",
"enum": [
"Unknown",
"Daily",
"Monthly",
"Biannually",
"Annually",
"OneTimePayment"
],
"x-enumName": "PremiumInterval"
}
},
"xml": {
"name": "GuestQuotePremium"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestSearchIdRequest": {
"required": [
"maxResultCount",
"type",
"id",
"sessionId"
],
"properties": {
"maxResultCount": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
},
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"x-enumName": "ExternalIdentifierType"
},
"id": {
"type": "string"
},
"sessionId": {
"description": "Unique identifier for the guest session.",
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "GuestSearchIdRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestSearchQueryRequest": {
"required": [
"searchSessionId"
],
"properties": {
"searchSessionId": {
"description": "Unique id to associate with the search request.",
"type": "string"
}
},
"xml": {
"name": "GuestSearchQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestSearchIdResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestAssetResult"
},
"xml": {
"name": "GuestAssetResult",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GuestSearchIdResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestAssetResult": {
"required": [
"isQuotable",
"isAutodetectable"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"categoryId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"commonAttributes": {
"$ref": "#/definitions/TrovContractAPIUnversionedCommonAttributesResponse"
},
"categoryAttributes": {
"$ref": "#/definitions/TrovContractAPIUnversionedCategoryAttributesResponse"
},
"externalIdentifiers": {
"items": {
"$ref": "#/definitions/TrovContractAPIExternalIdentifierResponse"
},
"xml": {
"name": "ExternalIdentifierResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"primaryExternalIdentifier": {
"$ref": "#/definitions/TrovContractAPIExternalIdentifierResponse"
},
"isQuotable": {
"type": "boolean"
},
"isAutodetectable": {
"type": "boolean"
}
},
"xml": {
"name": "GuestAssetResult"
},
"type": "object"
},
"TrovContractAPIUnversionedCommonAttributesResponse": {
"properties": {
"insurance": {
"$ref": "#/definitions/TrovContractAPIUnversionedInsuranceResponse"
},
"purchase": {
"$ref": "#/definitions/TrovContractAPIUnversionedPurchaseResponse"
},
"replacementValue": {
"$ref": "#/definitions/TrovContractAPIUnversionedValueInformationResponse"
},
"fairMarketValue": {
"$ref": "#/definitions/TrovContractAPIUnversionedValueInformationResponse"
},
"acquisitionInformation": {
"$ref": "#/definitions/TrovContractAPIUnversionedAcquisitionInformationResponse"
}
},
"xml": {
"name": "CommonAttributesResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedCategoryAttributesResponse": {
"properties": {
"wine": {
"$ref": "#/definitions/TrovContractAPIUnversionedWineResponse"
},
"product": {
"$ref": "#/definitions/TrovContractAPIUnversionedProductResponse"
},
"vehicle": {
"$ref": "#/definitions/TrovContractAPIUnversionedVehicleResponse"
},
"art": {
"$ref": "#/definitions/TrovContractAPIUnversionedArtResponse"
},
"property": {
"$ref": "#/definitions/TrovContractAPIUnversionedPropertyResponse"
}
},
"xml": {
"name": "CategoryAttributesResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedInsuranceResponse": {
"properties": {
"policyId": {
"type": "string"
},
"policyNumber": {
"type": "string"
},
"contact": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
}
},
"xml": {
"name": "InsuranceResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedPurchaseResponse": {
"properties": {
"date": {
"type": "string"
},
"amount": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"vendor": {
"type": "string"
}
},
"xml": {
"name": "PurchaseResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedValueInformationResponse": {
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"value": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"valuedBy": {
"type": "string"
}
},
"xml": {
"name": "ValueInformationResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedAcquisitionInformationResponse": {
"properties": {
"acquiredFromName": {
"type": "string"
},
"acquiredFromEmail": {
"type": "string"
},
"timestampUtc": {
"type": "string",
"format": "date-time"
},
"reason": {
"type": "string"
}
},
"xml": {
"name": "AcquisitionInformationResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedWineResponse": {
"properties": {
"type": {
"type": "string"
},
"vintage": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"varietal": {
"type": "string"
},
"designation": {
"type": "string"
},
"vineyard": {
"type": "string"
},
"region": {
"type": "string"
},
"subRegion": {
"type": "string"
},
"appellation": {
"type": "string"
},
"bottleSize": {
"type": "string"
}
},
"xml": {
"name": "WineResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedProductResponse": {
"properties": {
"make": {
"type": "string"
},
"model": {
"type": "string"
},
"series": {
"type": "string"
},
"serialNumber": {
"type": "string"
}
},
"xml": {
"name": "ProductResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedVehicleResponse": {
"properties": {
"year": {
"type": "integer",
"format": "int32"
},
"make": {
"type": "string"
},
"model": {
"type": "string"
},
"series": {
"type": "string"
},
"style": {
"type": "string"
},
"vin": {
"type": "string"
},
"exterior": {
"type": "string"
},
"interior": {
"type": "string"
},
"engine": {
"type": "string"
},
"transmission": {
"type": "string"
},
"driveTrain": {
"type": "string"
},
"licenceNumber": {
"type": "string"
},
"mileage": {
"type": "integer",
"format": "int32"
},
"condition": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4
],
"x-enumName": "VehicleCondition"
}
},
"xml": {
"name": "VehicleResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedArtResponse": {
"properties": {
"artist": {
"type": "string"
},
"title": {
"type": "string"
},
"creationDateUtc": {
"type": "string"
},
"medium": {
"type": "string"
},
"edition": {
"type": "string"
},
"signature": {
"type": "string"
},
"frame": {
"type": "string"
}
},
"xml": {
"name": "ArtResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedPropertyResponse": {
"properties": {
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress"
},
"lotSize": {
"type": "string"
},
"livingAreaSize": {
"$ref": "#/definitions/TrovContractAPIUnversionedMeasurementResponse"
},
"stories": {
"type": "integer",
"format": "int32"
},
"bedrooms": {
"type": "integer",
"format": "int32"
},
"bathrooms": {
"type": "number",
"format": "double"
},
"yearBuilt": {
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "PropertyResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMeasurementResponse": {
"properties": {
"unit": {
"type": "string"
},
"value": {
"type": "number",
"format": "double"
}
},
"xml": {
"name": "MeasurementResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestSearchProductRequest": {
"required": [
"maxResultCount",
"query",
"sessionId"
],
"properties": {
"maxResultCount": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
},
"query": {
"type": "string"
},
"sessionId": {
"description": "Unique identifier for the guest session.",
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "GuestSearchProductRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedGuestGuestSearchProductResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedGuestGuestAssetResult"
},
"xml": {
"name": "GuestAssetResult",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "GuestSearchProductResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataAssetCategoriesResponse": {
"required": [
"categories"
],
"properties": {
"categories": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataCategory"
},
"xml": {
"name": "Category",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "AssetCategoriesResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataCategory": {
"required": [
"id",
"name",
"thumbnailUri",
"imageUri",
"subCategories"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnailUri": {
"type": "string"
},
"imageUri": {
"type": "string"
},
"subCategories": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataSubCategory"
},
"xml": {
"name": "SubCategory",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "Category"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSubCategory": {
"required": [
"id",
"name",
"thumbnailUri",
"imageUri"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnailUri": {
"type": "string"
},
"imageUri": {
"type": "string"
}
},
"xml": {
"name": "SubCategory"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataAssetCategoryResponse": {
"properties": {
"category": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataCategory"
}
},
"xml": {
"name": "AssetCategoryResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataEnrichUserAddedAssetRequest": {
"required": [
"categoryId",
"subCategoryId",
"insuredValue"
],
"properties": {
"categoryId": {
"type": "string"
},
"subCategoryId": {
"type": "string"
},
"insuredValue": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyRequest"
}
},
"xml": {
"name": "EnrichUserAddedAssetRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataEnrichUserAddedAssetResponse": {
"required": [
"asset"
],
"properties": {
"asset": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataMetadataAssetResult"
}
},
"xml": {
"name": "EnrichUserAddedAssetResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataMetadataAssetResult": {
"required": [
"isQuotable",
"isAutodetectable"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"categoryId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"commonAttributes": {
"$ref": "#/definitions/TrovContractAPIUnversionedCommonAttributesResponse"
},
"categoryAttributes": {
"$ref": "#/definitions/TrovContractAPIUnversionedCategoryAttributesResponse"
},
"externalIdentifiers": {
"items": {
"$ref": "#/definitions/TrovContractAPIExternalIdentifierResponse"
},
"xml": {
"name": "ExternalIdentifierResponse",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"primaryExternalIdentifier": {
"$ref": "#/definitions/TrovContractAPIExternalIdentifierResponse"
},
"isQuotable": {
"type": "boolean"
},
"isAutodetectable": {
"type": "boolean"
}
},
"xml": {
"name": "MetadataAssetResult"
},
"type": "object"
},
"ArgumentException": {
"description": "ArgumentException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Value does not fall within the expected range.",
"ExceptionMessage": "Value does not fall within the expected range.",
"ExceptionType": "ArgumentException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ArgumentNullException": {
"description": "ArgumentNullException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Value cannot be null.",
"ExceptionMessage": "Value cannot be null.",
"ExceptionType": "ArgumentNullException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"EnrichFailedException": {
"description": "EnrichFailedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Asset enrichment failed for this request.",
"ExceptionMessage": "Asset enrichment failed for this request.",
"ExceptionType": "EnrichFailedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelAssetsPhoneEnrichmentRequest": {
"properties": {
"modelId": {
"description": "Gets or sets the model identifier for the phone.",
"type": "string"
},
"storage": {
"description": "Gets or sets the storage capacity of the phone.",
"type": "string"
},
"carrier": {
"description": "Gets or sets the carrier of the phone.",
"type": "string"
},
"manufacturer": {
"description": "Gets or sets the phone manufacturer.",
"type": "string"
},
"assetId": {
"description": "Gets or sets the asset ID. This only required if enriching a phone that was already created via search, e.g. from Trov Web.\r\nIf the enrich fails for this asset, a new asset will be created and this one deleted.",
"type": "string"
},
"color": {
"description": "Gets or sets the color of the device. Note that is only necessary in exceptional cases,\r\ne.g. the iPhone 7 Red, and must be ommitted otherwise.",
"type": "string"
}
},
"xml": {
"name": "PhoneEnrichmentRequest"
},
"type": "object",
"default": {
"ModelId": "iPhone2,1",
"Storage": "8",
"Carrier": "AT&T",
"Manufacturer": "Apple"
}
},
"TrovContractAPIUnversionedMetadataPhoneEnrichmentQueryRequest": {
"properties": {
"sessionId": {
"description": "Optional ThreatMetrix session id associated with the request.",
"type": "string"
}
},
"xml": {
"name": "PhoneEnrichmentQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchIdRequest": {
"required": [
"type",
"id",
"maxResultCount"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"x-enumName": "ExternalIdentifierType"
},
"id": {
"type": "string"
},
"maxResultCount": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
}
},
"xml": {
"name": "SearchIdRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchQueryRequest": {
"required": [
"searchSessionId"
],
"properties": {
"searchSessionId": {
"description": "Unique id to associate with the search request.",
"type": "string"
}
},
"xml": {
"name": "SearchQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchIdResponse": {
"required": [
"results"
],
"properties": {
"results": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataMetadataAssetResult"
},
"xml": {
"name": "MetadataAssetResult",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SearchIdResponse"
},
"type": "object"
},
"TrovContractAPIV40MetadataOtherPhoneEnrichmentQueryRequest": {
"properties": {
"token": {
"description": "The one time token for the enrichment request.",
"type": "string"
},
"sessionId": {
"description": "Optional ThreatMetrix session id associated with the request.",
"type": "string"
}
},
"xml": {
"name": "OtherPhoneEnrichmentQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchProductRequest": {
"required": [
"query",
"maxResultCount"
],
"properties": {
"query": {
"type": "string"
},
"maxResultCount": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
}
},
"xml": {
"name": "SearchProductRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchProductResponse": {
"required": [
"results"
],
"properties": {
"results": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataMetadataAssetResult"
},
"xml": {
"name": "MetadataAssetResult",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SearchProductResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchPropertyRequest": {
"required": [
"maxResultCount"
],
"properties": {
"street": {
"type": "string"
},
"street2": {
"description": "Gets or sets the secondary street of the address (e.g. \"Apt 56\").",
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"country": {
"type": "string"
},
"maxResultCount": {
"type": "integer",
"format": "int32",
"maximum": 50,
"minimum": 1
}
},
"xml": {
"name": "SearchPropertyRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedMetadataSearchPropertyResponse": {
"required": [
"results"
],
"properties": {
"results": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedMetadataMetadataAssetResult"
},
"xml": {
"name": "MetadataAssetResult",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SearchPropertyResponse"
},
"type": "object"
},
"InvalidAssetException": {
"description": "InvalidAssetException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidAssetException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIV31PaymentCardPaymentCardResponse": {
"required": [
"id",
"last4",
"expirationMonth",
"expirationYear",
"isDefault",
"brand",
"cvcCheckPass",
"addressCheckPass",
"fingerprint"
],
"properties": {
"tokenizationMethod": {
"type": "string"
},
"cardTokenizationMethod": {
"description": "The type of card tokenization method (e.g. ApplePay).",
"type": "string",
"enum": [
"ApplePay",
"AndroidPay"
],
"x-enumName": "TokenizationMethod"
},
"id": {
"type": "string"
},
"last4": {
"description": "The last 4 digits of the card number.",
"type": "string"
},
"expirationMonth": {
"type": "integer",
"format": "int32"
},
"expirationYear": {
"type": "integer",
"format": "int32"
},
"isDefault": {
"description": "Value indicating whether this is the default card.",
"type": "boolean"
},
"name": {
"description": "The name on the card.",
"type": "string"
},
"address": {
"$ref": "#/definitions/TrovContractAPIUnversionedAddress"
},
"brand": {
"type": "string",
"enum": [
"Unknown",
"Visa",
"AmericanExpress",
"MasterCard",
"Discover",
"JCB",
"DinersClub"
],
"x-enumName": "PaymentCardBrand"
},
"cvcCheckPass": {
"type": "boolean"
},
"addressCheckPass": {
"type": "boolean"
},
"fingerprint": {
"type": "string"
}
},
"xml": {
"name": "PaymentCardResponse"
},
"type": "object"
},
"PaymentProviderException": {
"description": "PaymentProviderException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "PaymentProviderException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIV31PaymentCardAddPaymentCardRequest": {
"required": [
"token"
],
"properties": {
"token": {
"description": "The Stripe.js token of the card to add.",
"type": "string"
},
"deleteExisting": {
"description": "Value indicating whether existing cards should be deleted as part of request.",
"type": "boolean"
}
},
"xml": {
"name": "AddPaymentCardRequest"
},
"type": "object"
},
"TrovCommonModelSicPaymentCardsPaymentCardUpdateRequest": {
"description": "Represents an Update {Trov.Common.Model.Sic.PaymentCards.PaymentCard} request.",
"required": [
"id",
"expirationMonth",
"expirationYear",
"name",
"street",
"zip"
],
"properties": {
"id": {
"description": "Gets or sets the internal id of the card.",
"type": "string"
},
"expirationMonth": {
"description": "Gets or sets the expiration month.",
"type": "integer",
"format": "int32"
},
"expirationYear": {
"description": "Gets or sets the expiration year.",
"type": "integer",
"format": "int32"
},
"name": {
"description": "Gets or sets the name on the card.",
"type": "string"
},
"street": {
"description": "Gets or sets the street of the card's address.",
"type": "string"
},
"street2": {
"description": "Gets or sets the secondary street of the card's address (e.g. \"Apt 56\").",
"type": "string"
},
"city": {
"description": "Gets or sets the city of the card's address.",
"type": "string"
},
"state": {
"description": "Gets or sets the state of the card's address.",
"type": "string"
},
"zip": {
"description": "Gets or sets the zip code of the card's address.",
"type": "string"
},
"country": {
"description": "Gets or sets the country of the card's address.",
"type": "string"
}
},
"xml": {
"name": "PaymentCardUpdateRequest"
},
"type": "object",
"default": {
"Id": "card_id",
"ExpirationMonth": 12,
"ExpirationYear": 2010,
"Name": "J.R. Smith",
"Street": "1835 73rd Ave NE",
"Street2": "APT 84",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA"
}
},
"TrovContractAPIUnversionedPdsProductDisclosureResponse": {
"required": [
"uri"
],
"properties": {
"uri": {
"type": "string"
},
"amendatoryEndorsementUri": {
"type": "string"
}
},
"xml": {
"name": "ProductDisclosureResponse"
},
"type": "object"
},
"UserNotFoundException": {
"description": "UserNotFoundException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionMessage": "The user with username string was not found, or the password associated with the login is incorrect.",
"ExceptionType": "UserNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedPdsCreateProductDisclosureSummaryRequest": {
"description": "Represents a PDS summary request.",
"required": [
"version"
],
"properties": {
"version": {
"description": "Gets or sets the version associated with the PDS summary.",
"type": "string"
}
},
"xml": {
"name": "CreateProductDisclosureSummaryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedPdsProductDisclosureSummaryResponse": {
"properties": {
"version": {
"type": "string"
},
"uri": {
"type": "string"
},
"effectiveDate": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "ProductDisclosureSummaryResponse"
},
"type": "object"
},
"PdsSummaryVersionNotProvidedException": {
"description": "PdsSummaryVersionNotProvidedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The PDS version is was not provided.",
"ExceptionMessage": "The PDS version is was not provided.",
"ExceptionType": "PdsSummaryVersionNotProvidedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PdsSummaryVersionExistsException": {
"description": "PdsSummaryVersionExistsException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The PDS version cannot be created because one already exists.",
"ExceptionMessage": "The PDS version cannot be created because one already exists.",
"ExceptionType": "PdsSummaryVersionExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedPdsAmendatoryEndorsementResponse": {
"properties": {
"version": {
"type": "string"
},
"uri": {
"type": "string"
},
"effectiveDate": {
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "AmendatoryEndorsementResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedPdsCreateAmendatoryEndorsementRequest": {
"required": [
"version",
"stateOfResidence"
],
"properties": {
"version": {
"type": "string"
},
"stateOfResidence": {
"type": "string"
}
},
"xml": {
"name": "CreateAmendatoryEndorsementRequest"
},
"type": "object"
},
"AmendatoryEndorsementVersionExistsException": {
"description": "AmendatoryEndorsementVersionExistsException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The Amendatory Endorsement version already exists.",
"ExceptionMessage": "The Amendatory Endorsement version already exists.",
"ExceptionType": "AmendatoryEndorsementVersionExistsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSicPriceOfferPremiumCalculationRequest": {
"description": "Represents a request for calculating an insurance premium.",
"required": [
"insuredValue",
"category",
"subCategory",
"age",
"city",
"state",
"postalCode",
"claimsInPastThreeYears",
"tenureInMonths",
"gender",
"customerOccupation",
"isOutdoor",
"effectiveDate",
"isGhostQuoteRequest"
],
"properties": {
"customerId": {
"description": "Gets or sets the customer id.",
"type": "string"
},
"insuredValue": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the insured value of the {Trov.Common.Model.Assets.IAsset}."
},
"excess": {
"description": "Gets or sets the excess percentage for the insurance quote. If a value is not specified,\r\nthen a quote will be returned for each available excess value.\r\n\r\nThis property should be named ExcessPercentage but the\r\ninsurance .json file references it so we can't change it yet.\r\n",
"type": "number",
"format": "double"
},
"category": {
"description": "Gets or sets the BeValued Category for the {Trov.Common.Model.Assets.IAsset}.",
"type": "string"
},
"subCategory": {
"description": "Gets or sets the BeValued SubCategory for the {Trov.Common.Model.Assets.IAsset}.",
"type": "string"
},
"age": {
"description": "Gets or sets the age of the customer (at the time of the {Trov.Common.Model.Sic.PriceOffer.IPriceOffer} request).",
"type": "integer",
"format": "int32"
},
"city": {
"description": "Gets or sets the {Trov.Common.Model.Sic.Customer.ICustomer}'s city.",
"type": "string"
},
"state": {
"description": "Gets or sets the {Trov.Common.Model.Sic.Customer.ICustomer}'s state.",
"type": "string"
},
"postalCode": {
"description": "Gets or sets the {Trov.Common.Model.Sic.Customer.ICustomer}'s postal code.",
"type": "string"
},
"claimsInPastThreeYears": {
"description": "Gets or sets the number of {N:Trov.Common.Model.Sic.Claim}s that the {Trov.Common.Model.Sic.Customer.ICustomer} has made in the\r\npast three years at the time of the {Trov.Common.Model.Sic.PriceOffer.IPriceOffer} request.",
"type": "integer",
"format": "int32"
},
"tenureInMonths": {
"description": "Gets or sets the number of months since the {Trov.Common.Model.Sic.Customer.ICustomer} was created.",
"type": "integer",
"format": "int32"
},
"gender": {
"description": "Gets or sets the {!:Access.Customer.Interface.Gender} of the {Trov.Common.Model.Sic.Customer.ICustomer}.",
"type": "string",
"enum": [
"F",
"M"
],
"x-enumName": "Gender"
},
"customerOccupation": {
"description": "Gets or sets the {Trov.Common.Model.Sic.Customer.ICustomer}'s occupation.",
"type": "string"
},
"travelOverseas": {
"description": "Gets or sets a value indicating whether the {Trov.Common.Model.Sic.Customer.ICustomer} will travel overseas (out of country)\r\nwith the {Trov.Common.Model.Assets.IAsset}.",
"type": "boolean"
},
"extendedWarranty": {
"description": "Gets or sets a value indicating whether the {Trov.Common.Model.Sic.Customer.ICustomer} is declaring the {Trov.Common.Model.Assets.IAsset}\r\nis covered by an extended warranty.",
"type": "boolean"
},
"isOutdoor": {
"description": "Gets or sets a value indicating whether the {Trov.Common.Model.Assets.IAsset} is portable.",
"type": "boolean"
},
"effectiveDate": {
"description": "Gets or sets the date the {Trov.Common.Model.Sic.PriceOffer.IPriceOffer} should be effective for.",
"type": "string",
"format": "date-time"
},
"isGhostQuoteRequest": {
"description": "Gets or sets a value indicating whether the request should use typical {Trov.Common.Model.Sic.Customer.ICustomer} information\r\nto generate the request (e.g. ghost profile).",
"type": "boolean"
},
"providerId": {
"$ref": "#/definitions/TrovContractCommonExternalIdentifier",
"description": "Gets or sets the provider id."
},
"isReplacementCalculationRequest": {
"description": "Gets or sets a value indicating whether this request is for a replacement price offer calculation request.",
"type": "boolean"
},
"customerRiskRatio": {
"description": "Gets or sets a value indicating the risk score of the customer",
"type": "number",
"format": "double"
},
"assetRiskRatio": {
"description": "Gets or sets a value indicating the risk score of the customer",
"type": "number",
"format": "double"
},
"sourceRiskRatio": {
"description": "Gets or sets a value indicating the risk score of the customer",
"type": "number",
"format": "double"
}
},
"xml": {
"name": "PremiumCalculationRequest"
},
"type": "object",
"default": {
"CustomerId": "4f96309f762dd76ece5a9591",
"InsuredValue": {
"Type": 0,
"Value": 150.00
},
"Category": "Audio",
"SubCategory": "Headphones",
"Age": 31,
"City": "FIVE DOCK",
"State": "NSW",
"PostalCode": "2046",
"ClaimsInPastThreeYears": 1,
"TenureInMonths": 3,
"Gender": "F",
"CustomerOccupation": "Television Host",
"TravelOverseas": false,
"ExtendedWarranty": false,
"IsOutdoor": true,
"EffectiveDate": "2016-01-26T10:11:12Z",
"IsGhostQuoteRequest": false,
"IsReplacementCalculationRequest": false,
"CustomerRiskRatio": 0.0,
"AssetRiskRatio": 0.0,
"SourceRiskRatio": 0.0
}
},
"TrovCommonModelSicPriceOfferPremiumCalculationResultsResponse": {
"required": [
"premiumCalculationResults",
"officialPremiumInterval"
],
"properties": {
"premiumCalculationResults": {
"items": {
"$ref": "#/definitions/TrovCommonModelSicPriceOfferIPremiumCalculationResult"
},
"xml": {
"name": "IPremiumCalculationResult",
"wrapped": true
},
"type": "array"
},
"officialPremiumInterval": {
"type": "string",
"enum": [
"Unknown",
"Monthly",
"Daily"
],
"x-enumName": "OfficialPremiumInterval"
}
},
"xml": {
"name": "PremiumCalculationResultsResponse"
},
"type": "object",
"default": {
"PremiumCalculationResults": [
{
"Status": "Success",
"Excess": {
"Type": 0,
"Value": 5.45
},
"ExcessPercentage": 10.0,
"DailyPremium": {
"Type": 0,
"Value": 5.45
},
"MonthlyTotal": {
"Type": 0,
"Value": 163.50
},
"DailyTaxes": [
{
"Type": "GST (8%)",
"Amount": {
"Type": 0,
"Value": 5.45
},
"Rate": 0.08,
"Created": "0001-01-01T00:00:00"
},
{
"Type": "PST (7%)",
"Amount": {
"Type": 0,
"Value": 5.45
},
"Rate": 0.07,
"Created": "0001-01-01T00:00:00"
}
],
"DailyTotal": {
"Type": 0,
"Value": 5.45
},
"Audit": [],
"PricingModelVersion": 0
}
],
"OfficialPremiumInterval": "Daily"
}
},
"TrovCommonModelSicPriceOfferIPremiumCalculationResult": {
"required": [
"status",
"excess",
"excessPercentage",
"dailyTaxes",
"dailyTotal",
"audit",
"pricingModelVersion"
],
"properties": {
"status": {
"description": "Gets or sets the status of the calculation.",
"type": "string",
"enum": [
"Success",
"FailedToPrice",
"Declined",
"ItemCategoryNotSupported",
"CustomerAgeNotSupported",
"CustomerAddressNotSupported",
"PremiumNotAffordable",
"UnderwritingDenied"
],
"x-enumName": "PremiumCalculationStatus"
},
"underwritingWarning": {
"description": "Gets or sets the underwriting warning, if any.",
"type": "string",
"enum": [
"None",
"InsuranceSoldOut",
"InsuranceCategorySoldOut",
"CustomerLimitReached",
"ItemLimitReached"
],
"x-enumName": "UnderwritingWarning"
},
"excess": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the excess amount."
},
"excessPercentage": {
"description": "Gets or sets the excess percentage used to calculate the excess amount.",
"type": "number",
"format": "double"
},
"dailyPremium": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the daily premium amount."
},
"monthlyTotal": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets the monthly total amount. This is an estimate in the AU/GB markets, calculated from the official DailyTotal",
"readOnly": true
},
"dailyTaxes": {
"description": "Gets or sets a collection of tax amounts included in the premium.",
"items": {
"$ref": "#/definitions/TrovCommonModelSicITaxCharge"
},
"xml": {
"name": "ITaxCharge",
"wrapped": true
},
"type": "array"
},
"dailyTotal": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the daily total."
},
"audit": {
"description": "Gets or sets the audit record for the premium calculation.",
"items": {
"type": "string"
},
"type": "array"
},
"pricingModelVersion": {
"description": "Gets or sets the version of the pricing model used to generate the premium.",
"type": "integer",
"format": "int64"
}
},
"xml": {
"name": "IPremiumCalculationResult"
},
"type": "object",
"default": {
"Status": "Success",
"Excess": {
"Type": 0,
"Value": 5.45
},
"ExcessPercentage": 10.0,
"DailyPremium": {
"Type": 0,
"Value": 5.45
},
"MonthlyTotal": {
"Type": 0,
"Value": 163.50
},
"DailyTaxes": [
{
"Type": "GST (8%)",
"Amount": {
"Type": 0,
"Value": 5.45
},
"Rate": 0.08,
"Created": "0001-01-01T00:00:00"
},
{
"Type": "PST (7%)",
"Amount": {
"Type": 0,
"Value": 5.45
},
"Rate": 0.07,
"Created": "0001-01-01T00:00:00"
}
],
"DailyTotal": {
"Type": 0,
"Value": 5.45
},
"Audit": [],
"PricingModelVersion": 0
}
},
"TrovCommonModelSicITaxCharge": {
"description": "A tax charge.",
"required": [
"type",
"amount"
],
"properties": {
"type": {
"description": "Gets or sets the type of the tax.",
"type": "string"
},
"amount": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the amount of the tax."
},
"rate": {
"description": "Gets or sets the rate of the tax.",
"type": "number",
"format": "double"
},
"id": {
"description": "Gets or sets the unique id of the type.",
"type": "string"
}
},
"xml": {
"name": "ITaxCharge"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteSupportedQuoteCategoriesResponse": {
"required": [
"categories"
],
"properties": {
"categories": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteQuoteCategoryResponse"
},
"xml": {
"name": "QuoteCategoryResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "SupportedQuoteCategoriesResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteQuoteCategoryResponse": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"subCategories": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteQuoteCategoryResponse"
},
"xml": {
"name": "QuoteCategoryResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "QuoteCategoryResponse"
},
"type": "object"
},
"TrovCommonModelProfileProfile": {
"description": "Represents a user profile.",
"properties": {
"global": {
"$ref": "#/definitions/TrovCommonModelProfileGlobalProfile",
"description": "Gets or sets the global information."
},
"customer": {
"$ref": "#/definitions/TrovCommonModelProfileCustomerProfile",
"description": "Gets or sets the customer information."
},
"photos": {
"$ref": "#/definitions/TrovCommonModelProfileProfilePhotos",
"description": "Gets or sets the customer photos."
}
},
"xml": {
"name": "Profile"
},
"type": "object",
"default": {
"Global": {
"Email": {
"Email": "john.smith@trov.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
},
"PhoneNumber": {
"Number": "555-237-7884",
"IsConfirmed": false
},
"UserCreationDate": "2016-01-26T10:11:12Z",
"TwoFactorAuthenticationEnabled": false
},
"Customer": {
"Address": {
"Street": "1835 73rd Ave NE",
"Street2": "APT 84",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"TimezoneId": "US/Pacific",
"IsEmpty": false,
"Hash": "B1AB2DF660EB22F8EC4C6654C7AEC9EF"
},
"BirthDate": {
"year": 1984,
"month": 10,
"day": 1,
"calendar": 0
},
"Name": {
"First": "John",
"Middle": "K.",
"Last": "Smith"
},
"Nationality": "British",
"Gender": "M",
"EmploymentStatus": "Employed",
"Emails": [
{
"Email": "foo@bar.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
},
{
"Email": "baz@qux.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
}
],
"IsSubscribed": false
},
"Photos": {
"Background": "http://www.trov.com/resources/images/logos/trov-logo-white.png",
"Profile": "http://www.trov.com/resources/images/logos/trov-logo-white.png"
}
}
},
"TrovCommonModelProfileGlobalProfile": {
"description": "Represents a user profile's global information.",
"properties": {
"email": {
"$ref": "#/definitions/TrovCommonModelProfileEmailAddress",
"description": "Gets or sets the email address of the profile."
},
"phoneNumber": {
"$ref": "#/definitions/TrovCommonModelProfileLegacyPhoneNumber",
"description": "Gets or sets the phone number of the profile."
},
"userCreationDate": {
"description": "Gets or sets the date the user account was created.",
"type": "string",
"format": "date-time"
},
"twoFactorAuthenticationEnabled": {
"description": "Gets or sets a value indicating whether the user account has two factor authentication enabled.",
"type": "boolean"
}
},
"xml": {
"name": "GlobalProfile"
},
"type": "object",
"default": {
"Email": {
"Email": "john.smith@trov.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
},
"PhoneNumber": {
"Number": "555-237-7884",
"IsConfirmed": false
},
"UserCreationDate": "2016-01-26T10:11:12Z",
"TwoFactorAuthenticationEnabled": false
}
},
"TrovCommonModelProfileCustomerProfile": {
"description": "Represent a user profile's customer information.",
"properties": {
"address": {
"$ref": "#/definitions/TrovCommonModelCoreNormalizedAddress",
"description": "Gets or sets the address of the profile."
},
"birthDate": {
"description": "Gets or sets the birth date of the profile.",
"example": "2016-09-22",
"type": "string",
"default": "2016-09-22"
},
"name": {
"$ref": "#/definitions/TrovCommonModelCoreIName",
"description": "Gets or sets the name of the profile."
},
"nationality": {
"description": "Gets or sets the nationality of the profile.",
"type": "string"
},
"gender": {
"description": "Gets or sets the gender of the profile.",
"type": "string",
"enum": [
"F",
"M"
],
"x-enumName": "Gender"
},
"employmentStatus": {
"description": "Gets or sets the employment status of the profile.",
"type": "string",
"enum": [
"UniversityStudent",
"CollegeStudent",
"Unemployed",
"Employed",
"SelfEmployed",
"Houseperson",
"Retired",
"Other",
"Unknown"
],
"x-enumName": "EmploymentStatus"
},
"emails": {
"description": "Gets or sets secondary email addresses associated with the profile.",
"items": {
"$ref": "#/definitions/TrovCommonModelProfileEmailAddress"
},
"xml": {
"name": "EmailAddress",
"wrapped": true
},
"type": "array",
"uniqueItems": true
},
"isSubscribed": {
"description": "Gets or sets a value indicating whether the profile is subscribed to marketing communications.\r\n\r\nDefaults to false.\r\n",
"type": "boolean"
}
},
"xml": {
"name": "CustomerProfile"
},
"type": "object",
"default": {
"Address": {
"Street": "1835 73rd Ave NE",
"Street2": "APT 84",
"City": "Medina",
"State": "WA",
"Zip": "98039",
"Country": "USA",
"TimezoneId": "US/Pacific",
"IsEmpty": false,
"Hash": "B1AB2DF660EB22F8EC4C6654C7AEC9EF"
},
"BirthDate": {
"year": 1984,
"month": 10,
"day": 1,
"calendar": 0
},
"Name": {
"First": "John",
"Middle": "K.",
"Last": "Smith"
},
"Nationality": "British",
"Gender": "M",
"EmploymentStatus": "Employed",
"Emails": [
{
"Email": "foo@bar.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
},
{
"Email": "baz@qux.com",
"LinkedStatus": "NotLinked",
"IsConfirmed": true
}
],
"IsSubscribed": false
}
},
"TrovCommonModelProfileProfilePhotos": {
"description": "Represents the available photos for a profile.",
"properties": {
"background": {
"description": "Gets or sets the {System.Uri} of the {!:ICustomer}'s background photo.",
"type": "string"
},
"profile": {
"description": "Gets or sets the {System.Uri} of the {!:ICustomer}'s profile photo.",
"type": "string"
}
},
"xml": {
"name": "ProfilePhotos"
},
"type": "object"
},
"TrovCommonModelProfileEmailAddress": {
"description": "Represents an email address.",
"required": [
"email"
],
"properties": {
"email": {
"description": "Gets or sets the email address.",
"type": "string"
},
"linkedStatus": {
"description": "Gets the linked status of the email address.",
"readOnly": true,
"type": "string"
},
"isConfirmed": {
"description": "Gets or sets a value indicating whether the email address has been confirmed as being owned by the associated user.",
"type": "boolean"
}
},
"xml": {
"name": "EmailAddress"
},
"type": "object"
},
"TrovCommonModelProfileLegacyPhoneNumber": {
"description": "Defines a model that represents a phone number.",
"required": [
"number"
],
"properties": {
"number": {
"description": "Gets the phone number.",
"readOnly": true,
"type": "string"
},
"isConfirmed": {
"description": "Gets a value indicating whether the phone number has been confirmed as being owned by the associated user.",
"readOnly": true,
"type": "boolean"
}
},
"xml": {
"name": "LegacyPhoneNumber"
},
"type": "object"
},
"CustomerAddressNotSupportedException": {
"description": "CustomerAddressNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Insurance is not available due to the customer's address.",
"ExceptionMessage": "Insurance is not available due to the customer's address.",
"ExceptionType": "CustomerAddressNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"CustomerAgeNotSupportedException": {
"description": "CustomerAgeNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Insurance is not available due to the customer's age.",
"ExceptionMessage": "Insurance is not available due to the customer's age.",
"ExceptionType": "CustomerAgeNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"StateOfResidenceNotSupportedException": {
"description": "StateOfResidenceNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Customer does not reside in an active US state",
"ExceptionMessage": "Customer does not reside in an active US state",
"ExceptionType": "StateOfResidenceNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"UnsupportedImageException": {
"description": "UnsupportedImageException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The file is not a valid image or not a supported type.",
"ExceptionMessage": "The file is not a valid image or not a supported type.",
"ExceptionType": "UnsupportedImageException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedPromotionGetPromotionsQueryRequest": {
"properties": {
"fromDate": {
"description": "Start of the date range for promotions to retrieve (optional).",
"type": "string",
"format": "date-time"
},
"toDate": {
"description": "End of the date range for promotions to retrieve (optional).",
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "GetPromotionsQueryRequest"
},
"type": "object"
},
"TrovCommonModelSicPromotionsPromotion": {
"description": "Defines a model for specific type of Marketing Promotion.",
"required": [
"promoCode",
"taxCalculation",
"promotionType",
"termsOfPromotionUrl",
"promotionStartUtc",
"promotionEndUtc",
"redemptionsPerCustomer",
"modified",
"modifiedBy",
"modifiedByEmail"
],
"properties": {
"promoCode": {
"description": "Gets or sets the PromoCode that is used to non-uniquely identify to the {Trov.Common.Model.Sic.Promotions.Promotion}.",
"type": "string"
},
"taxCalculation": {
"description": "Gets or sets an enum that defines how taxes are calculated when applying the credit to a bill.",
"type": "string",
"enum": [
"Unknown",
"BeforeTax",
"AfterTax"
],
"x-enumName": "TaxCalculation"
},
"promotionType": {
"description": "Gets or sets an enum that defines the type of promotion, e.g. Cash or Duration.",
"type": "string",
"enum": [
"Unknown",
"Cash",
"Duration"
],
"x-enumName": "PromotionType"
},
"termsOfPromotionUrl": {
"description": "Gets or sets a URL to a web page with the Terms of the Promotion for the customer to read.",
"type": "string"
},
"creditAmount": {
"$ref": "#/definitions/TrovCommonModelCoreCurrency",
"description": "Gets or sets the optional maximum credit amount that can be applied to an item for the {Trov.Common.Model.Sic.Promotions.Promotion}."
},
"creditDurationDays": {
"description": "Gets or sets the optional maximum number of free days that can be applied to an item for the {Trov.Common.Model.Sic.Promotions.Promotion}.",
"type": "number",
"format": "double"
},
"creditExpiryDays": {
"description": "Gets or sets the optional maximum number of days after the initial promotion redemption, in which any portion of the credit can be applied to an item on a bill.",
"type": "number",
"format": "double"
},
"promotionStartUtc": {
"description": "Gets or sets the start date after which the {Trov.Common.Model.Sic.Promotions.Promotion} can be redeemed by a customer.",
"type": "string",
"format": "date-time"
},
"promotionEndUtc": {
"description": "Gets or sets the end date after which the {Trov.Common.Model.Sic.Promotions.Promotion} cannot be redeemed by a customer.",
"type": "string",
"format": "date-time"
},
"maxRedemptions": {
"description": "Gets or sets the optional maximum total number of redemptions of the given {Trov.Common.Model.Sic.Promotions.Promotion}.\r\nIf this limit exists, once it is reached the {Trov.Common.Model.Sic.Promotions.Promotion} can no longer be redeemed.",
"type": "integer",
"format": "int32"
},
"redemptionsPerCustomer": {
"description": "Gets or sets the maximum number of times a single customer can redeem the {Trov.Common.Model.Sic.Promotions.Promotion}.\r\nOnce the limit is reached for a customer, that customer cannot apply the given {Trov.Common.Model.Sic.Promotions.Promotion} to any additional items;\r\nany existing redemptions would still be valid.",
"type": "integer",
"format": "int32"
},
"categories": {
"description": "Gets or sets the optional list of item categories and sub categories that are applicable to the {Trov.Common.Model.Sic.Promotions.Promotion}.",
"items": {
"$ref": "#/definitions/TrovCommonModelSicPromotionsPromotionCategory"
},
"xml": {
"name": "PromotionCategory",
"wrapped": true
},
"type": "array"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "Promotion"
},
"type": "object",
"default": {
"PromoCode": "TESTPROMO",
"TaxCalculation": "BeforeTax",
"PromotionType": "Duration",
"TermsOfPromotionUrl": "http://trov.com/promotions/TEST",
"CreditDurationDays": 30.0,
"PromotionStartUtc": "2017-02-01T15:33:29Z",
"PromotionEndUtc": "2017-04-01T15:33:29Z",
"RedemptionsPerCustomer": 1,
"Categories": [
{
"PromotionId": "1234",
"Category": "Photography",
"SubCategory": "Digital SLR/ System Cameras",
"Created": "0001-01-01T00:00:00"
},
{
"PromotionId": "1234",
"Category": "Photography",
"SubCategory": "Photographic Lenses",
"Created": "0001-01-01T00:00:00"
}
],
"Id": "1234",
"Modified": "0001-01-01T00:00:00",
"Created": "0001-01-01T00:00:00"
}
},
"TrovCommonModelSicPromotionsPromotionCategory": {
"required": [
"promotionId",
"category",
"subCategory"
],
"properties": {
"promotionId": {
"description": "Gets or sets the Id of the associated {Trov.Common.Model.Sic.Promotions.Promotion}.",
"type": "string"
},
"category": {
"description": "Gets or sets the Category of item that the associated {Trov.Common.Model.Sic.Promotions.Promotion} can be applied to.",
"type": "string"
},
"subCategory": {
"description": "Gets or sets the optional Sub-Category of item that the associated {Trov.Common.Model.Sic.Promotions.Promotion} can be applied to.",
"type": "string"
},
"id": {
"type": "string"
}
},
"xml": {
"name": "PromotionCategory"
},
"type": "object",
"default": {
"PromotionId": "1234",
"Category": "Photography",
"SubCategory": "Digital SLR/ System Cameras",
"Created": "0001-01-01T00:00:00"
}
},
"TrovContractAPIUnversionedPromotionGetPromotionQueryRequest": {
"properties": {
"startedBeforeUtc": {
"description": "The promotion to be retrieved starts before this date (optional).",
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "GetPromotionQueryRequest"
},
"type": "object"
},
"PromotionNotFoundException": {
"description": "PromotionNotFoundException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "A promotion with PromoCode string was not found.",
"ExceptionMessage": "A promotion with PromoCode string was not found.",
"ExceptionType": "PromotionNotFoundException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"InvalidDateException": {
"description": "InvalidDateException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "InvalidDateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"InvalidPromotionException": {
"description": "InvalidPromotionException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "'' is an invalid string for this operation.",
"ExceptionMessage": "'' is an invalid string for this operation.",
"ExceptionType": "InvalidPromotionException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"InvalidPromotionTypeException": {
"description": "InvalidPromotionTypeException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "'Unknown' is not a valid PromotionType for this operation.",
"ExceptionMessage": "'Unknown' is not a valid PromotionType for this operation.",
"ExceptionType": "InvalidPromotionTypeException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSicPromotionsPromotionUpdateRequest": {
"description": "Represents a request for a {Trov.Common.Model.Sic.Promotions.Promotion} update.",
"required": [
"promotionId",
"promotionEndUtc",
"redemptionsPerCustomer"
],
"properties": {
"promotionId": {
"description": "Gets or sets the Id that is used to uniquely identify a particular promotion {Trov.Common.Model.Sic.Promotions.Promotion}. This is the promotion that will be updated.",
"type": "string"
},
"promotionEndUtc": {
"description": "Gets or sets the end date after which the {Trov.Common.Model.Sic.Promotions.Promotion} cannot be redeemed by a customer.",
"type": "string",
"format": "date-time"
},
"maxRedemptions": {
"description": "Gets or sets the optional maximum total number of redemptions of the given {Trov.Common.Model.Sic.Promotions.Promotion}.\r\nIf this limit exists, once it is reached the {Trov.Common.Model.Sic.Promotions.Promotion} can no longer be redeemed.",
"type": "integer",
"format": "int32"
},
"redemptionsPerCustomer": {
"description": "Gets or sets the maximum number of times a single customer can redeem the {Trov.Common.Model.Sic.Promotions.Promotion}.\r\nOnce the limit is reached for a customer, that customer cannot apply the given {Trov.Common.Model.Sic.Promotions.Promotion} to any additional items;\r\nany existing redemptions would still be valid.",
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "PromotionUpdateRequest"
},
"type": "object",
"default": {
"PromotionId": "PROMOID",
"PromotionEndUtc": "2017-04-01T15:33:29Z",
"MaxRedemptions": 999,
"RedemptionsPerCustomer": 5
}
},
"PromotionAlreadyRedeemedException": {
"description": "PromotionAlreadyRedeemedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The promotion string cannot be deleted, as it has already been redeemed.",
"ExceptionMessage": "The promotion string cannot be deleted, as it has already been redeemed.",
"ExceptionType": "PromotionAlreadyRedeemedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedQuoteDisplayQuoteResponse": {
"required": [
"minOfficialPremium",
"maxOfficialPremium",
"minUnofficialPremium",
"maxUnofficialPremium",
"isGhostQuote"
],
"properties": {
"minOfficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"maxOfficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"minUnofficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"maxUnofficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"isGhostQuote": {
"type": "boolean"
}
},
"xml": {
"name": "DisplayQuoteResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteStartProtectionRequirementsResponse": {
"required": [
"requirements"
],
"properties": {
"requirements": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteStartProtectionRequirementResponse"
},
"xml": {
"name": "StartProtectionRequirementResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "StartProtectionRequirementsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteStartProtectionRequirementResponse": {
"required": [
"message",
"type",
"requirements"
],
"properties": {
"message": {
"description": "The initial message to display.",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Unknown",
"Photo"
],
"x-enumName": "StartProtectionRequirementType"
},
"requirements": {
"description": "A list of requirements for protection.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"xml": {
"name": "StartProtectionRequirementResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteProtectionBillSummaryResponse": {
"required": [
"billSummaries"
],
"properties": {
"billSummaries": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteBillSummaryResponse"
},
"xml": {
"name": "BillSummaryResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "ProtectionBillSummaryResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteBillSummaryResponse": {
"description": "Represents the next month bill item for an asset.",
"required": [
"value",
"start",
"end"
],
"properties": {
"value": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse",
"description": "Gets or sets the total for the following month."
},
"start": {
"description": "Gets the start date of the bill in the customer's local timezone.",
"example": "2016-09-22T12:53:00",
"type": "string",
"default": "2016-09-22T12:53:00"
},
"end": {
"description": "Gets the end date of the bill in the customer's local timezone.",
"example": "2016-09-22T12:53:00",
"type": "string",
"default": "2016-09-22T12:53:00"
},
"paymentDescriptionText": {
"description": "Gets or sets the text that describes additional information about\r\nhow the total amount due will be collected.",
"type": "string"
}
},
"xml": {
"name": "BillSummaryResponse"
},
"type": "object"
},
"AssetNotCoveredException": {
"description": "AssetNotCoveredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "There are no active coverage periods for this asset.",
"ExceptionMessage": "There are no active coverage periods for this asset.",
"ExceptionType": "AssetNotCoveredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedQuoteCheckoutBillSummaryResponse": {
"required": [
"billSummaries"
],
"properties": {
"billSummaries": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteBillSummaryResponse"
},
"xml": {
"name": "BillSummaryResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "CheckoutBillSummaryResponse"
},
"type": "object"
},
"AssetAlreadyInsuredException": {
"description": "AssetAlreadyInsuredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The asset is already insured.",
"ExceptionMessage": "The asset is already insured.",
"ExceptionType": "AssetAlreadyInsuredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedQuoteCreateQuoteQueryRequest": {
"properties": {
"sessionId": {
"description": "Optional ThreatMetrix session id associated with the quote request.",
"type": "string"
}
},
"xml": {
"name": "CreateQuoteQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteCreateQuoteResponse": {
"required": [
"assetId",
"assetRevision",
"insuredValue",
"priceOffers",
"quoteId",
"showPdsToUser",
"protectionRequirements"
],
"properties": {
"assetId": {
"type": "string"
},
"assetRevision": {
"type": "integer",
"format": "int32"
},
"insuredValue": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"priceOffers": {
"description": "A collection price offers applicable to this quote.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteQuotePriceOfferResponse"
},
"xml": {
"name": "QuotePriceOfferResponse",
"wrapped": true
},
"type": "array"
},
"quoteId": {
"type": "string"
},
"showPdsToUser": {
"description": "Value indicating whether the PDS must be shown to the user before accepting the quote.",
"type": "boolean"
},
"protectionRequirements": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuoteProtectionRequirements"
}
},
"xml": {
"name": "CreateQuoteResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteQuotePriceOfferResponse": {
"required": [
"id",
"excess",
"officialPremium",
"unofficialPremium"
],
"properties": {
"id": {
"type": "string"
},
"excess": {
"$ref": "#/definitions/TrovContractAPILegacyCurrencyResponse"
},
"officialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"unofficialPremium": {
"$ref": "#/definitions/TrovContractAPIUnversionedQuotePremium"
},
"excessPercentage": {
"type": "number",
"format": "double"
},
"pdsSummary": {
"type": "string"
},
"amendatoryEndorsement": {
"type": "string"
}
},
"xml": {
"name": "QuotePriceOfferResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedQuoteProtectionRequirements": {
"required": [
"minimumPictureCount",
"documentConsentRequired"
],
"properties": {
"minimumPictureCount": {
"type": "integer",
"format": "int32"
},
"documentConsentRequired": {
"type": "boolean"
}
},
"xml": {
"name": "ProtectionRequirements"
},
"type": "object"
},
"CategoryNotSupportedException": {
"description": "CategoryNotSupportedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The given asset has a category that is not supported for quotes.",
"ExceptionMessage": "The given asset has a category that is not supported for quotes.",
"ExceptionType": "CategoryNotSupportedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"CustomerBlockedException": {
"description": "CustomerBlockedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The customer is blocked from performing this operation",
"ExceptionMessage": "The customer is blocked from performing this operation",
"ExceptionType": "CustomerBlockedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"CustomerLimitReachedException": {
"description": "CustomerLimitReachedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The customer has reached their insurance limit.",
"ExceptionMessage": "The customer has reached their insurance limit.",
"ExceptionType": "CustomerLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"DeviceNotAutoDetectedException": {
"description": "DeviceNotAutoDetectedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The device cannot be insured",
"ExceptionMessage": "The device cannot be insured",
"ExceptionType": "DeviceNotAutoDetectedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"FraudValidationException": {
"description": "FraudValidationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Fraud validation failed.",
"ExceptionMessage": "Fraud validation failed.",
"ExceptionType": "FraudValidationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ItemLimitReachedException": {
"description": "ItemLimitReachedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The item exceeds the insurance limit.",
"ExceptionMessage": "The item exceeds the insurance limit.",
"ExceptionType": "ItemLimitReachedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ItemValueBelowMinException": {
"description": "ItemValueBelowMinException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Item value is below the minimum.",
"ExceptionMessage": "Item value is below the minimum.",
"ExceptionType": "ItemValueBelowMinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"NoValueEstimateException": {
"description": "NoValueEstimateException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Failed to generate price offer. (BeValuedNoValueEstimate)",
"ExceptionMessage": "Failed to generate price offer. (BeValuedNoValueEstimate)",
"ExceptionType": "NoValueEstimateException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"OfacScreeningFailedException": {
"description": "OfacScreeningFailedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "OFAC screening failed.",
"ExceptionMessage": "OFAC screening failed.",
"ExceptionType": "OfacScreeningFailedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PremiumValueBelowMinException": {
"description": "PremiumValueBelowMinException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The premium value is below the minimum.",
"ExceptionMessage": "The premium value is below the minimum.",
"ExceptionType": "PremiumValueBelowMinException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"ProductIsNotQuotableException": {
"description": "ProductIsNotQuotableException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Product is not quotable. string",
"ExceptionMessage": "Product is not quotable. string",
"ExceptionType": "ProductIsNotQuotableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PaymentProviderChargeException": {
"description": "PaymentProviderChargeException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Payment provider charge failed: string",
"ExceptionMessage": "Payment provider charge failed: string",
"ExceptionType": "PaymentProviderChargeException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PaymentProviderNoPaymentCardConfiguredForCustomerException": {
"description": "PaymentProviderNoPaymentCardConfiguredForCustomerException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "There is no payment card configured in the payment provider for the customer.",
"ExceptionMessage": "There is no payment card configured in the payment provider for the customer.",
"ExceptionType": "PaymentProviderNoPaymentCardConfiguredForCustomerException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PaymentProviderNotConfiguredForCustomerException": {
"description": "PaymentProviderNotConfiguredForCustomerException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The customer has not been configured with the payment provider.",
"ExceptionMessage": "The customer has not been configured with the payment provider.",
"ExceptionType": "PaymentProviderNotConfiguredForCustomerException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PremiumNotAffordableException": {
"description": "PremiumNotAffordableException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Insuring the specified asset would have an unaffordable premium.",
"ExceptionMessage": "Insuring the specified asset would have an unaffordable premium.",
"ExceptionType": "PremiumNotAffordableException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PriceOfferAlreadyAcceptedException": {
"description": "PriceOfferAlreadyAcceptedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The price offer has already been accepted.",
"ExceptionMessage": "The price offer has already been accepted.",
"ExceptionType": "PriceOfferAlreadyAcceptedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PriceOfferExpiredException": {
"description": "PriceOfferExpiredException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The price offer is expired.",
"ExceptionMessage": "The price offer is expired.",
"ExceptionType": "PriceOfferExpiredException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"PriceOfferProtectionRequiresAssetPhotosException": {
"description": "PriceOfferProtectionRequiresAssetPhotosException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "The price offer requires 0 photo(s).",
"ExceptionMessage": "The price offer requires 0 photo(s).",
"ExceptionType": "PriceOfferProtectionRequiresAssetPhotosException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"DocumentConsentNotAcceptedException": {
"description": "DocumentConsentNotAcceptedException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "To start protection for the asset current state document consent acceptance is required.",
"ExceptionMessage": "To start protection for the asset current state document consent acceptance is required.",
"ExceptionType": "DocumentConsentNotAcceptedException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovCommonModelSicRemoteOperationsRemoteAutodetectRequest": {
"description": "Defines a model that represents the remote auto-detect request.",
"required": [
"email"
],
"properties": {
"email": {
"description": "Gets or sets the email address where the device auto-detect invite link should be sent.",
"type": "string",
"pattern": ".+@.+"
},
"trovId": {
"description": "Gets or sets the trov ID.",
"type": "string"
},
"assetId": {
"description": "Gets or sets the asset ID.",
"type": "string"
},
"priceOfferIndex": {
"description": "Gets or sets the price offer index.",
"type": "integer",
"format": "int32"
},
"priceOfferId": {
"description": "Gets or sets the price offer ID. For analytics.",
"type": "string"
}
},
"xml": {
"name": "RemoteAutodetectRequest"
},
"type": "object",
"default": {
"Email": "someone@email.com",
"TrovId": "4d3ed089fb60ab534684b7e1",
"AssetId": "4d3ed089fb60ab534684b7e9",
"PriceOfferIndex": 3
}
},
"TrovCommonModelSicRemoteOperationsRemoteOperationRequest": {
"description": "Defines the model that represents the remote operation requests.",
"properties": {
"trovId": {
"description": "Gets or sets the trov ID.",
"type": "string"
},
"assetId": {
"description": "Gets or sets the asset ID.",
"type": "string"
},
"priceOfferIndex": {
"description": "Gets or sets the price offer index.",
"type": "integer",
"format": "int32"
},
"priceOfferId": {
"description": "Gets or sets the price offer ID. For analytics.",
"type": "string"
}
},
"xml": {
"name": "RemoteOperationRequest"
},
"type": "object",
"default": {
"TrovId": "4d3ed089fb60ab534684b7e1",
"AssetId": "4d3ed089fb60ab534684b7e9",
"PriceOfferIndex": 2,
"PriceOfferId": "pid"
}
},
"TrovContractAPIUnversionedRiskScoringRiskScoringResponse": {
"required": [
"hasPassedPrimaryRiskCheck",
"hasPassedSecondaryRiskCheck",
"riskScore",
"isWhitelisted"
],
"properties": {
"hasPassedPrimaryRiskCheck": {
"type": "boolean"
},
"hasPassedSecondaryRiskCheck": {
"type": "boolean"
},
"riskScore": {
"type": "integer",
"format": "int32"
},
"isWhitelisted": {
"type": "boolean"
}
},
"xml": {
"name": "RiskScoringResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedRiskScoringRiskScoringWhitelistAddRequest": {
"required": [
"customerId"
],
"properties": {
"customerId": {
"type": "string"
}
},
"xml": {
"name": "RiskScoringWhitelistAddRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedRiskScoringRiskScoringWhitelistRemoveRequest": {
"required": [
"customerId"
],
"properties": {
"customerId": {
"type": "string"
}
},
"xml": {
"name": "RiskScoringWhitelistRemoveRequest"
},
"type": "object"
},
"TrovCommonModelSecurityApplicationRoleResult": {
"description": "Represents a {!:TrovRoleName}.",
"properties": {
"id": {
"description": "Gets or sets the id of the role.",
"type": "integer",
"format": "int32"
},
"name": {
"description": "Gets or sets the name of the role.",
"type": "string"
},
"requiresTwoFactor": {
"description": "Gets or sets a value indicating whether the role requires two factor authentication enabled.",
"type": "boolean"
},
"currentUserCanModify": {
"description": "Gets or sets a value indicating whether the current user can modify the disassociate/associate users with the role.",
"type": "boolean"
}
},
"xml": {
"name": "ApplicationRoleResult"
},
"type": "object",
"default": {
"Id": 1,
"Name": "Application Role Result",
"RequiresTwoFactor": false,
"CurrentUserCanModify": true
}
},
"TrovCommonModelSecurityUpdateUserRolesRequest": {
"description": "Represents an update user roles request.",
"required": [
"userId",
"roles"
],
"properties": {
"userId": {
"description": "Gets or sets the id of the user to update the roles for.",
"type": "integer",
"format": "int32"
},
"roles": {
"description": "Gets or sets the roles to update to.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"xml": {
"name": "UpdateUserRolesRequest"
},
"type": "object",
"default": {
"UserId": 1,
"Roles": [
"scorer"
]
}
},
"RoleRequiresTwoFactorAuthenticationException": {
"description": "RoleRequiresTwoFactorAuthenticationException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "string",
"ExceptionMessage": "string",
"ExceptionType": "RoleRequiresTwoFactorAuthenticationException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedStatementsStatementsResponse": {
"required": [
"statements"
],
"properties": {
"statements": {
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedStatementsStatementSummaryResponse"
},
"xml": {
"name": "StatementSummaryResponse",
"wrapped": true
},
"type": "array"
}
},
"xml": {
"name": "StatementsResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedStatementsStatementSummaryResponse": {
"required": [
"statementId",
"label"
],
"properties": {
"statementId": {
"type": "string"
},
"label": {
"type": "string"
}
},
"xml": {
"name": "StatementSummaryResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedStatusStatusResponse": {
"required": [
"statuses",
"overallStatus",
"environmentVariables",
"releaseVersion"
],
"properties": {
"statuses": {
"description": "The list of statuses (e.g. MongoDB, MySQL, etc.).",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedStatusStatusResult"
},
"xml": {
"name": "StatusResult",
"wrapped": true
},
"type": "array"
},
"overallStatus": {
"description": "A value indicating whether the status is in an overall 'good' state.",
"readOnly": true,
"type": "boolean"
},
"environmentVariables": {
"description": "The environment variables for the hosting instance.",
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"releaseVersion": {
"description": "The current release version.",
"type": "string"
},
"buildIdentifier": {
"description": "The identifier of the build package.",
"type": "string"
}
},
"xml": {
"name": "StatusResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedStatusStatusResult": {
"required": [
"name",
"overallStatus"
],
"properties": {
"name": {
"description": "The name of the instance the status represents.",
"type": "string"
},
"overallStatus": {
"description": "Value indicating whether the status is in an overall 'good' state.",
"type": "boolean"
},
"details": {
"description": "Details about the status.",
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"exception": {
"description": "Optional exception thrown while verifying the status.",
"type": "object"
}
},
"xml": {
"name": "StatusResult"
},
"type": "object"
},
"TrovContractAPIUnversionedTestHookPublishToHangfirePlatformRequest": {
"required": [
"managerName",
"methodName"
],
"properties": {
"managerName": {
"description": "The fully qualified name of the manager to invoke.\r\ne.g. 'Trov.Manager.Account.Interface.IAccountManager, Trov.Manager.Account.Interface'.",
"type": "string"
},
"methodName": {
"description": "The name of the method on the manager to invoke.",
"type": "string"
},
"parameters": {
"items": {
"type": "object"
},
"type": "array"
},
"queueName": {
"type": "string"
}
},
"xml": {
"name": "PublishToHangfirePlatformRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedTestHookExecuteScheduledPlatformJobsRequest": {
"required": [
"dateTime"
],
"properties": {
"dateTime": {
"description": "The date/time to execute any scheduled job enqueued before.",
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "ExecuteScheduledPlatformJobsRequest"
},
"type": "object"
},
"TrovCommonModelSecurityTwoFactorSendRequest": {
"description": "Represents a request to send a two-factor authentication code.",
"required": [
"email",
"password"
],
"properties": {
"twoFactorProviderType": {
"description": "Gets or sets the type of two-factor provider to send the request via.",
"type": "integer",
"format": "int32",
"enum": [
0,
1,
3,
4
],
"x-enumName": "TwoFactorProviderType"
},
"email": {
"description": "Gets or sets the email of the user to request login for.",
"type": "string"
},
"password": {
"description": "Gets or sets the password of the user to request login for.",
"type": "string"
}
},
"xml": {
"name": "TwoFactorSendRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedTrovTrovResponse": {
"required": [
"id",
"defaultMarket",
"defaultCulture",
"baseApiUri",
"created"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"defaultMarket": {
"type": "string",
"enum": [
"Unknown",
"US",
"AU",
"GB"
],
"x-enumName": "Market"
},
"defaultCulture": {
"type": "string"
},
"baseApiUri": {
"type": "string"
},
"created": {
"type": "integer",
"format": "int64"
}
},
"xml": {
"name": "TrovResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedUserUserResponse": {
"required": [
"id",
"email",
"emailConfirmed",
"phoneNumberConfirmed",
"twoFactorEnabled",
"createdDateUtc"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"emailConfirmed": {
"description": "A value indicating whether the user email is confirmed.",
"type": "boolean"
},
"phoneNumberConfirmed": {
"description": "A value indicating whether the user phone number is confirmed.",
"type": "boolean"
},
"twoFactorEnabled": {
"description": "A value indicating whether the user has two-factor authentication enabled.",
"type": "boolean"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"createdDateUtc": {
"description": "The date the user was created in UTC.",
"type": "string",
"format": "date-time"
}
},
"xml": {
"name": "UserResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedUserSearchUserQueryRequest": {
"properties": {
"roleName": {
"description": "Optional role name to filter with.",
"type": "string"
},
"email": {
"description": "Optional email to filter with.",
"type": "string"
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
},
"xml": {
"name": "SearchUserQueryRequest"
},
"type": "object"
},
"TrovContractAPIV40GuestGuestUserConversionRequest": {
"required": [
"action",
"sessionId"
],
"properties": {
"action": {
"description": "The conversion action associated with the guest userId.",
"type": "string",
"enum": [
"Register",
"Login",
"FacebookRegister",
"FacebookLogin"
],
"x-enumName": "GuestConversionAction"
},
"sessionId": {
"description": "Unique identifier for the guest session.",
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "GuestUserConversionRequest"
},
"type": "object"
},
"CustomerHasActiveCoveragePeriodsException": {
"description": "CustomerHasActiveCoveragePeriodsException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Customer cannot be deactivated because it has active coverage periods.",
"ExceptionMessage": "Customer cannot be deactivated because it has active coverage periods.",
"ExceptionType": "CustomerHasActiveCoveragePeriodsException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
},
"TrovContractAPIUnversionedUserUserRegistrationRequest": {
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"pattern": ".+@.+"
},
"password": {
"type": "string",
"maxLength": 50,
"minLength": 8
},
"phoneNumber": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"xml": {
"name": "UserRegistrationRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedUserUserRegistrationQueryRequest": {
"properties": {
"sessionId": {
"description": "Optional ThreatMetrix session id associated with the user account creation.",
"type": "string"
},
"guestSessionId": {
"description": "Optional guest session id associated with the user account creation.",
"example": "00000000-0000-0000-0000-000000000000",
"type": "string",
"format": "uuid"
}
},
"xml": {
"name": "UserRegistrationQueryRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedUserUserRegisterResponse": {
"required": [
"trovs",
"user"
],
"properties": {
"trovs": {
"description": "Gets or sets a list of trovs associated with the user.",
"items": {
"$ref": "#/definitions/TrovContractAPIUnversionedTrovTrovResponse"
},
"xml": {
"name": "TrovResponse",
"wrapped": true
},
"type": "array"
},
"user": {
"$ref": "#/definitions/TrovContractAPIUnversionedUserAuthenticatedUserResponse",
"description": "Gets or sets the authenticated user information."
}
},
"xml": {
"name": "UserRegisterResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedUserAuthenticatedUserResponse": {
"required": [
"email",
"userId"
],
"properties": {
"username": {
"description": "Gets or sets the username.",
"type": "string"
},
"firstName": {
"description": "Gets or sets the user's first name.",
"type": "string"
},
"lastName": {
"description": "Gets or sets the user's last name.",
"type": "string"
},
"email": {
"description": "Gets or sets the user's email address.",
"type": "string"
},
"phoneNumber": {
"description": "Gets or sets the user's phone number.",
"type": "string"
},
"securityToken": {
"description": "Gets or sets the security token issued by the authentication service.",
"type": "string"
},
"userId": {
"description": "Gets or sets the user's unique id.",
"type": "integer",
"format": "int32"
},
"serviceList": {
"description": "Gets or sets the unique set of services the user has access to.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"isNewUser": {
"description": "Gets or sets a value indicating whether the user was created in the request.",
"type": "boolean"
}
},
"xml": {
"name": "AuthenticatedUserResponse"
},
"type": "object"
},
"TrovContractAPIUnversionedUserTokenAddDeviceTokenRequest": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
],
"x-enumName": "DeviceTokenType"
},
"value": {
"type": "string"
}
},
"xml": {
"name": "AddDeviceTokenRequest"
},
"type": "object"
},
"TrovContractAPIUnversionedUserTokenRemoveDeviceTokenRequest": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
],
"x-enumName": "DeviceTokenType"
},
"value": {
"type": "string"
}
},
"xml": {
"name": "RemoveDeviceTokenRequest"
},
"type": "object"
},
"TrovCommonModelAssetsWoozAssetResult": {
"description": "Represents a wooz asset result.",
"required": [
"id",
"rootId",
"created",
"hasPendingAccessor"
],
"properties": {
"id": {
"description": "Gets or sets the unique id of the result.",
"type": "string"
},
"rootId": {
"description": "Gets or sets the root id of the asset.",
"type": "string"
},
"created": {
"description": "Gets or sets the date the asset was created.",
"type": "integer",
"format": "int64"
},
"hasPendingAccessor": {
"description": "Gets or sets a value indicating whether an access request has been issues for the result.",
"type": "boolean"
}
},
"xml": {
"name": "WoozAssetResult"
},
"type": "object",
"default": {
"Id": "4d3ed089fb60ab534684b7fb",
"Created": 130982766720000000,
"HasPendingAccessor": false
}
},
"TrovCommonModelCoreWoozAccessResult": {
"description": "A model that represents a wooz access result.",
"properties": {
"hasPendingAccessor": {
"description": "Gets or sets a value indicating whether the wooz object has a pending accessor.",
"type": "boolean"
},
"trovId": {
"description": "Gets or sets the id of the trov being accessed.",
"type": "string"
},
"assetId": {
"description": "Gets or sets the id of the asset being accessed.",
"type": "string"
},
"signature": {
"description": "Gets or sets the signature of the access request.",
"type": "string"
},
"expire": {
"description": "Gets or sets the expiry timestamp of the access request.",
"type": "string"
}
},
"xml": {
"name": "WoozAccessResult"
},
"type": "object",
"default": {
"HasPendingAccessor": false,
"TrovId": "4d3ed089fb60ab534684b7e1",
"AssetId": "4d3ed089fb60ab534684b7e0",
"Signature": "jf843yfgjh93yrog9rey3htid98dsbhmvcpd0389jh5rj",
"Expire": "1/26/2016 10:11:12 AM"
}
},
"WozAccessNotEnabledException": {
"description": "WozAccessNotEnabledException",
"required": [
"Message",
"ExceptionType",
"CorrelationId"
],
"properties": {
"Message": {
"type": "string"
},
"ExceptionMessage": {
"type": "string"
},
"ExceptionType": {
"type": "string"
},
"StackTrace": {
"type": "string"
},
"CorrelationId": {
"type": "string"
}
},
"type": "object",
"default": {
"Message": "Woz access is not enabled for this trov.",
"ExceptionMessage": "Woz access is not enabled for this trov.",
"ExceptionType": "WozAccessNotEnabledException",
"CorrelationId": "00000000-0000-0000-0000-000000000000"
}
}
},
"tags": [
{
"name": "Account",
"description": "Defines the API endpoints associated with managing Trov accounts."
},
{
"name": "AccountStatus",
"description": "Defines the API endpoints associated with the current status of the customer's account and their on demand refunds."
},
{
"name": "Analytics",
"description": "Defines the API endpoints associated with supplying analytics with data."
},
{
"name": "Assets",
"description": "Defines the API endpoints associated with asset requests."
},
{
"name": "AutoSuggest",
"description": "Defines the API endpoints associated with autosuggestions."
},
{
"name": "Chatbot"
},
{
"name": "Claims",
"description": "Defines the API endpoints associated with SIC claims."
},
{
"name": "ClaimsEmployee",
"description": "Defines the API endpoints associated with SIC claims by a SicAdmin, SicSupportAdmin, SicSupportUser or OpsSupportAdmin."
},
{
"name": "ClientAdmin",
"description": "Defines the API endpoints associated with managing OAuth clients."
},
{
"name": "Configuration",
"description": "Defines the API endpoints associated with configuration requests."
},
{
"name": "CoveredAssetsEmployee",
"description": "Defines the API endpoints associated with providing access to covered assets for employees."
},
{
"name": "CustomerNotesEmployee",
"description": "Defines the API endpoints associated with SIC customer notes."
},
{
"name": "CustomersEmployee",
"description": "Defines the API endpoints associated with SIC customers."
},
{
"name": "Disclosure",
"description": "Defines the API endpoints associated with displaying disclosures."
},
{
"name": "DocumentConsent"
},
{
"name": "DocumentConsentContentEmployee"
},
{
"name": "EmployeesEmployee",
"description": "Defines the API endpoints associated with SIC employees."
},
{
"name": "ExperimentEmployee"
},
{
"name": "ExternalToken",
"description": "Defines the API endpoints associated with authorization tokens for various services."
},
{
"name": "Files",
"description": "Defines the API endpoints associated with file requests."
},
{
"name": "Fraud",
"description": "Defines the API endpoints associated with fraud"
},
{
"name": "Guest",
"description": "Defines the API endpoints for guests to register, search and quote\r\nAll endpoints will be throttled"
},
{
"name": "Images",
"description": "Defines the API endpoints associated with image requests."
},
{
"name": "Metadata",
"description": "Defines the API endpoints associated with asset metadata."
},
{
"name": "PaymentCards",
"description": "Defines the API endpoints associated with payment cards for SIC customers."
},
{
"name": "Pds",
"description": "Defines the API endpoints associated with product disclosure and amendatory endorsement documents."
},
{
"name": "PdsEmployee",
"description": "Defines the API endpoints associated with managing product disclosure and amendatory endorsement documents."
},
{
"name": "PremiumCalculationEmployee",
"description": "Defines the administrative API endpoints associated with SIC premium calculations."
},
{
"name": "PricingFileEmployee",
"description": "Defines the API endpoints associated with employees for quoting information"
},
{
"name": "Profile",
"description": "Defines the API endpoints associated with profile requests."
},
{
"name": "ProfileEmployee",
"description": "Defines the API endpoints associated with user profiles by a SicAdmin, SicSupportAdmin or SicSupportUser."
},
{
"name": "PromotionsEmployee",
"description": "Defines the API endpoints associated with SIC Promotions by a SicAdmin or SicSupportAdmin."
},
{
"name": "Quotes",
"description": "Defines the API endpoints associated with quotes."
},
{
"name": "RefreshToken",
"description": "Defines the API endpoints associated with managing refresh tokens."
},
{
"name": "RemoteOperations",
"description": "Defines the API endpoints that are sending remote authorization tokens and operation combos for various services."
},
{
"name": "RiskScoringEmployee",
"description": "Defines the API endpoints associated with employees for risk scoring customers."
},
{
"name": "RoleAdmin",
"description": "Defines the API endpoints associated with administrating roles."
},
{
"name": "Statements",
"description": "Defines the API endpoints associated with retrieving the customer's billing Statement documents."
},
{
"name": "Status",
"description": "Defines the API endpoints associated with status requests."
},
{
"name": "Suggestions",
"description": "Defines the API endpoints associated with Suggestions."
},
{
"name": "TestHook",
"description": "Defines the API endpoints for testing server functions and configuring test data."
},
{
"name": "Token",
"description": "Defines the API endpoints associated with logging into Trov system via OAuth 2.0."
},
{
"name": "TrovAdmin",
"description": "Defines the API endpoints associated with trov admin requests."
},
{
"name": "Trovs",
"description": "Defines the API endpoints associated with trov requests."
},
{
"name": "UserAdmin",
"description": "Defines the API endpoints associated with administrating users."
},
{
"name": "Users",
"description": "Defines the API endpoints associated with user requests."
},
{
"name": "UserToken",
"description": "Defines the API endpoints associated with user token requests."
},
{
"name": "Version",
"description": "Defines the API endpoints associated with version requests."
},
{
"name": "Wooz",
"description": "Defines the API endpoints associated with wooz requests."
}
]
}