GET api/role/{id}/offers?pageSize={pageSize}&pageNumber={pageNumber}&excludeDrafts={excludeDrafts}

Get all of the offers associated to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the role to get the offers for.

integer

Required

pageSize

Page size to return. Set to null for all

integer

None.

pageNumber

Page number to return. Set to null for all

integer

Default value is 1

excludeDrafts

The exclude drafts value supplied with the request.

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfOfferDataContract
NameDescriptionTypeAdditional information
TotalCount

The total count value.

integer

None.

CurrentCount

The current count value.

integer

None.

PageSize

The page size value.

integer

None.

PageNumber

The page number value.

integer

None.

Collection

The collection of collection.

Collection of OfferDataContract

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Collection[0].Response.Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Collection[0].Response.Documents[0].Attachments'.