GET api/v1/AddressBookApi/GetFOFHeader

Fetches the header for an FOF message.

Request Information

URI Parameters

None.

Body Parameters

The connection to the database.

TwoSms.Platform.Database.CustomerPortal.PortalDBContext
NameDescriptionTypeAdditional information
Accounts

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.Account

None.

AccountFeatures

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.AccountFeature

None.

AccountIdentityProviders

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.AccountIdentityProvider

None.

PasswordHistory

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.PasswordHistory

None.

Permissions

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.Permission

None.

Roles

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.Role

None.

RolePermissions

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.RolePermission

None.

Users

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.User

None.

Contacts

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.Contact

None.

UserClaims

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserClaim

None.

UserGroups

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserGroup

None.

UserGroupMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserGroupMapping

None.

UserGroupRoleMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserGroupRoleMapping

None.

UserLogins

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserLogin

None.

UserMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserMapping

None.

UserRoles

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserRole

None.

SmsPersonPlusMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.SmsPortalMapping

None.

Clients

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.Client

None.

RootAccounts

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.RootAccount

None.

UserClientCertificates

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Accounts.UserClientCertificate

None.

AddressBookGroupAccounts

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.AddressBook.AddressBookGroupAccount

None.

AddressBookGroupMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.AddressBook.AddressBookGroupMapping

None.

AddressBookGroups

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.AddressBook.AddressBookGroup

None.

AddressBookEntries

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.AddressBook.AddressBookEntry

None.

AddressBookMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.AddressBook.AddressBookMapping

None.

ErrorCodes

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.ErrorCode

None.

ErrorDescriptions

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.ErrorDescription

None.

Features

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.Feature

None.

Languages

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.Language

None.

PlaceHolders

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.PlaceHolder

None.

Links

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.Link

None.

SAMLIdentifiers

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SAML.Identifier

None.

SCIMAttributeMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SAML.SCIMAttributeMapping

None.

IdentityProviders

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SAML.IdentityProvider

None.

SSOSessions

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SAML.Session

None.

Messages

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.Message

None.

MessageResponses

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageResponse

None.

MessageDestinations

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageDestination

None.

MessageGroupMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageGroupMapping

None.

MessageReads

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageRead

None.

MessageSupplierInfos

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageSupplierInfo

None.

MessageTemplates

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageTemplate

None.

Statuses

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.Status

None.

StatusDescriptions

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.StatusDescription

None.

Templates

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.General.Template

None.

UrlManagements

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.UrlManagement

None.

MessagesTemplatesMappings

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessagesTemplatesMapping

None.

Tasks

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Task.Task

None.

TaskAccounts

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.Task.TaskAccount

None.

TeamData

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.TeamData

None.

AccessList

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.AccessList

None.

QuestionSet

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.QuestionSet

None.

DataSet

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.DataSet

None.

AnswerSet

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.AnswerSet

None.

RespondentSet

Collection of TwoSms.Platform.Database.CustomerPortal.Tables.TeamData.RespondentSet

None.

Database

System.Data.Entity.Database

None.

ChangeTracker

System.Data.Entity.Infrastructure.DbChangeTracker

None.

Configuration

System.Data.Entity.Infrastructure.DbContextConfiguration

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Header or null if no header is suitable

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string>sample string 1</string>