API docs by Redocly

Territory Helper API (1.0.0)

Download OpenAPI specification:Download

E-mail: help@territoryhelper.com License: Apache 2.0 Terms of Service

To start using the Territory Helper API, please contact the Help Desk to register your application. Please submit the name of your application, your contact name and email address (both of which will appear in Territory Helper during user-authorization), and your application website address (if applicable).

When we have registered your application, we will supply you with a Client ID and Client Secret (Signature). These credentials are specific to your application. The Client ID is publicly exposed (it is how Territory Helper identifies your application), but the Client Secret must be kept private between your application and Territory Helper.

The credentials will allow you to use the OAuth2 framework to obtain access to some of the data associated with a Territory Helper user account via an access token. There are two methods you can use to get an access token: "Authorization Code Web" and "Authorization Code PKCE". Use the "Authorization Code Web" method if your application is a website and you can secure the Client Secret on your server. Use "Authorization Code PKCE" if your application is a desktop or mobile one, or if you can't secure the Client Secret for some other reason. These two methods are described below.

Territory Helper Help Center and documentation.

Authorization Code (Web)

Used for web authorization.

Authorization code method (Step 1)

For use with web applications.

Territory Helper responds by displaying a login page, and when the user logs in, Territory Helper displays a "Request for Permission" page that allows the user to approve or reject the request.

If the user clicks the "Accept" button, Territory Helper supplies an authorization code at your REDIRECT URI using a query string field named "code".

If the user clicks the "Cancel" button, Territory Helper redirects to your REDIRECT URI using a query string field named "error" and value "access_denied".

Authorizations:
Public
query Parameters
client_id
required
string

client_id is supplied by Territory Helper during registration of your application.

redirect_uri
required
string

The URL Territory Helper will redirect to when issuing an authorization code.

Responses

Request an access token (Step 2)

In your callback code, your application should then request an access token from Territory Helper.

The returned token can be used to call the Territory Helper API, specifying it as a query string field named "access_token".

The access_token is short lived and may need to use the refresh_token to create new access tokens.

Authorizations:
Public
query Parameters
grant_type
required
string

The grant type "authorization_code" must be used to retrieve a new token.

"refresh_token" is used to refresh an existing access token.

refresh_token
string

The refresh_token supplied in a "authorization_code" and required for "refresh_token" grant type.

code
string

he authorization code supplied by Territory Helper appart of the redirect URI in the Authorization code method. Required for "authorization_code" grant types.

redirect_uri
string

The redirect URI supplied in the initial authorization. Required to validate "authorization_code" grant types.

client_id
required
string

client_id is supplied by Territory Helper during registration of your application.

client_secret
required
string

client_secret is supplied by Territory Helper during registration of your application. Also referred to as the signature.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Revoke token

Revoke an existing client token.

Authorizations:
Public
query Parameters
token
required
string

The access token or refresh token.

Responses

Authorization Code (PKCE)

Used for mobile and desktop application authorization.

Authorization code PKCE method (Step 1)

For use with mobile and desktop applications.

Territory Helper responds by displaying a login page, and when the user logs in, Territory Helper displays a "Request for Permission" page that allows the user to approve or reject the request.

If the user clicks the "Accept" button, Territory Helper supplies an authorization code at your REDIRECT URI using a query string field named "code".

If the user clicks the "Cancel" button, Territory Helper redirects to your REDIRECT URI using a query string field named "error" and value "access_denied".

Authorizations:
Public
query Parameters
response_type
required
string

response_type "code" indicates that your application is requesting an authorization code grant. "code" is the only supported response type for PKCE authorization.

client_id
required
string

client_id is supplied by Territory Helper during registration of your application.

redirect_uri
required
string

The URI Territory Helper will redirect to when issuing an authorization code.

state
required
string

State is an opaque value that you generate to prevent CSRF attacks.

code_challenge
required
string

The code challenge must be a generated random key value and then hashed. The hash must be created using SHA256 cryptography followed by base64Url (rfc4648) encoding.

code_challenge_method
required
string

The code challenge method must be set to "S256". Territory Helper does not support "plain".

Responses

Request an access token (Step 2)

In your callback code, your application should then request an access token from Territory Helper.

The returned token can be used to call the Territory Helper API, specifying it as a query string field named "access_token".

The access_token is short lived and may need to use the refresh_token to create new access tokens.

Authorizations:
Public
query Parameters
grant_type
required
string

The grant type "authorization_code" must be used to retrieve a new token.

"refresh_token" is used to refresh an existing access token.

refresh_token
string

The refresh_token supplied in a "authorization_code" and required for "refresh_token" grant type.

code
string

he authorization code supplied by Territory Helper appart of the redirect URI in the Authorization code method. Required for "authorization_code" grant types.

redirect_uri
string

The redirect URI supplied in the initial authorization. Required to validate "authorization_code" grant types.

client_id
required
string

client_id is supplied by Territory Helper during registration of your application.

code_verifier
required
string

The random key used to create the hashed and encrypted code_challenge in the previous authorization step.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Revoke token

Revoke an existing client token.

Authorizations:
Public
query Parameters
token
required
string

The access token or refresh token.

Responses

Languages

Languages supported in the website and mobile application.

Get all languages

Retreive all of the supported languages in Territory Helper. This entity is used to define a congregation's language.

Authorizations:
Public

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific language.

Retrieve a specific language entity.

Authorizations:
Public
path Parameters
language_id
required
string

The language ID.

Responses

Response samples

Content type
application/json
{
  • "Id": "st",
  • "Name": "string",
  • "MapLanguage": "strin"
}

Get the mobile language resource file URLs and date last modified.

The mobile language resource file is used to pull the latest translation for moble app usage.

Authorizations:
Public

Responses

Response samples

Content type
application/json
{
  • "Url": "string",
  • "DateModified": "2019-08-24T14:15:22Z"
}

Congregation

Congregation details, settings and properties.

Gets the publisher's congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LanguageId": "st",
  • "Number": 0,
  • "Name": "string",
  • "Address": "string",
  • "Coordinates": "string",
  • "PrimaryContactPhone": "string",
  • "PrimaryContactEmail": "string",
  • "OverviewBoundary": "string",
  • "OverdueDays": 0,
  • "PublisherLoginRequired": true,
  • "ApproveLocations": true,
  • "PublisherLocationAccessId": 0,
  • "PublisherTerritoryAccessId": 0,
  • "PublisherCanEditLocations": true,
  • "PublishercanAddLocations": true,
  • "PublisherCanEditNotes": true,
  • "PublisehrCanViewTerritories": true,
  • "PublisehrCanReturnAssignments": true,
  • "GdprCompliant": true,
  • "LocationsByAddress": true,
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModified": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Get a congregation.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
path Parameters
congregation_id
required
integer

The congregation ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LanguageId": "st",
  • "Number": 0,
  • "Name": "string",
  • "Address": "string",
  • "Coordinates": "string",
  • "PrimaryContactPhone": "string",
  • "PrimaryContactEmail": "string",
  • "OverviewBoundary": "string",
  • "OverdueDays": 0,
  • "PublisherLoginRequired": true,
  • "ApproveLocations": true,
  • "PublisherLocationAccessId": 0,
  • "PublisherTerritoryAccessId": 0,
  • "PublisherCanEditLocations": true,
  • "PublishercanAddLocations": true,
  • "PublisherCanEditNotes": true,
  • "PublisehrCanViewTerritories": true,
  • "PublisehrCanReturnAssignments": true,
  • "GdprCompliant": true,
  • "LocationsByAddress": true,
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModified": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the publisher's congregation administrators.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the congregation administrators.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
path Parameters
congregation_id
required
integer

The congregation ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the publisher's congregation publishers.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the congregation publishers.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
path Parameters
congregation_id
required
integer

The congregation ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the publisher's congregation service groups.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the congregation service groups.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
path Parameters
congregation_id
required
integer

The congregation ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Publishers

Publisher details and properties for a congregation.

Gets the details of the current publisher.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the current territories assigned to the publisher.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the current campaign territories assigned to the publisher.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the composite details of the current publisher.

This API can be used to retreive the publisher and all of their related congregation data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
{
  • "Publisher": {
    },
  • "Congregation": {
    },
  • "ServiceGroupPublishers": [
    ]
}

Adds a new publisher.

Pass the json formatted Publisher model in the body of your request. Applicable properties are FirstName, LastName, Email (optional), PhoneNumber (optional) and AccessLevelID (optional).

The newly-added publisher is returned as the response content.

Authorizations:
AccessTokenOAuth2
Request Body schema:
required

The new publisher.

Id
integer <int32>
CongregationId
integer <int32>
FirstName
string <= 45 characters
LastName
string <= 45 characters
string or null
AccessLevelId
integer
string or null
string or null
LastPasswordChangeDate
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a publisher.

Pass the json formatted Publisher model in the body of your request. Applicable properties are FirstName, LastName, Email (optional), PhoneNumber (optional) and AccessLevelID (optional).

The updated publisher is returned as the response content.

Authorizations:
AccessTokenOAuth2
path Parameters
publisher_id
required
integer

The publisher ID.

Request Body schema:
required

Updates a publisher.

Id
integer <int32>
CongregationId
integer <int32>
FirstName
string <= 45 characters
LastName
string <= 45 characters
string or null
AccessLevelId
integer
string or null
string or null
LastPasswordChangeDate
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a publisher.

Authorizations:
AccessTokenOAuth2
path Parameters
publisher_id
required
integer

The publisher ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "FirstName": "string",
  • "LastName": "string",
  • "Email": "string",
  • "AccessLevelId": 0,
  • "LanguageId": "st",
  • "PhoneNumber": "string",
  • "LastPasswordChangeDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the composite details of the specified publisher.

This API can be used to retreive the publisher and all of their related congregation data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
path Parameters
publisher_id
required
integer

The publisher ID.

Responses

Response samples

Content type
application/json
{
  • "Publisher": {
    },
  • "Congregation": {
    },
  • "ServiceGroupPublishers": [
    ]
}

Service Groups

Service group details and properties for a congregation.

Gets the publisher's service groups.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the publisher's service group roles.

0: Publisher
1: Assistant
2: Overseer

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the current territories assigned to the service group.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the current campaign territories assigned to the service group.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new service group.

Authorizations:
AccessTokenOAuth2
query Parameters
name
required
string

The service group name.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a service group.

Authorizations:
AccessTokenOAuth2
path Parameters
service_group_id
required
integer

The service group ID.

query Parameters
name
required
string

The service group name.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a service group.

Authorizations:
AccessTokenOAuth2
path Parameters
service_group_id
required
integer

The service group ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Territory Types

Territory types (categories or groups).

Gets the territory types for a congregation.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
query Parameters
congregation_id
integer

The congregation ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new territory type.

Pass the json formatted Territory type model in the body of your request.

Authorizations:
AccessTokenOAuth2
Request Body schema:
required

The new territory type.

Id
integer <int32>
string or null
Name
string <= 100 characters
string or null

The HEX code for the type color.

DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets a territory type.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_type_id
required
integer

The territory type ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates an existing territory type.

Pass the json formatted Territory type model in the body of your request. The newly-modified territory type is returned as the response content.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_type_id
required
integer

The territory type ID.

Request Body schema:
required

Updates an existing territory type.

Id
integer <int32>
string or null
Name
string <= 100 characters
string or null

The HEX code for the type color.

DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a territory type by ID.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_type_id
required
integer

The territory type ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "Code": "string",
  • "Name": "string",
  • "Color": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Territories

Territory details, properties and listings.

Gets the territories for a congregation.

Only the publisher's congregation is allowed to be accessed.

Authorizations:
AccessTokenOAuth2
query Parameters
congregation_id
integer

The congregation ID.

territory_type_id
integer

Territories of a specified territory type. Leaving empty will return territories of all territory types.

territory_number
string

Territories of a given number. Leaving empty will return territories with any number.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new territory.

Pass the json formatted Territory model in the body of your request.

TerritoryTypeId is required. If you omit Number, Territory Helper will automatically supply a value.

The newly-added territory is returned as the response content.

Authorizations:
AccessTokenOAuth2
Request Body schema:
required

The new territory.

Id
integer <int32>
UrlId
string <= 16 characters

The unique ID used to identify the territory on the web.

CongregationId
integer <int32>
TerritoryTypeId
integer <int32>
Number
string <= 10 characters
string or null

An array of coordinates making up the territory boundary as JSON.

string or null

The center point specified by the creator as JSON.

string or null

"polygon"
"marker"
NULL if unmapped

string or null

The current resolved notes from suggested or approved notes.

string or null
string or null
string or null

The short URL code used in the QR code.

https://r.territoryhelper.com/{ShortUrlCode}

IncludeStatistics
boolean

Whether the territory is included in statistics for the dashboard, statistical territory views, etc.

ViewUrl
string

The digital territory view URL.

PrintUrl
string

The territory print view URL.

TerritoryUrl
string

The full screen territory URL for embedding in applications.

StaticUrl
string

The full screen territory URL without controls for embedding in applications.

TerritoryImage
string

The URL to the territory image.

BoundaryDateModified
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the territories assigned to the current user.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a territory by ID.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates an existing territory.

Pass the json formatted Territory model in the body of your request. The newly-modified territory is returned as the response content.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

Updates an existing territory.

Id
integer <int32>
UrlId
string <= 16 characters

The unique ID used to identify the territory on the web.

CongregationId
integer <int32>
TerritoryTypeId
integer <int32>
Number
string <= 10 characters
string or null

An array of coordinates making up the territory boundary as JSON.

string or null

The center point specified by the creator as JSON.

string or null

"polygon"
"marker"
NULL if unmapped

string or null

The current resolved notes from suggested or approved notes.

string or null
string or null
string or null

The short URL code used in the QR code.

https://r.territoryhelper.com/{ShortUrlCode}

IncludeStatistics
boolean

Whether the territory is included in statistics for the dashboard, statistical territory views, etc.

ViewUrl
string

The digital territory view URL.

PrintUrl
string

The territory print view URL.

TerritoryUrl
string

The full screen territory URL for embedding in applications.

StaticUrl
string

The full screen territory URL without controls for embedding in applications.

TerritoryImage
string

The URL to the territory image.

BoundaryDateModified
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a territory by ID.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the composite territory for a territory.

This API can be used to retreive a specified territory along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

query Parameters
visits
string

assignment: (Default) Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "DisplayName": "string",
  • "Territory": {
    },
  • "TerritoryType": {
    },
  • "Assignment": {
    },
  • "TerritoryNotes": {
    },
  • "CompositeLocations": [
    ]
}

Gets the composite territories assigned to the logged in publisher and the service groups they belong to.

This API can be used to retreive the assigned territories along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
query Parameters
visits
string

assignment: Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: (Default) Do not include visit data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Requests a territory assignment.

Optionally add a Request to the body of the request. You can specify a TerritoryId if you know which territory to request; otherwise omit it. Territory Helper responds to the request by sending email to the territory servant.

Authorizations:
AccessTokenOAuth2
Request Body schema:
optional

The territory request.

string or null

The territory ID or URL ID.

string or null

Responses

Request samples

Content type
{
  • "TerritoryId": "string",
  • "Message": "string"
}

Response samples

Content type
application/json
{
  • "TerritoryId": "string",
  • "Message": "string"
}

Notifies a publisher about an overdue territory assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer

The assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Assignments

Territory assignments and assignment history.

Requests a territory assignment.

Optionally add a Request to the body of the request. You can specify a TerritoryId if you know which territory to request; otherwise omit it. Territory Helper responds to the request by sending email to the territory servant.

Authorizations:
AccessTokenOAuth2
Request Body schema:
optional

The territory request.

string or null

The territory ID or URL ID.

string or null

Responses

Request samples

Content type
{
  • "TerritoryId": "string",
  • "Message": "string"
}

Response samples

Content type
application/json
{
  • "TerritoryId": "string",
  • "Message": "string"
}

Notifies a publisher about an overdue territory assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer

The assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the assignments of the publisher's congregation.

Note that you can specify an optional 'take' parameter to specify the maximum number assignments to take. The default is 1. It is recommended to take as few assignments as possible in order to reduce response time and overhead.

Authorizations:
AccessTokenOAuth2
query Parameters
take
integer

The number of assignments per territory to take. If omitted the default of 1 will be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the assignments for a territory.

Note that you can specify an optional 'take' parameter to specify the maximum number assignments to take. The default is 1. It is recommended to take as few assignments as possible in order to reduce response time and overhead.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

query Parameters
take
integer

The number of assignments to take. If omitted the default of 1 will be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assigns a specified territory.

There are no mandatory values (you can omit the Assignment body). Note that the following values are ignored if you supply them: Id, TerritoryId, PublisherName, DateNotified, DateReturned, NotifierId, DateModified, CreatorId, and LastModifierId. If you omit PublisherId, then the current user is assumed. If you omit DateAssigned, then the current date is assumed. The newly-added assignment is returned as the response content.

Note that the user's ability to assign territories depends on his role.

You should specify the DateAssigned value using your local time. If you leave the DateAssigned null then the territory will still be booked out but the DateAssigned will be set by the server which operates in UTC (so the DateAssigned value may be some hours different from your local time).

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The assignment.

Id
integer <int32>
TerritoryId
integer <int32>
integer or null
integer or null
PublisherName
string <= 100 characters
string or null
Unworked
boolean
DateAssigned
string <date-time>
string or null
integer or null

The publisher that notified the assignee on the assignment being overdue

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the current assignment for a territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the current assignment for a territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer

The assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a territory assignment.

Can be used to return (i.e. check-in) a worked territory map. Note that the following values are ignored if you supply them: Id, TerritoryId, PublisherName, DateNotified, NotifierId, DateModified, CreatorId, and LastModifierId. The updated assignment is returned as the response content.

When updating an Assignment you must supply all applicable values (there is no PATCH method to update a subset of the Assignment's properties).

If you update any datetime values (e.g. DateReturned), please use your local time.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer

The assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a territory assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer

The assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Returns a territory assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer

The assignment ID.

query Parameters
return_date
string <date-time>

Use your local timezone. If omitted the current date and time will be used.

unworked
boolean

Whether the territory assignment was unworked.

notes
string

Notes about the assignment for the servants.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the composite publisher assignments of the specified publisher.

This API can be used to retreive all territory and campaign territory assignments along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
path Parameters
publisher_id
required
integer

The publisher ID.

query Parameters
visits
string

assignment: (Default) Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "CompositeTerritories": [
    ],
  • "CompositeCampaignTerritories": [
    ]
}

Gets the composite publisher assignments the current publisher.

This API can be used to retreive all territory and campaign territory assignments along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
query Parameters
visits
string

assignment: Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: (Default) Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "CompositeTerritories": [
    ],
  • "CompositeCampaignTerritories": [
    ]
}

Campaigns

Campaign details and listings.

Gets the campaigns for the publisher's congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the current active campaigns for the publisher's congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the future or upcoming campaigns for the publisher's congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the past concluded campaigns for the publisher's congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the campaign territories in a campaign.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer

The campaign ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the campaign territory for the specified campaign and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer

The campaign ID.

territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "CampaignId": 0,
  • "TerritoryId": 0,
  • "PublisherId": 0,
  • "ServiceGroupId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "DateAssigned": 0,
  • "DateCompleted": 0,
  • "ShortUrlCode": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a campaign territory.

The only properties that can be changed are complete_date and notes.

The localTime query string field to specify the user's local datetime in ISO8601 (otherwise the server will use UTC).

The campaign_territory body can be left null and the remaining properties will be ignored when updating the campaign territory.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer

The campaign ID.

territory_id
required
string

The territory ID or URL ID.

query Parameters
complete_date
string <date-time>

If left NULL the current date will be used.

Request Body schema:
optional

The modified campaign territory.

CampaignId
integer <int32>
TerritoryId
integer <int32>
integer or null
integer or null
PublisherName
string <= 100 characters
string or null
integer or null
integer or null
string or null

The short URL code used in the QR code.

https://r.territoryhelper.com/{ShortUrlCode}

DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "CampaignId": 0,
  • "TerritoryId": 0,
  • "PublisherId": 0,
  • "ServiceGroupId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "DateAssigned": 0,
  • "DateCompleted": 0,
  • "ShortUrlCode": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "CampaignId": 0,
  • "TerritoryId": 0,
  • "PublisherId": 0,
  • "ServiceGroupId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "DateAssigned": 0,
  • "DateCompleted": 0,
  • "ShortUrlCode": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a campaign territory assignment.

Deletes an existing campaign territory assignment and informs the territory servants (administrators and servants) that it was returned unworked.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer

The campaign ID.

territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "CampaignId": 0,
  • "TerritoryId": 0,
  • "PublisherId": 0,
  • "ServiceGroupId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "DateAssigned": 0,
  • "DateCompleted": 0,
  • "ShortUrlCode": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Completes a campaign territory assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer

The campaign ID.

territory_id
required
string

The territory ID or URL ID.

query Parameters
complete_date
string <date-time>

If left NULL the current date will be used.

unworked
boolean
notes
string

Responses

Response samples

Content type
application/json
{
  • "CampaignId": 0,
  • "TerritoryId": 0,
  • "PublisherId": 0,
  • "ServiceGroupId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "DateAssigned": 0,
  • "DateCompleted": 0,
  • "ShortUrlCode": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the composite campaign territory.

This API can be used to retreive a specified campaign territory along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
path Parameters
campaign_id
required
integer <int32>

The campaign ID.

territory_id
required
string

The territory ID or URL ID.

query Parameters
visits
string

assignment: (Default) Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "Territory": {
    },
  • "CampaignTerritory": {
    },
  • "Campaign": {
    }
}

Gets the composite campaign territories assigned to the logged in publisher and the service groups they belong to.

This API can be used to retreive the assigned campaign territories along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
query Parameters
visits
string

assignment: Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: (Default) Do not include visit data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the composite publisher assignments of the specified publisher.

This API can be used to retreive all territory and campaign territory assignments along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
path Parameters
publisher_id
required
integer

The publisher ID.

query Parameters
visits
string

assignment: (Default) Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "CompositeTerritories": [
    ],
  • "CompositeCampaignTerritories": [
    ]
}

Gets the composite publisher assignments the current publisher.

This API can be used to retreive all territory and campaign territory assignments along with related data, and is more efficient than making multiple API calls to retrieve the discrete data.

Authorizations:
AccessTokenOAuth2
query Parameters
visits
string

assignment: Include visit data for the current assignment.
recent: Include the most recent visit for each location and unit.
none: (Default) Do not include visit data.

Responses

Response samples

Content type
application/json
{
  • "CompositeTerritories": [
    ],
  • "CompositeCampaignTerritories": [
    ]
}

Territory Notes

Get and update territory notes and note properties.

Gets the notes for a territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "Notes": "string",
  • "NotesSuggested": "string",
  • "NotesSuggestedPublisherId": 0,
  • "NotesSuggestedDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates the notes for a territory.

Territory Helper will automatically handle the modification of territory notes depending on congregation settings and publisher role.

Publishers with administrators and servant roles will bypass suggested notes and directly set the territory notes.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

query Parameters
notes
string

If left NULL the notes will be cleared.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "Notes": "string",
  • "NotesSuggested": "string",
  • "NotesSuggestedPublisherId": 0,
  • "NotesSuggestedDate": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Tags

Territory tag details and listings.

Gets the tags for a congregation.

Authorizations:
AccessTokenOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the specified tag.

Authorizations:
AccessTokenOAuth2
path Parameters
tag_id
required
integer

The tag ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "Name": "string",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the territory tags for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations

Territory location details, properties and listings.

Gets the locations for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a location to the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The new location.

Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes all locations for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "UrlId": "string",
  • "CongregationId": 0,
  • "TerritoryTypeId": 0,
  • "Number": "string",
  • "Boundary": "string",
  • "CenterCoordinates": "string",
  • "ShapeType": "string",
  • "Notes": "string",
  • "Label": "string",
  • "Address": "string",
  • "ShortUrlCode": "string",
  • "IncludeStatistics": true,
  • "ViewUrl": "string",
  • "PrintUrl": "string",
  • "TerritoryUrl": "string",
  • "StaticUrl": "string",
  • "TerritoryImage": "string",
  • "BoundaryDateModified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets a specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates an existing location for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The modified location.

Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a location for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets a specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates an existing location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The modified location.

Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Adds a location to the specified territory.

Authorizations:
AccessTokenOAuth2
Request Body schema:
required

The modified location.

Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Batch Locations

Batch location processing.

Adds locations to a territory in batch.

Adding locations in a batch using this API is quicker than making multiple calls to add individual locations. Note that the batch is applied transactionally, which means either all the specified locations are added or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The locations to be added in batch.

Array
Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Updates locations for a territory in batch.

Updating locations in a batch using this API is quicker than making multiple calls to update individual locations. Note that the batch is applied transactionally, which means either all the specified locations are updated or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The locations to be modified in batch.

Array
Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Deletes locations for a territory in batch.

Deleting locations in a batch using this API is quicker than making multiple calls to delete individual locations. Note that the batch is applied transactionally, which means either all the specified locations are deleted or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The locations to be deleted in batch.

Array
Id
integer <int32>
CongregationId
integer <int32>
integer or null
Approved
boolean
TypeId
integer <byte>
StatusId
integer <byte>
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null
string or null

JSON encoded coordinates.

string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Location Units

Location unit details, properties and listings.

Gets the location units for a specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a unit for a specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The added location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes all of the location units for a specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets units for a specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a unit for a specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The added location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes all of the location units for a specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "CongregationId": 0,
  • "TerritoryId": 0,
  • "Approved": true,
  • "TypeId": 0,
  • "StatusId": 0,
  • "Address": "string",
  • "Number": "string",
  • "StreetName": "string",
  • "City": "string",
  • "County": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "CountryCode": "st",
  • "LatLng": "string",
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Adds a unit.

Authorizations:
AccessTokenOAuth2
Request Body schema:
required

The added location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets a location unit for the specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a unit for the specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Request Body schema:
required

The modified location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a unit for a specified location.

Authorizations:
AccessTokenOAuth2
path Parameters
location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets a location unit for the specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a unit for the specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Request Body schema:
required

The modified location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a unit for a specified location and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the specified location unit.

Authorizations:
AccessTokenOAuth2
path Parameters
unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a unit.

Authorizations:
AccessTokenOAuth2
path Parameters
unit_id
required
integer <int32>

The location unit ID.

Request Body schema:
required

The modified location unit.

Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes a unit.

Authorizations:
AccessTokenOAuth2
path Parameters
unit_id
required
integer <int32>

The location unit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "LocationId": 0,
  • "Approved": true,
  • "StatusId": 0,
  • "Number": "string",
  • "Floor": 0,
  • "DateLastVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Batch Location Units

Batch location unit processing.

Adds location units to a location in batch.

Adding units in a batch using this API is quicker than making multiple calls to add individual units. Note that the batch is applied transactionally, which means either all the specified units are added or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The location units to be added in batch.

Array
Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Updates location units for a territory in batch.

Updating units in a batch using this API is quicker than making multiple calls to update individual units. Note that the batch is applied transactionally, which means either all the specified units are updated or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The location units to be modified in batch.

Array
Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Deletes location units for a territory in batch.

Deleting units in a batch using this API is quicker than making multiple calls to delete individual units. Note that the batch is applied transactionally, which means either all the specified units are deleted or none are.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

location_id
required
integer <int32>

The location ID.

Request Body schema:
required

The location units to be deleted in batch.

Array
Id
integer <int32>
LocationId
integer <int32>
Approved
boolean
StatusId
integer <byte>
string or null
Floor
integer <int16>
string or null
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • 0
]

Location Statuses

Available location status definitions for locations and units.

Gets the available location status definitions.

Authorizations:
AccessTokenOAuth2
query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the specified location status.

Authorizations:
AccessTokenOAuth2
path Parameters
status_id
required
integer <int32>

The location status ID.

query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "InternalName": "string",
  • "LocalizedName": "string"
}

Location Types

Available Location type definitions for locations.

Gets the available location type definitions.

Authorizations:
AccessTokenOAuth2
query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the specified location type.

Authorizations:
AccessTokenOAuth2
path Parameters
type_id
required
integer <int32>

The location type ID.

query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "InternalName": "string",
  • "LocalizedName": "string"
}

Visits

Visit details for locations and units.

Gets the visits for the specified assignment and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer <int32>

The territory assignment ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds or updates a visit for the specified assignment and territory.

Adds a visit or updates an existing visit within the territory assignment.

Note that there is no PUT equivalent. Use POST to both add a new visit and update an existing one. (There is only ever 0 or 1 visits associated with a location for a given territory assignment, so POST will always update the visit if it already exists.)

The following Visit values are mandatory: StatusId, TerritoryId (but you can omit it if it is specified in the route), LocationId (or LocationUnitId). You should also explicitly set the DateVisited value if it is to be changed. Use your congregation's local time. Suitable defaults are used for other values that are unspecified.

Note that if you are specifying LocationUnitId it is not necessary to specify LocationId.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer <int32>

The territory assignment ID.

Request Body schema:
required

The added or modified visit.

Id
integer <int32>
StatusId
integer <byte>
TerritoryId
integer <int32>
integer or null
integer or null
integer or null
integer or null
PublisherId
integer <int32>
DateVisited
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes all visits for the specified assignment and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer <int32>

The territory assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the visits for the specified assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer <int32>

The territory assignment ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds or updates a visit for the specified assignment.

Adds a visit or updates an existing visit within the territory assignment.

Note that there is no PUT equivalent. Use POST to both add a new visit and update an existing one. (There is only ever 0 or 1 visits associated with a location for a given territory assignment, so POST will always update the visit if it already exists.)

The following Visit values are mandatory: StatusId, TerritoryId (but you can omit it if it is specified in the route), LocationId (or LocationUnitId). You should also explicitly set the DateVisited value if it is to be changed. Use your congregation's local time. Suitable defaults are used for other values that are unspecified.

Note that if you are specifying LocationUnitId it is not necessary to specify LocationId.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer <int32>

The assignment ID.

Request Body schema:
required

The added or modified visit.

Id
integer <int32>
StatusId
integer <byte>
TerritoryId
integer <int32>
integer or null
integer or null
integer or null
integer or null
PublisherId
integer <int32>
DateVisited
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes all visits for the specified assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer <int32>

The territory assignment ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "TerritoryId": 0,
  • "ServiceGroupId": 0,
  • "PublisherId": 0,
  • "PublisherName": "string",
  • "Notes": "string",
  • "Unworked": true,
  • "DateAssigned": "2019-08-24T14:15:22Z",
  • "DateReturned": "2019-08-24T14:15:22Z",
  • "NotifierId": 0,
  • "DateNotified": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the visits for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

query Parameters
verbose
boolean

true: All visit data for each location and unit.
false: (Default) Most recent visit for each location and unit.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds or updates a visit for the specified territory.

The following Visit values are mandatory: StatusId, LocationId (or LocationUnitId). You must not specify an AssignmentId (use the "assigments" route if required). You should explicitly set the DateVisited value if it is to be changed. Use your congregation's local time. Suitable defaults are used for other values that are unspecified.

Note that if you are specifying LocationUnitId it is not necessary to specify LocationId.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

Request Body schema:
required

The added or modified visit.

Id
integer <int32>
StatusId
integer <byte>
TerritoryId
integer <int32>
integer or null
integer or null
integer or null
integer or null
PublisherId
integer <int32>
DateVisited
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes the visit for a specified assignment and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

query Parameters
location_id
integer <int32>

The location ID.

unit_id
integer <int32>

The location unit ID.

assignment_id
integer <int32>

The assignment ID.

campaign_id
integer <int32>

The campaign ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the visit for a specified assignment and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer <int32>

The territory assignment ID.

visit_id
required
integer <int32>

The visit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes the visit for a specified assignment and territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

assignment_id
required
integer <int32>

The territory assignment ID.

visit_id
required
integer <int32>

The visit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Gets the visit for a specified assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer <int32>

The territory assignment ID.

visit_id
required
integer <int32>

The visit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes the visit for the specified assignment.

Authorizations:
AccessTokenOAuth2
path Parameters
assignment_id
required
integer <int32>

The territory assignment ID.

visit_id
required
integer <int32>

The visit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Updates a visit for the specified territory.

The following Visit values are mandatory: StatusId, LocationId (or LocationUnitId). You must not specify an AssignmentId (use the "assigments" route if required). You should explicitly set the DateVisited value if it is to be changed. Use your congregation's local time. Suitable defaults are used for other values that are unspecified.

Note that if you are specifying LocationUnitId it is not necessary to specify LocationId.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

visit_id
required
integer <int32>

The visit ID.

Request Body schema:
required

The modified visit.

Id
integer <int32>
StatusId
integer <byte>
TerritoryId
integer <int32>
integer or null
integer or null
integer or null
integer or null
PublisherId
integer <int32>
DateVisited
string <date-time>
DateCreated
string <date-time>
string or null
CreatorId
integer <int32>
integer or null

Responses

Request samples

Content type
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Deletes the visit for the specified territory.

Authorizations:
AccessTokenOAuth2
path Parameters
territory_id
required
string

The territory ID or URL ID.

visit_id
required
integer <int32>

The visit ID.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "StatusId": 0,
  • "TerritoryId": 0,
  • "LocationId": 0,
  • "LocationUnitId": 0,
  • "TerritoryAssignmentId": 0,
  • "CampaignId": 0,
  • "PublisherId": 0,
  • "DateVisited": "2019-08-24T14:15:22Z",
  • "DateCreated": "2019-08-24T14:15:22Z",
  • "DateModfied": "2019-08-24T14:15:22Z",
  • "CreatorId": 0,
  • "LastModifierId": 0
}

Visit Statuses

Available visit status definitions for location and unit visits.

Gets the available visit status definitions.

Authorizations:
AccessTokenOAuth2
query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the specified visit status.

Authorizations:
AccessTokenOAuth2
path Parameters
status_id
required
integer <int32>

The visit status ID.

query Parameters
language_id
string

The language ID. The publisher's language code will be used if not specified.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "InternalName": "string",
  • "LocalizedName": "string"
}