POST notifications/createregistrationid

Request Information

URI Parameters

None.

Body Parameters

CreateRegistrationIDRequest
NameDescriptionTypeAdditional information
ApiKey

globally unique identifier

Required

ApplicationVersion

integer

Required

ZoneID

integer

Required

Handle

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ApiKey": "652ac17e-92af-4059-a884-6591ce6f4788",
  "ApplicationVersion": 2,
  "ZoneID": 3,
  "Handle": "sample string 4"
}

application/xml, text/xml

Sample:
<CreateRegistrationIDRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Notifications">
  <ApiKey>652ac17e-92af-4059-a884-6591ce6f4788</ApiKey>
  <ApplicationVersion>2</ApplicationVersion>
  <Handle>sample string 4</Handle>
  <ZoneID>3</ZoneID>
</CreateRegistrationIDRequest>

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

Response Information

Resource Description

CreateRegistrationIDResult
NameDescriptionTypeAdditional information
RegistrationID

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "RegistrationID": "sample string 1",
  "Success": true
}

application/xml, text/xml

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