ServiceChannel Locations API
The Locations API from ServiceChannel — 34 operation(s) for locations.
OpenAPI Specification
swagger: '2.0'
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours Locations API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: Locations
paths:
/stores:
get:
tags:
- Locations
summary: Retrieve stores
description: "Returns a list of all Locations, also called Stores, if neither of the filters is used. You can get the details for a certain store by specifying any of the following parameters: `Id`, `storeIdentifier`, `name`.\r\n <br /> You can use either of these methods to get a list of the subscriber’s locations: [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\r\n <br /> Visit ServiceChannel University to find out more about [locations and provider assignments](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/556105830/Locations+Provider+Assignments)."
operationId: GETv3_stores?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: id
in: query
description: Unique location identifier.
required: false
type: integer
format: int32
- name: storeIdentifier
in: query
description: Alphanumeric location identifier in the client’s system. Assigned by and unique per subscriber.
required: false
type: string
- name: name
in: query
description: Location name.
required: false
type: string
- name: sort
in: query
description: Sort resources by the specified property in the response.
required: false
type: string
- name: page
in: query
description: Results page number.
required: false
type: integer
format: int32
- name: pageSize
in: query
description: Number of objects on the results page. The default and maximum per page is 50.
required: false
type: integer
format: int32
responses:
'200':
description: The requested locations are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc\r\n <br/>Error codes: \r\n 502 — Subscriber not found"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 - API call rejected by security permissions\r\n 100 — User has no permissions to perform this action"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error. \r\n <br/>Error codes:\r\n 501 — “Location ID” is not a valid value for Int32\r\n "
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/locations:
get:
tags:
- Locations
summary: Retrieve stores
description: "Returns a list of all Locations, also called Stores, if neither of the filters is used. You can get the details for a certain store by specifying any of the following parameters: `Id`, `storeIdentifier`, `name`.\r\n <br /> You can use either of these methods to get a list of the subscriber’s locations: [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\r\n <br /> Visit ServiceChannel University to find out more about [locations and provider assignments](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/556105830/Locations+Provider+Assignments)."
operationId: GETv3_locations?Id={Id}&storeIdentifier={storeIdentifier}&Name={Name}&Sort={Sort}&Page={Page}&PageSize={PageSize}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: id
in: query
description: Unique location identifier.
required: false
type: integer
format: int32
- name: storeIdentifier
in: query
description: Alphanumeric location identifier in the client’s system. Assigned by and unique per subscriber.
required: false
type: string
- name: name
in: query
description: Location name.
required: false
type: string
- name: sort
in: query
description: Sort resources by the specified property in the response.
required: false
type: string
- name: page
in: query
description: Results page number.
required: false
type: integer
format: int32
- name: pageSize
in: query
description: Number of objects on the results page. The default and maximum per page is 50.
required: false
type: integer
format: int32
responses:
'200':
description: The requested locations are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.GetLocationsWithTotalResponse'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc\r\n <br/>Error codes: \r\n 502 — Subscriber not found"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 - API call rejected by security permissions\r\n 100 — User has no permissions to perform this action"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error. \r\n <br/>Error codes:\r\n 501 — “Location ID” is not a valid value for Int32\r\n "
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/subscribers/current/users/current/stores:
get:
tags:
- Locations
summary: Get stores
description: "Returns a list of stores with the LocationIDs and subscriber IDs, along with the location address details. The method is available to subscribers only.\r\n <br /> To get more detailed information, use one of these methods: [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /odata/locations](/swagger/ui/index?version=3#/Locations/Locations_GetLocations).\r\n <br /> Learn about updating [location details](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/708936009/Updating+Location+Details) in ServiceChannel University."
operationId: GETv3_subscribers_current_users_current_stores
consumes: []
produces:
- application/json
- text/json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
deprecated: false
x-access: Any
/locations/{locationId}:
get:
tags:
- Locations
summary: Retrieve a location
description: "Returns the details for the specified location.\r\n <br /> To receive details of several locations, use one of these methods: [GET /stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET /odata/locations](/swagger/ui/index?version=3#/Locations/Locations_GetLocations)."
operationId: GETv3_locations_{locationId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: path
description: Unique numeric identifier of the location to return the details for.
required: true
type: integer
format: int32
responses:
'200':
description: The specified location details are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.LocationWithTimezoneName'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 601 — Location is not found"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: The server was unable to complete the request due to an internal error.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
put:
tags:
- Locations
summary: Update a location
description: "Modifies information of the existing location.You can use either of the following methods to retrieve location details: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\r\n <br />***Note:*** Method is available for subscribers with the *Super Admin* permission or *SC Admin* role.\r\n <br />Visit ServiceChannel University to find out [how subscribers can update location details](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/708936009/Updating+Location+Details).\r\n <br />**Example request**\r\n \r\n PUT / locations/{locationId}\r\n {\r\n \"StoreId\": \"34\",\r\n \"Name\": \"CSR Flagship\",\r\n \"Latitude\": 40.736601,\r\n \"Longitude\": -73.991795,\r\n \"Distance\": null,\r\n \"Address1\": \"3rd Floor, Innovation Center\",\r\n \"Address2\": \"18 E. 16th Street\",\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"StateId\": 1,\r\n \"Region\": \"Northeast\",\r\n \"District\": \"NYC/LI\",\r\n \"Zip\": \"10003\",\r\n \"Country\": \"US\",\r\n \"CountryId\": 1,\r\n \"ClosedDate\": \"null\",\r\n \"OpenDate\": \"2021-07-05T07:05:04.991Z\",\r\n \"Email\": \"flagship@gmail.com\",\r\n \"Phone\": \"212-555-1212\",\r\n \"Contact\": \"\",\r\n \"FaxNumber\": \"\",\r\n \"LocationTypeId\": null,\r\n \"SquareValue\": 20.21\r\n \"SquareMeasure\": \"ft or foot\" or \"m or metre\"\r\n }"
operationId: PUTv3_locations_{locationId}
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: locationId
in: path
description: Unique identifier of the subscriber’s location which information you want to update.
required: true
type: integer
format: int32
- name: request
in: body
description: Request to change the location details. Leaving a parameter empty or excluding it from the request model erases the already existing data.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.UpdateLocationExRequest'
responses:
'200':
description: The location details are updated.
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 601 — Location not found\r\n 1254 — Invalid square measure"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: The server was unable to complete the request due to an internal error.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/locations/{locationId}/notes:
get:
tags:
- Locations
summary: Retrieve location notes
description: Returns the location notes for the specified location.
operationId: GETv3_locations_{locationId}_notes?privateNotes={privateNotes}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: path
description: Unique ID of the location you want to receive notes for.
required: true
type: integer
format: int32
- name: privateNotes
in: query
description: Should privateNotes be included. Settings from dashboardSetup by default
required: false
type: boolean
default: false
responses:
'200':
description: Location notes are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.LocationNote.LocationNote'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 601 — Location not found"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 - API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: The server was unable to complete the request due to an internal error.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
post:
tags:
- Locations
summary: Add a location note
description: "Adds a location note for the specified location. If a note is already added, you can change it by sending the request, or leave the `Value` parameter empty to delete the note.\r\n <br /> To retrieve location IDs along with the location notes, send either of these requests: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\r\n Get location notes separately for the specified location by sending the [GET/locations/{locationId}/notes](/swagger/ui/index?version=3#/Locations/GETv3_locations__locationId__notes) request.\r\n <br />***Note***: Method is available for users with the *Super Admin* or *Admin* roles, or the *Location Admin* permission.\r\n <br /> **Example request**\r\n \r\n POST /locations/{locationId}/notes\r\n {\r\n \"Header\": \"Location Manager\",\r\n \"Value\": \"John Smith\"\r\n }"
operationId: POSTv3_locations_{locationId}_notes
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: locationId
in: path
description: Unique ID of the location you want to update a note for.
required: true
type: integer
format: int32
- name: locNoteHeader
in: body
description: Request to add, update or delete a location note header for a location.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeaderApiModelRequest'
responses:
'200':
description: The note is added to the specified location.
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 601 — Location is not found\r\n 1301 — Request is empty or null"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n <br/>Error codes:\r\n 100 — User has no rights to perform this action\r\n 612 — The user does not have access to update a protected location note header"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "The requested resource does not exist on the server.\r\n <br/>Error codes:\r\n 611 — The location note header does not exist on the subscriber instance"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/locations/{storeId}/updateNotes:
post:
tags:
- Locations
summary: Add location notes
description: "Add location notes for the specified location. If a note is already added, you can change it by sending the request, or leave the `Value` parameter empty to delete the note.\r\n <br /> ***Note***: To retrieve store IDs along with the location notes, send either of these requests: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).\r\n Get location notes separately for the specified location by sending the [GET/locations/{locationId}/notes](/swagger/ui/index?version=3#/Locations/GETv3_locations__locationId__notes) request.\r\n <br /> **Example request**\r\n \r\n POST /locations/{storeId}/updateNotes\r\n {\r\n \"Notes\": [\r\n {\r\n \"Header\": \"Note1\",\r\n \"Value\": \"1\"\r\n },\r\n {\r\n \"Header\": \"Note2\",\r\n \"Value\": \"2\"\r\n }\r\n ]\r\n }"
operationId: POSTv3_locations_{storeId}_updateNotes
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: storeId
in: path
description: Unique storeId of the location you want to update a note for.
required: true
type: string
- name: locNoteHeaders
in: body
description: Request to add, update or delete a location note headers for a location.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.LocationNote.UpdateLocationNoteHeadersApiModelRequest'
responses:
'200':
description: The note is added to the specified location.
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes:\r\n 601 — Location is not found\r\n 1301 — Request is empty or null"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n <br/>Error codes:\r\n 100 — User has no rights to perform this action\r\n 612 — The user does not have access to update a protected location note header"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "The requested resource does not exist on the server.\r\n <br/>Error codes:\r\n 611 — The location note header does not exist on the subscriber instance"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/locations/UnassignedContracts:
get:
tags:
- Locations
summary: Get unassigned contracts
description: "Returns subscriber’s locations with open trades that have unassigned providers.\r\n <br /> ***Note***: Method could be outdated causing faulty results."
operationId: GETv3_locations_UnassignedContracts
consumes: []
produces:
- application/json
- text/json
responses:
'200':
description: The requested locations are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.GetProviderAssignmentExtendedLocationsResponse'
'400':
description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: The requested resource does not exist on the server.
deprecated: false
x-access: Any
/locations/{locationId}/evacuationmaps:
get:
tags:
- Locations
summary: Get an evacuation plan map of a location
description: "Returns evacuation plan map attachments details for the specified location.\r\n <br /> Visit ServiceChannel University to learn about [Location Emergency Evacuation Plan Map(s)](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/710312376/Location+Emergency+Evacuation+Plan+Map+s)."
operationId: GETv3_locations_{locationId}_evacuationmaps
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: path
description: Unique numeric identifier of the location to return the details for.
required: true
type: integer
format: int32
responses:
'200':
description: Location evacuation plan maps are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.GetLocationAttachmentsResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: The server was unable to complete the request due to an internal error.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/locations/CheckIfLocationIsOpen:
get:
tags:
- Locations
summary: Check whether the location is open or closed.
description: "Returns information on the specified location if it is open or closed now. If the `checkTime` parameter is not provided, the location is checked at the current time.\r\n <br /> Learn about [managing business hours](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/683507788/Managing+Business+Hours) in ServiceChannel University."
operationId: GETv3_locations_CheckIfLocationIsOpen?locationId={locationId}&checkTime={checkTime}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: locationId
in: query
description: Unique location identifier
required: true
type: integer
format: int32
- name: checkTime
in: query
description: Date and time to check if the location is open
required: false
type: string
format: date-time
responses:
'200':
description: The location opening status is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.AfterHours.CheckIfLocationIsOpenResponse'
deprecated: false
x-access: Any
/GetFilteredLocations:
post:
tags:
- Locations
summary: Get locations by filters
description: "Returns locations based on the filters applied.\r\n By default closed locations are not included in the response. To include them, set the `IncludeClosedLocations` parameter to `true`."
operationId: POSTv3_GetFilteredLocations
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: "Request parameters to filter the response. Parameters can be used separately, as a combination of several parameters, or all at once. For the `LocationIds` and `StateIds` parameters, several values can be entered separated with a comma.\r\n <br />**Example Request**\r\n \r\n POST /GetFilteredLocations\r\n {\r\n \"ProviderId\": 2000069665,\r\n \"LocationIds\": [\r\n 2005862796, 2005901195\r\n ],\r\n \"StateIds\": [\r\n 30, 32\r\n ],\r\n \"IncludeClosedLocations\": \"false\"\r\n }"
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.GetFilteredLocationsRequest'
responses:
'200':
description: The filtered locations are in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Location.LocationShortModel'
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/>Error codes: \r\n 502 — Subscriber not found"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The request is not authorized.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n <br/>Error codes:\r\n 100 — User has no rights to perform this action"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/locations/LocationWithNotes:
post:
tags:
- Locations
summary: Create a location with location notes
description: "Create or update a location along with location notes.\r\n <br />**Note:** Method takes a dynamic list of parameters as input.\r\n <br />**Example request**\r\n \r\n POST /locations/LocationWithNotes\r\n {\r\n \"StoreId\":\"TestStore\",\r\n \"Name\": \"CSR Flagship\",\r\n \"MainAddress\": \"18 E. 16th Street\",\r\n \"AddlAddress\": \"3rd Floor, Innovation Center\",\r\n \"Latitude\": 40.736601,\r\n \"Longitude\": -73.991795,\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"Region\": \"Northeast\",\r\n \"District\": \"NYC/LI\",\r\n \"Zip\": \"10003\",\r\n \"Country\": \"US\",\r\n \"OpenDate\": \"2021-07-03T00:10:00.308Z\",\r\n \"ClosedDate\": \"\",\r\n \"Email\": \"csrflagship@gmail.com\",\r\n \"Phone\": \"212-555-1212\",\r\n \"Contact\": \"\",\r\n \"FaxNumber\": \"\",\r\n \"YourLocationNoteHeader1\": \"Value1\",\r\n \"YourLocationNoteHeader2\": \"Value2\",\r\n \"YourLocationNoteHe
# --- truncated at 32 KB (184 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-locations-api-openapi.yml