POST api/Apps

Create 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": "750b5719-4626-45f9-918b-240c956a180b",
  "MerchantId": "9d21a44d-b499-4824-9e44-5f419ab4c4e3",
  "KeyId": "962012df-97de-478d-9363-ccb7dae61b52",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2019-03-21T01:52:03.0474642+00:00",
  "Modified": "2019-03-21T01:52:03.0474642+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "d6825e0c-e68c-4bdf-9220-8925125cfac1",
    "PlanId": "f8aef282-3e3b-43d9-be4f-9fc22c812fb8",
    "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:52:03.0474642+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2019-03-21T01:52:03.0474642+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": "7555e7a7-52c0-4226-aac3-da853005753f",
      "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": "bb283580-e3c3-4100-864b-a97055f42a07",
        "MerchantId": "7c31fb43-c21c-4c06-8c73-c9edea378804",
        "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": "6ef661d8-46eb-4010-b698-ed1c617850dc",
    "MerchantId": "9220a55b-90bb-40b7-b829-72aac0f17120",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2019-03-21T01:52:03.0474642+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 or an alert message/email if the App limit has been reached

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": "aeba6d9d-8cc5-4504-8a79-f480ee733885",
  "MerchantId": "59b70aea-f35a-4230-b050-7f4349e12816",
  "KeyId": "595b89f5-bdbe-4f8a-999d-dec7273155fa",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2019-03-21T01:52:03.2154945+00:00",
  "Modified": "2019-03-21T01:52:03.2154945+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "f0114cdc-4973-437d-99f9-2a6c8f41b8aa",
    "PlanId": "f844f5a3-9371-49e8-8803-d4a78d79c957",
    "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:52:03.2154945+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2019-03-21T01:52:03.2154945+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": "09e2af8f-3d99-4915-89d6-4e93e881b82a",
      "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": "73237662-5a0a-4591-8af6-945e802ae19e",
        "MerchantId": "2bcf7251-3767-4e11-adbf-f40dd16b5375",
        "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": "a0ddb40d-5afb-43e0-a953-5e2ab5e8d7a9",
    "MerchantId": "0211efd8-657a-4969-8d0c-2e42128203e7",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2019-03-21T01:52:03.2154945+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.