APIClientMappingResource
Allows to store and retrieve your id and version for entities, and get the Sowprog id of these entities
The following resources are applicable:
- /apiClientMapping/artist/{clientId}
- /apiClientMapping/event/{clientId}
- /apiClientMapping/eventGroup/{clientId}
- /apiClientMapping/eventStyle/{clientId}
- /apiClientMapping/eventType/{clientId}
- /apiClientMapping/location/{clientId}
/apiClientMapping/artist/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/artist/{clientId}
GET
Gets client mapping information for artist by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The artist id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for artist.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200
/apiClientMapping/event/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/event/{clientId}
GET
Gets client mapping information for event by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The event id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for event.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200
/apiClientMapping/eventGroup/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/eventGroup/{clientId}
GET
Gets client mapping information for eventGroup by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The eventGroup id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for eventGroup.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200
/apiClientMapping/eventStyle/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/eventStyle/{clientId}
GET
Gets client mapping information for eventStyle by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The eventStyle id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for eventStyle.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200
/apiClientMapping/eventType/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/eventType/{clientId}
GET
Gets client mapping information for eventType by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The eventType id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for eventType.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200
/apiClientMapping/location/{clientId}
Mount Point: /../../../api/v1/apiClientMapping/location/{clientId}
GET
Gets client mapping information for location by clientId
STATUS CODES :
200 - The mapping information is returned
404 - The location id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the mapping information
PUT
Update client mapping information for location.
STATUS CODES :
200 - The client mapping information was updated
404 - The client id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| clientId | client's id | path |
Request Body
| element: | APIClientMapping |
| media types: | application/xml application/json |
client mapping information
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the updated client mapping information or a message if the status is not 200