RaiseADIssue - Raise an issue for a given ad - Real-estate data API

PUT

browse

{flxId}

_issue

curl --request PUT \
  --url https://api.f6o.co/v2/browse/ad/{flxId}/_issue \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": [
    "ISSUE_TYPE_UNKNOWN"
  ],
  "userId": [
    "<string>"
  ],
  "comments": [
    "<string>"
  ],
  "raisedAt": "2023-11-07T05:31:56Z",
  "hits": 123
}'

{
  "status": {
    "code": 123,
    "message": "<string>",
    "details": [
      {
        "@type": "<string>"
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Path Parameters

flxId

string

required

Body

application/json

type

enum<string>[]

Available options:

ISSUE_TYPE_UNKNOWN,

ISSUE_TYPE_PRICE,

ISSUE_TYPE_OFFLINE,

ISSUE_TYPE_LOCATION,

ISSUE_TYPE_WRONG_LINK,

ISSUE_TYPE_WRONG_MERGE,

ISSUE_TYPE_OTHER

userId

string[]

comments

string[]

raisedAt

string

hits

integer

Response

200

application/json

A successful response.

status

object

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

status.code

integer

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

status.message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

status.details

object[]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

status.details.@type

string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt If no scheme is provided, https is assumed. README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. README.md _snippets api-ai-reference api-analytics-reference api-elasticimmo-reference api-geography-reference api-maps-reference api-search-alert-reference authentification.mdx doc favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_elasticimmo.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-elasticimmo.json swagger-geography.json swagger-maps.json tmp.txt Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

status.details.{key}

object

Was this page helpful?

Sample advert webhook body Get adverts byt their flx_id

curl --request PUT \
  --url https://api.f6o.co/v2/browse/ad/{flxId}/_issue \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": [
    "ISSUE_TYPE_UNKNOWN"
  ],
  "userId": [
    "<string>"
  ],
  "comments": [
    "<string>"
  ],
  "raisedAt": "2023-11-07T05:31:56Z",
  "hits": 123
}'

{
  "status": {
    "code": 123,
    "message": "<string>",
    "details": [
      {
        "@type": "<string>"
      }
    ]
  }
}

System

Properties

Adverts

RealEstate Companies

Models

RaiseADIssue - Raise an issue for a given ad

Authorizations

Path Parameters

Body

Response