GET api/public/v2/archivedJobsReport?model.MerchantApiKey={model.MerchantApiKey}&model.TeamIdentifier={model.TeamIdentifier}&model.OrganisationIdentifier={model.OrganisationIdentifier}&model.Month={model.Month}&model.Year={model.Year}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&paging.PagingMaxId={paging.PagingMaxId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
MerchantApiKey

globally unique identifier

Required

Matching regular expression pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

TeamIdentifier

globally unique identifier

Matching regular expression pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

OrganisationIdentifier

globally unique identifier

Matching regular expression pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Month

string

Required

Matching regular expression pattern: ^(0[1-9]|1[012])

Year

string

Required

Matching regular expression pattern: ^(20[0-9][0-9])$

PageNumber

The page number of the results. Note the first page is 1 (not 0). Defaults to first page.

integer

None.

PageSize

The amount of items to display in each page. Defaults to 50 records.

integer

None.

PagingMaxId

integer

None.

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.