PUT api/passes/getpasslist
Request Information
URI Parameters
None.
Body Parameters
PassAPIRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId | integer |
None. |
|
| UniqueId | globally unique identifier |
None. |
|
| ContactId | integer |
None. |
|
| LanguageId | integer |
None. |
|
| SearchText | string |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortBy | string |
None. |
|
| SortDir | string |
None. |
|
| ListType | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustomerId": 1,
"UniqueId": "d19b0297-b791-4369-825a-340c3b193311",
"ContactId": 3,
"LanguageId": 4,
"SearchText": "sample string 5",
"PageNumber": 6,
"PageSize": 7,
"SortBy": "sample string 8",
"SortDir": "sample string 9",
"ListType": 10
}
application/xml, text/xml
Sample:
<PassAPIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model"> <ContactId>3</ContactId> <CustomerId>1</CustomerId> <LanguageId>4</LanguageId> <ListType>10</ListType> <PageNumber>6</PageNumber> <PageSize>7</PageSize> <SearchText>sample string 5</SearchText> <SortBy>sample string 8</SortBy> <SortDir>sample string 9</SortDir> <UniqueId>d19b0297-b791-4369-825a-340c3b193311</UniqueId> </PassAPIRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APICommonWrapperOfPassListAPIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | HttpStatusCode |
None. |
|
| Message | string |
None. |
|
| Data | PassListAPIResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 100,
"Message": "sample string 1",
"Data": {
"PassList": [
{
"PassId": 1,
"PassTitle": "sample string 2",
"PassDescription": "sample string 3",
"PassRules": "sample string 4",
"PassTypeId": 5,
"PassType": "sample string 6",
"PassEndDate": "2026-04-17T11:38:51.284244+00:00",
"PassUseTimeLimit": "sample string 7",
"PassPrice": 8.0,
"IsRestricted": true
},
{
"PassId": 1,
"PassTitle": "sample string 2",
"PassDescription": "sample string 3",
"PassRules": "sample string 4",
"PassTypeId": 5,
"PassType": "sample string 6",
"PassEndDate": "2026-04-17T11:38:51.284244+00:00",
"PassUseTimeLimit": "sample string 7",
"PassPrice": 8.0,
"IsRestricted": true
}
],
"TotalRecords": 1
}
}
application/xml, text/xml
Sample:
<APICommonWrapperOfPassListAPIResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
<Data>
<PassList>
<PassList>
<IsRestricted>true</IsRestricted>
<PassDescription>sample string 3</PassDescription>
<PassEndDate>2026-04-17T11:38:51.284244+00:00</PassEndDate>
<PassId>1</PassId>
<PassPrice>8</PassPrice>
<PassRules>sample string 4</PassRules>
<PassTitle>sample string 2</PassTitle>
<PassType>sample string 6</PassType>
<PassTypeId>5</PassTypeId>
<PassUseTimeLimit>sample string 7</PassUseTimeLimit>
</PassList>
<PassList>
<IsRestricted>true</IsRestricted>
<PassDescription>sample string 3</PassDescription>
<PassEndDate>2026-04-17T11:38:51.284244+00:00</PassEndDate>
<PassId>1</PassId>
<PassPrice>8</PassPrice>
<PassRules>sample string 4</PassRules>
<PassTitle>sample string 2</PassTitle>
<PassType>sample string 6</PassType>
<PassTypeId>5</PassTypeId>
<PassUseTimeLimit>sample string 7</PassUseTimeLimit>
</PassList>
</PassList>
<TotalRecords>1</TotalRecords>
</Data>
<Message>sample string 1</Message>
<Status>Continue</Status>
</APICommonWrapperOfPassListAPIResponseZdSfSp5S>