POST v1/api/GetCommunicationOptions

Get Communication Options

Request Information

URI Parameters

None.

Body Parameters

CommunicationOptionsRequestDto

Name	Type	Additional information
CommunicationType	CommunicationTypeEnum	None.
CommunicationTypeValue	string	None.
CommunicationCountryCode	string	None.
UserId	string	None.
CompanyCode	SBLICompanyEnum	None.
UtcOffset	integer	None.
DaylightSavingsRecognized	YorNEnum	None.
CommunicationChannels	Collection of CommunicationChannelDto	None.

Request Formats

application/json

Sample:


REQUEST
{
  "CommunicationTypeValue": "1-123-978-5685",
}

Response Information

Resource Description

CommunicationOptionsResponseDto

Name	Description	Type	Additional information
CommunicationOptionsRecord		Collection of CommunicationOptionsRecordDto	None.

Response Formats

application/json

Sample:

RESPONSE
{
  "CommunicationOptionsRecord":[
    {
	  "CommunicationType":"C",
	  "CommunicationTypeValue":"1239785685",
	  "UserId":"SAMService",
	  "CommunicationChannel":"Marketing",
	  "CommunicationSubChannel":"BASE",
	  "PlatformName":"0ae7f8df-d645-e911-9108-005056b1ef67",
	  "OptIn":"P",
	  "ArticleTemplateId":"",
	  "SmsMessageId":"",
	  "SmsNotifyId":""
	},
	    {
	  "CommunicationType":"C",
	  "CommunicationTypeValue":"1239785685",
	  "UserId":"SAMService",
	  "CommunicationChannel":"Service",
	  "CommunicationSubChannel":"BASE",
	  "PlatformName":"0ae7f8df-d645-e911-9108-005056b1ef67",
	  "OptIn":"I",
	  "ArticleTemplateId":"",
	  "SmsMessageId":"",
	  "SmsNotifyId":""
	}
  ]
}