Skip to main content
POST
/
subscription
/
list
Get all subscription by status and organization id
curl --request POST \
  --url https://apigw.bienport.com/api/subscription/list \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '{
  "organizationId": 12312,
  "subscriptionStatus": 1
}'
[
  {
    "id": "123532",
    "type": "<string>",
    "documentNumber": "ABN-30514",
    "name": "F.KA***",
    "status": "Active",
    "characteristic": [
      {
        "name": "CAMPAIGN",
        "valueType": "String",
        "value": "İLK 9 AY %50"
      },
      {
        "name": "MONTAGEADRESS",
        "valueType": "String",
        "value": "***"
      },
      {
        "name": "MONTAGECOUNTY",
        "valueType": "String",
        "value": "KONAK"
      },
      {
        "name": "MONTAGECITY",
        "valueType": "String",
        "value": "İZMİR"
      },
      {
        "name": "MONTAGE_DATE",
        "valueType": "Date",
        "value": null
      },
      {
        "name": "TOTAL_PAST_DUE_INSTALMENT",
        "valueType": "Float",
        "value": "0.0"
      },
      {
        "name": "PANELBRAND",
        "valueType": "String",
        "value": null
      },
      {
        "name": "PANELMODEL",
        "valueType": "String",
        "value": null
      },
      {
        "name": "PANELNO",
        "valueType": "String",
        "value": null
      },
      {
        "name": "RESOURCE_ID",
        "valueType": "Long",
        "value": 23145
      },
      {
        "name": "SALESEMP",
        "valueType": "String",
        "value": "***"
      },
      {
        "name": "STAGE",
        "valueType": "String",
        "value": "1 - Kayıt"
      }
    ],
    "completionDate": {
      "endDateTime": "2022-08-16T00:00:00.000Z",
      "startDateTime": "2021-08-16T00:00:00.000Z"
    },
    "engagedParty": [
      {
        "id": "456789",
        "name": "<string>"
      }
    ]
  }
]

Headers

​
Authorization
string
required

Access Token

​
OrganizationId
string
required

Organization ID

Body

application/json

subscriptionRequest

Request Model for Get all Subscription by status and organization id

​
organizationId
integer
required

Organization Id

Example:

12312

​
subscriptionStatus
enum<integer>
required

Subscription Status( 1 : active,0 : passive, 2 : all)

Available options:
0,
1,
2
Example:

1

Response

List of Agreement returns.

​
id
string
Example:

"123532"

​
type
string
​
documentNumber
string
Example:

"ABN-30514"

​
name
string
Example:

"F.KA***"

​
status
enum<string>
Available options:
Passive,
Active
Example:

"Active"

​
characteristic
Characteristic · object[]
Example:
[
  {
    "name": "CAMPAIGN",
    "valueType": "String",
    "value": "İLK 9 AY %50"
  },
  {
    "name": "MONTAGEADRESS",
    "valueType": "String",
    "value": "***"
  },
  {
    "name": "MONTAGECOUNTY",
    "valueType": "String",
    "value": "KONAK"
  },
  {
    "name": "MONTAGECITY",
    "valueType": "String",
    "value": "İZMİR"
  },
  {
    "name": "MONTAGE_DATE",
    "valueType": "Date",
    "value": null
  },
  {
    "name": "TOTAL_PAST_DUE_INSTALMENT",
    "valueType": "Float",
    "value": "0.0"
  },
  {
    "name": "PANELBRAND",
    "valueType": "String",
    "value": null
  },
  {
    "name": "PANELMODEL",
    "valueType": "String",
    "value": null
  },
  {
    "name": "PANELNO",
    "valueType": "String",
    "value": null
  },
  {
    "name": "RESOURCE_ID",
    "valueType": "Long",
    "value": 23145
  },
  {
    "name": "SALESEMP",
    "valueType": "String",
    "value": "***"
  },
  {
    "name": "STAGE",
    "valueType": "String",
    "value": "1 - Kayıt"
  }
]
​
completionDate
object

A period of time, either as a deadline (endDateTime only) a startDateTime only, or both

​
engagedParty
RelatedParty · object[]