GET api/Apps/{merchantId}

Get Apps

Request Information

URI Parameters

NameDescriptionTypeAdditional information
merchantId

Id for the Merchant

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of Apps

App
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

MerchantId

GUID Id for Merchant. [REQUIRED]

globally unique identifier

None.

KeyId

GUID Id for API Key. [REQUIRED]

globally unique identifier

None.

Name

Name of App [NULL]

string

None.

Description

Description of App [NULL]

string

None.

Created

Date App was created. Assigned by system on Create. [REQUIRED]

date

None.

Modified

Date App was modified [NULLABLE]

date

None.

Photo

Photo of the App [NULL]

string

None.

Deleted

Indicates whether the App has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

Merchant

Gets the Merchant for the App.

Merchant

None.

Key

Gets the API Key for the App.

Key

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "282f2e67-522d-4326-8196-ebe867a03f94",
  "MerchantId": "88a95638-a4c6-442b-bbd5-6bcb2be3635e",
  "KeyId": "6c26e161-efde-4b69-8b2b-21ef7ba9b648",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2018-06-14T18:10:55.5705914+00:00",
  "Modified": "2018-06-14T18:10:55.5705914+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "9340892f-00f1-4b5b-a076-26a2828c86c3",
    "PlanId": "81b93948-5430-4624-80d6-b039e9d26010",
    "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-06-14T18:10:55.5705914+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-06-14T18:10:55.5705914+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": "c11f6488-3ead-44df-a217-23a45f6729f6",
      "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": [
      {
        "$id": "6",
        "Id": "c1d0f061-70f9-40f8-a868-b89f8289aac1",
        "MerchantId": "7de9bc6f-ff2e-42a4-b81a-09a32f373d90",
        "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,
        "Merchant": {
          "$ref": "2"
        },
        "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "Key": {
    "$id": "7",
    "Id": "7e73afd7-10ef-4b51-bf7d-39a167325e40",
    "MerchantId": "b5cda567-7c4c-4835-bfb2-04f8b4b10032",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2018-06-14T18:10:55.5705914+00:00",
    "Deleted": true,
    "Assigned": true,
    "Merchant": {
      "$ref": "2"
    }
  }
}

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 'FaceOffers.Entities.Consumer' 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 'FaceOffers.Entities.Consumer' contains cycles and cannot be serialized if reference tracking is disabled.