OPTIONS api/UserAccount/GetSubscribers

Request Information

URI Parameters

None.

Body Parameters

GetSubscribersCommand
NameDescriptionTypeAdditional information
AccountId

string

None.

AddressId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountId": "sample string 1",
  "AddressId": "sample string 2"
}

application/xml, text/xml

Sample:
<GetSubscribersCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pronto.Core.Services.ServiceCommands">
  <AccountId>sample string 1</AccountId>
  <AddressId>sample string 2</AddressId>
</GetSubscribersCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of NotificationSubscriber
NameDescriptionTypeAdditional information
Email

string

None.

OrderNumber

string

None.

LoadNumber

string

None.

PONumber

string

None.

AccountId

string

None.

AddressId

string

None.

NotificationType

string

None.

AddedOn

date

None.

ModifiedOn

date

None.

Active

boolean

None.

NextStop

boolean

None.

RA

boolean

None.

RemoveSubscriber

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Email": "sample string 1",
    "OrderNumber": "sample string 2",
    "LoadNumber": "sample string 3",
    "PONumber": "sample string 4",
    "AccountId": "sample string 5",
    "AddressId": "sample string 6",
    "NotificationType": "sample string 7",
    "AddedOn": "2024-11-01T11:36:41.0564732+00:00",
    "ModifiedOn": "2024-11-01T11:36:41.0564732+00:00",
    "Active": true,
    "NextStop": true,
    "RA": true,
    "RemoveSubscriber": true
  },
  {
    "Email": "sample string 1",
    "OrderNumber": "sample string 2",
    "LoadNumber": "sample string 3",
    "PONumber": "sample string 4",
    "AccountId": "sample string 5",
    "AddressId": "sample string 6",
    "NotificationType": "sample string 7",
    "AddedOn": "2024-11-01T11:36:41.0564732+00:00",
    "ModifiedOn": "2024-11-01T11:36:41.0564732+00:00",
    "Active": true,
    "NextStop": true,
    "RA": true,
    "RemoveSubscriber": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfNotificationSubscriber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pronto.Core.Entities">
  <NotificationSubscriber>
    <AccountId>sample string 5</AccountId>
    <Active>true</Active>
    <AddedOn>2024-11-01T11:36:41.0564732+00:00</AddedOn>
    <AddressId>sample string 6</AddressId>
    <ModifiedOn>2024-11-01T11:36:41.0564732+00:00</ModifiedOn>
    <NextStop>true</NextStop>
    <NotificationType>sample string 7</NotificationType>
    <RA>true</RA>
    <RemoveSubscriber>true</RemoveSubscriber>
    <Email>sample string 1</Email>
    <LoadNumber>sample string 3</LoadNumber>
    <OrderNumber>sample string 2</OrderNumber>
    <PONumber>sample string 4</PONumber>
  </NotificationSubscriber>
  <NotificationSubscriber>
    <AccountId>sample string 5</AccountId>
    <Active>true</Active>
    <AddedOn>2024-11-01T11:36:41.0564732+00:00</AddedOn>
    <AddressId>sample string 6</AddressId>
    <ModifiedOn>2024-11-01T11:36:41.0564732+00:00</ModifiedOn>
    <NextStop>true</NextStop>
    <NotificationType>sample string 7</NotificationType>
    <RA>true</RA>
    <RemoveSubscriber>true</RemoveSubscriber>
    <Email>sample string 1</Email>
    <LoadNumber>sample string 3</LoadNumber>
    <OrderNumber>sample string 2</OrderNumber>
    <PONumber>sample string 4</PONumber>
  </NotificationSubscriber>
</ArrayOfNotificationSubscriber>