Adds a new host code
post
/service/hostcodes
This endpoint is used to add a new host code.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
sourceCode: string
Source from which request is initiated
Request Body that contains data required for creating a new hostcodes
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : HostCodeDTO-allOf[1]
Type:
Show Source
object
-
countryOfficeCode:
string
Required Country Code
-
defaultBrCode(optional):
string
Required branch code which indicates the main branch of the group of branches linked to the same host code
-
hostCode:
string
Minimum Length:
1
Maximum Length:8
Pattern:[a-zA-Z0-9_]+
Processing zone that is applicable for the requests -
hostDescription:
string
Minimum Length:
1
Maximum Length:35
Description of the host code -
hostId(optional):
number
Host ID
-
processTimeZone:
string
Time zone that is used for processing the request
Response
Supported Media Types
- application/json
- application/xml
- text/csv
201 Response
Returns message of succes or failure
Headers
-
Location: string
URL of newly created hostcodes
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : HostCodeDTO-allOf[1]
Type:
Show Source
object
-
countryOfficeCode:
string
Required Country Code
-
defaultBrCode(optional):
string
Required branch code which indicates the main branch of the group of branches linked to the same host code
-
hostCode:
string
Minimum Length:
1
Maximum Length:8
Pattern:[a-zA-Z0-9_]+
Processing zone that is applicable for the requests -
hostDescription:
string
Minimum Length:
1
Maximum Length:35
Description of the host code -
hostId(optional):
number
Host ID
-
processTimeZone:
string
Time zone that is used for processing the request
Nested Schema : items
Type:
object
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error