POST notifications/createorupdateregistration

Request Information

URI Parameters

None.

Body Parameters

DeviceRegistration
NameDescriptionTypeAdditional information
ApiKey

globally unique identifier

Required

ApplicationVersion

integer

Required

OSVersion

string

Required

ZoneID

integer

Required

Udid

string

Required

UserID

globally unique identifier

Required

RegistrationID

string

Required

Handle

string

Required

FavoritesLeafletRetailers

Collection of globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "ApiKey": "2e38c35d-52fb-4294-9651-637472691469",
  "ApplicationVersion": 2,
  "OSVersion": "sample string 3",
  "ZoneID": 4,
  "Udid": "sample string 5",
  "UserID": "39727e84-998d-4694-80ba-954355ffe829",
  "RegistrationID": "sample string 7",
  "Handle": "sample string 8",
  "FavoritesLeafletRetailers": [
    "e00af5ad-41ac-4636-8db7-60ebcd4657db",
    "bfc58a3e-2b76-4f65-a317-b2deda592f10"
  ]
}

application/xml, text/xml

Sample:
<DeviceRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.services.Notifications.Models">
  <ApiKey>2e38c35d-52fb-4294-9651-637472691469</ApiKey>
  <ApplicationVersion>2</ApplicationVersion>
  <FavoritesLeafletRetailers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>e00af5ad-41ac-4636-8db7-60ebcd4657db</d2p1:guid>
    <d2p1:guid>bfc58a3e-2b76-4f65-a317-b2deda592f10</d2p1:guid>
  </FavoritesLeafletRetailers>
  <Handle>sample string 8</Handle>
  <OSVersion>sample string 3</OSVersion>
  <RegistrationID>sample string 7</RegistrationID>
  <Udid>sample string 5</Udid>
  <UserID>39727e84-998d-4694-80ba-954355ffe829</UserID>
  <ZoneID>4</ZoneID>
</DeviceRegistration>

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

Response Information

Resource Description

CreateOrUpdateRegistrationResult
NameDescriptionTypeAdditional information
Success

boolean

None.

IsGone

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "IsGone": true
}

application/xml, text/xml

Sample:
<CreateOrUpdateRegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Notifications">
  <IsGone>true</IsGone>
  <Success>true</Success>
</CreateOrUpdateRegistrationResult>