{
"Account": {
"putApiAccountEmail": {
"spec": {
"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/ChangeEmailRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/account/email"
},
"putApiAccountPassword": {
"spec": {
"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/ChangePasswordRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/account/password"
},
"postApiAccountPassword": {
"spec": {
"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/SetPasswordRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/password"
},
"putApiAccountTwoFactorAuthentication": {
"spec": {
"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/ToggleTwoFactorAuthenticationRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/account/twoFactorAuthentication"
},
"putApiAccountPhoneNumber": {
"spec": {
"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/ChangePhoneNumberRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/account/phoneNumber"
},
"postApiAccountLogoff": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/logoff"
},
"postApiAccountResetPassword": {
"spec": {
"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/ResetPasswordRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/resetPassword"
},
"postApiAccountPhoneNumberConfirm": {
"spec": {
"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/ConfirmPhoneNumberRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/phoneNumber/confirm"
},
"postApiAccountEmailRequestConfirm": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/email/requestConfirm"
},
"postApiAccountPhoneNumberRequestConfirm": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account/phoneNumber/requestConfirm"
}
},
"AccountStatus": {
"getApiAccountStatusSummary": {
"spec": {
"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/AccountStatusSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/account-status/summary"
},
"getApiAccountStatusDetailed": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/account-status/detailed"
},
"postApiAccountStatusOnDemandRefund": {
"spec": {
"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/OnDemandRefundResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/account-status/on-demand-refund"
}
},
"Analytics": {
"postApiAnalyticsGenerate": {
"spec": {
"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/GenerateAnalyticsDataRequest"
}
},
{
"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/GenerateAnalyticsDataResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/analytics/generate"
}
},
"Assets": {
"getApiTrovsTrovIdAssetsAssetIdAssetStatus": {
"spec": {
"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/AssetStatusResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}/asset-status"
},
"getApiTrovsTrovIdAssetsAssetId": {
"spec": {
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}"
},
"putApiTrovsTrovIdAssetsAssetId": {
"spec": {
"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/AssetUpdateRequest"
}
},
{
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}"
},
"deleteApiTrovsTrovIdAssetsAssetId": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}"
},
"getApiTrovsTrovIdAssets": {
"spec": {
"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/AssetsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/assets"
},
"postApiTrovsTrovIdAssets": {
"spec": {
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trovs/{trovId}/assets"
},
"getApiTrovsTrovIdAssetsTrash": {
"spec": {
"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/AssetResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/assets/trash"
},
"postApiTrovsTrovIdAssetsAssetIdRequestWoz": {
"spec": {
"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
},
"method": "post",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}/requestWoz"
}
},
"AutoSuggest": {
"getApiAutosuggest": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/autosuggest"
}
},
"Chatbot": {
"postChatbotApiMessages": {
"spec": {
"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/Activity"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/chatbot/api/messages"
}
},
"Claims": {
"getApiSicClaimClaimId": {
"spec": {
"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/GetClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/claim/{claimId}"
},
"getApiSicAssetAssetIdClaims": {
"spec": {
"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/GetClaimsForAssetResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/asset/{assetId}/claims"
},
"getApiSicClaimClaimIdEvents": {
"spec": {
"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/GetClaimEventsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/claim/{claimId}/events"
},
"postApiSicClaimClaimIdPhoto": {
"spec": {
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/photo"
},
"postApiSicClaimClaimIdCancel": {
"spec": {
"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/CancelClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/cancel"
},
"postApiSicClaimClaimIdSubmit": {
"spec": {
"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/SubmitClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/submit"
},
"postApiSicClaimClaimIdMessage": {
"spec": {
"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/AddClaimMessageRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/message"
},
"postApiSicClaimClaimIdDescription": {
"spec": {
"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/AddClaimDescriptionRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/description"
},
"postApiSicClaimClaimIdBankAccount": {
"spec": {
"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/UpdateClaimBankAccountRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/bank-account"
},
"postApiSicClaimClaimIdPaymentCard": {
"spec": {
"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/UpdateClaimPaymentCardRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/payment-card"
},
"postApiSicClaimClaimIdPhoneNumber": {
"spec": {
"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/UpdateClaimPhoneNumberRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/phone-number"
},
"postApiSicClaims": {
"spec": {
"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/CreateClaimRequest"
}
},
{
"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/CreateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claims"
},
"postApiSicClaimClaimIdIncidentDate": {
"spec": {
"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/UpdateClaimIncidentDateRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/incident-date"
},
"postApiSicClaimClaimIdIncidentTime": {
"spec": {
"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/UpdateClaimIncidentTimeRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/incident-time"
},
"postApiSicClaimClaimIdIncidentType": {
"spec": {
"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/UpdateClaimIncidentTypeRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/incident-type"
},
"postApiSicClaimClaimIdIncidentLocation": {
"spec": {
"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/UpdateClaimIncidentLocationRequest"
}
},
{
"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/UpdateClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/claim/{claimId}/incident-location"
}
},
"ClaimsEmployee": {
"getApiSicClaims": {
"spec": {
"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/GetClaimsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/claims"
},
"getApiSicCustomerCustomerIdClaimClaimId": {
"spec": {
"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/ClaimDetailsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}"
},
"getApiSicCustomerCustomerIdClaimClaimIdEvents": {
"spec": {
"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/GetClaimEventDetailsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/events"
},
"getApiSicCustomerCustomerIdClaimClaimIdStatus": {
"spec": {
"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/GetClaimStatusResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/status"
},
"getApiSicCustomerCustomerIdClaimClaimIdProtectionSummary": {
"spec": {
"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/GetProtectionSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/protection-summary"
},
"getApiSicCustomerCustomerIdClaimClaimIdSettlementSummary": {
"spec": {
"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/GetSettlementSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/settlement-summary"
},
"postApiSicCustomerCustomerIdClaimClaimIdDeny": {
"spec": {
"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/DenyClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/deny"
},
"postApiSicCustomerCustomerIdClaimClaimIdClose": {
"spec": {
"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/CloseClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/close"
},
"postApiSicCustomerCustomerIdClaimClaimIdAccept": {
"spec": {
"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/AcceptClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/accept"
},
"postApiSicCustomerCustomerIdClaimClaimIdReopen": {
"spec": {
"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/ReopenClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/reopen"
},
"postApiSicCustomerCustomerIdClaimClaimIdSettle": {
"spec": {
"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/SettleClaimResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/settle"
},
"postApiSicCustomerCustomerIdClaimClaimIdMessage": {
"spec": {
"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/AddClaimMessageRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/message"
},
"postApiSicCustomerCustomerIdClaimClaimIdAssetCustomerAssetIdClaimAmount": {
"spec": {
"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/UpdateAssetClaimAmountRequest"
}
},
{
"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/UpdateAssetClaimAmountResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/asset/{customerAssetId}/claim-amount"
},
"postApiSicCustomerCustomerIdClaimClaimIdAssetCustomerAssetIdSettlementMethod": {
"spec": {
"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/SetSettlementMethodRequest"
}
},
{
"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/SetSettlementMethodResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/claim/{claimId}/asset/{customerAssetId}/settlement-method"
}
},
"ClientAdmin": {
"getApiAdminClient": {
"spec": {
"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/ClientResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/admin/client"
},
"postApiAdminClient": {
"spec": {
"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/CreateClientRequest"
}
},
{
"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/ClientResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/admin/client"
},
"putApiAdminClientClientIdIsActiveIsActive": {
"spec": {
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/admin/client/{clientId}/isActive/{isActive}"
}
},
"Configuration": {
"getApiDefinitions": {
"spec": {
"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/IDefinitions"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/definitions"
},
"getApiPublishableKeys": {
"spec": {
"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/PublishableKeysResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/publishableKeys"
}
},
"CoveredAssetsEmployee": {
"getApiSicCustomerCustomerIdAssetCustomerAssetId": {
"spec": {
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/asset/{customerAssetId}"
},
"getApiSicCustomerCustomerIdAssetCustomerAssetIdFiles": {
"spec": {
"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/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"audio": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"building": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"collection": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"document": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"file": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"floor": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"image": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"property": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"room": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"trov": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"userInvite": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"user": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"video": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"sitemap": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"trovInvite": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"index": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"floorPlan": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"xml": {
"name": "FileInfoResponse",
"wrapped": true
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"$ref": "#/definitions/FileInfoResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/asset/{customerAssetId}/files"
}
},
"CustomerNotesEmployee": {
"getApiSicCustomerCustomerIdNotes": {
"spec": {
"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/CustomerNote"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/notes"
},
"postApiSicCustomerCustomerIdNotes": {
"spec": {
"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/CreateCustomerNoteRequest"
}
},
{
"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/CustomerNote"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/notes"
}
},
"CustomersEmployee": {
"getApiSicCustomerCustomerId": {
"spec": {
"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/CustomerResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}"
},
"patchApiSicCustomerCustomerId": {
"spec": {
"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/CustomerUpdateRequest"
}
},
{
"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/CustomerResponse"
}
},
"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"
}
}
}
}
},
"method": "patch",
"path": "/api/v4.0/sic/customer/{customerId}"
},
"getApiSicCustomerCustomerIdAudits": {
"spec": {
"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/CustomerAuditResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/audits"
},
"getApiSicCustomerCustomerIdFraudClaimId": {
"spec": {
"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/CustomerFraudSignals"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/fraud/{claimId}"
},
"getApiSicCustomers": {
"spec": {
"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/CustomerResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customers"
},
"getApiSicCustomerCustomerIdProfileResults": {
"spec": {
"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/CustomerFraudProfilingResult"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/customer/{customerId}/profileResults"
},
"postApiSicCustomerCustomerIdHardBlock": {
"spec": {
"tags": [
"CustomersEmployee"
],
"summary": "Hard block an existing customer to prevent it from using any insurance feature.",
"operationId": "POST_api_sic_customer_customerId_hard_block",
"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": "request",
"in": "body",
"description": "The model that represents the update information.",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateCustomerIsHardBlockedRequest"
}
},
{
"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": "OK",
"schema": {
"type": "object"
}
},
"401 AuthenticationException": {
"description": "The current user is not a SIC admin.",
"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 admin 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 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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/hard-block"
},
"postApiSicCustomerQuotesStopCustomerId": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/quotes/stop/{customerId}"
},
"postApiSicCustomerCustomerIdOfacScreen": {
"spec": {
"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/OfacScreeningResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/{customerId}/ofac-screen"
},
"postApiSicCustomerQuotesStopCustomerIdEndOfBillingCycle": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/customer/quotes/stop/{customerId}/endOfBillingCycle"
}
},
"Disclosure": {
"getApiDisclosureFraud": {
"spec": {
"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/FraudDisclosureResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/disclosure/fraud"
}
},
"DocumentConsent": {
"getApiConsentDocumentType": {
"spec": {
"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/DocumentConsentStatusResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/consent/{documentType}"
},
"postApiConsent": {
"spec": {
"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/CreateDocumentConsentRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/consent"
}
},
"DocumentConsentContentEmployee": {
"getApiConsentContentDocumentType": {
"spec": {
"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/DocumentConsentContentResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/consent-content/{documentType}"
},
"postApiConsentContent": {
"spec": {
"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/CreateDocumentConsentContentRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/consent-content"
},
"postApiConsentContentAssign": {
"spec": {
"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/AssignDocumentConsentContentToStateRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/consent-content/assign"
}
},
"EmployeesEmployee": {
"getApiSicEmployeeAudits": {
"spec": {
"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/EmployeeAudit"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/employee/audits"
},
"getApiSicEmployeeEmployeeId": {
"spec": {
"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/IEmployee"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/employee/{employeeId}"
},
"putApiSicEmployeeEmployeeId": {
"spec": {
"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/UpdateEmployeeRequest"
}
},
{
"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/IEmployee"
}
},
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/sic/employee/{employeeId}"
},
"deleteApiSicEmployeeEmployeeId": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/sic/employee/{employeeId}"
},
"getApiSicEmployeeEmployeeIdAudits": {
"spec": {
"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/EmployeeAudit"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/employee/{employeeId}/audits"
},
"getApiSicEmployees": {
"spec": {
"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/IEmployee"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/employees"
},
"postApiSicEmployees": {
"spec": {
"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/CreateEmployeeRequest"
}
},
{
"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/IEmployee"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/employees"
}
},
"ExperimentEmployee": {
"getApiExperimentsPricingFiles": {
"spec": {
"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/GetAllPricingFileExperimentsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/experiments/pricing-files"
},
"postApiExperimentsPricingFiles": {
"spec": {
"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/CreatePricingFileExperimentRequest"
}
},
{
"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/CreatePricingFileExperimentResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/experiments/pricing-files"
},
"postApiExperimentsPricingFilesExperimentIdStatus": {
"spec": {
"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/UpdatePricingFileExperimentRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/experiments/pricing-files/{experimentId}/status"
}
},
"ExternalToken": {
"getApiSicTokenCurrencyCloud": {
"spec": {
"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/AuthTokenResult"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/token/currencyCloud"
}
},
"Files": {
"getApiFilesFileIdInfo": {
"spec": {
"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/IFileInfo"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/files/{fileId}/info"
},
"getApiFilesFileId": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/files/{fileId}"
},
"getApiItemsItemIdFiles": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/items/{itemId}/files"
},
"postApiItemsItemIdFiles": {
"spec": {
"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/IFileInfoResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/items/{itemId}/files"
},
"getApiItemsItemIdFilesInfo": {
"spec": {
"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/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"audio": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"building": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"collection": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"document": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"file": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"floor": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"image": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"property": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"room": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"trov": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"userInvite": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"user": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"video": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"sitemap": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"trovInvite": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"index": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"floorPlan": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"xml": {
"name": "IFileInfo",
"wrapped": true
},
"type": "array"
},
"bulkTrovInvite": {
"items": {
"$ref": "#/definitions/IFileInfo"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/items/{itemId}/files/info"
},
"deleteApiItemsItemIdFilesFileIdList": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/items/{itemId}/files/{fileIdList}"
}
},
"Fraud": {
"getApiFraudSessionId": {
"spec": {
"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/FraudProfilingSuccessResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/fraud/{sessionId}"
}
},
"Guest": {
"getApiGuestsSuggestionGroups": {
"spec": {
"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/SuggestionsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/guests/suggestion-groups"
},
"postApiGuestsQuote": {
"spec": {
"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/GuestQuoteRequest"
}
},
{
"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/GuestQuoteResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/guests/quote"
},
"postApiGuestsTextToDownload": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/guests/textToDownload"
},
"postApiGuestsSearchId": {
"spec": {
"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/GuestSearchIdRequest"
}
},
{
"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/GuestSearchIdResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/guests/search-id"
},
"postApiGuestsSearchProduct": {
"spec": {
"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/GuestSearchProductRequest"
}
},
{
"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/GuestSearchProductResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/guests/search-product"
}
},
"Images": {
"getApiImagesFileId": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/images/{fileId}"
},
"getApiTrovsTrovIdAssetsAssetIdThumbnail": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/assets/{assetId}/thumbnail"
}
},
"Metadata": {
"getApiMetadataCategories": {
"spec": {
"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/AssetCategoriesResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/metadata/categories"
},
"getApiMetadataCategoryCategoryId": {
"spec": {
"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/AssetCategoryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/metadata/category/{categoryId}"
},
"postApiMetadataEnrichOtherPhone": {
"spec": {
"tags": [
"Metadata"
],
"summary": "Enriches the provided phone information with additional data.",
"operationId": "POST_api_metadata_enrich_other_phone",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "phoneEnrichmentRequest",
"in": "header",
"description": "The asset to enrich.",
"required": true
},
{
"name": "requestQuery",
"in": "header",
"description": "Query request parameters.",
"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": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/other-phone"
},
"postApiMetadataEnrichUserAddedAsset": {
"spec": {
"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/EnrichUserAddedAssetRequest"
}
},
{
"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/EnrichUserAddedAssetResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/user-added-asset"
},
"postApiMetadataEnrichPhone": {
"spec": {
"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/PhoneEnrichmentRequest"
}
},
{
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/phone"
},
"postApiMetadataEnrichSearchId": {
"spec": {
"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/SearchIdRequest"
}
},
{
"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/SearchIdResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/search-id"
},
"postApiMetadataEnrichSearchProduct": {
"spec": {
"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/SearchProductRequest"
}
},
{
"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/SearchProductResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/search-product"
},
"postApiMetadataEnrichSearchProperty": {
"spec": {
"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/SearchPropertyRequest"
}
},
{
"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/SearchPropertyResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/search-property"
},
"postApiMetadataEnrichAssets": {
"spec": {
"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/IAsset"
}
},
{
"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/IAsset"
},
"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
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"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
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 3,
"Id": "49118839"
},
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Title365",
"CategoryId": "123",
"CategoryName": "Single-Family Homes",
"Level": 1
},
{
"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
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"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
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 3,
"Id": "49118839"
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/metadata/enrich/assets"
}
},
"PaymentCards": {
"getApiSicPaymentCards": {
"spec": {
"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/PaymentCardResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/sic/paymentCards"
},
"postApiSicPaymentCards": {
"spec": {
"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/AddPaymentCardRequest"
}
},
{
"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/PaymentCardResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/paymentCards"
},
"putApiSicPaymentCard": {
"spec": {
"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/PaymentCardUpdateRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/sic/paymentCard"
},
"putApiSicPaymentCardDefaultCardId": {
"spec": {
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/sic/paymentCard/{defaultCardId}"
},
"deleteApiSicPaymentCardCardId": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/sic/paymentCard/{cardId}"
}
},
"Pds": {
"getApiPds": {
"spec": {
"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/ProductDisclosureResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/pds"
}
},
"PdsEmployee": {
"postApiPds": {
"spec": {
"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/CreateProductDisclosureSummaryRequest"
}
},
{
"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/ProductDisclosureSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/pds"
},
"getApiPdsHistory": {
"spec": {
"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/ProductDisclosureSummaryResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/pds/history"
},
"getApiPdsRegional": {
"spec": {
"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/ProductDisclosureSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/pds/regional"
},
"getApiPdsUriPdsVersion": {
"spec": {
"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/ProductDisclosureSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/pds/uri/{pdsVersion}"
},
"getApiAmendatoryEndorsementStateOfResidenceHistory": {
"spec": {
"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/AmendatoryEndorsementResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/amendatoryEndorsement/{stateOfResidence}/history"
},
"postApiAmendatoryEndorsement": {
"spec": {
"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/CreateAmendatoryEndorsementRequest"
}
},
{
"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/AmendatoryEndorsementResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/amendatoryEndorsement"
}
},
"PremiumCalculationEmployee": {
"postApiSicPremiumTest": {
"spec": {
"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/PremiumCalculationRequest"
}
},
{
"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/PremiumCalculationResultsResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/premium/test"
},
"postApiSicPremiumTestBulk": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/premium/test/bulk"
}
},
"PricingFileEmployee": {
"getApiTrovQuoteCategories": {
"spec": {
"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/SupportedQuoteCategoriesResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trov/quote/categories"
}
},
"Profile": {
"getApiProfile": {
"spec": {
"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/Profile"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/profile"
},
"putApiProfileCustomer": {
"spec": {
"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/CustomerProfile"
}
},
{
"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/Profile"
}
},
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/profile/customer"
},
"postApiProfilePhotosProfile": {
"spec": {
"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/Profile"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/profile/photos/profile"
},
"postApiProfilePhotosBackground": {
"spec": {
"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/Profile"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/profile/photos/background"
}
},
"ProfileEmployee": {
"getApiProfileUserId": {
"spec": {
"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/Profile"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/profile/{userId}"
}
},
"PromotionsEmployee": {
"getApiPromotions": {
"spec": {
"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/Promotion"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/promotions"
},
"getApiPromotionPromoCode": {
"spec": {
"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/Promotion"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/promotion/{promoCode}"
},
"postApiPromotion": {
"spec": {
"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/Promotion"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/promotion"
},
"patchApiPromotion": {
"spec": {
"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/PromotionUpdateRequest"
}
},
{
"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"
}
}
}
}
},
"method": "patch",
"path": "/api/v4.0/promotion"
},
"deleteApiPromotionPromotionId": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/promotion/{promotionId}"
}
},
"Quotes": {
"getApiTrovTrovIdAssetAssetIdDisplayQuote": {
"spec": {
"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/DisplayQuoteResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trov/{trovId}/asset/{assetId}/display-quote"
},
"getApiTrovTrovIdQuotePriceOfferIdStartRequirements": {
"spec": {
"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/StartProtectionRequirementsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trov/{trovId}/quote/{priceOfferId}/start-requirements"
},
"getApiTrovTrovIdAssetAssetIdProtectionBillingSummaryBillingCycleCount": {
"spec": {
"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/ProtectionBillSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trov/{trovId}/asset/{assetId}/protection-billing-summary/{billingCycleCount}"
},
"getApiTrovTrovIdPriceOfferPriceOfferIdCheckoutBillingSummaryBillingCycleCount": {
"spec": {
"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/CheckoutBillSummaryResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trov/{trovId}/price-offer/{priceOfferId}/checkout-billing-summary/{billingCycleCount}"
},
"postApiTrovTrovIdQuotesStop": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trov/{trovId}/quotes/stop"
},
"postApiTrovTrovIdAssetAssetIdStopInsurance": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trov/{trovId}/asset/{assetId}/stop-insurance"
},
"postApiTrovTrovIdQuoteAssetId": {
"spec": {
"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/CreateQuoteResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trov/{trovId}/quote/{assetId}"
},
"postApiTrovTrovIdQuotePriceOfferIdStartProtection": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trov/{trovId}/quote/{priceOfferId}/start-protection"
}
},
"RefreshToken": {
"deleteApiRefreshTokenRefreshToken": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/refreshToken/{refreshToken}"
}
},
"RemoteOperations": {
"postApiSicTokenRequestRemoteAutoDetect": {
"spec": {
"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/RemoteAutodetectRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/token/requestRemoteAutoDetect"
},
"postApiSicTokenRequestRemoteLoginAndAutodetect": {
"spec": {
"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/RemoteOperationRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/sic/token/requestRemoteLoginAndAutodetect"
}
},
"RiskScoringEmployee": {
"getApiRiskScoreCustomerId": {
"spec": {
"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/RiskScoringResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/risk/score/{customerId}"
}
},
"RoleAdmin": {
"getApiAdminRole": {
"spec": {
"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/ApplicationRoleResult"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/admin/role"
},
"postApiAdminRole": {
"spec": {
"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/UpdateUserRolesRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/admin/role"
}
},
"Statements": {
"getApiStatements": {
"spec": {
"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/StatementsResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/statements"
},
"getApiStatementStatementId": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/statement/{statementId}"
}
},
"Status": {
"getApiStatus": {
"spec": {
"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/StatusResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/status"
},
"getApiStatusInternal": {
"spec": {
"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/StatusResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/status/internal"
}
},
"Suggestions": {
"getApiSuggestionGroups": {
"spec": {
"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/SuggestionGroup"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/suggestionGroups"
},
"putApiSuggestionGroups": {
"spec": {
"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/SuggestionGroup"
},
"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/SuggestionGroup"
},
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/suggestionGroups"
},
"getApiSuggestionGroupsTrovId": {
"spec": {
"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/SuggestionGroup"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/suggestionGroups/{trovId}"
},
"getApiSuggestionsSuggestionIdAddedAssetsTrovId": {
"spec": {
"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/IAsset"
},
"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
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"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
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 3,
"Id": "49118839"
},
{
"Type": 4,
"Id": "68890082"
}
],
"ExternalCategories": [
{
"Provider": "Title365",
"CategoryId": "123",
"CategoryName": "Single-Family Homes",
"Level": 1
},
{
"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
}
},
"Purchase": {
"Date": "1/26/2016",
"Amount": {
"Type": 0,
"Value": 167944810
},
"Vendor": "Sotheby's International Realty"
},
"ReplacementValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"ValuedBy": "Zestimate by Zillow"
},
"FairMarketValue": {
"Date": "2016-01-26T00:00:00Z",
"Value": {
"Type": 0,
"Value": 167944810
},
"HighValue": {
"Type": 0,
"Value": 177944810
},
"LowValue": {
"Type": 0,
"Value": 157944810
},
"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
},
"Stories": 4,
"Bedrooms": 25,
"Bathrooms": 8,
"YearBuilt": 1994
}
},
"ExternalIdentifiers": [
{
"Type": 3,
"Id": "49118839"
},
{
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/suggestions/{suggestionId}/addedAssets/{trovId}"
}
},
"TestHook": {
"postApiTestSentEmails": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/test/sentEmails"
},
"postApiTestPublishToPlatformHangfire": {
"spec": {
"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/PublishToHangfirePlatformRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/test/publish-to-platform-hangfire"
},
"postApiTestExecuteScheduledPlatformJobs": {
"spec": {
"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/ExecuteScheduledPlatformJobsRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/test/execute-scheduled-platform-jobs"
},
"postApiTestNotificationQueue": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/test/notification/queue"
}
},
"Token": {
"postApiTokenTwoFactor": {
"spec": {
"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/TwoFactorSendRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/token/twoFactor"
},
"tokenToken": {
"spec": {
"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"
}
}
}
},
"method": "post",
"path": "/api/token"
}
},
"TrovAdmin": {
"getApiAdminTrovs": {
"spec": {
"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/TrovResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/admin/trovs"
}
},
"Trovs": {
"getApiTrovs": {
"spec": {
"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/TrovResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs"
},
"postApiTrovs": {
"spec": {
"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/TrovResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trovs"
},
"getApiTrovsTrovId": {
"spec": {
"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/TrovResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}"
},
"getApiTrovsTrovIdSettings": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/trovs/{trovId}/settings"
},
"postApiTrovsTrovIdSettings": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/trovs/{trovId}/settings"
}
},
"UserAdmin": {
"getApiAdminUserUserId": {
"spec": {
"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/UserResponse"
}
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/admin/user/{userId}"
},
"getApiAdminUser": {
"spec": {
"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/UserResponse"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/admin/user"
}
},
"Users": {
"postApiUsersConversion": {
"spec": {
"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/GuestUserConversionRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/users/conversion"
},
"postApiUsersDeactivate": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/users/deactivate"
},
"postApiUsers": {
"spec": {
"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/UserRegistrationRequest"
}
},
{
"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/UserRegisterResponse"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/users"
}
},
"UserToken": {
"putApiUsersTokens": {
"spec": {
"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/AddDeviceTokenRequest"
}
},
{
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/users/tokens"
},
"postApiUsersTokensDelete": {
"spec": {
"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/RemoveDeviceTokenRequest"
}
},
{
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/users/tokens/delete"
},
"deleteApiUsersTokensTokenTypeTokenValue": {
"spec": {
"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
},
"method": "delete",
"path": "/api/v4.0/users/tokens/{tokenType}/{tokenValue}"
}
},
"Version": {
"getApiVersionMinimumApiVersion": {
"spec": {
"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"
}
}
}
}
},
"method": "get",
"path": "/api/version/minimumApiVersion"
}
},
"Wooz": {
"getApiWoz": {
"spec": {
"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/WoozAssetResult"
},
"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"
}
}
}
}
},
"method": "get",
"path": "/api/v4.0/woz"
},
"putApiAdminTrovsWoozTrovIdAssetsAssetId": {
"spec": {
"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/AssetUpdateRequest"
}
},
{
"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/AssetResponse"
}
},
"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"
}
}
}
}
},
"method": "put",
"path": "/api/v4.0/admin/trovs/{woozTrovId}/assets/{assetId}"
},
"deleteApiAdminTrovsWoozTrovIdAssetsAssetId": {
"spec": {
"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"
}
}
}
}
},
"method": "delete",
"path": "/api/v4.0/admin/trovs/{woozTrovId}/assets/{assetId}"
},
"postApiAdminTrovsWoozTrovIdAssets": {
"spec": {
"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/WoozAccessResult"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/admin/trovs/{woozTrovId}/assets"
},
"postApiWozClaim": {
"spec": {
"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/WoozAccessResult"
}
},
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/woz/claim"
},
"postApiWozRemove": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/woz/remove"
},
"postApiWozUnclaim": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/woz/unclaim"
},
"postApiAdminTrovsWoozTrovIdAssetsAssetIdDuplicate": {
"spec": {
"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"
}
}
}
}
},
"method": "post",
"path": "/api/v4.0/admin/trovs/{woozTrovId}/assets/{assetId}/duplicate"
}
}
}