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": "e51dd75a-cd70-48cb-a3b1-9b5b1f9aa440",
  "MerchantId": "bac60e09-1aa5-442d-acf7-6201676d2a1f",
  "KeyId": "12b31970-44bc-453a-a111-9aaff5fa92b5",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2018-09-20T00:02:19.9850406+00:00",
  "Modified": "2018-09-20T00:02:19.9850406+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "074fa27d-9524-4cd4-b2f9-40c0deeec49c",
    "PlanId": "d6aba886-c70b-4f0e-a27b-a219634a672f",
    "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-20T00:02:19.9850406+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-09-20T00:02:19.9850406+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": "e3e93483-3a08-45a7-ae07-bccf19afb460",
      "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": "aa7c067a-e38f-4606-8f21-eeebae379cfb",
        "MerchantId": "0d612ff8-6d64-4b1f-868f-56600fc464d3",
        "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": {
          "$ref": "2"
        },
        "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "Key": {
    "$id": "7",
    "Id": "68306b63-febc-4ad4-ade7-bca5335e65de",
    "MerchantId": "041fef85-9464-42c5-99c6-8bcbf742650d",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2018-09-20T00:02:19.9850406+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": "2935cc6c-b60f-4c34-b5ad-f1c3c5799d96",
  "MerchantId": "0e99a143-3c8f-4c55-b4e7-1d84d839e599",
  "KeyId": "5fe346e4-6471-4277-a70e-5814ef04149f",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2018-09-20T00:02:20.1113261+00:00",
  "Modified": "2018-09-20T00:02:20.1113261+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "403c49e5-5b59-4392-9880-e8ae62f78041",
    "PlanId": "7de59adb-d2ae-4a7f-9579-6e561d902226",
    "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-20T00:02:20.1113261+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-09-20T00:02:20.1113261+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": "f7312312-aeee-40cf-bb13-0ca1e4a19fac",
      "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": "10c8085b-5c80-48b0-bb52-cafe3fd65ddd",
        "MerchantId": "b4d3971e-db14-43ad-8d3c-a188101948c8",
        "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": {
          "$ref": "2"
        },
        "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
      },
      {
        "$ref": "6"
      }
    ]
  },
  "Key": {
    "$id": "7",
    "Id": "805ce2b5-5258-48f6-a8e7-1611f5cf43f5",
    "MerchantId": "f1477287-e1ca-4383-8e67-eb224ea6584a",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2018-09-20T00:02:20.1113261+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.