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": "d2c50ce6-b6bc-41c2-902b-6f3e8c295375",
  "MerchantId": "58d830ff-fa66-434b-a5a8-1ceb5ee30b97",
  "KeyId": "b8eb0ac6-5da4-472f-828f-7fb80525ac9d",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2018-06-14T12:56:39.6259487+00:00",
  "Modified": "2018-06-14T12:56:39.6259487+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "517319bd-72f0-477c-8d16-f273682193bb",
    "PlanId": "7423308e-abd7-41bd-976a-e3c5c8fc049f",
    "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-14T12:56:39.6728364+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-06-14T12:56:39.6728364+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": "99a6d749-1ee3-41f1-b9e6-2bc38bc4cca1",
      "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": "55b921bb-1f62-4b55-b193-df5429c6ae2e",
        "MerchantId": "f61a3c62-f0da-4bb2-b260-50b829ecb1b1",
        "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": "a72d5c26-21fb-46cb-bbee-c0f237d546b0",
    "MerchantId": "428bfe31-68bb-465e-ad8e-ffef6db29d55",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2018-06-14T12:56:39.6884481+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": "f358e27c-02d1-47dd-93a4-11bee30bde24",
  "MerchantId": "0670944c-b6c3-473a-b0b0-0485ed77d1d0",
  "KeyId": "e13aa5d3-00af-4349-9ef3-958f7b558803",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Created": "2018-06-14T12:56:41.1715545+00:00",
  "Modified": "2018-06-14T12:56:41.1715545+00:00",
  "Photo": "sample string 7",
  "Deleted": true,
  "Merchant": {
    "$id": "2",
    "Id": "b86050a0-13b5-4c4f-82ff-69f26c4f8d7e",
    "PlanId": "28c1cb6a-2ef5-4735-a5ce-6b3d9b93620b",
    "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-14T12:56:41.1715545+00:00",
      "RegistrationCompleted": true,
      "LastLogin": "2018-06-14T12:56:41.1715545+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": "1041c755-18a1-42d0-a660-2e31a149d4a4",
      "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": "58ddb230-5071-4cad-b8e0-79216125aa68",
        "MerchantId": "31b3a09e-5630-4a89-935f-e97653e61379",
        "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": "30743a58-ae7a-47b9-ab82-aaa695cac842",
    "MerchantId": "82cc02b1-1d09-43ad-b742-b843b82131a5",
    "Name": "sample string 3",
    "SecretKey": "sample string 4",
    "Created": "2018-06-14T12:56:41.1715545+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.