GET api/Request/GetHokmStatus?NationalCode={NationalCode}&LedgerNumber={LedgerNumber}&AccountNumber={AccountNumber}

Get Hokm Status - Allow Anonymous

Request Information

URI Parameters

NameDescriptionTypeAdditional information
NationalCode

string

Required

LedgerNumber

string

Required

AccountNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

HokmStatusResponseModel
NameDescriptionTypeAdditional information
Hokm

HokmModel

None.

Movazafin

Collection of MovazafModel

None.

HasAnyResult

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "hokm": {
    "dastgahPardakht": "sample string 1",
    "name": "sample string 2",
    "famil": "sample string 3",
    "namePedar": "sample string 4",
    "shShenasnameh": "sample string 5",
    "daftarKol": "sample string 6",
    "shMelli": "sample string 7",
    "title1": "sample string 8",
    "title2": "sample string 9",
    "title3": "sample string 10",
    "hokm_type_Prn_Desc": "sample string 11",
    "hokm_Type_Code": 12,
    "hoghoogh": 13,
    "hoghooghGhabl": 14,
    "afzayeshKahesh": 15,
    "shahr": "sample string 16",
    "dastgah": "sample string 17",
    "shomareHokm": 18,
    "tozihat": "sample string 19",
    "modirOstan": "sample string 20",
    "semat": "sample string 21",
    "trSodoor": "sample string 22"
  },
  "movazafin": [
    {
      "sahmHoghoogh": 1,
      "radifVarase": 2,
      "name": "sample string 3",
      "famil": "sample string 4",
      "nesbat": "sample string 5",
      "shMelli": "sample string 6",
      "trTavalod": "sample string 7"
    },
    {
      "sahmHoghoogh": 1,
      "radifVarase": 2,
      "name": "sample string 3",
      "famil": "sample string 4",
      "nesbat": "sample string 5",
      "shMelli": "sample string 6",
      "trTavalod": "sample string 7"
    }
  ],
  "hasAnyResult": true
}

text/html

Sample:
{"hokm":{"dastgahPardakht":"sample string 1","name":"sample string 2","famil":"sample string 3","namePedar":"sample string 4","shShenasnameh":"sample string 5","daftarKol":"sample string 6","shMelli":"sample string 7","title1":"sample string 8","title2":"sample string 9","title3":"sample string 10","hokm_type_Prn_Desc":"sample string 11","hokm_Type_Code":12,"hoghoogh":13,"hoghooghGhabl":14,"afzayeshKahesh":15,"shahr":"sample string 16","dastgah":"sample string 17","shomareHokm":18,"tozihat":"sample string 19","modirOstan":"sample string 20","semat":"sample string 21","trSodoor":"sample string 22"},"movazafin":[{"sahmHoghoogh":1,"radifVarase":2,"name":"sample string 3","famil":"sample string 4","nesbat":"sample string 5","shMelli":"sample string 6","trTavalod":"sample string 7"},{"sahmHoghoogh":1,"radifVarase":2,"name":"sample string 3","famil":"sample string 4","nesbat":"sample string 5","shMelli":"sample string 6","trTavalod":"sample string 7"}],"hasAnyResult":true}

application/xml, text/xml

Sample:
<HokmStatusResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Saba.Common.PublicApi">
  <Hokm>
    <AfzayeshKahesh>15</AfzayeshKahesh>
    <DaftarKol>sample string 6</DaftarKol>
    <Dastgah>sample string 17</Dastgah>
    <DastgahPardakht>sample string 1</DastgahPardakht>
    <Famil>sample string 3</Famil>
    <Hoghoogh>13</Hoghoogh>
    <HoghooghGhabl>14</HoghooghGhabl>
    <Hokm_Type_Code>12</Hokm_Type_Code>
    <Hokm_type_Prn_Desc>sample string 11</Hokm_type_Prn_Desc>
    <ModirOstan>sample string 20</ModirOstan>
    <Name>sample string 2</Name>
    <NamePedar>sample string 4</NamePedar>
    <Semat>sample string 21</Semat>
    <ShMelli>sample string 7</ShMelli>
    <ShShenasnameh>sample string 5</ShShenasnameh>
    <Shahr>sample string 16</Shahr>
    <ShomareHokm>18</ShomareHokm>
    <Title1>sample string 8</Title1>
    <Title2>sample string 9</Title2>
    <Title3>sample string 10</Title3>
    <Tozihat>sample string 19</Tozihat>
    <TrSodoor>sample string 22</TrSodoor>
  </Hokm>
  <Movazafin>
    <MovazafModel>
      <Famil>sample string 4</Famil>
      <Name>sample string 3</Name>
      <Nesbat>sample string 5</Nesbat>
      <RadifVarase>2</RadifVarase>
      <SahmHoghoogh>1</SahmHoghoogh>
      <ShMelli>sample string 6</ShMelli>
      <TrTavalod>sample string 7</TrTavalod>
    </MovazafModel>
    <MovazafModel>
      <Famil>sample string 4</Famil>
      <Name>sample string 3</Name>
      <Nesbat>sample string 5</Nesbat>
      <RadifVarase>2</RadifVarase>
      <SahmHoghoogh>1</SahmHoghoogh>
      <ShMelli>sample string 6</ShMelli>
      <TrTavalod>sample string 7</TrTavalod>
    </MovazafModel>
  </Movazafin>
</HokmStatusResponseModel>