CampLife version v1.3.5

https://smokies.camplife.com/hub/api/

Welcome

Welcome to the CampLife API Documentation. This feature is enabled on a per-account basis and is not enabled by default.

Changelog

v1.3.5 (2022-05-24)

Update all customer endpoints to support idIsNotAlias query string parameter

v1.3.4 (2021-03-29)

Add auth endpoints to support Single-Sign-On to camplife.com

v1.3.3 (2021-02-12)

Add customer note endpoints to retrieve and create notes

v1.3.2 (2021-02-09)

Updates to customer addresses model
Updates to customer bookings model

v1.3.1 (2021-01-14)

Add /membership endpoint and extend all membership endpoints to support active parameter

v1.3 (2020-12-15)

Requests to retrieve an access_token now support SHA256. Requests using SHA1 will still be allowed but will receive a warning.

v1.2 (2019-10-16)

Added customer bookings
Updates to customer membership model

v1.0 (2018-02-28)

Original release

Authentication

Access Key - Creation

You can generate access key/secret pairs in Hub -> Settings -> Web. An access key/secret are used to generate an access token using the process described below.

Access Token - Creation

First, start by generating a url that looks like this:

https://smokies.camplife.com/hub/token?grant_type=client_signature&access_key={KEY}&timestamp={TIMESTAMP}

KEY is the access key
TIMESTAMP is the current unix timestamp in the UTC timezone (NOTE: unix timestamp is seconds, not milliseconds)

A signature now needs to be generated and added as a parameter to the request (in a similar way to how AWS does it):

Create a string that prepends the http verb in front of the url referenced above: GEThttps://smokies.camplife.com/hub/token?grant_type=client_signature&access_key={KEY}&timestamp={TIMESTAMP}
Sign this string using HMAC-SHA256 and the access secret as the key (SECRET-WILL-BE-AT-LEAST-32-CHARS-LONG for this example), hex encoding the resulting byte array: 5427d8189463393e0330a726a5411e73ab157831959a377ecefa5099612efdcc
Then append it as the final parameter in the original url: https://smokies.camplife.com/hub/token?grant_type=client_signature&access_key={KEY}&timestamp={TIMESTAMP}&signature=5427d8189463393e0330a726a5411e73ab157831959a377ecefa5099612efdcc

Sending a request to this generated url will result in a json response that looks something like:

Success

{
"access_token": "ASJHH1287shSK297sHSHDLPOQHN20o978287.ASJKHDH120897sSHDKHS2010SD172ASFHAS",
"token_type":"bearer",
"expires_in":3600
}

Take note of two headers set in a successful response:

Date -- the date and time (UTC) that the access_token was issued (HTTP date format)

Expires -- the date and time (UCT) that the access_token will expire (HTTP date format)

NOTE: HTTP date format is EEE, dd MMM yyyy HH:mm:ss z

Error

{
"error": "ERROR_TYPE",
"error_description": "ERROR_DESCRIPTION"
}

ERROR_DESCRIPTION will be a human readable description of the error, possibly with details or a message for a developer to know why it occured

ERROR_TYPE will be one of:

HTTP status code 400

invalid_client – If an access_key, timestamp, or signature parameter is missing.
invalid_grant – If a grant_type is missing or requested that we don’t recognize.

HTTP status code 401

invalid_client – Authentication failed, if the request contains an invalid/unknown access key or if the signature/timestamp is not valid.
invalid_grant – If the access key has expired.

HTTP status code 403

unauthorized_client – This client is not authorized to use the api. This can also occur if the access key has been de-activated. To fix, you will need to contact support.
service_disabled - The service is currently disabled. The request is valid and would otherwise be honored.

Access Token - Usage

Use the access_token property that you received from the token endpoint in your api requests in one of two ways:

via a request header (recommended)
```
Authorization: Bearer {ACCESS_TOKEN}
```
via a url parameter to your request (NOTE: you will need to URL encode the ACCESS_TOKEN)
```
?access_token={ACCESS_TOKEN}
```

/account

Entity representing an account

/account get

get

Retrieve the account

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "alias": "ACME-ACCOUNT",
  "accountName": "ACME Properties"
}

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/account/membership get

Collection of available memberships.

get

Retrieve a list of active memberships being issued by the account

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Query Parameters

active: (string)
Return only the inactive memberships OR include the inactive memberships in the response of active memberships
Example:
```
'false' or 'both'
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "Commerce Guild": {
      "promoCode": null,
      "validFrom": "2920-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Confederacy of Independant Systems": {
      "promoCode": null,
      "validFrom": "2762-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Galactic Republic": {
      "promoCode": null,
      "validFrom": null,
      "validTo": "null"
    }
  },
  {
    "Intergalactic Banking Clan": {
      "promoCode": null,
      "validFrom": "2970-01-01T00:00:00Z",
      "validTo": "3050-01-01T00:00:00Z"
    }
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/account/tag get

Collection of available tags.

get

Retrieve a list of tags bound to any of the account's properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
    "Contact Member Services",
    "EMPLOYEE",
    "New Member",
    "Military",
    "Membership Suspended",
    "No Show Penalty",
    "Past Due",
    "VIP"
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/account/tag/{tagName} put delete

put

Add a tag with tagName = {tagName} to all of an account's properties

delete

Remove a tag with tagName = {tagName} from all of an account's properties

Add a tag with tagName = {tagName} to all of an account's properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

tagName: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove a tag with tagName = {tagName} from all of an account's properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

tagName: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property

Entity representing a property

/property get

get

Retrieve a list of properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": 999,
    "alias": "CAMPLIFE-ACME",
    "organizationName": "CampLife ACME",
  },
  {
    "id": 1000,
    "alias": "CAMPLIFE-TEST",
    "organizationName": "CampLife Test Campground",
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property/{alias} get

Represention a Property

get

Retrieve the property with alias = {alias}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": 999,
  "alias": "CAMPLIFE-ACME",
  "organizationName": "CampLife ACME",
  "email": "",
  "timeZone": "US/Eastern",
  "lat": "",
  "lon": "",
  "description": "",
  "website": "",
  "phone": "",
  "address": ""
}

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property/{alias}/customer get

get

Retrieve a list of a property's customers based on search query parameters

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

alias: required(string)

Query Parameters

email: (string)
Customer Email
Example:
```
eli@test.com
```

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property/{alias}/tag get

Collection of available tags.

get

Retrieve a list of tags bound to the property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
    "Damaged Cabin Penalty",
    "Dog Clean Up Penalty",
    "Excessive Cabin Cleaning Penalty",
    "Pet In Non-Pet Cabin Penalty",
    "Potential Issue",
    "Seasonal",
    "Smoking in Cabin Penalty",
    "Storage"
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property/{alias}/tag/{tagName} put delete

put

Bind a tag with tagName = {tagName} to the property

delete

Remove a tag with tagName = {tagName} from the property

Bind a tag with tagName = {tagName} to the property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

alias: required(string)
tagName: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove a tag with tagName = {tagName} from the property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

alias: required(string)
tagName: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/property/{alias}/membership get

Collection of available memberships.

get

Retrieve a list of active memberships being issued by the property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

alias: required(string)

Query Parameters

all: (string)
Whether or not to include memberships that are available via the account
Example:
```
(any non-empty string as a value will be treated as the boolean 'true')
```
active: (string)
Return only the inactive memberships OR include the inactive memberships in the response of active memberships
Example:
```
'false' or 'both'
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "Lothal Rebels": {
      "promoCode": null,
      "validFrom": "2890-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Tusken Raiders": {
      "promoCode": null,
      "validFrom": "2391-01-01T00:00:00Z",
      "validTo": "null"
    }
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer

Representation of a customer. Endpoints that have {id} also support a query string parameter idIsNotAlias.

/customer get post

get

Retrieve a list of customer based on search query parameters

post

Create a new customer

Retrieve a list of customer based on search query parameters

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Query Parameters

email: (string)
Customer Email
Example:
```
test@test.com
```
firstName&lastName&city: (string)
Customer Name and City
Example:
```
?firstName=Elijah&lastName=Smith&address.city=Roswell
```
memberNumber: (string)
Customer Member Number
Example:
```
38921
```
id: (string)
Customer Alias
Example:
```
NR2738921
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": 9999999,
    "memberNumber": "SALLIE.MAE@TEST.COM",
    "displayName": "Mae, Sallie",
    "email": "sallie.mae@test.com",
    "address": " 123 Test Rd\nTest, CA 99999\nUnited States",
    "phone": "+1 1235556262",
    "membership": [
      {
        "ACME 7 Night Stay": "12341234"
      },
      {
        "Good Sam": "1234"
      }
    ]
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Create a new customer

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

Query Parameters

alias: required(string)
Property alias to specify as originating property
Example:
```
SUNRISE-ACME
```

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id} get post delete

Representing a Customer

get

Retrieve the customer with id = {id}

post

Update the customer with id = {id}

delete

Remove the customer with id = {id}

Retrieve the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": 9999999,
  "addresses": [
    {
      "addressType": "HOME",
      "primary": true,
      "address1": "123 Test Rd",
      "address2": null,
      "city": "Test",
      "country": "United States",
      "stateprovince": "CA",
      "zipcode": "99999",
      "display": " 123 Test Rd\nTest, CA 99999\nUnited States"
    }
  ],
  "anniversaryDay": null,
  "anniversaryMonth": null,
  "birthDay": null,
  "birthMonth": null,
  "credentialsExpirationDate": null,
  "membership": [
    {
      "ACME 7 Night Stay length": {
        "memberNumber": "12341234",
        "effectiveFrom": "2018-01-02T00:00:00Z",
        "effectiveTo": "2018-01-31T00:00:00Z"
      }
    },
    {
      "Good Sam": {
        "memberNumber": "1234",
        "effectiveFrom": "2018-01-03T00:00:00Z",
        "effectiveTo": "2018-01-26T00:00:00Z"
      }
    }
  ],
  "memberNumber": null,
  "firstName": "Sallie",
  "lastName": "Mae",
  "middleName": null,
  "suffix": null,
  "displayName": "Mae, Sallie",
  "email": null,
  "lastLogin": null,
  "loyaltyAccountCode": null,
  "phones": [
    {
      "phoneType": "MOBILE",
      "primary": true,
      "extension": null,
      "number": "+13211234567",
      "display": "+1 (321) 123-4567"
    }
  ],
  "tags": [
       {
            "No Show Penalty": [
                "CAMPLIFE-TEST"
            ]
        },
        {
            "Contact Member Services": [
                "CAMPLIFE-TEST"
            ]
        }
  ],
  "vehicles": [
    {
      "color": "Blue",
      "licensePlate": "123123A",
      "make": "Tesla",
      "model": null,
      "registeredStateProvince": "CA",
      "vehicleType": "CAR",
      "year": 2018
    }
  ]
}

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"error": "unprocessable_entity", "error_description": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Update the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "number"
    },
    "addresses": {
      "type": "array",
      "items": {
        "description": "Customer address",
        "type": "object",
        "properties": {
          "address1": {
            "type": "string"
          },
          "address2": {
            "type": "string"
          },
          "addressType": {
            "description": "valid values: HOME (default-value), MAILING, BUSINESS",
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "country": {
            "description": "default-value: UNK",
            "type": "string"
          },
          "primary": {
            "type": "boolean"
          },
          "stateprovince": {
            "type": "string"
          },
          "zipcode": {
            "type": "string"
          }
        }
      }
    },
    "anniversaryDay": {
      "type": "string"
    },
    "anniversaryMonth": {
      "type": "string"
    },
    "birthDay": {
      "type": "string"
    },
    "birthMonth": {
      "type": "string"
    },
    "membership": {
      "type": "array",
      "items": {
        "description": "Customer memberships",
        "type": "object",
        "properties": {
          "membershipName": {
            "type": "object",
            "maxLength": 64,
            "properties": {
              "effectiveFrom": {
                "type": "string",
                "format": "date"
              },
              "effectiveTo": {
                "type": "string",
                "format": "date"
              },
              "memberNumber": {
                "type": "string",
                "maxLength": 32
              }
            }
          }
        }
      }
    },
    "memberNumber": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "middleName": {
      "type": "string"
    },
    "phones": {
      "type": "array",
      "items": {
        "description": "Customer phone",
        "type": "object",
        "properties": {
          "areaCode": {
            "description": "[deprecated] will be removed in the future",
            "type": "string"
          },
          "countryCode": {
            "description": "[deprecated] will be removed in the future",
            "type": "string"
          },
          "extension": {
            "type": "string"
          },
          "phoneNumber": {
            "description": "[deprecated] will be removed in the future",
            "type": "string"
          },
          "phoneType": {
            "description": "valid values: HOME, BUSINESS, EMERGENCY, MOBILE (default-value), FAX",
            "type": "string"
          },
          "primary": {
            "type": "boolean"
          },
          "number": {
            "type": "string"
          }
        }
      }
    },
    "suffix": {
      "type": "string"
    },
    "tags": {
      "type": "array",
      "items": {
        "description": "Customer tag",
        "type": "object",
        "properties": {
          "displayText": {
            "type": "string"
          }
        }
      }
    },
    "vehicles": {
      "type": "array",
      "items": {
        "description": "Customer vehicle",
        "type": "object",
        "properties": {
          "color": {
            "type": "string"
          },
          "licensePlate": {
            "type": "string"
          },
          "make": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "registeredStateProvince": {
            "type": "string"
          },
          "vehicleType": {
            "type": "string"
          },
          "year": {
            "type": "number"
          }
        }
      }
    }
  }
}

Example:

{
  "membership": [
    {
      "ACME 7 Night Stay": {
        "memberNumber": "12341234",
        "effectiveFrom": "2018-01-02T00:00:00Z",
        "effectiveTo": "2018-01-31T00:00:00Z"
      }
    }
  ],
  "firstName": "Sallie",
  "lastName": "Mae",
  "phones": [
    {
      "phoneType": "MOBILE",
      "primary": true,
      "number": "+1235556262"
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "success": true,"message": "The customer has been properly updated" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customer has been removed" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/account get post delete

Operations for the customer's owning account collection

get

Is the account using the api an owning account for the customer with id = {id}

post

Ensure that the account using the api is an owning account for the customer with id = {id}

delete

Remove the account using the api as an owning account for the customer with id = {id}

Is the account using the api an owning account for the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

id: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Ensure that the account using the api is an owning account for the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

id: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove the account using the api as an owning account for the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Request
Security

URI Parameters

id: required(string)

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/address delete

delete

Remove all addresses from the customer based on query parameters (at least one parameter required)

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Query Parameters

address1: (string)
Customer address line 1
Example:
```
123 Test Lane
```
address2: (string)
Customer address line 2
Example:
```
Unit B
```
city: (string)
Customer city
Example:
```
Nashville
```
stateprovince: (string)
Customer state or province
Example:
```
TN
```
country: (string)
Customer country
Example:
```
United States of America
```
zipcode: (string)
Customer zip code
Example:
```
91767
```
addressType: (string)
Customer address type
Example:
```
HOME
```
primary: (boolean)
Customer primary address
Example:
```
true
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customer address has been removed" }

HTTP status code 400

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "no address parameters specified" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer address unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/booking get

Collection of customer bookings

get

Retrieve bookings belonging to the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
   {
      "sites": [
         {
            "siteName": "Site 01",
            "siteType": "Premium"
         }
      ],
      "events": [
          {
              "time": "2019-10-16T21:37:34Z",
              "type": "ACCEPTED"
          }
      ],
      "id": 2255,
      "splitReservation": null,
      "groupReservation": null,
	  "occupancy": {
		  "numAdults": 2,
		  "numChildren": 2,
		  "numPets": 0
	  },
	  "organizationName": "Dunder Mifflin",
      "referralMethod": "Phone",
      "currentEventStatus": "ACCEPTED",
      "confirmationCode": "XXXXXXXXX",
      "createdTS": "2019-10-16T21:37:34Z",
      "checkinDate": "2019-10-16T00:00:00Z",
      "checkoutDate": "2019-10-19T00:00:00Z",
      "type": "STANDARD"
   },
   {
      "sites": [],
      "events": [
          {
              "time": "2018-10-31T05:08:57Z",
              "type": "ACCEPTED"
          },
          {
              "time": "2018-11-30T05:08:57Z",
              "type": "CANCELLED"
          }
      ],
      "id": 2017,
      "splitReservation": null,
      "groupReservation": null,
      "name": "Online Group Reservation",
      "organizationName": "Scranton",
	  "occupancy": {
		  "numAdults": 2,
		  "numChildren": 0,
		  "numPets": 1
	  },
	  "referralMethod": "Strangler",
      "currentEventStatus": "CANCELLED",
      "confirmationCode": "XXXXXXXXX",
      "createdTS": "2018-10-31T05:08:57Z",
      "checkinDate": "2018-10-30T00:00:00Z",
      "checkoutDate": "2018-11-07T00:00:00Z",
      "type": "GROUP_HELD"
  },
  {
     "sites": [
        {
           "siteName": "RV Site 020",
           "siteType": "Full Hook-up"
        }
     ],
      "events": [
          {
              "time": "2018-10-29T05:05:01Z",
              "type": "ACCEPTED"
          },
          {
              "time": "2018-10-30T05:05:01Z",
              "type": "CHECKED_IN"
          },
      ],
     "id": 2019,
     "splitReservation": null,
     "groupReservation": {
        "id": 2017,
        "name": "Online Group Reservation"
     },
	 "occupancy": {
		 "numAdults": 2,
		 "numChildren": 0,
		 "numPets": 0
	 },
	 "organizationName": "The Rebellion",
     "currentEventStatus": "CHECKED_IN",
     "referralMethod": "The Force",
     "confirmationCode": "XXXXXXXXX",
     "createdTS": "2018-10-29:05:01Z",
     "checkinDate": "2018-10-30T00:00:00Z",
     "checkoutDate": "2018-11-07T00:00:00Z",
     "type": "STANDARD"
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/merge post

Merge two customer entities

post

Merge two customer entities based on query parameters

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Query Parameters

targetId: required(integer)
Target Customer's Id
Example:
```
12345
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customers have successfully been merged" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/membership get

Collection of available customer memberships

get

Retrieve memberships belonging to the customer with id = {id}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "ACME 7 Night Stay": {
      "memberNumber": "12341234",
      "effectiveFrom": "2018-01-02T00:00:00Z",
      "effectiveTo": "2018-01-31T00:00:00Z"
    }
  },
  {
    "Good Sam": {
      "memberNumber": "1234",
      "effectiveFrom": "2018-01-03T00:00:00Z",
      "effectiveTo": "2018-01-26T00:00:00Z"
    }
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/membership/{membershipName} put post delete

Customer membership entity

put

Create/Replace the customer's membership with membershipName = {membershipName}

post

Update the customer's membership with membershipName = {membershipName}

delete

Remove the customer's membership with membershipName = {membershipName}

Create/Replace the customer's membership with membershipName = {membershipName}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
membershipName: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "properties": {
    "membershipName": {
      "type": "object",
      "description": "Membership name to add/replace",
      "required": ["memberNumber", "effectiveFrom"],
      "properties": {
        "memberNumber": {
          "type": "string",
          "maxLength": 32
        },
        "effectiveFrom": {
          "type": "string",
          "format": "date"
        },
        "effectiveTo": {
          "type": "string",
          "format": "date"
        }
      }
    }
  }
}

Example:

{
  "ACME 7 Night Stay": {
    "memberNumber": "12341234",
    "effectiveFrom": "2018-01-02T00:00:00Z",
    "effectiveTo": "2018-01-31T00:00:00Z"
  }
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "success": true,"message": "The customer membership has been properly updated" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer membership unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Update the customer's membership with membershipName = {membershipName}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
membershipName: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "required": ["memberNumber", "effectiveFrom"],
  "properties": {
    "memberNumber": {
      "type": "string",
      "maxLength": 32
    },
    "effectiveFrom": {
      "type": "string",
      "format": "date"
    },
    "effectiveTo": {
      "type": "string",
      "format": "date"
    }
  }
}

Example:

{
  "memberNumber": "12341234",
  "effectiveFrom": "2018-01-02",
  "effectiveTo": "2018-01-31"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "success": true,"message": "The customer membership has been properly updated" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer membership unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove the customer's membership with membershipName = {membershipName}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
membershipName: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customer membership has been removed" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer membership unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/note get post

Collection of available notes.

get

Retrieve a list of notes for the customer across all properties

post

Create a customer note at a specified property

Retrieve a list of notes for the customer across all properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
    {
        "text": "The Force will be with you. Always.",
        "timestamp": "2036-02-01T09:00:00Z",
        "organizationName": "Obi-Wan Kenobi"
    },
    {
        "text": "Do. Or do not. There is no try.",
        "timestamp": "3081-01-01T09:00:00Z",
        "organizationName": "Yoda"
    }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Create a customer note at a specified property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Query Parameters

cgAlias: required(string)
Property alias to specify as originating property
Example:
```
SUNRISE-ACME
```

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "required": ["text"],
  "properties": {
    "text": {
      "description": "Note text",
      "type": "string",
      "maxLength": 1024
    }
  }
}

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

{ "success": true,"message": "customer note has been created" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer note unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/phone delete

delete

Remove all phones from the customer based on query parameters

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Query Parameters

phoneNumber: required(string)
REQUIRED Specify customer phone number
Example:
```
1234567
```
areaCode: required(string)
REQUIRED Specify customer phone nunber area code
Example:
```
123
```
countryCode: (string)
Customer Phone Country Code
Example:
```
1
```
extension: (string)
Customer Phone Extension
Example:
```
2458
```
phoneType: (string)
Customer Phone Type
Example:
```
MOBILE
```
primary: (boolean)
Customer Primary Phone
Example:
```
true
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customer phone has been removed" }

HTTP status code 400

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "missing areaCode/phoneNumber parameter" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer phone unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/tag get

Collection of available tags.

get

Retrieve bound tags for the customer across all properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
    {
        "New Member": [
            "CAMPLIFE-TEST"
        ]
    },
    {
        "No Show Penalty": [
            "CAMPLIFE-TEST"
        ]
    },
    {
        "Contact Member Services": [
            "CAMPLIFE-TEST"
        ]
    }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/tag/{tagName} put delete

Manage customer tags for all properties

put

Bind a tag with tagName = {tagName} to the customer for all properties that have the tag

delete

Remove all tags with tagName = {tagName} from the customer for all properties that have the tag

Bind a tag with tagName = {tagName} to the customer for all properties that have the tag

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
tagName: required(string)

Query Parameters

alias: required(string)
Property alias to specify as originating property
Example:
```
SUNRISE-ACME
```

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "required": ["tagName"],
  "properties": {
    "tagName": {
      "description": "Tag name to replace",
      "type": "string",
      "maxLength": 32
    }
  }
}

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

{ "success": true,"message": "customer tag has been created" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer tag unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove all tags with tagName = {tagName} from the customer for all properties that have the tag

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
tagName: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "customer tag has been removed" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer tag unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/property get

Collection of available properties.

get

Retrieve properties bound to the customer

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

Can not resolve examples/customer-properties.sample

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/property/{alias} put delete

Manage properties bound to the customer

put

Bind the customer to property with alias = {alias}

delete

Remove the customer's binding from property with alias = {alias}

Bind the customer to property with alias = {alias}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "property binding has been added to customer" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove the customer's binding from property with alias = {alias}

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "property binding has been removed from customer" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/property/{alias}/booking get

Collection of available bookings.

get

Retrieve bookings belonging to the customer for a property

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
   {
      "sites": [
         {
            "siteName": "Site 01",
            "siteType": "Premium"
         }
      ],
      "events": [
          {
              "time": "2019-10-16T21:37:34Z",
              "type": "ACCEPTED"
          }
      ],
      "id": 2255,
      "splitReservation": null,
      "groupReservation": null,
	  "occupancy": {
		  "numAdults": 2,
		  "numChildren": 2,
		  "numPets": 0
	  },
	  "organizationName": "Dunder Mifflin",
      "referralMethod": "Phone",
      "currentEventStatus": "ACCEPTED",
      "confirmationCode": "XXXXXXXXX",
      "createdTS": "2019-10-16T21:37:34Z",
      "checkinDate": "2019-10-16T00:00:00Z",
      "checkoutDate": "2019-10-19T00:00:00Z",
      "type": "STANDARD"
   },
   {
      "sites": [],
      "events": [
          {
              "time": "2018-10-31T05:08:57Z",
              "type": "ACCEPTED"
          },
          {
              "time": "2018-11-30T05:08:57Z",
              "type": "CANCELLED"
          }
      ],
      "id": 2017,
      "splitReservation": null,
      "groupReservation": null,
      "name": "Online Group Reservation",
      "organizationName": "Scranton",
	  "occupancy": {
		  "numAdults": 2,
		  "numChildren": 0,
		  "numPets": 1
	  },
	  "referralMethod": "Strangler",
      "currentEventStatus": "CANCELLED",
      "confirmationCode": "XXXXXXXXX",
      "createdTS": "2018-10-31T05:08:57Z",
      "checkinDate": "2018-10-30T00:00:00Z",
      "checkoutDate": "2018-11-07T00:00:00Z",
      "type": "GROUP_HELD"
  },
  {
     "sites": [
        {
           "siteName": "RV Site 020",
           "siteType": "Full Hook-up"
        }
     ],
      "events": [
          {
              "time": "2018-10-29T05:05:01Z",
              "type": "ACCEPTED"
          },
          {
              "time": "2018-10-30T05:05:01Z",
              "type": "CHECKED_IN"
          },
      ],
     "id": 2019,
     "splitReservation": null,
     "groupReservation": {
        "id": 2017,
        "name": "Online Group Reservation"
     },
	 "occupancy": {
		 "numAdults": 2,
		 "numChildren": 0,
		 "numPets": 0
	 },
	 "organizationName": "The Rebellion",
     "currentEventStatus": "CHECKED_IN",
     "referralMethod": "The Force",
     "confirmationCode": "XXXXXXXXX",
     "createdTS": "2018-10-29:05:01Z",
     "checkinDate": "2018-10-30T00:00:00Z",
     "checkoutDate": "2018-11-07T00:00:00Z",
     "type": "STANDARD"
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/property/{alias}/tag get

Collection of available tags.

get

Retrieve tags for the property bound to the customer

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
    {
        "New Member": [
            "CAMPLIFE-TEST"
        ]
    },
    {
        "No Show Penalty": [
            "CAMPLIFE-TEST"
        ]
    },
    {
        "Contact Member Services": [
            "CAMPLIFE-TEST"
        ]
    }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/customer/{id}/property/{alias}/tag/{tagName} put delete

Manage the property's tags bound to the customer

put

Add a tag with tagName = {tagName} to the customer, adding it to the property with alias = alias if necessary

delete

Remove a tag with tagName = {tagName} from the customer for the property with alias = alias if it has the tag

Add a tag with tagName = {tagName} to the customer, adding it to the property with alias = alias if necessary

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)
tagName: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "success": true, "message": "property tag has been added to customer" }

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

{ "success": true, "message": "property tag has been created and added to customer" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer tag unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

Remove a tag with tagName = {tagName} from the customer for the property with alias = alias if it has the tag

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)
alias: required(string)
tagName: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"success": true, "message": "tag has been removed from customer" }

HTTP status code 422

Body

Media type: application/json

Type: any

Example:

{"success": false, "message": "customer tag unable to be processed" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/membership

All memberships

/membership get

get

Retrieve a list of globally accessible active memberships being issued across the account and all properties

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

Query Parameters

active: (string)
Return only the inactive memberships OR include the inactive memberships in the response of active memberships
Example:
```
'false' or 'both'
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "Commerce Guild": {
      "promoCode": null,
      "validFrom": "2920-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Confederacy of Independant Systems": {
      "promoCode": null,
      "validFrom": "2762-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Galactic Republic": {
      "promoCode": null,
      "validFrom": null,
      "validTo": "null"
    }
  },
  {
    "Gungan Grand Army": {
      "promoCode": null,
      "validFrom": "2870-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Intergalactic Banking Clan": {
      "promoCode": null,
      "validFrom": "2970-01-01T00:00:00Z",
      "validTo": "3050-01-01T00:00:00Z"
    }
  },
  {
    "Lothal Rebels": {
      "promoCode": null,
      "validFrom": "2890-01-01T00:00:00Z",
      "validTo": "null"
    }
  },
  {
    "Tusken Raiders": {
      "promoCode": null,
      "validFrom": "2391-01-01T00:00:00Z",
      "validTo": "null"
    }
  }
]

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

/auth

/auth/camplife/{id} get

get

retrieve a url that will auto-log the user ( with id OR alias = {id}) into camplife.com

Secured by oauth_2.0

CampLife API supports a slightly customized OAuth 2.0 security policy

URI Parameters

id: required(string)

Query Parameters

property: (string)
The property id or alias to focus the user on after login
Example:
```
'123' OR 'ACMENASH'
```

HTTP status code 200

Headers

Location: (string)

Example:

https://www.camplife.com/token/921878zd98712f9873rjh231r90871487...1278

Location (when property supplied): (string)

Example:

https://www.camplife.com/123/token/921878zd98712f9873rjh231r90871487...1278

Body

Media type: application/json

Type: any

Example:

{ "url": "https://www.camplife.com/token/921878zd98712f9873rjh231r90871487...1278" }

Media type: application/json (when property supplied)

Type: any

Example:

{ "url": "https://www.camplife.com/123/token/921878zd98712f9873rjh231r90871487...1278" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "error": "not_found", "error_description": "user not found" }

Secured by oauth_2.0

Headers

Authorization: required(string)
Used to send a valid access token. Do not use with the "access_token" query string parameter.
Example:
```
Authorization: Bearer {ACCESS_TOKEN}
```

Query Parameters

access_token: required(string)
Used to send a valid access token. Do not use together with the "Authorization" header
Example:
```
access_token={ACCESS_TOKEN}
```

HTTP status code 401

Unauthorized. This can happen if the API consumer uses an invalid, revoked, or expired access token. To fix, you should retrieve a new access token. ERROR_TYPE will be one of:

invalid_token - token is missing
invalid_token - token is malformed in structure or encoding
invalid_token - token signature isn't valid
invalid_token - token audience doesn't match
invalid_token - token has expired

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

HTTP status code 403

Access forbidden. ERROR_TYPE will be one of:

unauthorized_token - The account that granted the token does not currently have the role granting access to this api. To fix, you will need to contact support.
service_disabled - The API service is currently disabled. The token is valid and the request would otherwise be allowed.

Body

Media type: application/json

Type: any

Example:

{"error": ERROR_TYPE, "error_description": ERROR_DESCRIPTION }

CampLife version v1.3.5

v1.3.5 (2022-05-24)

v1.3.4 (2021-03-29)

v1.3.3 (2021-02-12)

v1.3.2 (2021-02-09)

v1.3.1 (2021-01-14)

v1.3 (2020-12-15)

v1.2 (2019-10-16)

v1.0 (2018-02-28)

Access Key - Creation

Access Token - Creation

Success

Error

Access Token - Usage

/account

get /account

HTTP status code 200

Body

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

get /account/membership

Query Parameters

HTTP status code 200

Body

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

get /account/tag

HTTP status code 200

Body

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

put /account/tag/{tagName}

URI Parameters

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

delete /account/tag/{tagName}

URI Parameters

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

/property

get /property

HTTP status code 200

Body

Secured by oauth_2.0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

get /property/{alias}

URI Parameters

HTTP status code 200

Body

Secured by oauth_2.0