Organization API (1.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com License: MIT

Amusement Connect Organization API

Organization

Organizations

Partner

Partners

Get Partners

Authorizations:

apiKeysubscriptionKey

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"count": 0,
"items": [{"partnerType": "Ami",
"displayName": "string",
"correspondenceName": "string",
"logoUrl": "http://example.com",
"partnershipExpiration": "2019-08-24"
}
]
}

Prepare Partner OIDC Sign-In

Authorizations:

apiKeysubscriptionKey

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Request Body schema: application/json

partner	string (PartnerType) Value: "Ami"
organizationId	string <uuid> Id of the organization
redirectUrl	string <uri> Redirect URL to be used after OIDC sign-in
scope	string Scope of the OIDC sign-in

Responses

Request samples

Payload

Content type

application/json

{"partner": "Ami",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"redirectUrl": "http://example.com",
"scope": "openid profile email"
}

Response samples

200
400
500

Content type

application/json

{"oidcSignInUrl": "http://example.com"
}

Exchange OIDC Code

Authorizations:

apiKeysubscriptionKey

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Request Body schema: application/json

code	string OIDC code to exchange
state	string State parameter to maintain state between request and callback

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"state": "string"
}

Response samples

200
400
500

Content type

application/json

{"partnerType": "Ami",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"partnerOrganizationId": "d91d89d3-a207-4b33-9932-db23b3116a62",
"redirectUrl": "http://example.com",
"scope": "openid profile email"
}

PartnerOrganization

Partner Organizations

Get Partner Organizations

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId

required

string <uuid>

Id of the organization

query Parameters

partnerType	string (PartnerType) Value: "Ami" Type of the partner organization to filter by
apiVersion	string Default: "1.0" Value: "1.0" The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"count": 0,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"partnerType": "Ami",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"status": "Connected"
}
]
}

Get Partner Organization

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"partnerType": "Ami",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"status": "Connected"
}

Update Partner Organization

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Request Body schema: application/json

displayName

string

Display name of the partner organization

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Request samples

Payload

Content type

application/json

{"displayName": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"partnerType": "Ami",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"status": "Connected"
}

Disconnect Partner Organization

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Get Partner Organization Token

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization

query Parameters

scope required	string Example: scope=openid profile email A list of scopes, seperated by spaces, that the token must have. The order of scopes doesn't matter.
apiVersion	string Default: "1.0" Value: "1.0" The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/token

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/token

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/token

Response samples

200
400
500

Content type

application/json

{"token": "string",
"expirationUtc": "2019-08-24T14:15:22Z"
}

PartnerLocation

Partner Locations

Get Partner Locations

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location

Response samples

200
400
500

Content type

application/json

{"count": 0,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"locationId": 0
}
]
}

Get Partner Location

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization
partnerLocationId required	string <uuid> Id of the partner location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"locationId": 0
}

Update Partner Location

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization
partnerLocationId required	string <uuid> Id of the partner location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

displayName

string

Display name of the partner location

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Request samples

Payload

Content type

application/json

{"displayName": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"locationId": 0
}

Delete Partner Location

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization
partnerLocationId required	string <uuid> Id of the partner location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Link Partner Location to Location

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization
partnerLocationId required	string <uuid> Id of the partner location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

locationId

number <int32>

Id of the location to link with the partner location

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Request samples

Payload

Content type

application/json

{"locationId": 0
}

Response samples

200
400
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"externalName": "string",
"externalId": "string",
"locationId": 0
}

Unlink Partner Location from Location

Authorizations:

apiKeysubscriptionKey

path Parameters

organizationId required	string <uuid> Id of the organization
partnerOrganizationId required	string <uuid> Id of the partner organization
partnerLocationId required	string <uuid> Id of the partner location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Dev environment

https://apisdev.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Test environment

https://apistest.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Production environment

https://apis.amusementconnect.com/organization-service/organization/{organizationId}/partner-organization/{partnerOrganizationId}/partner-location/{partnerLocationId}/location

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Location

Get Location by ID

Authorizations:

apiKeysubscriptionKey

path Parameters

locationId

required

string <uuid>

Id of the location

query Parameters

apiVersion

string

Default: "1.0"

Value: "1.0"

The version of the API to use.

Responses

Response samples

200
400
500

Content type

application/json

{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png"
}

Search Locations

Search for locations with options for filtering by a text query, geolocation, etc.

Authorizations:

apiKeysubscriptionKey

query Parameters

apiVersion	string Default: "1.0" Value: "1.0" The version of the API to use.
latitude	number (latitude) [ -90 .. 90 ] Example: latitude=39.1395
longitude	number (longitude) [ -180 .. 180 ] Example: longitude=-94.5711
radius	number <double> [ 500 .. 400000 ] Default: 50000 A radius in meters from the given latitude and longitude
skip	integer Example: skip=10 The number of records to skip in the response. If not specified, no records are skipped.
take	integer Example: take=10 The maximum number of records to return in the response. If not specified, all records are returned.

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": true
},
{"id": 2,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 3,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 4,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 5,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 6,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 7,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
},
{"id": 8,
"name": "Retro Arcade & Bar",
"address": {"addr1": "1234 Main Street",
"addr2": "Suite 100",
"city": "Austin",
"state": "TX",
"zip": "78701"
},
"coordinates": {"latitude": 30.2672,
"longitude": -97.7431
},
"businessType": "Arcade",
"logoUrl": "https://example.com/logos/retro-arcade.png",
"isUserFavorite": false
}
]

Add a location to the user's list of favorites

Authorizations:

apiKeysubscriptionKey

path Parameters

locationId

required

string <uuid>

Id of the location

Responses

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Remove a location from the user's list of favorites

Authorizations:

apiKeysubscriptionKey

path Parameters

locationId

required

string <uuid>

Id of the location

Responses

Response samples

400
500

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
}
}

Organization API (1.0)

Organization

Partner

Get Partners

Authorizations:

query Parameters

Responses

Response samples

Prepare Partner OIDC Sign-In

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Exchange OIDC Code

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

PartnerOrganization

Get Partner Organizations

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get Partner Organization

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update Partner Organization

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Disconnect Partner Organization

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get Partner Organization Token

Authorizations:

path Parameters

query Parameters

Responses

Response samples

PartnerLocation

Get Partner Locations

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get Partner Location

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update Partner Location

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Partner Location

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required