PUT api/Apps

Update App

Request Information

URI Parameters

None.

Body Parameters

The App class

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.

Request Formats

application/json, text/json

Sample:
{
  "Id": "bbf75e47-ee6b-424a-bfaf-b868aeb82258",
  "MerchantId": "0de3742b-29d8-4196-b844-d10cda43a478",
  "KeyId": "04c6dfff-426a-4619-b2ef-470d3ddc7209",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2019-03-21T01:42:48.0286476+00:00",
  "Modified": "2019-03-21T01:42:48.0286476+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "77e2b8a5-8bb8-4469-8ca6-a85452ce17d4",
    "PlanId": "a8a5c260-fa7c-4fc5-a630-98122a952e78",
    "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": "2019-03-21T01:42:48.0286476+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2019-03-21T01:42:48.0286476+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": "9236d153-d369-433f-b6e1-88171c4a3db1",
      "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": "60f48a97-0461-440d-b047-0fb10bdb7b5e",
        "MerchantId": "6bc1563d-ec2c-4beb-9550-d795e7131c3e",
        "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": {
          "$ref": "2"
        },
        "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "Key": {
    "$id": "7",
    "Id": "23bf5bb3-3c51-4b7e-980b-866134f1af2e",
    "MerchantId": "cab5bd18-6cf4-4334-8f85-518fd114df3d",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2019-03-21T01:42:48.0397969+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.

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 'App'.

Response Information

Resource Description

Returns an App

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": "72417f01-f865-41e1-acf4-299d6c7c8669",
  "MerchantId": "51ac7553-753c-4718-a86a-04766e3c58e5",
  "KeyId": "9cdd415c-69b9-4d85-b975-8e53d25e9c17",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2019-03-21T01:42:48.1804399+00:00",
  "Modified": "2019-03-21T01:42:48.1804399+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "319ae587-993e-4bbf-8051-3aa59dcb40d4",
    "PlanId": "a1fb6446-f80e-42bf-b816-442b93d96962",
    "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": "2019-03-21T01:42:48.1804399+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2019-03-21T01:42:48.1804399+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": "02f7ccc5-e2f0-45fe-b0ae-f1798cd61b02",
      "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": "ec9f99cf-d376-4fd6-91ad-4e3388f9bfde",
        "MerchantId": "0491ecdc-c2ca-45c5-acd3-e41aa3d6964b",
        "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": {
          "$ref": "2"
        },
        "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "Key": {
    "$id": "7",
    "Id": "743c8329-c729-42a0-88fe-a2cd3d65c38f",
    "MerchantId": "604bfc4e-cd3c-4d50-aae4-4bd5eef24b90",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2019-03-21T01:42:48.1804399+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.