Get paperwork fields

GET 
/v1/partner/locations/:location_id/paperwork-fields

This endpoint returns the paperwork fields configured in the Solv settings at the location specified by location_id. The response contains an array of objects that represent a location and its paperwork fields.

Token scope:

{'scope': 'read:locations'}

Request

Path Parameters

location_id Location Idrequired

Required. The unique identifier of the location.

Responses

200

Successful Response

application/json

Schema

Schema

location_id Location Id (integer)required

The unique identifier of the location

paperwork_fields

object[]

required

Array [

depends_on Depends On (string)

field_display_name Field Display Name (string)required

field_name Field Name (string)required

field_type Field Type (string)required

ranking Ranking (integer)required

response_options string[]required

]

Example (from schema)

{
  "location_id": 0,
  "paperwork_fields": [
    {
      "depends_on": "string",
      "field_display_name": "string",
      "field_name": "string",
      "field_type": "string",
      "ranking": 0,
      "response_options": [
        "string"
      ]
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...