API Overview Resources Schemas

Schemas

ActorResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "code": "jjhags123-a1",
  "name": "Test Name",
  "surname": "Test Surname",
  "type": "INTERNAL_MANAGER",
  "email": "test@masmovil.es",
  "parent_id": "DEAL-1233",
  "relation_type": "DIRECT"
}

Name	Type	Required	Description
id	string	true	Id of the actor
code	string	true	Code of the actor
name	string	false	Name of the actor
surname	string	false	Surname of the actor
type	string	true	Enumeration of possible actor types
email	string	true	Email of the actor
parent_id	string	false	parentId if exist
relation_type	string	false	Enumeration of possible relations between actors and dealers

Property	Values
type	one of [INTERNAL_MANAGER, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, POS_MANAGER, TRAINER]
relation_type	one of [DIRECT_AND_INDIRECT, DIRECT, INDIRECT]

ApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

ApiErrorResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "ref": "string",
      "details": "string"
    }
  ]
}

Name	Type	Required	Description
errors	[ApiError]	false	none

ActorInsertRequest

1
2
3
4
5
6
7
8


{
  "code": "GTRW12341A",
  "name": "Test Name",
  "surname": "Surname Test",
  "type": "INTERNAL_MANAGER",
  "email": "test@masmovil.es",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}

Name	Type	Required	Description
code	string	true	Code of the actor
name	string	true	Name of the actor
surname	string	false	Surname of the actor msisdn
type	string	true	Enumeration of possible actor types
email	string	true	Email of the actor
parent_id	string	false	parentId if exist

Property	Values
type	one of [INTERNAL_MANAGER, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, POS_MANAGER, TRAINER]

DealerBillingRequest

1
2
3


{
  "billing_dealer_id": 123456
}

Name	Type	Required	Description
billing_dealer_id	integer(int32)	true	Id of the dealer that bill

TicketConfigInsertRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "printType": "A4"
}

Name	Type	Required	Description
commercialName	string	false	Commercial name of the ticket config
address	string	false	Address of the ticket config
city	string	false	City of the ticket config
province	string	false	Province of the ticket config
postalCode	string	false	Postal code of the ticket config
country	string	false	Country of the ticket config
documentType	string	false	Document type of the ticket config
documentNumber	string	false	Document number of the ticket config
printType	string	false	Print type of the ticket config

ActorTypeListApiModelRequest

1
2
3
4
5


{
  "actorTypes": [
    "INTERNAL_MANAGER"
  ]
}

Name	Type	Required	Description
actorTypes	[string]	false	List of actor types

ActorsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
      "code": "jjhags123-a1",
      "name": "Test Name",
      "surname": "Test Surname",
      "type": "INTERNAL_MANAGER",
      "email": "test@masmovil.es",
      "parent_id": "DEAL-1233",
      "relation_type": "DIRECT"
    }
  ]
}

Name	Type	Required	Description
offset	integer(int32)	false	Offset used to paginate in conjunction with limit
limit	integer(int32)	false	Max number of results of the response
total	integer(int32)	false	Total number of records
sort	string	false	The fields by which the results will be sorted. It can be a list of fields separated by commas
items	[ActorResponse]	true	List of items

ActorTypeResponse

1
2
3
4
5


{
  "types": [
    "INTERNAL_MANAGER"
  ]
}

Name	Type	Required	Description
types	[string]	true	List of actor types

BillingOfDealerResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "dealer_id": 12344567,
  "billing_dealer": {
    "id": 12344567,
    "code": "COD-123",
    "commercial_name": "Testing Test SL",
    "document_type": "DNI",
    "document_number": "12345678A"
  }
}

Name	Type	Required	Description
dealer_id	integer(int32)	true	Id of the dealer
billing_dealer	BillingResponse	true	Information of the billing of a dealer

BillingResponse

1
2
3
4
5
6
7


{
  "id": 12344567,
  "code": "COD-123",
  "commercial_name": "Testing Test SL",
  "document_type": "DNI",
  "document_number": "12345678A"
}

Name	Type	Required	Description
id	integer(int32)	true	Id of the dealer
code	string	true	Code of the dealer
commercial_name	string	true	CommercialName of the dealer
document_type	string	true	Type of the document
document_number	string	true	Number of the document

TicketConfigResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "dealerId": 1234,
  "printType": "A4"
}

Name	Type	Required	Description
id	string	true	Id of the ticket config
commercialName	string	true	Commercial name of the ticket config
address	string	true	Address of the ticket config
city	string	true	City of the ticket config
province	string	true	Province of the ticket config
postalCode	string	true	Postal code of the ticket config
country	string	true	Country of the ticket config
documentType	string	true	Document type of the ticket config
documentNumber	string	true	Document number of the ticket config
dealerId	integer(int32)	true	Dealer id related to the ticket config
printType	string	false	Print type of the ticket config

DealerResponse

1
2
3
4
5
6
7
8
9


{
  "id": 12344567,
  "code": "COD-123",
  "commercial_name": "Testing Test SL",
  "level_id": 2,
  "status_code": "ACTIVO",
  "subchannel_id": "1",
  "relation_type": "DIRECT"
}

Name	Type	Required	Description
id	integer(int32)	true	Id of the dealer
code	string	true	Code of the dealer
commercial_name	string	true	CommercialName of the dealer
level_id	integer(int32)	true	Level of the dealer
status_code	string	true	Status of the dealer
subchannel_id	string	true	Subchannel of the dealer
relation_type	string	false	Enumeration of possible relations between actors and dealers

Property	Values
relation_type	one of [DIRECT_AND_INDIRECT, DIRECT, INDIRECT]

DealersResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": 12344567,
      "code": "COD-123",
      "commercial_name": "Testing Test SL",
      "level_id": 2,
      "status_code": "ACTIVO",
      "subchannel_id": "1",
      "relation_type": "DIRECT"
    }
  ]
}

Name	Type	Required	Description
offset	integer(int32)	false	Offset used to paginate in conjunction with limit
limit	integer(int32)	false	Max number of results of the response
total	integer(int32)	false	Total number of records
sort	string	false	The fields by which the results will be sorted. It can be a list of fields separated by commas
items	[DealerResponse]	true	List of items

LoadsResponse

1
2
3


{
  "message": "string"
}

Name	Type	Required	Description
message	string	false	none

FixGeocodingDealer

1
2
3


{
  "dealer_id": 0
}

Name	Type	Required	Description
dealer_id	integer(int32)	true	The dealerId to identify a specific dealer

FixGeocodingResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "modified_dealers_ids": [
    {
      "dealer_id": 0
    }
  ],
  "not_modified_dealers_ids": [
    {
      "dealer_id": 0
    }
  ]
}

Name	Type	Required	Description
modified_dealers_ids	[FixGeocodingDealer]	true	The list of the dealers that were modified
not_modified_dealers_ids	[FixGeocodingDealer]	true	The list of the dealers that were NOT modified

ActorUpdateRequest

1
2
3
4
5
6
7


{
  "name": "Test Name",
  "surname": "Surname Test",
  "type": "INTERNAL_MANAGER",
  "email": "test@masmovil.es",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}

Name	Type	Required	Description
name	string	true	Name of the actor
surname	string	true	Surname of the actor msisdn
type	string	true	Enumeration of possible actor types
email	string	true	Email of the actor
parent_id	string	true	parentId if exist

Property	Values
type	one of [INTERNAL_MANAGER, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, POS_MANAGER, TRAINER]

TicketConfigUpdateRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "printType": "A4"
}

Name	Type	Required	Description
commercialName	string	true	Commercial name of the ticket config
address	string	true	Address of the ticket config
city	string	true	City of the ticket config
province	string	true	Province of the ticket config
postalCode	string	true	Postal code of the ticket config
country	string	true	Country of the ticket config
documentType	string	true	Document type of the ticket config
documentNumber	string	true	Document number of the ticket config
printType	string	true	Print type of the ticket config