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.

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": "fe112e95-69a8-44a1-9785-2757311f4db4",
  "MerchantId": "280e4046-95f3-4f98-8a35-9d75d6818ed6",
  "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,
  "Merchant": {
    "$id": "2",
    "Id": "e1426c72-6c88-424a-a0c9-47e6e6418d85",
    "PlanId": "b9a0007c-d08d-44d4-bc87-d864f8361ac8",
    "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-09-21T20:03:52.2600593+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-09-21T20:03:52.2600593+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": "bab0528d-3f82-47d0-a799-d27c74c4a076",
      "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.

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": "ecffaee9-b924-4e6c-a3b9-a3149e5a1ec8",
  "MerchantId": "ed55e840-da25-49fc-91e3-9fd2809b07bc",
  "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,
  "Merchant": {
    "$id": "2",
    "Id": "a8933d19-4fc3-47a7-9e9c-7f825f2189e6",
    "PlanId": "016edc81-7a85-4d7f-9124-acf7dd7b6f18",
    "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-09-21T20:03:52.3891037+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-09-21T20:03:52.3891037+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": "8ee1ae34-aede-4b6f-89de-cc6eda4f07c7",
      "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.