Alfa nimede taotlus

API marsruudid alfanimede loomiseks ja loetlemiseks (teate saatjana kasutatavad kinnitatud ettevõttenimed).

1. Looge organisatsiooni alfanimi

Seda POST-päringut kasutatakse organisatsiooniga seotud uue alfanime loomiseks. Taotlus nõuab päistesse organisatsiooni autoriseerimisvõtit.

Taotlus - URL: https://restapi.smsbat.com/organizations/alpha_name - Meetod: POSTITA - Päised: - "Nõustu: rakendus/json". - X-Authorization-Key: {organization_token} (Loodud kasutajaprofiili jaotises).

Keha:

{
  "name": "testName",
  "companyCode": "88888888"
}

Keha parameetrid: 1. "nimi" (string): pakutud alfanimi. - Nõue: pikkus peab olema alla 12 tähemärgi. 2. Ettevõttekood (string): ettevõtte registreerimiskood, mis on seotud alfanimega (ERPOU/IPN Ukraina jaoks).

Võimalikud vastused: - 200 OK: Alfa nimi saadeti modereerimiseks/loomiseks. - 400 Bad Request: Valideerimisviga (nt nimi on liiga pikk). - 401 Volitamata: X-Authorization-Key on kehtetu või puudub.

---

2. Hankige alfanimede loend

Hangib ajakohase alfanimede loendi, sealhulgas nende praegused modereerimisolekud.

Taotlus - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Meetod: HANGI - Päised: - X-volituse võti: {organisation_token}

Vastus (200 OK):

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

Alfa nime olekud ("statusCode"): - „PA” – kinnitamise ootel - "A" - heaks kiidetud - "D" - Keeldunud