API docs by Redocly

Reciprocity API (1.2.4)

Download OpenAPI specification:Download

Api documentation for Reciprocity API

States

Fetch all states

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Find a state

Fetch a single state by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a state

Update a state by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
summary
string
image
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Changelog

Fetch all changelogs for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post a changelog for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
summary
required
string
date
string

Responses

Request samples

Content type
application/json
{
  • "summary": "This is a state's changelog summary",
  • "date": "2023-12-11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fetch a changelog by its id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch a changelog by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
summary
string
date
string

Responses

Request samples

Content type
application/json
{
  • "summary": "This is a state's changelog summary",
  • "date": "2023-12-11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a changelog by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Patch reciprocity by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
association
string
notes
string
residencyRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "association": "none",
  • "notes": "permitless carry",
  • "residencyRequired": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reciprocity

Fetch reciprocities for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post a reciprocity for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
childId
required
string
association
required
string
notes
string
residencyRequired
required
boolean

Responses

Request samples

Content type
application/json
{
  • "childId": "2114e5ac-774f-11ed-b5c8-0242ac120007",
  • "association": "none",
  • "notes": "permitless carry",
  • "residencyRequired": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fetch all reciprocities

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fetch reciprocity by its id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reverse Reciprocity

Fetch reverse reciprocities for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fetch all links for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post a link for a specific state

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
title
required
string
link
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "laws",
  • "link": "Step 1"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fetch a link by its id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch a link by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
title
string
link
string

Responses

Request samples

Content type
application/json
{
  • "title": "laws",
  • "link": "Step 1"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a link by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Content

Fetch content for states by state id and content's type

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post content for a state by state id and content's type

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
stateId
required
string
contentType
required
string
heading
required
string
subheading
string
content
required
string
icon
string

Responses

Request samples

Content type
application/json
{
  • "stateId": "2114e5ac-774f-11ed-b5c8-0242ac120007",
  • "contentType": "laws",
  • "heading": "Step 1",
  • "subheading": "How to do this!",
  • "content": "<p>Content Here</p>",
  • "icon": "Do Not Icon"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fetch content by its id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch content by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
heading
string
subheading
string
content
string
icon
string

Responses

Request samples

Content type
application/json
{
  • "heading": "Step 1",
  • "subheading": "How to do this!",
  • "content": "<p>Content Here</p>",
  • "icon": "Do Not Icon"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete content by id

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

User

Fetch user

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch a user

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
stateId
string

Responses

Request samples

Content type
application/json
{
  • "stateId": "2114e5ac-774f-11ed-b5c8-0242ac120007"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post a user

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
stateId
required
string

Responses

Request samples

Content type
application/json
{
  • "stateId": "2114e5ac-774f-11ed-b5c8-0242ac120007"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Permit

Fetch permits for a user

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Post a permit fora user

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
stateId
required
string
expiration
string

Responses

Request samples

Content type
application/json
{
  • "stateId": "2114e5ac-774f-11ed-b5c8-0242ac120007",
  • "expiration": "2023-12-11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Fetch a permit by its id

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch a permit by id

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
expiration
string

Responses

Request samples

Content type
application/json
{
  • "expiration": "2023-12-11"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a permit by id

Authorizations:
X-Api-Token
header Parameters
X-User-Id
required
string
Example: 2114e5ac-774f-11ed-b5c8-0242ac120007
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}