POST api/MerchantLocations

Create MerchantLocation

Request Information

URI Parameters

None.

Body Parameters

The MerchantLocation class

MerchantLocation
NameDescriptionTypeAdditional information
Id

GUID Id for Location. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

MerchantId

GUID Id for Merchant. [REQUIRED]

globally unique identifier

None.

Active

Indicates whether the Location is active or not. [REQUIRED]

boolean

None.

Name

Name of the Location. [NULL]

string

None.

Address1

Address 1 for the Location. [NULL]

string

None.

Address2

Address 2 for the Location. [NULL]

string

None.

City

City of the Location [NULL]

string

None.

State

State of the Location [NULL]

string

None.

ZipCode

ZipCode for the Location [NULL]

string

None.

PhoneNumber

Phone number for the Location [NULL]

string

None.

Deleted

Indicates whether the Location has been deleted or not. [REQUIRED]

boolean

None.

Main

Indicates whether the Location is the main Location for the Merchant. [REQUIRED]

boolean

None.

Latitude

GPS Latitude coordinates for location. [NULLABLE]

decimal number

None.

Longitude

GPS Longitude coordinates for location. [NULLABLE]

decimal number

None.

GeoLocation

Latitude and Longitude combined to get geographic point on Earth [NULL]

DbGeography

None.

GeoSpot

Indicates whether the location is used for an actual business or a location marker for targeting purposes [REQUIRED]

boolean

None.

StoreLocationId

Location Id for the POS [NULL]

string

None.

Merchant

Gets the Merchant using MerchantId.

Merchant

None.

CompleteAddress

Gets the complete address for the Location.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "00e47f12-58b7-4a1b-a194-4ab7ec77a278",
  "MerchantId": "1db5939b-3c22-4e89-be39-b00ab98924e5",
  "Active": true,
  "Name": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "ZipCode": "sample string 9",
  "PhoneNumber": "sample string 10",
  "Deleted": true,
  "Main": true,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "GeoLocation": null,
  "GeoSpot": true,
  "StoreLocationId": "sample string 14",
  "Merchant": {
    "$id": "2",
    "Id": "c97892e9-54e5-4e12-8472-e3ce7f981c0b",
    "PlanId": "8375b9b3-e29d-424b-9e54-b3af47c6adcc",
    "StripeToken": "sample string 2",
    "StripeCustomerId": "sample string 3",
    "CompanyName": "sample string 4",
    "UserId": "sample string 5",
    "Active": true,
    "Deleted": true,
    "TimeZone": "sample string 8",
    "User": {
      "$id": "3",
      "Id": "sample string 1",
      "Email": "sample string 2",
      "EmailConfirmed": true,
      "UserName": "sample string 10",
      "FirstName": "sample string 11",
      "LastName": "sample string 12",
      "Address1": "sample string 13",
      "Address2": "sample string 14",
      "City": "sample string 15",
      "State": "sample string 16",
      "Country": "sample string 17",
      "ZipCode": "sample string 18",
      "DateRegistered": "2018-12-12T05:52:38.3369879+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-12-12T05:52:38.3369879+00:00",
      "TermsConditions": true,
      "MobileNumber": "sample string 21",
      "ProfileImage": "sample string 22",
      "FullName": "sample string 12, sample string 11",
      "Roles": [
        {
          "$id": "4",
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Users": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ]
        },
        {
          "$ref": "4"
        }
      ]
    },
    "Plan": {
      "$id": "5",
      "Id": "687b859a-ba32-49de-b42e-16f4d259191a",
      "PlanName": "sample string 2",
      "Description": "sample string 3",
      "LimitedApps": true,
      "AppLimit": 1,
      "LimitedLocations": true,
      "LocationLimit": 1,
      "LimitedOffers": true,
      "OfferLimit": 1,
      "Amount": 1,
      "WithCall": true,
      "SortNo": 8,
      "Billable": true
    },
    "MerchantLocations": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  },
  "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.MerchantConsumer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.MerchantConsumer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MerchantLocation'.

Response Information

Resource Description

Returns a MerchantLocation or an alert message/email if the MerchantLocation limit has been reached

MerchantLocation
NameDescriptionTypeAdditional information
Id

GUID Id for Location. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

MerchantId

GUID Id for Merchant. [REQUIRED]

globally unique identifier

None.

Active

Indicates whether the Location is active or not. [REQUIRED]

boolean

None.

Name

Name of the Location. [NULL]

string

None.

Address1

Address 1 for the Location. [NULL]

string

None.

Address2

Address 2 for the Location. [NULL]

string

None.

City

City of the Location [NULL]

string

None.

State

State of the Location [NULL]

string

None.

ZipCode

ZipCode for the Location [NULL]

string

None.

PhoneNumber

Phone number for the Location [NULL]

string

None.

Deleted

Indicates whether the Location has been deleted or not. [REQUIRED]

boolean

None.

Main

Indicates whether the Location is the main Location for the Merchant. [REQUIRED]

boolean

None.

Latitude

GPS Latitude coordinates for location. [NULLABLE]

decimal number

None.

Longitude

GPS Longitude coordinates for location. [NULLABLE]

decimal number

None.

GeoLocation

Latitude and Longitude combined to get geographic point on Earth [NULL]

DbGeography

None.

GeoSpot

Indicates whether the location is used for an actual business or a location marker for targeting purposes [REQUIRED]

boolean

None.

StoreLocationId

Location Id for the POS [NULL]

string

None.

Merchant

Gets the Merchant using MerchantId.

Merchant

None.

CompleteAddress

Gets the complete address for the Location.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "1786a6a3-f064-4470-81e2-559865a0a169",
  "MerchantId": "76836559-d88a-49c9-9b90-0c58e6226a1a",
  "Active": true,
  "Name": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "ZipCode": "sample string 9",
  "PhoneNumber": "sample string 10",
  "Deleted": true,
  "Main": true,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "GeoLocation": null,
  "GeoSpot": true,
  "StoreLocationId": "sample string 14",
  "Merchant": {
    "$id": "2",
    "Id": "c5a980d0-d3b0-474b-9446-057d2f7d9c77",
    "PlanId": "c2da9085-860c-4207-86b7-90a6062846a1",
    "StripeToken": "sample string 2",
    "StripeCustomerId": "sample string 3",
    "CompanyName": "sample string 4",
    "UserId": "sample string 5",
    "Active": true,
    "Deleted": true,
    "TimeZone": "sample string 8",
    "User": {
      "$id": "3",
      "Id": "sample string 1",
      "Email": "sample string 2",
      "EmailConfirmed": true,
      "UserName": "sample string 10",
      "FirstName": "sample string 11",
      "LastName": "sample string 12",
      "Address1": "sample string 13",
      "Address2": "sample string 14",
      "City": "sample string 15",
      "State": "sample string 16",
      "Country": "sample string 17",
      "ZipCode": "sample string 18",
      "DateRegistered": "2018-12-12T05:52:38.4932375+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-12-12T05:52:38.4932375+00:00",
      "TermsConditions": true,
      "MobileNumber": "sample string 21",
      "ProfileImage": "sample string 22",
      "FullName": "sample string 12, sample string 11",
      "Roles": [
        {
          "$id": "4",
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Users": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ]
        },
        {
          "$ref": "4"
        }
      ]
    },
    "Plan": {
      "$id": "5",
      "Id": "db8fd802-622f-4876-b774-5e3f953fd476",
      "PlanName": "sample string 2",
      "Description": "sample string 3",
      "LimitedApps": true,
      "AppLimit": 1,
      "LimitedLocations": true,
      "LocationLimit": 1,
      "LimitedOffers": true,
      "OfferLimit": 1,
      "Amount": 1,
      "WithCall": true,
      "SortNo": 8,
      "Billable": true
    },
    "MerchantLocations": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  },
  "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.MerchantConsumer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.MerchantConsumer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.