Alfanavneanmodninger

API-ruter til at oprette og liste alfanavne (verificerede virksomhedsnavne, der bruges som meddelelsesafsender).

1. Opret organisationens alfanavn

Denne POST-anmodning bruges til at oprette et nyt alfanavn knyttet til en organisation. Anmodningen kræver en organisationsgodkendelsesnøgle i overskrifterne.

Anmodning

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metode: POST
• Overskrifter:
  • Accepter: application/json
  • X-Authorization-Key: {organization_token} (Oprettet i afsnittet Brugerprofil).

Krop:

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

Kropsparametre:

1. navn (streng): Det foreslåede alfanavn.
   • Krav: Længden skal være mindre end 12 tegn.
2. companyCode (String): Den virksomhedsregistreringskode, der er knyttet til alfanavnet (ERPOU/IPN for Ukraine).

Mulige svar:

• 200 OK: Alfanavn blev sendt til moderering/oprettelse.
• 400 Bad Request: Valideringsfejl (f.eks. navnet er for langt).
• 401 Uautoriseret: Ugyldig eller manglende ‘X-Authorization-Key’.

---

2. Hent alfanavneliste

Henter en opdateret liste over alfanavne, inklusive deres aktuelle modereringsstatusser.

Anmodning

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Metode: FÅ
• Overskrifter:
  • X-Authorization-Key: {organization_token}

Svar (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"
    }
]

Alfanavnestatusser (statuskode):

• PA - Afventer godkendelse
• A - Godkendt
• D - Afvist